schematized

Schematized

Turn JS objects into JSON schemas that continue to improve as you provide examples.

A Node port of the Python module Genson.

:rocket: Quickstart

1. Add dependency

yarn add schematized

1. Basic usage

import { SchemaBuilder } from 'schematized' // Typescript & ES6+
const { default: SchemaBuilder } = require('schematized') // CommonJS

const builder = new SchemaBuilder()

// Consume JSON
builder.addObject({
  token: '74aea1a53d68b77e4f1f55fa90a7eb81',
  role: ['Basic'],
})

// Produce JSON Schemas!
const schema = builder.toSchema()

1. Improve the schema

...

// Add more example objects
builder.addObject({
  token: 'Bearer 6498d9afc96d1d8d881a2b7ded4f9290',
  role: [
    'Admin',
    'Basic',
    'Publisher'
  ]
})

// Or combine data from another JSON Schema
builder.addSchema({
  title: '/user response',
  description: 'User data from server.'
})

Schema from the single example:

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "maxLength": 32,
      "minLength": 32
    },
    "role": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5,
        "minLength": 5
      }
    }
  },
  "required": [
    "role",
    "token"
  ]
}

Schema from the two examples:

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "maxLength": 39,
      "minLength": 32
    },
    "role": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 9,
        "minLength": 5
      }
    }
  },
  "required": [
    "role",
    "token"
  ]
}

Schema from the two examples and the schema:

{
  "$schema": "http://json-schema.org/schema#",
  "title": "/user response",
  "description": "User data from server.",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "maxLength": 39,
      "minLength": 32
    },
    "role": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 9,
        "minLength": 5
      }
    }
  },
  "required": [
    "role",
    "token"
  ]
}

Changelog

1.4.0 (2020-06-21)

Features

• schema-node.ts: added support for typeless schema props (7095d11)