Registry / serialization / json-schema-to-typescript-lite

json-schema-to-typescript-lite

library15.0.0jsnpmunverified

json-schema-to-typescript-lite is a focused fork of json-schema-to-typescript, designed to compile JSON schemas into TypeScript typings with a significantly reduced dependency footprint. The current stable version is 15.0.0. This package emphasizes programmatic usage, foregoing CLI support and internal Prettier integrations for a leaner build. It achieves smaller bundle sizes by replacing heavy dependencies like `lodash` with `lodash-es` (bundled) and targets modern ESNext environments. It offers dual module support (ESM and CJS) and includes support for custom naming options, making it suitable for environments where bundle size and minimal dependencies are critical considerations.

serialization type-stubs

npm install json-schema-to-typescript-lite

github ↗package ↗

INSTALL

IMPORT

SIG · JSON-SCHEMA-TO-TYP

json-schema-to-typescript-lite

serializationjavascriptv15.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

compile

✓ import { compile } from 'json-schema-to-typescript-lite';

✗ const compile = require('json-schema-to-typescript-lite');

The primary function for compiling a JSON schema to a TypeScript string. Supports both ESM and CJS, but ESM import is preferred in modern Node.js/browser environments.

compile (default import incorrect)

✓ import { compile } from 'json-schema-to-typescript-lite';

✗ import compile from 'json-schema-to-typescript-lite';

The 'compile' function is a named export, not a default export.

Type definitions

✓ import type { JSONSchema4, Options } from 'json-schema-to-typescript-lite';

While `Options` and schema types are available for type hinting, they are not always explicitly imported for basic usage.

Demonstrates basic usage of `compile` to convert a JSON schema object into a TypeScript interface string, including common options.

import { compile } from 'json-schema-to-typescript-lite'; async function generateUserTypes() { const userSchema = { type: 'object', properties: { id: { type: 'string', description: 'Unique user identifier' }, name: { type: 'string', minLength: 1 }, email: { type: 'string', format: 'email' }, age: { type: 'number', minimum: 0, maximum: 120 }, isActive: { type: 'boolean', default: true }, roles: { type: 'array', items: { type: 'string', enum: ['admin', 'editor', 'viewer'] }, minItems: 1 } }, required: ['id', 'name', 'email', 'isActive'], additionalProperties: false, title: 'UserSchema', // Used as base name if not overridden by second arg description: 'Defines the structure for a user object.' }; try { const tsDefinition = await compile(userSchema, 'IUser', { bannerComment: '/* Generated by json-schema-to-typescript-lite */', declareExternallyReferenced: false, unknownAny: false, // Prefer 'unknown' over 'any' customName: (id: string) => id === 'IUser' ? 'MyCustomUserType' : id, }); console.log(tsDefinition); } catch (error) { console.error('Failed to compile schema:', error); } } generateUserTypes().catch(console.error);

Debug

Known issues

breakingCLI support has been completely removed. This package is strictly for programmatic usage.

fix

Migrate any CLI usage to direct programmatic calls to the `compile` function within your build scripts or application.

affects: >=1.0.0

breakingInternal Prettier integration has been removed. The package now generates well-formatted code by default, but external formatting is required if specific Prettier rules are desired.

fix

Run Prettier as a separate step on the generated TypeScript output if custom formatting is necessary.

affects: >=1.0.0

breakingDependencies like `lodash` have been replaced with lighter alternatives or bundled (`lodash-es`). While improving bundle size, this means any explicit dependency on these from the original `json-schema-to-typescript` will no longer be satisfied by this 'lite' fork.

fix

Review your project's dependencies and explicitly add any external libraries that were implicitly provided by the non-lite version.

affects: >=1.0.0

gotchaThis is a 'lite' fork. While it aims for similar core functionality, subtle behavioral differences might exist due to dependency changes or optimizations not present in the main `json-schema-to-typescript` package.

fix

Thoroughly test your schema compilation output when migrating from `json-schema-to-typescript` to `json-schema-to-typescript-lite`.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'json-schema-to-typescript-lite'

The package is not installed or the import path is incorrect.

fix

Ensure the package is installed: `npm install json-schema-to-typescript-lite` or `yarn add json-schema-to-typescript-lite`. Verify the import statement is `import { compile } from 'json-schema-to-typescript-lite';`.

Schema validation failed

The provided JSON schema is not a valid JSON Schema Draft 04/06/07.

fix

Review your JSON schema against the specification. Common issues include incorrect `type` definitions, missing `properties` or `items` for array/object types, or invalid keywords.

TypeError: Cannot read properties of undefined (reading 'type')

You likely passed an `undefined` or `null` value instead of a valid JSON schema object to the `compile` function.

fix

Ensure the first argument passed to `compile` is a valid, non-null JSON schema object.

Upgrade

Version history

15.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

21 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/bcherny/json-schema-to-typescript ↗

packagehttps://www.npmjs.com/package/json-schema-to-typescript-lite ↗