chai-json-schema-ajv

A chai plugin for validate json schema.

This is based on ajv, a JSON schema Validator.

version	ajv version	json schema version
v1	4.11.8	JSON Schema draft 4
v2	5.5.2	JSON Schema draft-06
v3	^6.7.0	JSON Schema draft-07
v4	>=4 <7
v5	>=4 <7	Same as v4, but different message format
v5.2	>=4

Installation

1npm i ajv --save-dev # Or any version you prefer `npm i ajv@4 --save-dev`
2npm i chai-json-schema-ajv --save-dev

Usage

Validate data (jsonSchema)

1const chai = require('chai')
2chai.use(require('chai-json-schema-ajv'))
3const expect = chai.expect
4const assert = chai.assert
5
6const apple = {
7  name: 'foo',
8  color: ['red', 'green', 'yellow'],
9  value: 10
10}
11const car = {
12  name: 'bar',
13  speed: 1.1
14}
15const schema = {
16  title: 'fruit schema v0.1',
17  type: 'object',
18  required: ['name', 'color', 'value'],
19  properties: {
20    name: {
21      type: 'string',
22      minLength: 3
23    },
24    color: {
25      type: 'array',
26      minItems: 1,
27      uniqueItems: true,
28      items: {
29        type: 'string'
30      }
31    },
32    value: {
33      type: 'integer',
34      minimum: 5
35    }
36  }
37}
38
39expect(apple).to.be.jsonSchema(schema, 'custom flag')
40expect(car).to.not.be.jsonSchema(schema, 'custom flag')
41
42assert.jsonSchema(apple, schema, 'custom flag')
43assert.notJsonSchema(car, schema, 'custom flag')

Validate schema (validJsonSchema)

1const chai = require('chai')
2chai.use(require('chai-json-schema-ajv'))
3const expect = chai.expect
4const assert = chai.assert
5
6const schema = {
7  title: 'valid schema',
8  type: 'object',
9  required: ['name'],
10  properties: {
11    name: {
12      type: 'string',
13      minLength: 3
14    }
15  }
16}
17
18expect(schema, 'custom flag').to.be.validJsonSchema
19expect({ type: '__invalid__' }, 'custom flag').to.not.be.validJsonSchema
20
21assert.validJsonSchema(schema, 'custom flag')
22assert.notValidJsonSchema({ type: '__invalid__' }, 'custom flag')

Custom options

Options will also pass to ajv

1...
2const options = { ... }
3chai.use(
4  require('chai-json-schema-ajv').create(options)
5)
6...
7
8// Basically, it's same as `new Ajv(options)`

Option verbose

Default error message is parsed by ajv.errorsText.

1...
2chai.use(
3  require('chai-json-schema-ajv')
4)
5...

1expected data to match json-schema
2data should have required property 'color'

If you go with option {verbose: true}, it will print full errors.

1...
2chai.use(
3  require('chai-json-schema-ajv').create({
4    verbose: true
5  })
6)
7...

1expected { name: 'bar', speed: 1.1 } to match json-schema
2[ { keyword: 'required',
3    dataPath: '',
4    schemaPath: '#/required',
5    params: { missingProperty: 'color' },
6    message: 'should have required property \'color\'',
7    schema: 
8     { name: { type: 'string', minLength: 3 },
9       color: 
10        { type: 'array',
11          minItems: 1,
12          uniqueItems: true,
13          items: { type: 'string' } },
14       value: { type: 'integer', minimum: 5 } },
15    parentSchema: 
16     { title: 'fruit schema v0.1',
17       type: 'object',
18       required: [ 'name', 'color', 'value' ],
19       properties: 
20        { name: { type: 'string', minLength: 3 },
21          color: 
22           { type: 'array',
23             minItems: 1,
24             uniqueItems: true,
25             items: { type: 'string' } },
26          value: { type: 'integer', minimum: 5 } } },
27    data: { name: 'bar', speed: 1.1 } } ]

Option ajv

If you want to reuse ajv instance, you can

1const ajv = new Ajv
2...
3chai.use(
4  require('chai-json-schema-ajv').create({
5    ajv
6  })
7)
8...
9
10assert.ok(ajv === chai.ajv)

Access ajv instance

1...
2chai.use(
3  require('chai-json-schema-ajv')
4)
5...
6
7assert.ok(chai.ajv instanceof Ajv)

TODO

• Support browser side
• Move to es2017 async/await
• Add linter
• Send option to ajv (thanks @dimac)

License

MIT