@ephesoft/validation.sdk v1.16.0

README

@ephesoft/validation.sdk

This library contains custom validators and patterns.

IMPORTANT: @ephesoft/core.sdk is required as a peer dependency when using classes under the validators/json namespace.

TOC

Using the library

Prerequisites

Add the package to your repository:

npm i @ephesoft/validation.sdk

Using the library

Using the patterns:

// Import Library
import { patterns } from '@ephesoft/validation.sdk';
import { expect } from 'chai'; // Used for example

// Check ISO 8601 date
expect('2001-01-1T00:00:00.000Z').to.match(patterns.iso8601utc);

// Check URL
expect(patterns.url.test('whoneedsprotocols.com')).to.equal(false);

// Check UUID
expect(patterns.uuid.test('a60474ce-6a61-11ea-bc55-0242ac130003')).to.equal(true);

// Many more patterns....

Using the JSON Schema Validator (JSON Schema):

// Import Library
import { JsonSchemaValidator } from '@ephesoft/validation.sdk/validators/json/JsonSchemaValidator';
import { expect } from 'chai'; // Used for example

// Validate Success - empty array
const validator = new JsonSchemaValidator({ type: 'object' });
expect(validator.validate({})).to.deep.equal([]);

// Validation Issues - See response for each issue
const validator = new JsonSchemaValidator({
    type: 'object',
    properties: {
        key: { type: 'string' }
    },
    required: ['key']
});
expect(validator.validate({ key: 42 })).to.deep.equal([
    {
        code: 'type',
        message: 'must be string',
        location: {
            objectPath: '/key',
            schemaPath: '#/properties/key/type'
        },
        context: {
            type: 'string'
        }
    }
]);

NPM run targets

Run NPM commands as

npm run command

Available Commands