xsschema

npm i xsschema

Coverage

validate doesn't require manual support and works with any Standard Schema-compatible library.

Here is the list of libraries that toJsonSchema is compatible with:

Implementer	Version(s)	Status
Zod	3.24.0+	Supported
Valibot	v1.0+	Supported
ArkType	v2.0+	Supported
Effect Schema	v3.13.0+	Supported

Usage

If you're using xsAI, this package is a dependency of some of those packages - you don't need to install it separately.

toJsonSchema

import { type } from 'arktype'
import { Schema } from 'effect'
import * as v from 'valibot'
import { toJsonSchema } from 'xsschema'
import { z } from 'zod'
 
const arktypeSchema = type({
  myString: 'string',
  myUnion: 'number | boolean',
}).describe('My neat object schema')
 
const arktypeJsonSchema = await toJsonSchema(arktypeSchema)
 
const effectSchema = Schema.Struct({
  myString: Schema.String,
  myUnion: Schema.Union(Schema.Number, Schema.Boolean),
}).annotations({ description: 'My neat object schema' })
 
const effectJsonSchema = await toJsonSchema(
  // https://github.com/Effect-TS/effect/issues/4494
  Object.assign(effectSchema, Schema.standardSchemaV1(effectSchema)) 
)
 
const valibotSchema = v.pipe(
  v.object({
    myString: v.string(),
    myUnion: v.union([v.number(), v.boolean()]),
  }),
  v.description('My neat object schema'),
)
 
const valibotJsonSchema = await toJsonSchema(valibotSchema)
 
const zodSchema = z.object({
  myString: z.string(),
  myUnion: z.union([z.number(), z.boolean()]),
}).describe('My neat object schema')
 
const zodJsonSchema = await toJsonSchema(zodSchema)

toJsonSchemaSync (experimental)

toJsonSchema is async (because it has to await import the vendor's dependencies), but we also support a synchronous version: toJsonSchemaSync.

Before using toJsonSchemaSync, you must call initToJsonSchemaSyncVendor with your schema vendor.

import { initToJsonSchemaSyncVendor } from 'xsschema'
 
await initToJsonSchemaSyncVendor('arktype')
// or
await initToJsonSchemaSyncVendor('effect')
// or
await initToJsonSchemaSyncVendor('valibot')
// or
await initToJsonSchemaSyncVendor('zod')

You can register multiple schema vendors if you need to.

import { type } from 'arktype'
import { Schema } from 'effect'
import * as v from 'valibot'
import { toJsonSchemaSync } from 'xsschema'
import { z } from 'zod'
 
const arktypeSchema = type({
  myString: 'string',
  myUnion: 'number | boolean',
}).describe('My neat object schema')
 
const arktypeJsonSchema = toJsonSchemaSync(arktypeSchema)
 
const effectSchema = Schema.Struct({
  myString: Schema.String,
  myUnion: Schema.Union(Schema.Number, Schema.Boolean),
}).annotations({ description: 'My neat object schema' })
 
const effectJsonSchema = toJsonSchemaSync(
  // https://github.com/Effect-TS/effect/issues/4494
  Object.assign(effectSchema, Schema.standardSchemaV1(effectSchema)) 
)
 
const valibotSchema = v.pipe(
  v.object({
    myString: v.string(),
    myUnion: v.union([v.number(), v.boolean()]),
  }),
  v.description('My neat object schema'),
)
 
const valibotJsonSchema = toJsonSchemaSync(valibotSchema)
 
const zodSchema = z.object({
  myString: z.string(),
  myUnion: z.union([z.number(), z.boolean()]),
}).describe('My neat object schema')
 
const zodJsonSchema = toJsonSchemaSync(zodSchema)

validate

import { validate } from 'xsschema'
import { type } from 'arktype'
import * as v from 'valibot'
import * as z from 'zod'
 
const arktypeSchema = type("string")
const valibotSchema = v.string()
const zodSchema = z.string()
 
const arktypeResult = await validate(arktypeSchema, '123')
const valibotResult = await validate(valibotSchema, '123')
const zodResult = await validate(zodSchema, '123')