JSON Schema

import { object, str, num, email, int, positive, optional, toJsonSchema } from '@sylphx/vex'

const userSchema = object({
  name: str(),
  email: str(email),
  age: num(int, positive),
  bio: optional(str()),
})

const jsonSchema = toJsonSchema(userSchema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "email": { "type": "string", "format": "email" },
    "age": { "type": "integer", "exclusiveMinimum": 0 },
    "bio": { "type": "string" }
  },
  "required": ["name", "email", "age"]
}

toJsonSchema(schema, { draft: 'draft-07' })      // default
toJsonSchema(schema, { draft: 'draft-2019-09' })
toJsonSchema(schema, { draft: 'draft-2020-12' })

toJsonSchema(schema, { $schema: false })

toJsonSchema(schema, {
  definitions: {
    User: userSchema,
    Post: postSchema,
  }
})

import { str, email, title, description, examples, toJsonSchema } from '@sylphx/vex'

const emailSchema = str(
  email,
  title('Email'),
  description('User email address'),
  examples(['user@example.com'])
)

toJsonSchema(emailSchema)
// {
//   "type": "string",
//   "format": "email",
//   "title": "Email",
//   "description": "User email address",
//   "examples": ["user@example.com"]
// }