@tokenscript/libxmljs2-xsd

libxmljs2-xsd
===============


XSD 1.0 validation for node.js 16.x, 18.x and 20.x using libxml via libxmljs2
As of now, XSD 1.1 is not supported, and the author does not actively work on it. Feel free to submit a PR if you want to.

Installation
------------

npm install libxmljs2-xsd

On windows there are several prerequisites that need to be met before an install will work.
Windows-Build-Tools is a great helper module for this task.

npm install --global --production windows-build-tools
npm install libxmljs2-xsd

Basic usage
-----------

``js
var xsd = require('libxmljs2-xsd');
// throws in case of error
var schema = xsd.parseFile(schemaPath);
// throws in case of technical error, returns a list of validation errors,
// or null if the document is valid
var validationErrors = schema.validate(documentString);
});
`

libxmljs2 integration
--------------------

libxmljs2-xsd depends on libxmljs2 that bundles libxml.

The libxmljs2 module required by node-libxml-xsd is exposed as `require('libxmljs2-xsd').libxmljs``. This prevents depending on libxmljs2 twice which is not optimal and source of weird bugs.

It is possible to work with libxmljs2 documents instead of strings as inputs to the parse() and validate() functions.

Imports and includes
--------------------

XSD includes are supported but relative paths must be given from the execution directory, usually the root of the project.

Includes are resolved when parsing the schema. Therefore the parsing task becomes IO bound, which is why you should not use synchronous parsing when you expect some includes.

Environment compatibility
-------------------------

For now 64bits linux and 32bits windows are confirmed. Other environments are probably ok, but not checked. Please report an issue if you encounter some difficulties.

node-libxml-xsd depends on node-gyp, you will need to meet its requirements. This can be a bit painful mostly for windows users. The node-gyp version bundled in your npm will have to be greater than 0.13.0, so you might have to follow these instructions to upgrade. There is no system dependancy otherwise as libxml is bundled by libxmljs2.

API Reference
=============

libxml-xsd

Node.js bindings for XSD validation from libxml

* libxml-xsd
* _static_
* .libxmljs
* .parse(source, options) ⇒
* .parseFile(sourcePath, options) ⇒
* _inner_
* ~Schema
* new Schema(schemaDoc, schemaObj)
* .validate(source) ⇒
* .validateFile(sourcePath) ⇒

$3

The libxmljs module. Prevents the need for a user's code to require it a second time. Also prevent weird bugs.

Kind: static property of libxml-xsd

$3

Parse a XSD schema

Kind: static method of libxml-xsd
Returns: The parsed Schema

| Param | Type | Description |
| --- | --- | --- |
| source | string \| Document | The content of the schema as a string or a libxmljs document |
| options | object | The parsing options |

$3

Parse a XSD schema

Kind: static method of libxml-xsd
Returns: The parsed Schema

| Param | Type | Description |
| --- | --- | --- |
| sourcePath | stringPath | The path of the file |
| options | object | The parsing options |

$3

Kind: inner class of libxml-xsd

* ~Schema
* new Schema(schemaDoc, schemaObj)
* .validate(source) ⇒
* .validateFile(sourcePath) ⇒

#### new Schema(schemaDoc, schemaObj)
A compiled schema. Do not call this constructor, instead use parse or parseFile.

store both the source document and the parsed schema
if we don't store the schema doc it will be deleted by garbage collector and it will result in segfaults.

| Param | Type | Description |
| --- | --- | --- |
| schemaDoc | Document | XML document source of the schema |
| schemaObj | Document | Simple wrapper of a XSD schema |

#### schema.validate(source) ⇒
Validate a XML document over a schema

Kind: instance method of Schema
Returns: An array of validation errors, or null if document is valid

| Param | Type | Description |
| --- | --- | --- |
| source | string \| Document | The XML content to validate with the schema, to be given as a string or a libxmljs document |

#### schema.validateFile(sourcePath) ⇒
Apply a schema to a XML file

Kind: instance method of Schema
Returns: An array of validation errors, or null if document is valid

| Param | Type | Description |
| --- | --- | --- |
| sourcePath | string | The path of the file to read |

documented by jsdoc-to-markdown.