Install

``bash
$ npm install @sinclair/typemap --save
`

Usage

Parse and Compile Types from TypeScript Syntax (Example)

`typescript
import { Compile } from '@sinclair/typemap'

// Compile Types With Syntax

const validator = Compile({ a: string, b: string }) // const validator: Validator // a: TString,
// b: TString
// }>>

// Validate with Standard Schema

const result = validator['~standard'].validate({ // const result: StandardSchemaV1.Result<{
a: 'hello', // a: string,
b: 'world' // b: string
}) // }>
`

Overview

TypeMap is a syntax frontend and compiler backend for the TypeBox, Valibot and Zod runtime type libraries. It offers a common TypeScript syntax for type construction, a runtime compiler for high-performance validation and type translation from one library to another.

TypeMap is written as an advanced type mapping system for the TypeBox project. It is designed to accelerate remote type libraries on TypeBox infrastructure as well enabling TypeBox to integrate with remote type library infrastructure via reverse type remapping. This project also offers high-performance validation for frameworks that orientate around the Standard Schema TypeScript interface.

License: MIT

Contents

- Install
- Usage
- Overview
- Example
- Mapping
- Syntax
- TypeBox
- Valibot
- Zod
- Syntax
- Types
- Options
- Parameters
- Generics
- Static
- Json Schema
- Tree Shake
- Compile
- Benchmark
- Contribute

Example

Use TypeScript syntax to create types for TypeBox, Valibot and Zod (Example)

`typescript
import { TypeBox, Valibot, Zod } from '@sinclair/typemap'

// Syntax Types

const S = {
x: number,
y: number,
z: number
}

// Runtime Types

const T = TypeBox(S) // const T: TObject<{ ... }>

const V = Valibot(S) // const V: ObjectSchema<{ ... }, ...>

const Z = Zod(S) // const Z: ZodObject<{ ... }, ...>
`

Translate TypeBox, Valibot and Zod types (Example)

`typescript
import { TypeBox, Valibot, Zod } from '@sinclair/typemap'

// Syntax -> Zod -> Valibot -> TypeBox

const T = TypeBox(Valibot(Zod({
x: number,
y: number,
z: number
})))
`

Compile Valibot and Zod types on TypeBox infrastructure (Example)

`typescript
import { Compile } from '@sinclair/typemap'

import z from 'zod'

// Zod Type

const Z = z.object({ // const Z: ZodObject<{
x: z.number(), // x: ZodNumber,
y: z.number(), // y: ZodNumber,
z: z.number(), // z: ZodNumber
}) // }>

// Remap and Compile

const C = Compile(Z) // const C: Validator // x: TNumber,
// y: TNumber,
// z: TNumber
// }>>

// High Throughout Validation

const R = C.Check({ // Iterations: 10_000_000
x: 1, //
y: 2, // Zod : 4000ms (approx)
z: 3 // TypeMap : 40ms (approx)
})
`

Mapping

TypeMap is designed for runtime type translation. It provides one mapping function per library which can be used to translate remote types into types specific to that library. All mapping functions make a best effort attempt to translate the structures and semantics from each library. If no translation is possible, these functions return a never representation.

$3

Use the Syntax function to translate types into a Syntax string (Example)

`typescript
import { Syntax } from '@sinclair/typemap'

const S = Syntax('string[]') // const S: 'string[]' (Syntax)
const T = Syntax(t.Number()) // const T: 'number' (TypeBox)
const V = Syntax(v.string()) // const V: 'string' (Valibot)
const Z = Syntax(z.boolean()) // const Z: 'boolean' (Zod)
`

$3

Use the TypeBox function to translate types and syntax into TypeBox types (Example)

`typescript
import { TypeBox } from '@sinclair/typemap'

const S = TypeBox('string[]') // const S: TArray (Syntax)
const T = TypeBox(t.Number()) // const T: TNumber (TypeBox)
const V = TypeBox(v.string()) // const V: TString (Valibot)
const Z = TypeBox(z.boolean()) // const Z: TBoolean (Zod)
`

$3

Use the Valibot function to translate types and syntax into Valibot types (Example)

`typescript
import { Valibot } from '@sinclair/typemap'

const S = Valibot('string[]') // const S: v.ArraySchema<...> (Syntax)
const T = Valibot(t.Number()) // const T: v.NumberSchema (TypeBox)
const V = Valibot(v.string()) // const V: v.StringSchema (Valibot)
const Z = Valibot(z.boolean()) // const Z: v.BooleanSchema (Zod)
`

$3

Use the Zod function to translate types and syntax into Zod types (Example)

`typescript
import { Zod } from '@sinclair/typemap'

const S = Zod('string[]') // const S: z.ZodArray<...> (Syntax)
const T = Zod(t.Number()) // const T: z.ZodNumber (TypeBox)
const V = Zod(v.string()) // const V: z.ZodString (Valibot)
const Z = Zod(z.boolean()) // const Z: z.ZodBoolean (Zod)
`

Syntax

TypeMap provides an optional TypeScript syntax parser that can be used to construct library types. Syntax parsing is implemented at runtime as well as in the type system. This feature can be used to uniformly construct types across libraries, as well as create types with embedded remote types.

$3

Syntax types can be created by passing a string parameter to any library mapping function. TypeMap supports most TypeScript syntax. If the string contains a syntax error, the function will return a never type. (Example)

`typescript
import { TypeBox } from '@sinclair/typemap'

const T = TypeBox('{ x: 1, y: 2 }') // const T: TObject<{
// x: TLiteral<1>,
// y: TLiteral<2>
// }>

