README

@talesoft/schema

A very clean and lightweight implementation of the JSON-Schema standard.

It provides easy construction of schemas and a full, blazing-fast validator.

Especially for TypeScript users it also provides clean and proper typing for JSON-Schemas.

Install

// Yarn
yarn add @talesoft/schema

// NPM
npm i @talesoft/schema

TypeScript typings are included (No @types/ package needed)

Usage

Type a schema

This library comes with a lot of ready-to-use types for common schemas.

For most common use-cases you can fully rely on the Schema-type, which includes all properties known to the JSON-Schema standard.

import type { Schema } from '@talesoft/schema'

const user: Schema = {
  type: 'object',
  properties: {
    email: { type: 'string', format: 'email' },
    password: { type: 'string', minLength: 5 },
  },
}

Build schemas easily with factories

With a set of factories you can build fully-fledged schemas a lot easier.

We avoid bringing in complex, reference-based builders so that you can use the factories in functional programming patterns for even smarter and faster schema creation.

import { object, string } from '@talesoft/schema'

const user = object({
  properties: {
    email: string({ format: 'email' }),
    password: string({ minLength: 5 }),
  },
  required: ['email'],
})

Showcasing some factories (find more in the docs)

// Primitives
import {
  schemaNull,
  boolean,
  string,
  number,
  integer,
  arrayOf,
  objectOf,
  nullable,
} from '@talesoft/schema'

const product = objectOf({
  title: string({ minLength: 5 }),
  description: oneOf(string(), schemaNull()),
  shortDescription: nullable(string()),
  price: number({ minimum: 0, maximum: 1000 }),
  stock: integer({ minimum: 0 }),
  tags: arrayOf(string(), { maxItems: 5 }),
}, { required: ['title', 'price', 'tags'] })

Composition of schemas

See the official JSON-Schema docs for more information.

import { allOf, anyOf, oneOf, not, ... } from '@talesoft/schema'

allOf(string(), { minLength: 5 }) // { allOf: [{ type: 'string' }, { minLength: 5 }] }
anyOf(string(), number(), schemaNull()) // { anyOf: [{ type: 'string' }, { type: 'number' }, { type: 'null' }]}
oneOf(string(), schemaNull()) // { anyOf: [{ type: 'string' }, { type: 'number' }, { type: 'null' }]}
not(anyOf(string(), number()))

Usage no npm install needed!