Converts a JSON schema to a Joi schema.
JavaScript
Switch branches/tags
Clone or download
Latest commit f3c72ab Jun 14, 2018
Permalink
Failed to load latest commit information.
lib add schame not support May 19, 2018
test add schame not support May 19, 2018
.eslintrc add rules Jan 9, 2018
.gitignore updated to ignore package-lock.json May 10, 2018
.npmignore bump version Jun 13, 2018
.travis.yml updated travis builds for 3.0 Dec 28, 2017
CHANGELOG.md bump version Jun 13, 2018
LICENSE.txt added license.txt Mar 13, 2018
README.md cleanup readme more Jan 10, 2018
package.json bump version Jun 13, 2018

README.md

Build Status NPM version

enjoi

Converts a JSON schema to a Joi schema for object validation.

Schema Support

enjoi is built against json-schema v4, but does not support all of json-schema.

Here is a list of some missing keyword support still being worked on:

  • object:patternProperties - Joi limitation.

API

  • enjoi(schema [, options])
    • schema - a JSON schema or a string type representation (such as 'integer').
    • options - an (optional) object of additional options such as subSchemas and custom types.
      • subSchemas - an (optional) object with keys representing schema ids, and values representing schemas.
      • types - an (optional) object with keys representing type names and values representing a Joi schema.
      • refineType(type, format) - an (optional) function to call to apply to type based on the type and format of the JSON schema.
      • strictMode - make schemas strict(value) with a default value of false.

Example:

const Joi = require('joi');
const Enjoi = require('enjoi');

const schema = Enjoi({
    type: 'object',
    properties: {
        firstName: {
            description: 'First name.',
            type: 'string'
        },
        lastName: {
            description: 'Last name.',
            type: 'string'
        },
        age: {
            description: 'Age in years',
            type: 'integer',
            minimum: 1
        }
    },
    'required': ['firstName', 'lastName']
});

Joi.validate({firstName: 'John', lastName: 'Doe', age: 45}, schema, function (error, value) {
    error && console.log(error);
});

Can also call validate directly on the created schema.

schema.validate({firstName: 'John', lastName: 'Doe', age: 45}, function (error, value) {
    error && console.log(error);
});

Sub Schemas

Sub-schemas can be provided through the subSchemas option for $ref values to lookup against.

Example:

const schema = Enjoi({
    type: 'object',
    properties: {
        a: {
            $ref: '#/b' // # is root schema
        },
        b: {
            type: 'string'
        },
        c: {
            $ref: '#sub/d' // #sub is 'sub' under subSchemas.
        }
    }
}, {
    subSchemas: {
        sub: {
            d: {
                'type': 'string'
            }
        }
    }
});

Custom Types

Custom types can be provided through the types option.

const schema = Enjoi({
    type: 'thing'
}, {
    types: {
        thing: Joi.any()
    }
});

Refine Type

You can use the refine type function to help refine types based on type and format. This will allow transforming a type for lookup against the custom types.

const schema = Enjoi({
    type: 'string',
    format: 'email'
}, {
    types: {
        email: Joi.string().email()
    },
    refineType(type, format) {
        if (type === 'string' && format === 'email') {
            return 'email';
        }
    }
});