Generate JSON schema from typescript

Question

I am trying to create a typescript doc-generator, but to do so, i need to parse a typescript file into something more easily readable

EX:

"Command": {
    "description": "A command object for the command handler",
    "constructor": [
      {
        "name": "name",
        "type": "string",
        "optional": false,
        "default": null,
        "description": "Name of the command"
      },
      {
        "name": "callback",
        "type": "(event: CommandContext) => void",
        "optional": false,
        "default": null,
        "description": "Callback for the command"
      }
    ],
    "properties": [
      {
        "name": "name",
        "description": "Name of the command",
        "type": "string"
      },
      {
        "name": "fullname",
        "description": "Fullname of the command",
        "type": "string"
      }
    ],
    "methods": [
      {
        "name": "canRun",
        "description": "Checks all permission checks and verifies if a command can be run",
        "parameters": [
          {
            "name": "context",
            "type": "CommandContext",
            "optional": false,
            "default": null,
            "description": "The context for the command",
            "returns": "PermissionCheckResult"
          }
        ]
      }
    ],
    "events": null
  }

would come from something like this

export declare class Command {
    /**
     * Name of the command
     */
    name: string;
    /**
     * Fullname of the command
     */
    fullname: string;
    /**
     * Create a command
     * @param name - Name of the command
     * @param callback - Callback for the command
     */
    constructor(name: string, callback: (event: CommandContext) => void);
    /**
     * Checks all permission checks and verifies if a command can be run
     * @param context - The context for the command
     */
    canRun(context: CommandContext): boolean;
}

how would I accomplish this, preferably in the browser, but if that is not possible I could also do it using node.js

There is no mature solution. Some links: github.com/YousefED/typescript-json-schema , github.com/Microsoft/TypeScript/issues/14419 , github.com/Microsoft/TypeScript/issues/… — Paleo
– Paleo, Commented Aug 29, 2017 at 13:47

Jarno · Accepted Answer · 2022-04-01 14:24:48Z

13

ts-json-schema-generator works quite well for me.

command-line use:

npx ts-json-schema-generator -p types.ts > types.json

programmatic use:

// generate schema from typescript types
const tsj = require("ts-json-schema-generator");
const fs = require("fs");
const output_path = "some-type.schema.json";
/** @type {import('ts-json-schema-generator/dist/src/Config').Config} */
const config = {
  path: "path/to/index.d.ts",
  tsconfig: "path/to/tsconfig.json",
  type: "SomeType", // "*" for all types
};
const schemaGenerator = tsj.createGenerator(config);
const schema = schemaGenerator.createSchema(config.type);
const schemaString = JSON.stringify(schema, null, 2);
fs.writeFileSync(output_path, schemaString);

// use the schema to validate some data
import Ajv from "ajv"
const ajv = new Ajv({
  strict: true,
  allErrors: true,
});
ajv.validateSchema(schema);
if (ajv.errors) {
  console.dir(ajv.errors, { depth: null });
  throw new Error("The schema is not valid");
}
const validate = ajv.compile(schema);
const data = {
  foo: 1,
  bar: "abc"
};
const valid = validate(data);
if (!valid) console.log(validate.errors);

There is also typescript-json-schema, but it can produce invalid schemas in some cases.

edited Apr 1, 2022 at 14:24

answered Dec 16, 2021 at 16:07

Jarno

7,3625 gold badges49 silver badges62 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

bocko Over a year ago

Now also available as a VSCode extension. marketplace.visualstudio.com/…

sham Over a year ago

is there any way i can use that in the client? and not use node to run it or the cli? i want to create a function that returns to me the schema. i use cypress.

DusterTheFirst · Accepted Answer · 2017-11-04 01:37:19Z

3

TypeDoc has a similar feature, you can use the --json tag to get data about the module in JSON format

it is not exactly what I was looking for, but can be used to accomplish the same thing

answered Nov 4, 2017 at 1:37

DusterTheFirst

3571 gold badge5 silver badges16 bronze badges

1 Comment

Mateja Petrovic Over a year ago

I've tried to convert webpack type definitions file to a json schema using typedoc and the --json flag, but it untimately did not work out as seen here. How did you accomplish it?

Pranit Bhatt · Accepted Answer · 2022-07-17 20:38:26Z

0

https://www.npmjs.com/package/typescript-json-schema

Command Line use:

./node_modules/.bin/typescript-json-schema <path-to-typescript-files-or-tsconfig> <type> --out schema.json

I used like this,

./node_modules/.bin/ts-json-schema-generator index.ts Book --out schema.json

index.ts

export interface Book {
author: string;
/**
 * The size of the shape.
 *
 * @minimum 0
 * @TJS-type integer
 * @items.optional true
 */
pages: number;
genre: BookGenre;}

edited Jul 17, 2022 at 20:38

answered Jul 17, 2022 at 20:34

Pranit Bhatt

11 bronze badge

Collectives™ on Stack Overflow

Generate JSON schema from typescript

3 Answers 3

2 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related