Schema Validator README

Overview

This package is a schema validation tool designed to validate JSON schemas and their associated example objects. The validator uses the AJV (Another JSON Validator) library, along with plugins for custom formats and error handling.

It validates the presence of required schema fields, checks for correct naming and versioning conventions, and ensures that example data complies with the schema.

Installation

npm install @nqminds/schema-validator

Usage

This package provides two key functions:

1. validateSchema(schema): Validates the structure of a JSON schema and its example data.
2. validateJsonObjectAgainstSchema(schema, jsonObject): Validates a JSON object against a given schema.

Importing the Library

You can import the library in either CommonJS or ES module format depending on your environment.

For CommonJS (Node.js):

const { validateSchema, validateJsonObjectAgainstSchema } = require('@nqminds/schema-validator');

For ES Modules:

import { validateSchema, validateJsonObjectAgainstSchema } from '@nqminds/schema-validator';

Example Usage

1. Validate a JSON Schema

const schema = {
  $id: 'https://example.com/schemas/schema-1.v1.0.0.schema.yaml',
  title: 'Example Schema',
  description: 'An example schema for testing',
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'number', minimum: 0 }
  },
  required: ['name', 'age'],
  examples: [
    { name: 'John', age: 30 },
    { name: 'Jane', age: 25 }
  ]
};

const results = validateSchema(schema);
console.log(results);

2. Validate a JSON Object Against a Schema

const jsonObject = {
  name: 'John',
  age: 30
};

const validationResults = validateJsonObjectAgainstSchema(schema, jsonObject);
console.log(validationResults);

Functions

validateSchema(schema)

• Parameters: A valid JSON schema object.
• Returns: An object containing:
  • errors: Array of errors (if any).
  • exampleValidation: Boolean indicating whether the example data in the schema is valid.
  • schemaValidation: Boolean indicating whether the schema compiled successfully.

validateJsonObjectAgainstSchema(schema, jsonObject)

• Parameters:
  • schema: A valid JSON schema.
  • jsonObject: A JSON object to validate against the schema.
• Returns: An object containing:
  • valid: Boolean indicating if the JSON object is valid.
  • errors: Array of errors (if any).

Custom Fields and Formats

This validator includes support for additional fields such as units and helpText that might not be standard in JSON schemas but are necessary for specific use cases.

Running Tests

You can run the test suite using Jest:

npm test

Build

The package uses Rollup for building the CommonJS and ES module versions of the library:

npm run build

Development

To contribute to the project or modify it locally:

1. Clone the repository.
2. Install dependencies using npm install.
3. Run npm run build to compile the project.

Dependencies

• AJV: JSON Schema Validator
• ajv-errors: Custom error messages for AJV
• ajv-formats: Adds support for standard formats like date-time, email, etc.