schema-markdown v1.2.9

schema-markdown

schema-markdown is a schema definition and validation library.

Links

• The Schema Markdown Language
• API Documentation
• Source code

Define a Schema

Schemas are defined using the Schema Markdown language, which is parsed by the parseSchemaMarkdown function. For example:

import {parseSchemaMarkdown} from 'schema-markdown/lib/parser.js';

export const modelTypes = parseSchemaMarkdown(`\
# An aggregate numerical operation
struct Aggregation

    # The aggregation function - default is "Sum"
    optional AggregationFunction aggregation

    # The numbers to aggregate on
    int[len > 0] numbers

# An aggregation function
enum AggregationFunction
    Average
    Sum
`);

Validate using a Schema

To validate an object using the schema, use the validateType function. For example:

import {validateType} from 'schema-markdown/lib/schema.js';

const obj = validateType(modelTypes, 'Aggregation', {'numbers': [1, 2, '3', 4]});
console.assert(obj.numbers[2] === 3);

Notice that the numerical input '3' above is type-massaged to the integer 3 by validation.

Validation fails if the object does not match the schema:

try {
    validateType(modelTypes, 'Aggregation', {'numbers': [1, 2, 'asdf', 4]});
} catch ({message}) {
    console.assert(message === "Invalid value \"asdf\" (type 'string') for member 'numbers.2', expected type 'int'", message);
}

Validation also fails if a member constraint is violated:

try {
    validateType(modelTypes, 'Aggregation', {'numbers': []});
} catch ({message}) {
    console.assert(message === "Invalid value [] (type 'object') for member 'numbers', expected type 'array' [len > 0]", message);
}

Document a Schema

To document the schema, download the documentation application stub and save the type model as JSON:

curl -O https://craigahobbs.github.io/schema-markdown-doc/extra/index.html
node --input-type=module \
    -e 'import {modelTypes} from "model.js"; console.log(JSON.stringify(modelTypes))' \
    > model.json

To host locally, start a local static web server:

python3 -m http.server

Development

This package is developed using javascript-build. It was started using javascript-template as follows:

template-specialize javascript-template/template/ schema-markdown-js/ -k package schema-markdown -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapp 1