@csys.pub/json-schema-to-typescript

json-schema-to-typescript

Compile json schema to typescript typings

Example

Input:

{
  "title": "Example Schema",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "age": {
      "description": "Age in years",
      "type": "integer",
      "minimum": 0
    },
    "hairColor": {
      "enum": ["black", "brown", "blue"],
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": ["firstName", "lastName"]
}

Output:

export interface ExampleSchema {
  firstName: string;
  lastName: string;
  /**
   * Age in years
   */
  age?: number;
  hairColor?: "black" | "brown" | "blue";
}

Installation

# Using Yarn:
yarn add json-schema-to-typescript

# Or, using NPM:
npm install json-schema-to-typescript --save

Usage

import { compile, compileFromFile } from 'json-schema-to-typescript'

// compile from file
compileFromFile('foo.json')
  .then(ts => fs.writeFileSync('foo.d.ts', ts))

// or, compile a JS object
let mySchema = {
  properties: [...]
}
compile(mySchema, 'MySchema')
  .then(ts => ...)

See server demo and browser demo for full examples.

Options

compileFromFile and compile accept options as their last argument (all keys are optional):

key	type	default	description
bannerComment	string	"/**\n* This file was automatically generated by json-schema-to-typescript.\n* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n* and run json-schema-to-typescript to regenerate this file.\n*/"	Disclaimer comment prepended to the top of each generated file
cwd	string	process.cwd()	Root directory for resolving $refs
declareExternallyReferenced	boolean	true	Declare external schemas referenced via $ref?
enableConstEnums	boolean	true	Prepend enums with const?
style	object	{ bracketSpacing: false, printWidth: 120, semi: true, singleQuote: false, tabWidth: 2, trailingComma: 'none', useTabs: false }	A Prettier configuration
unreachableDefinitions	boolean	false	Generates code for definitions that aren't referenced by the schema.

CLI

A simple CLI utility is provided with this package.

cat foo.json | json2ts > foo.d.ts
# or
json2ts foo.json > foo.d.ts
# or
json2ts foo.json foo.d.ts
# or
json2ts --input foo.json --output foo.d.ts
# or
json2ts -i foo.json -o foo.d.ts

You can pass any of the options described above (including style options) as CLI flags. Boolean values can be set to false using the no- prefix.

# generate code for definitions that aren't referenced
json2ts -i foo.json -o foo.d.ts --unreachableDefinitions
# use single quotes and disable trailing semicolons
json2ts -i foo.json -o foo.d.ts --style.singleQuote --no-style.semi

Tests

npm test

Features

• [x] title => interface
• [x] Primitive types:
  • [x] array
  • [x] homogeneous array
  • [x] boolean
  • [x] integer
  • [x] number
  • [x] null
  • [x] object
  • [x] string
  • [x] homogeneous enum
  • [x] heterogeneous enum
• [x] Non/extensible interfaces
• [ ] Custom JSON-schema extensions
• [x] Nested properties
• [x] Schema definitions
• [x] Schema references
• [x] Local (filesystem) schema references
• [x] External (network) schema references
• [x] Add support for running in browser
• [x] default interface name
• [x] infer unnamed interface name from filename
• [x] allOf ("intersection")
• [x] anyOf ("union")
• [x] oneOf (treated like anyOf)
• [x] additionalProperties of type
• [x] patternProperties (partial support)
• [x] extends
• [x] required properties on objects (eg)
• [ ] validateRequired (eg)
• [x] literal objects in enum (eg)
• [x] referencing schema by id (eg)

Not expressible in TypeScript:

• dependencies (single, multiple)
• divisibleBy (eg)
• format (eg)
• multipleOf (eg)
• maximum (eg)
• minimum (eg)
• maxItems (eg)
• minItems (eg)
• maxProperties (eg)
• minProperties (eg)
• not/disallow
• oneOf ("xor", use anyOf instead)
• pattern (string, regex)
• uniqueItems (eg)

Further Reading

• JSON-schema spec: https://tools.ietf.org/html/draft-zyp-json-schema-04
• JSON-schema wiki: https://github.com/json-schema/json-schema/wiki
• JSON-schema test suite: https://github.com/json-schema/JSON-Schema-Test-Suite/blob/node
• TypeScript spec: https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md

Projects That Use JSON-Schema-to-TypeScript

• RAML-to-TypeScript
• See more: https://www.npmjs.com/browse/depended/json-schema-to-typescript