Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@kingbri1/standard-json

npm version [npm downloads

standard-schema, standard-community, standard-schema-community, json-schema, convertor

readme

Standard JSON

npm version npm downloads license

Standard Schema Validator's JSON Schema Converter

Installation

Install the main package -

pnpm add @standard-community/standard-json

For some specific vendor, install the respective package also -

Vendor Package
Zod zod-to-json-schema
Valibot @valibot/to-json-schema

Usage

import { toJsonSchema } from "@standard-community/standard-json";

// Define your schema
const schema = v.pipe(
    v.object({
        myString: v.string(),
        myUnion: v.union([v.number(), v.boolean()]),
    }),
    v.description("My neat object schema"),
);

// Convert it to JSON Schema
const jsonSchema = await toJsonSchema(schema);

Compatibility

List of supported validators -

Vendor Supported
Zod
Valibot
ArkType
Typebox ✅ (Using TypeMap
Effect Schema 🛠️

You can check the compatibility versions at standardschema.dev

Credit

  • This project is inspired by the work of kwaa and their xsschema package.