rishabhjain96 / json-schema-type Goto Github PK

Currently in order to add this library as a dependency one has to include its directory in node_modules as an extra step.

Compiling and shipping a single index.d.ts file (or .js if needed in the future) would allow it to be importable and "just work" after npm i or yarn add.

The library works flawlessly for small, freshly written schemas, but existing schemas cannot be used currently.

E.g. the following won't work, even though it is a valid schema:

// schema.json
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "required": ["myProp"],
    "properties": {
        "myProp": {
            "type": "string"
        }
    }
}

// index.ts
import { ResolvedJsonSchema } from "json-schema-type";
import schema from "schema.json";

type MyObject = ResolvedJsonSchema<typeof schema>;

Also, the JsonSchema* types form the json-schema library would be useful for type inference and completion while writing schemas, but the following would also not work:

import { ResolvedJsonSchema } from "json-schema-type";

const schema = <JSONSchema7>{
  type: "object",
  required: ["myProp"],
  properties: {
    myProp: {
      type: "string",
    },
  },
};

type MyObject = ResolvedJsonSchema<typeof schema>;

edit: I just realized that a JsonSchema type is exposed by the library so that is great, but reading schemas from JSON is probably still worth exploring, here's a related ts issue.