triggerdotdev/json-schema-fnsPublic

NotificationsYou must be signed in to change notification settings
Fork5
Star12

Modern utility library and typescript typings for building JSON Schema documents

License

MIT license

12 stars 5 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
.github/workflows		.github/workflows
.vscode		.vscode
badges		badges
src		src
tests		tests
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.npmignore		.npmignore
.prettierrc		.prettierrc
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
rollup.config.js		rollup.config.js
test-node.js		test-node.js
tsconfig.json		tsconfig.json

Repository files navigation

json-schema-fns

Modern utility library and typescript typings for building JSON Schema documents dynamically

Features

Build JSON Schema documents for various drafts (currently only draft-2020-12 but more coming soon)
Strongly typed documents using Typescript
Allows you to build correct JSON Schema documents using dynamic data

Usage

Create a simple draft-2020-12 document:

import{s}from"json-schema-fns";constschema=s.object({properties:[s.requiredProperty("foo",s.string()),s.property("bar",s.int())],});schema.toSchemaDocument();

Will result in

{"$schema":"https://json-schema.org/draft/2020-12/schema#","$id":"https://jsonhero.io/schemas/root.json","type":"object","properties": {"foo": {"type":"string" },"bar": {"type":"integer" }  },"required": ["foo"]}

You can also import the types for a specific draft to use, like so:

import{s,Schema,IntSchema,StringSchema,StringFormat}from"json-schema-fns";functionbuildIntSchema(maximum:number,minimum:number):IntSchema{returns.int({ minimum, maximum});}functionbuildStringFormat(format:JSONStriStringFormatgFormat):StringSchema{returns.string({ format});}

json-schema-fns support all the features of JSON schema:

import{s}from"json-schema-fns";constphoneNumber=s.def("phoneNumber",s.string({pattern:"^[0-9]{3}-[0-9]{3}-[0-9]{4}$"}));constusAddress=s.def("usAddress",s.object({properties:[s.requiredProperty("zipCode",s.string())],}),);constukAddress=s.def("ukAddress",s.object({properties:[s.requiredProperty("postCode",s.string())],}),);s.object({$id:"/schemas/person",title:"Person Profile",description:"Attributes of a person object",examples:[{name:"Eric",email:"eric@stackhero.dev",},],$comment:"This is just a preview",default:{},properties:[s.requiredProperty("name",s.string()),s.property("email",s.string({format:"email"})),s.property("phoneNumber",s.ref("phoneNumber")),s.property("billingAddress",s.oneOf(s.ref("ukAddress"),s.ref("usAddress"))),s.patternProperty("^[A-Za-z]$",s.string()),],additionalProperties:s.array({items:s.number({minimum:0,maximum:5000}),}),propertyNames:"^[A-Za-z_][A-Za-z0-9_]*$",minProperties:3,maxProperties:20,unevaluatedProperties:false,defs:[phoneNumber,usAddress,ukAddress],}).toSchemaDocument();

Will result in

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","$id":"/schemas/person","title":"Person Profile","description":"Attributes of a person object","examples": [    {"name":"Eric","email":"eric@stackhero.dev"    }  ],"$comment":"This is just a preview","default": {},"minProperties":3,"maxProperties":20,"unevaluatedProperties":false,"properties": {"name": {"type":"string"    },"email": {"type":"string","format":"email"    },"phoneNumber": {"$ref":"#/$defs/phoneNumber"    },"billingAddress": {"oneOf": [        {"$ref":"#/$defs/ukAddress"        },        {"$ref":"#/$defs/usAddress"        }      ]    }  },"required": ["name"],"patternProperties": {"^[A-Za-z]$": {"type":"string"    }  },"propertyNames": {"pattern":"^[A-Za-z_][A-Za-z0-9_]*$"  },"additionalProperties": {"type":"array","items": {"type":"number","minimum":0,"maximum":5000    }  },"$defs": {"phoneNumber": {"type":"string","pattern":"^[0-9]{3}-[0-9]{3}-[0-9]{4}$"    },"usAddress": {"type":"object","properties": {"zipCode": {"type":"string"        }      },"required": ["zipCode"]    },"ukAddress": {"type":"object","properties": {"postCode": {"type":"string"        }      },"required": ["postCode"]    }  }}

API

`s`

All the builder methods for creating subschemas are available on thes object

import{s}from"json-schema-fns";

Or if you want to import a specific dialect:

import{s}from"json-schema-fns/2020";

All builder methods return aSchemaBuilder, and you can generate the JSON schema created by the builder usingtoSchemaDocument like so

s.object().toSchemaDocument();

Which will result in the following document

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object"}

If you don't want the$schema property, usetoSchema instead:

s.object().toSchema();// { "type": "object" }

All builder methods also support the options inAnnotationSchema:

s.object({$id:"#/foobar",$comment:"This is a comment",default:{},title:"FooBar Object Schema",description:"This is the FooBar schema description",examples:[{foo:"bar"}],deprecated:true,readOnly:true,writeOnly:false,}).toSchema();

Produces the schema

{"type":"object","$id":"#/foobar","$comment":"This is a comment","default": {},"title":"FooBar Object Schema","description":"This is the FooBar schema description","examples": [{"foo":"bar" }],"deprecated":true,"readOnly":true,"writeOnly":false}

