json-schema-typed

JSON Schema TypeScript definitions with complete inline documentation.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
json-schema-typed
10628.0.12 years ago5 years agoMinified + gzip package size for json-schema-typed in KB

Readme

npm downloads-per-month Licenselicense
JSON Schema Typed
JSON Schema TypeScript definitions with complete inline documentation.
NOTE: This library only supports defining schemas. You will need a separate library for data validation.
There are 3 JSON Schema drafts included in this package:
  • draft-07
  • draft-2019-09
  • draft-2020-12

Install

npm install json-schema-typed

Usage

  1. Chose which draft you'd like to import.

  • The main package export points to the latest supported stable draft, currently
draft-2020-12. Future releases that point the main package export to a new draft will always incur a bump to the major semantic version.
```ts import { type JSONSchema } from "json-schema-typed"; ```
  • Or you can specify the exact draft you need.
```ts import { type JSONSchema } from "json-schema-typed/draft-2020-12"; ```
  1. Define a schema
```ts
import { Format, type JSONSchema } from "json-schema-typed";

const schema: JSONSchema = {
  properties: {
    email: {
      format: Format.Email,
      type: "string",
    },
  },
  type: "object",
};

// The JSONSchema namespace also provides type-specific narrowed interfaces
const stringSchema: JSONSchema.String = {
  // Only { type: "string" } and common keywords are allowed
  maxLength: 100,
  type: "string",
};
```

Upgrading

Version 8.0.0 has breaking changes from the previous release.
  • Now a
pure ESM package.
  • Many exports were renamed. The table below reflects the new export names.
These are considered final and unlikely to change in future releases.
  • The JSONSchema type was changed from an interface to a type which is a
mixed union that allows boolean values in order to properly align with the JSON Schema spec. If you were previously extending the JSONSchema interface, you can access the interface directly with JSONSchema.Interface.
  • The previous main package export pointed to Draft 7. Import it directly if you
need to continue using it: ```ts import { type JSONSchema } from "json-schema-typed/draft-07"; ```

Exports supported in each draft module

| Name | Type | Purpose | | ----------------- | --------------- | ------------------------------------------------------------------ | | $schema | string | Draft meta schema URL that can be used with the $schema keyword. | | ContentEncoding | Enum object | String content encoding strategies. | | draft | string | Draft version. | | Format | Enum object | String formats. | | JSONSchema | TypeScript Type | Used to define a JSON Schema. | | keywords | string[] | All the keywords for the imported draft. | | TypeName | Enum object | Simple type names for the type keyword. |

Versioning

This library follows semantic versioning.

Maintainers

License

BSD-2-Clauselicense