# @spec2ts/jsonschema

> Utility to convert JSON Schemas to Typescript using TypeScript native compiler

Latest version **4.1.1** (published 2026-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @spec2ts/jsonschema
pnpm add @spec2ts/jsonschema
yarn add @spec2ts/jsonschema
bun add @spec2ts/jsonschema
```

Provides the command `jsonschema2ts`.

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2026-09-07 |
| First published | 2020-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 52.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Touchify |
| Maintainers | mluce, mtrimolet |
| Keywords | ast, compile, compiler, interface, json, schema, share, spec, spec2ts, transpile, typescript, typing |

## Links

- npm: https://www.npmjs.com/package/@spec2ts/jsonschema
- Repository: https://github.com/touchifyapp/spec2ts
- Homepage: https://github.com/touchifyapp/spec2ts/blob/master/packages/jsonschema#readme
- Issues: https://github.com/touchifyapp/spec2ts/issues
- npm.io page: https://npm.io/package/@spec2ts/jsonschema

## Dependencies (4)

- [yargs](https://npm.io/package/yargs.md) ^18.0.0
- [typescript](https://npm.io/package/typescript.md) ^6.0.0
- [@spec2ts/core](https://npm.io/package/@spec2ts/core.md) ^4.1.1
- [@apidevtools/json-schema-ref-parser](https://npm.io/package/@apidevtools/json-schema-ref-parser.md) ^10.1.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 4.1.1 (latest) — 2026-09-07
- 4.1.0 — 2026-09-07
- 4.0.1 — 2026-07-09
- 4.0.0 — 2026-07-09
- 3.0.5 — 2025-04-10
- 3.0.4 — 2023-10-23
- 3.0.3 — 2023-10-03
- 3.0.2 — 2023-09-25
- 3.0.1 — 2023-09-12
- 3.0.0 — 2023-09-12
- 2.0.0 — 2023-09-08
- 2.0.0-beta.8 — 2022-09-21
- 2.0.0-beta.7 — 2022-07-29
- 2.0.0-beta.6 — 2022-01-27
- 2.0.0-beta.5 — 2021-11-03
- … 15 more at https://npm.io/package/@spec2ts/jsonschema/versions

## README

# @spec2ts/jsonschema

[![NPM version](https://img.shields.io/npm/v/@spec2ts/jsonschema.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/jsonschema)
[![NPM download](https://img.shields.io/npm/dm/@spec2ts/jsonschema.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/jsonschema)
[![Build Status](https://travis-ci.org/touchifyapp/spec2ts.svg?branch=master)](https://travis-ci.org/touchifyapp/spec2ts)

`@spec2ts/jsonschema` is an utility to create TypeScript types from JSON schemas. Unlike other code generators `@spec2ts/jsonschema` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree (AST).

## Features

- **AST-based:** Unlike other code generators `@spec2ts/jsonschema` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree.
- **Tree-shakeable:** Individually exported types allows you to bundle only the ones you actually use.
- **YAML or JSON:** Use YAML or JSON for your JSON Schemas.
- **External references:** Resolves automatically external references and bundle or import them in generated files.
- **Implementation agnostic:** Use generated types in any projet or framework.

## Installation

Install in your project:

```bash
npm install @spec2ts/jsonschema
```

## CLI Usage

```bash
jsonschema2ts [options] <input..>

Generate TypeScript types from JSON Schemas

Positionals:
  input  Path to JSON Schema(s) to convert to TypeScript                [string]

Options:
  --version     Show version number                                    [boolean]
  --help        Show help usage                                        [boolean]
  --output, -o  Output directory for generated types                    [string]
  --cwd, -c     Root directory for resolving $refs                      [string]
  --avoidAny    Avoid the `any` type and use `unknown` instead         [boolean]
  --enableDate  Build `Date` for format `date` and `date-time`         [boolean]
  --banner, -b  Comment prepended to the top of each generated file     [string]
```

## Programmatic Usage

```typescript
import { printer } from "@spec2ts/core";
import { parseSchema, JSONSchema } from "@spec2ts/jsonschema";

async function generateSchema(schema: JSONSchema): Promise<string> {
    const result = await parseSchema(schema);
    return printer.printNodes(result);
}
```

## Implementations

- [x] Primitive types:
    - [x] array
    - [x] boolean
    - [x] integer
    - [x] number
    - [x] null
    - [x] object
    - [x] string
    - [x] homogeneous enum
    - [x] heterogeneous enum
- [x] Special types:
    - [x] Date (`date` and `date-time` formats)
    - [x] Blob (`binary` format)
- [x] Automatic type naming:
    - [x] From `id`
    - [x] From `path`
    - [x] From `title`
- [ ] Custom JSON-schema extensions
- [x] Nested properties
- [x] Schema definitions
- [x] [Schema references](http://json-schema.org/latest/json-schema-core.html#rfc.section.7.2.2)
    - [x] Local (filesystem) schema references
    - [x] External (network) schema references
- [x] Modular architecture
    - [x] Import local references
    - [x] Embed external references
- [x] `allOf` ("intersection")
- [x] `anyOf` ("union")
- [x] `oneOf` (treated like `anyOf`)
- [ ] `maxItems`
- [ ] `minItems`
- [x] `additionalProperties` of type
- [ ] `patternProperties` (partial support)
- [x] `extends` (with `allOf`)
- [x] `required` properties on objects
- [ ] `validateRequired`
- [ ] literal objects in enum
- [x] referencing schema by id

## Compatibility Matrix

| TypeScript version | spec2ts version |
| ------------------ | --------------- |
| v3.x.x             | v1              |
| v4.x.x             | v2              |
| v5.x.x             | v3              |
| v6.x.x             | v4              |

## License

This project is under MIT License. See the [LICENSE](LICENSE) file for the full license text.

---
_Source: https://npm.io/package/@spec2ts/jsonschema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
