JSPM – @orpc/zod@0.0.0-next.e0f01a5

Package Exports

@orpc/zod

Readme

Typesafe APIs Made Simple 🪄

oRPC is a powerful combination of RPC and OpenAPI, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.

Highlights

End-to-End Type Safety 🔒: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
First-Class OpenAPI 📄: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
Contract-First Development 📜: (Optional) Define your API contract upfront and implement it with confidence.
Exceptional Developer Experience ✨: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
Multi-Runtime Support 🌍: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
Framework Integrations 🧩: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
Server Actions ⚡️: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
Standard Schema Support 🗂️: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
Fast & Lightweight 💨: Built on native APIs across all runtimes – optimized for speed and efficiency.
Native Types 📦: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
Lazy Router ⏱️: Improve cold start times with our lazy routing feature.
SSE & Streaming 📡: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
Reusability 🔄: Write once and reuse your code across multiple purposes effortlessly.
Extendability 🔌: Easily enhance oRPC with plugins, middleware, and interceptors.
Reliability 🛡️: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
Simplicity 💡: Enjoy straightforward, clean code with no hidden magic.

Documentation

You can find the full documentation here.

Packages

@orpc/contract: Build your API contract.
@orpc/server: Build your API or implement API contract.
@orpc/client: Consume your API on the client with type-safety.
@orpc/react: Utilities for integrating oRPC with React and React Server Actions.
@orpc/react-query: Integration with React Query.
@orpc/vue-query: Integration with Vue Query.
@orpc/solid-query: Integration with Solid Query.
@orpc/svelte-query: Integration with Svelte Query.
@orpc/vue-colada: Integration with Pinia Colada.
@orpc/openapi: Generate OpenAPI specs and handle OpenAPI requests.
@orpc/zod: More schemas that Zod doesn't support yet.
@orpc/valibot: OpenAPI spec generation from Valibot.
@orpc/arktype: OpenAPI spec generation from ArkType.

`@orpc/zod`

More schemas that Zod doesn't support yet, and provides ZodToJsonSchemaConverter for generating OpenAPI specs.

More Schemas

oz.url: Zod schema for URL instance.
oz.blob: Zod schema for Blob instance.
oz.file: Zod schema for File instance.
oz.regexp: Zod schema for RegExp instance.

import { oz } from '@orpc/zod'
import { z } from 'zod'

const Example = z.object({
  url: oz.url(),
  blob: oz.blob(),
  file: oz.file().type('image/png'),
  regexp: oz.regexp(),
})

Generate OpenAPI Spec

import { OpenAPIGenerator } from '@orpc/openapi'
import { ZodToJsonSchemaConverter } from '@orpc/zod'

const openAPIGenerator = new OpenAPIGenerator({
  schemaConverters: [new ZodToJsonSchemaConverter()],
})

const specFromContract = await openAPIGenerator.generate(contract, {
  info: {
    title: 'My App',
    version: '0.0.0',
  },
})

const specFromRouter = await openAPIGenerator.generate(router, {
  info: {
    title: 'My App',
    version: '0.0.0',
  },
})

Extending the Specification

import { oz } from '@orpc/zod'
import { z } from 'zod'

const InputSchema = oz.openapi(
  z.object({
    name: z.string(),
  }),
  {
    examples: [
      { name: 'Earth' },
      { name: 'Mars' },
    ],
    // additional options...
  }
)

License

Distributed under the MIT License. See LICENSE for more information.

@orpc/zod