`s.object(options: ObjectOptions)`

Builds a schema of typeobject, accepting a single argument of typeObjectOptions

`ObjectOptions.properties`

An array of optional and required properties

s.object({properties:[s.property("name",s.string()),s.requiredProperty("email",s.string({format:"email"})),],}).toSchema();

Produces the schema

{"type":"object","properties": {"name": {"type":"string" },"email": {"type":"string","format":"email" }  },"required": ["email"]}

You can also addpatternProperties

s.object({properties:[s.patternProperty("^S_",s.string())]}).toSchema();

which produces the schema

{"type":"object","patternProperties": {"^S_": {"type":"string" }  }}

`ObjectOptions.additonalProperties`

Add anadditonalProperties schema:

s.object({additionalProperties:s.number()}).toSchema();

Produces the schema

{"type":"object","additionalProperties": {"type":"number"  }}

`ObjectOptions.propertyNames`

Add apropertyNames pattern:

s.object({propertyNames:"^[A-Za-z_][A-Za-z0-9_]*$"}).toSchema();

Produces the schema

{"type":"object","propertyNames": {"pattern":"^[A-Za-z_][A-Za-z0-9_]*$"  }}

`ObjectOptions.minProperties` and`ObjectOptions.maxProperties`

Validate the number of properties in an object usingmin/maxProperties

s.object({minProperties:4,maxProperties:10}).toSchema();

Produces the schema

{"type":"object","minProperties":4,"maxProperties":10}

`ObjectOptions.unevaluatedProperties`

Specify the handling ofunevaluatedProperties

s.object({unevaluatedProperties:false}).toSchema();

Produces the schema

{"type":"object","unevaluatedProperties":false}

`s.array(options: ArrayOptions)`

Builds a schema of typearray, accepting a single argument of typeArrayOptions

`ArrayOptions.items`

Define theitems schema for an array:

s.array({items:s.string()}).toSchema();

Produces the schema

{"type":"array","items": {"type":"string" }}

`ArrayOptions.minItems` and`ArrayOptions.maxItems`

Define the arraylength

s.array({contains:{schema:s.number(),min:1,max:3}).toSchema();

Produces the schema

{"type":"array","contains": {"type":"number" },"minContains":1,"maxContains":3}

`ArrayOptions.prefixItems`

Allows you to performtuple validation:

s.array({prefixItems:[s.string(),s.number()]}).toSchema();

Produces the schema

{"type":"array","prefixItems": [{"type":"string" }, {"type":"number" }]}

`ArrayOptions.unevaluatedItems`

Define the schema forunevaluatedItems

s.array({unevaluatedItems:s.object()}).toSchema();

Produces the schema

{"type":"array","unevaluatedItems": {"type":"object" }}

`ArrayOptions.contains`

Define the schemacontains

s.array({contains:{schema:s.number(),min:1,max:3}).toSchema();

Produces the schema

{"type":"array","contains": {"type":"number" },"minContains":1,"maxContains":3}

`string`

`integer` and`number`

`boolean`

`nil`

`nullable`

`anyOf` |`allOf` |`oneOf`

`ifThenElse` and`ifThen`

`not`

`def` and`ref`

`$const`

`$enumerator`

`$true` and`$false`

Roadmap

Support draft-04
Support draft-06
Support draft-07
Support draft/2019-09

About

Modern utility library and typescript typings for building JSON Schema documents

Resources

Readme

License

MIT license

Code of conduct

Releases1

Initial release Latest

Jan 14, 2022

Packages

No packages published

Movatterモバイル変換

License

triggerdotdev/json-schema-fns

Folders and files

Latest commit

History

Repository files navigation

json-schema-fns

Features

Usage

API

s

s.object(options: ObjectOptions)

ObjectOptions.properties

ObjectOptions.additonalProperties

ObjectOptions.propertyNames

ObjectOptions.minProperties andObjectOptions.maxProperties

ObjectOptions.unevaluatedProperties

s.array(options: ArrayOptions)

ArrayOptions.items

ArrayOptions.minItems andArrayOptions.maxItems

ArrayOptions.prefixItems

ArrayOptions.unevaluatedItems

ArrayOptions.contains

string

integer andnumber

boolean

nil

nullable

anyOf |allOf |oneOf

ifThenElse andifThen

not

def andref

$const

$enumerator

$true and$false

Roadmap

About

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases1

Packages0

Uh oh!

Contributors2

Uh oh!

Languages

`s`

`s.object(options: ObjectOptions)`

`ObjectOptions.properties`

`ObjectOptions.additonalProperties`

`ObjectOptions.propertyNames`

`ObjectOptions.minProperties` and`ObjectOptions.maxProperties`

`ObjectOptions.unevaluatedProperties`

`s.array(options: ArrayOptions)`

`ArrayOptions.items`

`ArrayOptions.minItems` and`ArrayOptions.maxItems`

`ArrayOptions.prefixItems`

`ArrayOptions.unevaluatedItems`

`ArrayOptions.contains`

`string`

`integer` and`number`

`boolean`

`nil`

`nullable`

`anyOf` |`allOf` |`oneOf`

`ifThenElse` and`ifThen`

`not`

`def` and`ref`

`$const`

`$enumerator`

`$true` and`$false`

Packages