@orpc/zod 0.0.0-next.db1f26d → 0.0.0-next.df024bb

package/README.md

@@ -0,0 +1,132 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/zod">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fzod?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**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), 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](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@orpc/zod`
+
+More schemas that [Zod](https://zod.dev/) doesn't support yet, and provides `ZodToJsonSchemaConverter` for generating OpenAPI specs.
+
+### More Schemas
+
+- `oz.url`: Zod schema for [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) instance.
+- `oz.blob`: Zod schema for [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) instance.
+- `oz.file`: Zod schema for [File](https://developer.mozilla.org/en-US/docs/Web/API/File) instance.
+- `oz.regexp`: Zod schema for [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) instance.
+
+```ts
+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
+
+```ts
+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
+
+```ts
+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](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.d.mts

@@ -0,0 +1,89 @@
+import { Context } from '@orpc/server';
+import { Plugin } from '@orpc/server/plugins';
+import { StandardHandlerOptions } from '@orpc/server/standard';
+import { Schema } from '@orpc/contract';
+import { JSONSchema, SchemaConverter, SchemaConvertOptions } from '@orpc/openapi';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { JSONSchema as JSONSchema$1 } from 'json-schema-typed/draft-2020-12';
+import { ZodTypeDef, CustomErrorParams, ZodType, ZodEffects, ZodTypeAny, input, output } from 'zod';
+
+declare class ZodSmartCoercionPlugin<TContext extends Context> implements Plugin<TContext> {
+    init(options: StandardHandlerOptions<TContext>): void;
+}
+
+declare const NON_LOGIC_KEYWORDS: ("default" | "$anchor" | "$comment" | "$defs" | "$dynamicAnchor" | "$dynamicRef" | "$id" | "$schema" | "$vocabulary" | "definitions" | "deprecated" | "description" | "examples" | "format" | "readOnly" | "title" | "writeOnly" | "contentEncoding" | "contentMediaType")[];
+declare const UNSUPPORTED_JSON_SCHEMA: {
+    not: {};
+};
+declare const UNDEFINED_JSON_SCHEMA: {
+    const: string;
+};
+interface ZodToJsonSchemaOptions {
+    /**
+     * Max depth of lazy type, if it exceeds.
+     *
+     * Used `{}` when reach max depth
+     *
+     * @default 5
+     */
+    maxLazyDepth?: number;
+    /**
+     * The length used to track the depth of lazy type
+     *
+     * @internal
+     */
+    lazyDepth?: number;
+    /**
+     * The expected json schema for input or output zod schema
+     *
+     * @default input
+     */
+    mode?: 'input' | 'output';
+    /**
+     * Track if current level schema is handled custom json schema to prevent recursive
+     *
+     * @internal
+     */
+    isHandledCustomJSONSchema?: boolean;
+    /**
+     * Track if current level schema is handled zod description to prevent recursive
+     *
+     * @internal
+     */
+    isHandledZodDescription?: boolean;
+}
+declare function zodToJsonSchema(schema: StandardSchemaV1, options?: ZodToJsonSchemaOptions): Exclude<JSONSchema.JSONSchema, boolean>;
+declare class ZodToJsonSchemaConverter implements SchemaConverter {
+    condition(schema: Schema): boolean;
+    convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
+}
+
+type CustomZodType = 'File' | 'Blob' | 'Invalid Date' | 'RegExp' | 'URL';
+type CustomParams = CustomErrorParams & {
+    fatal?: boolean;
+};
+declare function getCustomZodType(def: ZodTypeDef): CustomZodType | undefined;
+declare function getCustomZodFileMimeType(def: ZodTypeDef): string | undefined;
+declare function getCustomJSONSchema(def: ZodTypeDef, options?: {
+    mode?: 'input' | 'output';
+}): Exclude<JSONSchema$1, boolean> | undefined;
+declare function file(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<InstanceType<typeof File>, ZodTypeDef, InstanceType<typeof File>> & {
+    type(mimeType: string, params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodEffects<ZodType<InstanceType<typeof File>, ZodTypeDef, InstanceType<typeof File>>, InstanceType<typeof File>, InstanceType<typeof File>>;
+};
+declare function blob(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<InstanceType<typeof Blob>, ZodTypeDef, InstanceType<typeof Blob>>;
+declare function invalidDate(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<Date, ZodTypeDef, Date>;
+declare function regexp(options?: CustomParams): ZodType<RegExp, ZodTypeDef, RegExp>;
+declare function url(options?: CustomParams): ZodType<URL, ZodTypeDef, URL>;
+declare function openapi<T extends ZodTypeAny, TMode extends 'input' | 'output' | 'both' = 'both'>(schema: T, custom: Exclude<JSONSchema$1<TMode extends 'input' ? input<T> : TMode extends 'output' ? output<T> : input<T> & output<T>>, boolean>, options?: {
+    mode: TMode;
+}): ReturnType<T['refine']>;
+declare const oz: {
+    openapi: typeof openapi;
+    file: typeof file;
+    blob: typeof blob;
+    invalidDate: typeof invalidDate;
+    regexp: typeof regexp;
+    url: typeof url;
+};
+
+export { type CustomZodType, NON_LOGIC_KEYWORDS, UNDEFINED_JSON_SCHEMA, UNSUPPORTED_JSON_SCHEMA, ZodSmartCoercionPlugin as ZodAutoCoercePlugin, ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, type ZodToJsonSchemaOptions, blob, file, getCustomJSONSchema, getCustomZodFileMimeType, getCustomZodType, invalidDate, openapi, oz, regexp, url, zodToJsonSchema };

package/dist/index.d.ts

@@ -0,0 +1,89 @@
+import { Context } from '@orpc/server';
+import { Plugin } from '@orpc/server/plugins';
+import { StandardHandlerOptions } from '@orpc/server/standard';
+import { Schema } from '@orpc/contract';
+import { JSONSchema, SchemaConverter, SchemaConvertOptions } from '@orpc/openapi';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { JSONSchema as JSONSchema$1 } from 'json-schema-typed/draft-2020-12';
+import { ZodTypeDef, CustomErrorParams, ZodType, ZodEffects, ZodTypeAny, input, output } from 'zod';
+
+declare class ZodSmartCoercionPlugin<TContext extends Context> implements Plugin<TContext> {
+    init(options: StandardHandlerOptions<TContext>): void;
+}
+
+declare const NON_LOGIC_KEYWORDS: ("default" | "$anchor" | "$comment" | "$defs" | "$dynamicAnchor" | "$dynamicRef" | "$id" | "$schema" | "$vocabulary" | "definitions" | "deprecated" | "description" | "examples" | "format" | "readOnly" | "title" | "writeOnly" | "contentEncoding" | "contentMediaType")[];
+declare const UNSUPPORTED_JSON_SCHEMA: {
+    not: {};
+};
+declare const UNDEFINED_JSON_SCHEMA: {
+    const: string;
+};
+interface ZodToJsonSchemaOptions {
+    /**
+     * Max depth of lazy type, if it exceeds.
+     *
+     * Used `{}` when reach max depth
+     *
+     * @default 5
+     */
+    maxLazyDepth?: number;
+    /**
+     * The length used to track the depth of lazy type
+     *
+     * @internal
+     */
+    lazyDepth?: number;
+    /**
+     * The expected json schema for input or output zod schema
+     *
+     * @default input
+     */
+    mode?: 'input' | 'output';
+    /**
+     * Track if current level schema is handled custom json schema to prevent recursive
+     *
+     * @internal
+     */
+    isHandledCustomJSONSchema?: boolean;
+    /**
+     * Track if current level schema is handled zod description to prevent recursive
+     *
+     * @internal
+     */
+    isHandledZodDescription?: boolean;
+}
+declare function zodToJsonSchema(schema: StandardSchemaV1, options?: ZodToJsonSchemaOptions): Exclude<JSONSchema.JSONSchema, boolean>;
+declare class ZodToJsonSchemaConverter implements SchemaConverter {
+    condition(schema: Schema): boolean;
+    convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
+}
+
+type CustomZodType = 'File' | 'Blob' | 'Invalid Date' | 'RegExp' | 'URL';
+type CustomParams = CustomErrorParams & {
+    fatal?: boolean;
+};
+declare function getCustomZodType(def: ZodTypeDef): CustomZodType | undefined;
+declare function getCustomZodFileMimeType(def: ZodTypeDef): string | undefined;
+declare function getCustomJSONSchema(def: ZodTypeDef, options?: {
+    mode?: 'input' | 'output';
+}): Exclude<JSONSchema$1, boolean> | undefined;
+declare function file(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<InstanceType<typeof File>, ZodTypeDef, InstanceType<typeof File>> & {
+    type(mimeType: string, params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodEffects<ZodType<InstanceType<typeof File>, ZodTypeDef, InstanceType<typeof File>>, InstanceType<typeof File>, InstanceType<typeof File>>;
+};
+declare function blob(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<InstanceType<typeof Blob>, ZodTypeDef, InstanceType<typeof Blob>>;
+declare function invalidDate(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<Date, ZodTypeDef, Date>;
+declare function regexp(options?: CustomParams): ZodType<RegExp, ZodTypeDef, RegExp>;
+declare function url(options?: CustomParams): ZodType<URL, ZodTypeDef, URL>;
+declare function openapi<T extends ZodTypeAny, TMode extends 'input' | 'output' | 'both' = 'both'>(schema: T, custom: Exclude<JSONSchema$1<TMode extends 'input' ? input<T> : TMode extends 'output' ? output<T> : input<T> & output<T>>, boolean>, options?: {
+    mode: TMode;
+}): ReturnType<T['refine']>;
+declare const oz: {
+    openapi: typeof openapi;
+    file: typeof file;
+    blob: typeof blob;
+    invalidDate: typeof invalidDate;
+    regexp: typeof regexp;
+    url: typeof url;
+};
+
+export { type CustomZodType, NON_LOGIC_KEYWORDS, UNDEFINED_JSON_SCHEMA, UNSUPPORTED_JSON_SCHEMA, ZodSmartCoercionPlugin as ZodAutoCoercePlugin, ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, type ZodToJsonSchemaOptions, blob, file, getCustomJSONSchema, getCustomZodFileMimeType, getCustomZodType, invalidDate, openapi, oz, regexp, url, zodToJsonSchema };