@orpc/zod 0.0.0-next.dcc6c29 → 0.0.0-next.dda04c5

package/README.md

@@ -21,28 +21,24 @@
 
 <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.
+**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
 
 ---
 
 ## 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.
+- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
+- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
+- **📝 Contract-First Development**: Optionally define your API contract before implementation.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
+- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
+- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
+- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
+- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
+- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
+- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 
@@ -53,13 +49,12 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@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/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
-- [@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/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
-- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
+- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
 - [@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/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
 - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
 - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
 - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).

package/dist/index.d.mts

@@ -40,34 +40,43 @@ declare class ZodSmartCoercionPlugin<TContext extends Context> implements Standa
 
 interface ZodToJsonSchemaOptions {
     /**
-     * Max depth of lazy type, if it exceeds.
+     * Max depth of lazy type
      *
-     * Used `{}` when reach max depth
+     * Used `{}` when exceed max depth
      *
      * @default 3
      */
     maxLazyDepth?: number;
     /**
-     * The schema to be used when the Zod schema is unsupported.
+     * Max depth of nested types
      *
-     * @default { not: {} }
+     * Used anyJsonSchema (`{}`) when exceed max depth
+     *
+     * @default 10
      */
-    unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
+    maxStructureDepth?: number;
     /**
      * The schema to be used to represent the any | unknown type.
      *
      * @default { }
      */
     anyJsonSchema?: Exclude<JSONSchema, boolean>;
+    /**
+     * The schema to be used when the Zod schema is unsupported.
+     *
+     * @default { not: {} }
+     */
+    unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
 }
 declare class ZodToJsonSchemaConverter implements ConditionalSchemaConverter {
     #private;
     private readonly maxLazyDepth;
+    private readonly maxStructureDepth;
     private readonly unsupportedJsonSchema;
     private readonly anyJsonSchema;
     constructor(options?: ZodToJsonSchemaOptions);
     condition(schema: AnySchema | undefined): boolean;
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions, lazyDepth?: number, isHandledCustomJSONSchema?: boolean, isHandledZodDescription?: boolean): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions, lazyDepth?: number, isHandledCustomJSONSchema?: boolean, isHandledZodDescription?: boolean, structureDepth?: number): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
 }
 
 declare const oz: {
@@ -78,4 +87,5 @@ declare const oz: {
     openapi: typeof customJsonSchema;
 };
 
-export { type CustomParams, type CustomZodDef, ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, type ZodToJsonSchemaOptions, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
+export { ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
+export type { CustomParams, CustomZodDef, ZodToJsonSchemaOptions };

package/dist/index.d.ts

@@ -40,34 +40,43 @@ declare class ZodSmartCoercionPlugin<TContext extends Context> implements Standa
 
 interface ZodToJsonSchemaOptions {
     /**
-     * Max depth of lazy type, if it exceeds.
+     * Max depth of lazy type
      *
-     * Used `{}` when reach max depth
+     * Used `{}` when exceed max depth
      *
      * @default 3
      */
     maxLazyDepth?: number;
     /**
-     * The schema to be used when the Zod schema is unsupported.
+     * Max depth of nested types
      *
-     * @default { not: {} }
+     * Used anyJsonSchema (`{}`) when exceed max depth
+     *
+     * @default 10
      */
-    unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
+    maxStructureDepth?: number;
     /**
      * The schema to be used to represent the any | unknown type.
      *
      * @default { }
      */
     anyJsonSchema?: Exclude<JSONSchema, boolean>;
+    /**
+     * The schema to be used when the Zod schema is unsupported.
+     *
+     * @default { not: {} }
+     */
+    unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
 }
 declare class ZodToJsonSchemaConverter implements ConditionalSchemaConverter {
     #private;
     private readonly maxLazyDepth;
+    private readonly maxStructureDepth;
     private readonly unsupportedJsonSchema;
     private readonly anyJsonSchema;
     constructor(options?: ZodToJsonSchemaOptions);
     condition(schema: AnySchema | undefined): boolean;
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions, lazyDepth?: number, isHandledCustomJSONSchema?: boolean, isHandledZodDescription?: boolean): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions, lazyDepth?: number, isHandledCustomJSONSchema?: boolean, isHandledZodDescription?: boolean, structureDepth?: number): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
 }
 
 declare const oz: {
@@ -78,4 +87,5 @@ declare const oz: {
     openapi: typeof customJsonSchema;
 };
 
-export { type CustomParams, type CustomZodDef, ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, type ZodToJsonSchemaOptions, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
+export { ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
+export type { CustomParams, CustomZodDef, ZodToJsonSchemaOptions };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { custom, ZodFirstPartyTypeKind } from 'zod';
 import wcmatch from 'wildcard-match';
-import { isObject, guard } from '@orpc/shared';
+import { isObject, guard, toArray } from '@orpc/shared';
 import { JSONSchemaFormat } from '@orpc/openapi';
 import escapeStringRegexp from 'escape-string-regexp';
 
@@ -390,25 +390,39 @@ function safeToDate(value) {
 
 class ZodToJsonSchemaConverter {
   maxLazyDepth;
+  maxStructureDepth;
   unsupportedJsonSchema;
   anyJsonSchema;
   constructor(options = {}) {
     this.maxLazyDepth = options.maxLazyDepth ?? 3;
+    this.maxStructureDepth = options.maxStructureDepth ?? 10;
     this.unsupportedJsonSchema = options.unsupportedJsonSchema ?? { not: {} };
     this.anyJsonSchema = options.anyJsonSchema ?? {};
   }
   condition(schema) {
     return schema !== void 0 && schema["~standard"].vendor === "zod";
   }
-  convert(schema, options, lazyDepth = 0, isHandledCustomJSONSchema = false, isHandledZodDescription = false) {
+  convert(schema, options, lazyDepth = 0, isHandledCustomJSONSchema = false, isHandledZodDescription = false, structureDepth = 0) {
     const def = schema._def;
+    if (structureDepth > this.maxStructureDepth) {
+      return [false, this.anyJsonSchema];
+    }
+    if (!options.minStructureDepthForRef || options.minStructureDepthForRef <= structureDepth) {
+      const components = toArray(options.components);
+      for (const component of components) {
+        if (component.schema === schema && component.allowedStrategies.includes(options.strategy)) {
+          return [component.required, { $ref: component.ref }];
+        }
+      }
+    }
     if (!isHandledZodDescription && "description" in def && typeof def.description === "string") {
       const [required, json] = this.convert(
         schema,
         options,
         lazyDepth,
         isHandledCustomJSONSchema,
-        true
+        true,
+        structureDepth
       );
       return [required, { ...json, description: def.description }];
     }
@@ -420,7 +434,8 @@ class ZodToJsonSchemaConverter {
           options,
           lazyDepth,
           true,
-          isHandledZodDescription
+          isHandledZodDescription,
+          structureDepth
         );
         return [required, { ...json, ...customJSONSchema }];
       }
@@ -591,7 +606,7 @@ class ZodToJsonSchemaConverter {
         const schema_ = schema;
         const def2 = schema_._def;
         const json = { type: "array" };
-        const [itemRequired, itemJson] = this.convert(def2.type, options, lazyDepth, false, false);
+        const [itemRequired, itemJson] = this.convert(def2.type, options, lazyDepth, false, false, structureDepth + 1);
         json.items = this.#toArrayItemJsonSchema(itemRequired, itemJson, options.strategy);
         if (def2.exactLength) {
           json.maxItems = def2.exactLength.value;
@@ -610,7 +625,7 @@ class ZodToJsonSchemaConverter {
         const prefixItems = [];
         const json = { type: "array" };
         for (const item of schema_._def.items) {
-          const [itemRequired, itemJson] = this.convert(item, options, lazyDepth, false, false);
+          const [itemRequired, itemJson] = this.convert(item, options, lazyDepth, false, false, structureDepth + 1);
           prefixItems.push(
             this.#toArrayItemJsonSchema(itemRequired, itemJson, options.strategy)
           );
@@ -619,7 +634,7 @@ class ZodToJsonSchemaConverter {
           json.prefixItems = prefixItems;
         }
         if (schema_._def.rest) {
-          const [itemRequired, itemJson] = this.convert(schema_._def.rest, options, lazyDepth, false, false);
+          const [itemRequired, itemJson] = this.convert(schema_._def.rest, options, lazyDepth, false, false, structureDepth + 1);
           json.items = this.#toArrayItemJsonSchema(itemRequired, itemJson, options.strategy);
         }
         return [true, json];
@@ -630,7 +645,7 @@ class ZodToJsonSchemaConverter {
         const properties = {};
         const required = [];
         for (const [key, value] of Object.entries(schema_.shape)) {
-          const [itemRequired, itemJson] = this.convert(value, options, lazyDepth, false, false);
+          const [itemRequired, itemJson] = this.convert(value, options, lazyDepth, false, false, structureDepth + 1);
           properties[key] = itemJson;
           if (itemRequired) {
             required.push(key);
@@ -648,7 +663,7 @@ class ZodToJsonSchemaConverter {
             json.additionalProperties = false;
           }
         } else {
-          const [_, addJson] = this.convert(schema_._def.catchall, options, lazyDepth, false, false);
+          const [_, addJson] = this.convert(schema_._def.catchall, options, lazyDepth, false, false, structureDepth + 1);
           json.additionalProperties = addJson;
         }
         return [true, json];
@@ -656,25 +671,25 @@ class ZodToJsonSchemaConverter {
       case ZodFirstPartyTypeKind.ZodRecord: {
         const schema_ = schema;
         const json = { type: "object" };
-        const [__, keyJson] = this.convert(schema_._def.keyType, options, lazyDepth, false, false);
+        const [__, keyJson] = this.convert(schema_._def.keyType, options, lazyDepth, false, false, structureDepth + 1);
         if (Object.entries(keyJson).some(([k, v]) => k !== "type" || v !== "string")) {
           json.propertyNames = keyJson;
         }
-        const [_, itemJson] = this.convert(schema_._def.valueType, options, lazyDepth, false, false);
+        const [_, itemJson] = this.convert(schema_._def.valueType, options, lazyDepth, false, false, structureDepth + 1);
         json.additionalProperties = itemJson;
         return [true, json];
       }
       case ZodFirstPartyTypeKind.ZodSet: {
         const schema_ = schema;
         const json = { type: "array", uniqueItems: true };
-        const [itemRequired, itemJson] = this.convert(schema_._def.valueType, options, lazyDepth, false, false);
+        const [itemRequired, itemJson] = this.convert(schema_._def.valueType, options, lazyDepth, false, false, structureDepth + 1);
         json.items = this.#toArrayItemJsonSchema(itemRequired, itemJson, options.strategy);
         return [true, json];
       }
       case ZodFirstPartyTypeKind.ZodMap: {
         const schema_ = schema;
-        const [keyRequired, keyJson] = this.convert(schema_._def.keyType, options, lazyDepth, false, false);
-        const [valueRequired, valueJson] = this.convert(schema_._def.valueType, options, lazyDepth, false, false);
+        const [keyRequired, keyJson] = this.convert(schema_._def.keyType, options, lazyDepth, false, false, structureDepth + 1);
+        const [valueRequired, valueJson] = this.convert(schema_._def.valueType, options, lazyDepth, false, false, structureDepth + 1);
         return [true, {
           type: "array",
           items: {
@@ -694,7 +709,7 @@ class ZodToJsonSchemaConverter {
         const anyOf = [];
         let required = true;
         for (const item of schema_._def.options) {
-          const [itemRequired, itemJson] = this.convert(item, options, lazyDepth, false, false);
+          const [itemRequired, itemJson] = this.convert(item, options, lazyDepth, false, false, structureDepth);
           if (!itemRequired) {
             required = false;
             if (itemJson !== this.unsupportedJsonSchema) {
@@ -714,7 +729,7 @@ class ZodToJsonSchemaConverter {
         const allOf = [];
         let required = false;
         for (const item of [schema_._def.left, schema_._def.right]) {
-          const [itemRequired, itemJson] = this.convert(item, options, lazyDepth, false, false);
+          const [itemRequired, itemJson] = this.convert(item, options, lazyDepth, false, false, structureDepth);
           allOf.push(itemJson);
           if (itemRequired) {
             required = true;
@@ -723,25 +738,26 @@ class ZodToJsonSchemaConverter {
         return [required, { allOf }];
       }
       case ZodFirstPartyTypeKind.ZodLazy: {
-        if (lazyDepth >= this.maxLazyDepth) {
+        const currentLazyDepth = lazyDepth + 1;
+        if (currentLazyDepth > this.maxLazyDepth) {
           return [false, this.anyJsonSchema];
         }
         const schema_ = schema;
-        return this.convert(schema_._def.getter(), options, lazyDepth + 1, false, false);
+        return this.convert(schema_._def.getter(), options, currentLazyDepth, false, false, structureDepth);
       }
       case ZodFirstPartyTypeKind.ZodOptional: {
         const schema_ = schema;
-        const [_, inner] = this.convert(schema_._def.innerType, options, lazyDepth, false, false);
+        const [_, inner] = this.convert(schema_._def.innerType, options, lazyDepth, false, false, structureDepth);
         return [false, inner];
       }
       case ZodFirstPartyTypeKind.ZodReadonly: {
         const schema_ = schema;
-        const [required, json] = this.convert(schema_._def.innerType, options, lazyDepth, false, false);
+        const [required, json] = this.convert(schema_._def.innerType, options, lazyDepth, false, false, structureDepth);
         return [required, { ...json, readOnly: true }];
       }
       case ZodFirstPartyTypeKind.ZodDefault: {
         const schema_ = schema;
-        const [_, json] = this.convert(schema_._def.innerType, options, lazyDepth, false, false);
+        const [_, json] = this.convert(schema_._def.innerType, options, lazyDepth, false, false, structureDepth);
         return [false, { default: schema_._def.defaultValue(), ...json }];
       }
       case ZodFirstPartyTypeKind.ZodEffects: {
@@ -749,15 +765,15 @@ class ZodToJsonSchemaConverter {
         if (schema_._def.effect.type === "transform" && options.strategy === "output") {
           return [false, this.anyJsonSchema];
         }
-        return this.convert(schema_._def.schema, options, lazyDepth, false, false);
+        return this.convert(schema_._def.schema, options, lazyDepth, false, false, structureDepth);
       }
       case ZodFirstPartyTypeKind.ZodCatch: {
         const schema_ = schema;
-        return this.convert(schema_._def.innerType, options, lazyDepth, false, false);
+        return this.convert(schema_._def.innerType, options, lazyDepth, false, false, structureDepth);
       }
       case ZodFirstPartyTypeKind.ZodBranded: {
         const schema_ = schema;
-        return this.convert(schema_._def.type, options, lazyDepth, false, false);
+        return this.convert(schema_._def.type, options, lazyDepth, false, false, structureDepth);
       }
       case ZodFirstPartyTypeKind.ZodPipeline: {
         const schema_ = schema;
@@ -766,13 +782,14 @@ class ZodToJsonSchemaConverter {
           options,
           lazyDepth,
           false,
-          false
+          false,
+          structureDepth
         );
       }
       case ZodFirstPartyTypeKind.ZodNullable: {
         const schema_ = schema;
-        const [required, json] = this.convert(schema_._def.innerType, options, lazyDepth, false, false);
-        return [required, { anyOf: [{ type: "null" }, json] }];
+        const [required, json] = this.convert(schema_._def.innerType, options, lazyDepth, false, false, structureDepth);
+        return [required, { anyOf: [json, { type: "null" }] }];
       }
     }
     return [true, this.unsupportedJsonSchema];