@rjsf/validator-ajv8

What is @rjsf/validator-ajv8?

@rjsf/validator-ajv8 is a validation package for React JSON Schema Form (RJSF) that uses AJV version 8 for JSON schema validation. It allows you to validate form data against a JSON schema, ensuring that the data conforms to the specified structure and constraints.

What are @rjsf/validator-ajv8's main functionalities?

Schema Validation

This feature allows you to validate data against a JSON schema. The code sample demonstrates how to compile a schema and validate data using AJV.

const Ajv = require('ajv');
const ajv = new Ajv();
const schema = {
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'integer' }
  },
  required: ['name', 'age']
};
const validate = ajv.compile(schema);
const data = { name: 'John', age: 30 };
const valid = validate(data);
if (!valid) console.log(validate.errors);

Custom Keywords

This feature allows you to add custom validation keywords to your schema. The code sample shows how to add a custom keyword 'isPositive' and use it in a schema.

const Ajv = require('ajv');
const ajv = new Ajv();
ajv.addKeyword('isPositive', {
  type: 'number',
  validate: (schema, data) => data > 0
});
const schema = {
  type: 'object',
  properties: {
    positiveNumber: { type: 'number', isPositive: true }
  }
};
const validate = ajv.compile(schema);
const data = { positiveNumber: 10 };
const valid = validate(data);
if (!valid) console.log(validate.errors);

Error Messages

This feature provides detailed error messages when validation fails. The code sample demonstrates how to enable all error messages and validate data that does not meet the schema requirements.

const Ajv = require('ajv');
const ajv = new Ajv({ allErrors: true });
const schema = {
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'integer', minimum: 18 }
  },
  required: ['name', 'age']
};
const validate = ajv.compile(schema);
const data = { name: 'John', age: 16 };
const valid = validate(data);
if (!valid) console.log(validate.errors);

Other packages similar to @rjsf/validator-ajv8

ajv

AJV (Another JSON Schema Validator) is a popular JSON schema validator used for validating data against JSON schemas. It is highly performant and supports JSON Schema draft-07 and later. Compared to @rjsf/validator-ajv8, AJV is a more general-purpose validator and can be used outside of the React JSON Schema Form context.

jsonschema

The jsonschema package is a simple and lightweight JSON schema validator for JavaScript. It supports JSON Schema draft-04 and is easy to use for basic validation needs. While it is not as feature-rich as AJV, it provides a straightforward way to validate JSON data. Compared to @rjsf/validator-ajv8, jsonschema is less powerful but may be sufficient for simpler use cases.

is-my-json-valid

is-my-json-valid is a fast JSON schema validator that supports JSON Schema draft-04. It is designed for performance and can be used in both Node.js and browser environments. Compared to @rjsf/validator-ajv8, is-my-json-valid is focused on speed and may lack some of the advanced features provided by AJV.

README

@rjsf/validator-ajv8

AJV-8 based validator plugin for react-jsonschema-form.
Explore the docs »

View Playground · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Contact

About The Project

Exports validator-ajv8 plugin for react-jsonschema-form.

Built With

• react-jsonschema-form
• AJV
• TypeScript

Getting Started

Prerequisites

React JsonSchema Form Utils

• @rjsf/utils >= 5.0.0

yarn add @rjsf/core

Installation

yarn add @rjsf/validator-ajv8

Usage

import {RJSFSchema} from "packages/utils/dist/index";
import Form from 'packages/core/dist/index';
import validator from '@rjsf/validator-ajv8';

const schema: RJSFSchema = {
    type: 'string',
};

<Form schema={schema} validator={validator}/>

or, using a more complex example using custom validator with custom formats

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv8';

const customFormats = {
  'phone-us': /\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$/
};

const validator = customizeValidator({
  customFormats,
});

const schema: RJSFSchema = {
  type: 'string',
  format: 'phone-us'
};

<Form schema={schema} validator={validator} />

or, using a more complex example using a custom with additional meta schema

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv8';

const metaSchemaDraft06 = require("ajv/lib/refs/json-schema-draft-06.json");

const validator = customizeValidator({
  additionalMetaSchemas: [metaSchemaDraft06],
});

const schema: RJSFSchema = {
  "$schema": "http://json-schema.org/draft-06/schema#",
  type: 'string',
};

<Form schema={schema} validator={validator} />

or, using a more complex example using custom validator config override options

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv8';

const validator = customizeValidator({
  ajvOptionsOverrides: {
    $data: true,
    verbose: true,
  }
});

const schema: RJSFSchema = {
  type: 'string',
};

<Form schema={schema} validator={validator} />

or, using a more complex example using ajv-formats custom format options.

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv8';

const validator = customizeValidator({
  ajvFormatOptions: {
    keywords: true,
    formats: ["date", "time"]
  }
});

const schema: RJSFSchema = {
  type: 'string',
};

<Form schema={schema} validator={validator} />

Finally, you can combine both additional meta schemas, custom formats, custom validator config override options and ajv-formats custom format options.

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv8';

const metaSchemaDraft06 = require("ajv/lib/refs/json-schema-draft-06.json");

const customFormats = {
  'phone-us': /\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$/
};

const validator = customizeValidator({
  additionalMetaSchemas: [metaSchemaDraft06],
  customFormats,
  ajvOptionsOverrides: {
    $data: true,
    verbose: true,
  },
  ajvFormatOptions: {
    keywords: true,
    formats: ["date", "time"]
  }
});

const schema: RJSFSchema = {
  "$schema": "http://json-schema.org/draft-06/schema#",
  type: 'string',
  format: 'phone-us'
};

<Form schema={schema} validator={validator} />

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Read our contributors' guide to get started.

Contact

rjsf team: https://github.com/orgs/rjsf-team/people

GitHub repository: https://github.com/rjsf-team/react-jsonschema-form

Changelog

v5.0.0-beta.6

@rjsf/bootstrap-4

• Change custom attribute to bsPrefix by @WillowP, fixing (https://github.com/rjsf-team/react-jsonschema-form/issues/2648)

@rjsf/core

• Added tests for the new @rjsf/validator-ajv8 to the validate_test.js file to ensure the validation works with both validator implementations

@rjsf/mui

• Fixed the README.md to correct the package name in several places to match the actual package

@rjsf/utils

• Fixed the README.md to remove references to ajv6 validator, adding link to the utility-functions.md in the docs
• Fixed the README.md to correct the package name in several places to match the actual package
• Updated getDefaultFormState() so that oneOf and anyOf default values do not always use the first option when formData contains a better option, fixing (https://github.com/rjsf-team/react-jsonschema-form/issues/2183)

@rjsf/validator-ajv6

• Fixed the README.md to correct the package name in several places to match the actual package

@rjsf/validator-ajv8

• Support for localization (L10n) on a customized validator using a Localizer function passed as a second parameter to customizeValidator(), fixing (https://github.com/rjsf-team/react-jsonschema-form/pull/846, and https://github.com/rjsf-team/react-jsonschema-form/issues/1195)
• Fixed the README.md to correct the package name in several places to match the actual package

Dev / docs / playground

• Added two new validator selections, AJV8 and AJV8_es to the list of available validators for the playground; Using the second one will translate error messages to spanish.
• Updated the validation documentation to clarify the case of empty strings being stored as null in certain cases.