@naturalcycles/common-type

@naturalcycles/common-type

Common Type interface and generator

Allows to generate "Common Type" and JSON Schema from a set of Typescript files with Interfaces (also Types and Enums).

Status: experimental! Everything is subject to change!

Example

Install common-type as your devDependency:

yarn add -D @naturacycles/common-type

Define a commonType.cfg.js in the root of you project:

module.exports = {
  paths: ['src/types/*.ts'],
  outputDir: 'src/schemas',
}

Config says to scan all *.ts files in src/types, parse them, generate JSON schemas, write them into src/schemas folder.

Develop

Typescript AST debugging: https://ts-ast-viewer.com/

todo

• parse multiple files, "cross-link" them

• Link to schemas instead of inlining them (let ajv compile/combine them for us)

• null type

• union types support

• nullable union types support

• array of union types

• tuple type

• StringMap support

• fix dataFlags bug

• includeTypes/excludeTypes in cfg

Non-structural validation:

• unixTimestamp type
• isoDate type
• email type (regex)
• id type
• regex validation support

Currently NOT supported

Partial, Required, Omit, Pick

Generic interfaces e.g:

interface MyType<T> {
  current: T
  future: T
}