LDkit

Schema generators

LDkit provides experimental schema generators that help you convert existing Linked Data definitions into TypeScript schemas compatible with LDkit. These tools are available via the LDkit CLI and support generating code directly from JSON-LD contexts, or ShEx shapes.

⚠️ Note: These generators are experimental and currently support only a subset of the respective technologies. Manual review and adjustments of the generated schemas are recommended.

Available Generators

1. context-to-schema

Converts a JSON-LD context into an LDkit TypeScript schema.

Supported JSON-LD features:

  • property types
  • containers of type @language, @set and @list
  • @reverse properties
  • nested @context entries

Since JSON-LD context do not support setting an arity of entities, all the properties are considered required by default in the LDkit schema, which may require manual adjustment.

Example:

npx ldkit context-to-schema url https://ldkit.io/examples/person.jsonld

2. shexc-to-schema

Converts a ShExC schema into an LDkit TypeScript schema.

Supported ShEx features:

  • explicit property types
  • property types inferred from enumerations (value sets)
  • property cardinalities represented as optional and/or array properties
  • expression choices represented as optional properties
  • inverse properties
  • nested shapes (both explicit and anonymous)
  • simplified AND / OR shapes logic
  • reuse of named triple expressions
npx ldkit shexc-to-schema url https://ldkit.io/examples/person.shex

3. shexj-to-schema

Converts a ShExJ schema into an LDkit TypeScript schema. Supported ShExJ features are the same as for ShExC.

npx ldkit shexj-to-schema url https://ldkit.io/examples/person.shex.jsonld

Command Syntax

npx ldkit <command> <method> <input>

  • <command>: One of context-to-schema, shex-to-schema, or shacl-to-schema.

  • <method>: Defines how the input is provided. Possible values:

    • url — The input is a URL pointing to the resource.

    • file — The input is a path to a local file.

    • arg — The input is passed directly as a string argument.

  • <input>: The actual input data, depending on the selected method.

Output

The generators produce TypeScript code that can be used directly in your LDkit projects. The output is printed to the console and can be redirected to a file:

npx ldkit context-to-schema url https://example.com/context.jsonld > schema.ts

Installing the CLI

While the LDkit CLI may be called with npx command, it can also be installed.

Node:

npm install -g ldkit

Deno:

deno install -g -n ldkit https://deno.land/x/ldkit/cli.ts

After the script is installed, it can be called directly, for example:

ldkit context-to-schema file ./person.jsonld > person.ts

Limitations

The generators do not fully cover all features of JSON-LD or ShEx. Complex validation rules, advanced constraints, and some specialized constructs may be omitted or simplified.

Manual post-processing of the generated schemas may be necessary for production use.

← PreviousComponents: Query EngineNext →Features