@schemashift/zod-arktype

Zod ↔ ArkType transformer for SchemaShift. Supports both forward (Zod → ArkType) and backward (ArkType → Zod) migrations.


Tier: Pro+

Installation

``bash
npm install @schemashift/zod-arktype
`

Usage

`typescript
import { createZodToArktypeHandler, createArktypeToZodHandler } from '@schemashift/zod-arktype';
import { TransformEngine } from '@schemashift/core';

const engine = new TransformEngine();
engine.registerHandler('zod', 'arktype', createZodToArktypeHandler());
engine.registerHandler('arktype', 'zod', createArktypeToZodHandler()); // Backward migration (Pro+)
`

API Paradigm Difference

Zod uses a method chain API:

`typescript
z.object({ name: z.string().email(), age: z.number().int() })
`

ArkType uses a TypeScript-like string API:

`typescript
type({ name: "string.email", age: "number.integer" })
`

Transformation Mappings

$3

| Zod | ArkType |
|-----|---------|
| import { z } from 'zod' | import { type } from 'arktype' |

$3

| Zod | ArkType |
|-----|---------|
| z.string() | "string" |
| z.number() | "number" |
| z.boolean() | "boolean" |
| z.bigint() | "bigint" |
| z.date() | "Date" |
| z.unknown() | "unknown" |
| z.never() | "never" |
| z.null() | "null" |
| z.void() | "void" |
| z.any() | "unknown" |
| z.object({...}) | type({...}) |
| z.array(s) | "s[]" |
| z.enum(["a", "b"]) | type("'a' \| 'b'") |
| z.literal(42) | type("=== 42") |
| z.union([a, b]) | type("a \| b") |
| z.record(k, v) | type("Record") |

$3

| Zod | ArkType |
|-----|---------|
| z.string().email() | "string.email" |
| z.string().url() | "string.url" |
| z.string().uuid() | "string.uuid" |
| z.string().ip() | "string.ip" |
| z.number().int() | "number.integer" |

$3

| Zod | ArkType |
|-----|---------|
| .optional() | "type?" |
| .nullable() | "type \| null" |

$3

| Zod | ArkType |
|-----|---------|
| z.infer | typeof s.infer |
| z.input | typeof s.in |
| z.output | typeof s.infer |

Patterns Requiring Manual Review

$3

ArkType uses .narrow() for refinements:

`typescript
// Zod
z.string().refine((s) => s.length > 0, "Required");

// ArkType
type("string").narrow((s) => s.length > 0);
`

$3

ArkType uses morphs via .pipe():

`typescript
// Zod
z.string().transform((s) => s.toUpperCase());

// ArkType
type("string").pipe((s) => s.toUpperCase());
`

$3

ArkType uses scope() for recursive definitions:

`typescript
// Zod
const node: z.ZodType = z.lazy(() => z.object({ children: z.array(node) }));

// ArkType
const types = scope({ node: { children: "node[]" } }).export();
`

$3

ArkType has no .brand()` equivalent. Use nominal types or tagged unions instead.

Related Packages

- schemashift-cli — CLI tool for running migrations
- @schemashift/core — Core analysis engine
- @schemashift/zod-valibot — Zod ↔ Valibot transformer

License

MIT