const S = TypeBox('!!!') // const S: TNever - Syntax Error
`

$3

You can pass Json Schema options on the last parameter of a syntax type. TypeMap translates known keywords into appropriate runtime representations if possible (Example)

`typescript
import { TypeBox, Zod } from '@sinclair/typemap'

const T = TypeBox('string', { // const T: TString = {
format: 'email' // type: 'string',
}) // format: 'email'
// }


const S = Zod('{ x?: number }', { // const S = z.object({
additionalProperties: false // x: z.number().optional()
}) // }).strict()
`

$3

Syntax types can be parameterized to receive exterior types. Parameters are automatically translated to the receiving type (Example)

`typescript
import { Valibot, Zod } from '@sinclair/typemap'

const V = Valibot('number') // const V: NumberSchema

// Parameter V mapped for target Z

const Z = Zod({ V }, { values: V[] }) // const Z: ZodObject<{
// values: ZodArray
// }, { ... }>
`

$3

Use parameterized types with functions to create generic syntax types (Example)

`typescript
import { TypeBox, Valibot, Zod } from '@sinclair/typemap'

// Generic Type

const Vector = (T: T) => TypeBox({ T }, {
x: T,
y: T,
z: T
})

// Instanced Types

const T = Vector(Valibot('number')) // const T: TObject<{
// x: TNumber,
// y: TNumber,
// z: TNumber,
// }>

const S = Vector(Zod('string')) // const S: TObject<{
// x: TString,
// y: TString,
// z: TString,
// }>
`

Static

Use Static to infer for library and syntax types

`typescript
import { type Static } from '@sinclair/typemap'

const T = t.Number() // TypeBox
const V = v.string() // Valibot
const Z = z.boolean() // Zod
const S = 'string[]' // Syntax

type S = Static // string[]
type T = Static // number
type V = Static // string
type Z = Static // boolean
`

Json Schema

Use TypeBox to transform remote library types into Json Schema (Example)

`typescript
import { TypeBox as JsonSchema } from '@sinclair/typemap'

const Z = z.object({ // const Z: z.ZodObject<{
x: z.number(), // x: z.ZodNumber;
y: z.number(), // y: z.ZodNumber;
z: z.number() // z: z.ZodNumber;
}).strict() // }, "strict", ...>

// TypeBox encodes types as Json Schema

const T = JsonSchema(Z) // const T = {
// type: 'object',
// required: ['x', 'y', 'z'],
// additionalProperties: false,
// properties: {
// x: { type: 'number' },
// y: { type: 'number' },
// z: { type: 'number' }
// }
// }
`

Tree Shake

TypeMap takes on TypeBox, Valibot and Zod as peer dependencies. If bundling, it is recommended that you import specific translation functions. By doing this it will by-pass library imports and enable unused libraries to be omitted from the bundle.

`typescript
import { TypeBoxFromZod } from '@sinclair/typemap' // Use TypeBox & Zod, Tree Shake Valibot

import * as z from 'zod'

const T = TypeBoxFromZod(z.object({ // const T: TObject<{
x: z.number(), // x: TNumber;
y: z.number(), // y: TNumber;
z: z.number() // z: TNumber;
})) // }>
`

Compile

Use the Compile function to compile TypeBox, Valibot and Zod on TypeBox infrastructure (Example)

`typescript
import { Compile, Zod } from '@sinclair/typemap'

// Compile Zod Type

const validator = Compile(Zod({
x: number,
y: number,
z: number
}))

const R1 = validator.Check({ x: 1, y: 2, z: 3 }) // Accelerated

// Standard Schema
//
// ... which should have been named 'Standard Validator'

const R2 = validator['~standard'].validate({ x: 1, y: 2, z: 3 })
`

Benchmark

This project manages a small benchmark that compares validation performance using Zod, Valibot, and TypeBox validators. For more comprehensive community benchmarks, refer to the runtime-type-benchmarks project.

$3

Benchmarks are run for the following type.

`typescript
type T = { x: number, y: string, z: boolean }
`

$3

Results show the approximate elapsed time to complete the given iterations

`typescript
┌─────────┬────────────────┬────────────────────┬────────────┬────────────┐
│ (index) │ library │ using │ iterations │ elapsed │
├─────────┼────────────────┼────────────────────┼────────────┼────────────┤
│ 0 │ 'valibot ' │ 'valibot ' │ 10000000 │ '1534 ms ' │
│ 1 │ 'valibot ' │ 'typebox:value ' │ 10000000 │ '1377 ms ' │
│ 2 │ 'valibot ' │ 'typebox:compile ' │ 10000000 │ '46 ms ' │
└─────────┴────────────────┴────────────────────┴────────────┴────────────┘
┌─────────┬────────────────┬────────────────────┬────────────┬────────────┐
│ (index) │ library │ using │ iterations │ elapsed │
├─────────┼────────────────┼────────────────────┼────────────┼────────────┤
│ 0 │ 'zod ' │ 'zod ' │ 10000000 │ '4669 ms ' │
│ 1 │ 'zod ' │ 'typebox:value ' │ 10000000 │ '1359 ms ' │
│ 2 │ 'zod ' │ 'typebox:compile ' │ 10000000 │ '47 ms ' │
└─────────┴────────────────┴────────────────────┴────────────┴────────────┘
``

Contribute

This project is open to community contributions. Please ensure you submit an open issue before creating a pull request. TypeBox and associated projects preference open community discussion before accepting new features.