Standard JSON


Standard Schema Validator's JSON Schema Converter

Installation

Install the main package -

``sh
pnpm add @standard-community/standard-json
`

For some specific vendor, install the respective package also -

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

Usage

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

// Define your validation schema
const schema = {
// ...
};

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

$3

This is useful for -

#### Adding support for Unsupported validation libs

`ts
import { toJsonSchema, loadVendor } from "@standard-community/standard-json";
import { convertSchemaToJson } from "your-validation-lib";

// The lib should support Standard Schema, like Sury
// as we use 'schema["~standard"].vendor' to get the vendor name
// Eg. loadVendor(zod["~standard"].vendor, convertorFunction)
loadVendor("validation-lib-name", convertSchemaToJson)

// Define your validation schema
const schema = {
// ...
};

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

#### Customize the toJSONFunction of a supported lib

`ts
import { toJsonSchema, loadVendor } from "@standard-community/standard-json";
import zodHandler from "@standard-community/standard-json/zod";

// Or pass a custom implmentation
loadVendor("zod", zodHandler())

// Define your validation schema
const schema = {
// ...
};

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