@orpc/openapi 1.4.5 → 1.5.1

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
 export { OpenAPI } from '@orpc/contract';
-export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.qZLdpE0a.mjs';
+export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.CbIlrReM.mjs';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from 'json-schema-typed/draft-2020-12';
@@ -65,6 +65,7 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  * @internal
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
+declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
 
 declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
 
@@ -105,5 +106,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
 export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
 export { OpenAPI } from '@orpc/contract';
-export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.qZLdpE0a.js';
+export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.CbIlrReM.js';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from 'json-schema-typed/draft-2020-12';
@@ -65,6 +65,7 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  * @internal
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
+declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
 
 declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
 
@@ -105,5 +106,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
 export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { c as customOpenAPIOperation } from './shared/openapi.DaYgbD_w.mjs';
-export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, p as expandArrayableSchema, o as expandUnionSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, q as isPrimitiveSchema, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.DaYgbD_w.mjs';
+import { c as customOpenAPIOperation } from './shared/openapi.C_3bk7bB.mjs';
+export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, p as expandArrayableSchema, o as expandUnionSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, q as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.C_3bk7bB.mjs';
 import { createORPCErrorFromJson } from '@orpc/client';
 import { StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
 import { ORPCError, createRouterClient } from '@orpc/server';

package/dist/plugins/index.d.mts

@@ -2,7 +2,7 @@ import { OpenAPI } from '@orpc/contract';
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value, Promisable } from '@orpc/shared';
-import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.qZLdpE0a.mjs';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CbIlrReM.mjs';
 import '@orpc/openapi-client/standard';
 import 'json-schema-typed/draft-2020-12';
 

package/dist/plugins/index.d.ts

@@ -2,7 +2,7 @@ import { OpenAPI } from '@orpc/contract';
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value, Promisable } from '@orpc/shared';
-import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.qZLdpE0a.js';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CbIlrReM.js';
 import '@orpc/openapi-client/standard';
 import 'json-schema-typed/draft-2020-12';
 

package/dist/plugins/index.mjs

@@ -1,5 +1,5 @@
 import { stringifyJSON, once, value } from '@orpc/shared';
-import { O as OpenAPIGenerator } from '../shared/openapi.DaYgbD_w.mjs';
+import { O as OpenAPIGenerator } from '../shared/openapi.C_3bk7bB.mjs';
 import '@orpc/client';
 import '@orpc/client/standard';
 import '@orpc/contract';

package/dist/shared/{openapi.DaYgbD_w.mjs → openapi.C_3bk7bB.mjs}

@@ -345,6 +345,15 @@ function checkParamsSchema(schema, params) {
 function toOpenAPISchema(schema) {
   return schema === true ? {} : schema === false ? { not: {} } : schema;
 }
+const OPENAPI_JSON_SCHEMA_REF_PREFIX = "#/components/schemas/";
+function resolveOpenAPIJsonSchemaRef(doc, schema) {
+  if (typeof schema !== "object" || !schema.$ref?.startsWith(OPENAPI_JSON_SCHEMA_REF_PREFIX)) {
+    return schema;
+  }
+  const name = schema.$ref.slice(OPENAPI_JSON_SCHEMA_REF_PREFIX.length);
+  const resolved = doc.components?.schemas?.[name];
+  return resolved ?? schema;
+}
 
 class CompositeSchemaConverter {
   converters;
@@ -381,8 +390,10 @@ class OpenAPIGenerator {
       ...clone(options),
       info: options.info ?? { title: "API Reference", version: "0.0.0" },
       openapi: "3.1.1",
-      exclude: void 0
+      exclude: void 0,
+      commonSchemas: void 0
     };
+    const baseSchemaConvertOptions = await this.#resolveCommonSchemas(doc, options.commonSchemas);
     const contracts = [];
     await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
       if (!exclude(contract, path)) {
@@ -407,9 +418,9 @@ class OpenAPIGenerator {
             deprecated: def.route.deprecated,
             tags: def.route.tags?.map((tag) => tag)
           };
-          await this.#request(operationObjectRef, def);
-          await this.#successResponse(operationObjectRef, def);
-          await this.#errorResponse(operationObjectRef, def);
+          await this.#request(doc, operationObjectRef, def, baseSchemaConvertOptions);
+          await this.#successResponse(doc, operationObjectRef, def, baseSchemaConvertOptions);
+          await this.#errorResponse(operationObjectRef, def, baseSchemaConvertOptions);
         }
         doc.paths ??= {};
         doc.paths[httpPath] ??= {};
@@ -433,22 +444,73 @@ ${errors.join("\n\n")}`
     }
     return this.serializer.serialize(doc)[0];
   }
-  async #request(ref, def) {
+  async #resolveCommonSchemas(doc, commonSchemas) {
+    const baseOptions = {};
+    if (commonSchemas) {
+      baseOptions.components = [];
+      for (const key in commonSchemas) {
+        const { schema, strategy = "input" } = commonSchemas[key];
+        const [required, json] = await this.converter.convert(schema, { strategy });
+        const allowedStrategies = [strategy];
+        if (strategy === "input") {
+          const [outputRequired, outputJson] = await this.converter.convert(schema, { strategy: "output" });
+          if (outputRequired === required && stringifyJSON(outputJson) === stringifyJSON(json)) {
+            allowedStrategies.push("output");
+          }
+        } else if (strategy === "output") {
+          const [inputRequired, inputJson] = await this.converter.convert(schema, { strategy: "input" });
+          if (inputRequired === required && stringifyJSON(inputJson) === stringifyJSON(json)) {
+            allowedStrategies.push("input");
+          }
+        }
+        baseOptions.components.push({
+          schema,
+          required,
+          ref: `#/components/schemas/${key}`,
+          allowedStrategies
+        });
+      }
+      doc.components ??= {};
+      doc.components.schemas ??= {};
+      for (const key in commonSchemas) {
+        const { schema, strategy = "input" } = commonSchemas[key];
+        const [, json] = await this.converter.convert(
+          schema,
+          {
+            ...baseOptions,
+            strategy,
+            minStructureDepthForRef: 1
+            // not allow use $ref for root schemas
+          }
+        );
+        doc.components.schemas[key] = toOpenAPISchema(json);
+      }
+    }
+    return baseOptions;
+  }
+  async #request(doc, ref, def, baseSchemaConvertOptions) {
     const method = fallbackContractConfig("defaultMethod", def.route.method);
     const details = getEventIteratorSchemaDetails(def.inputSchema);
     if (details) {
       ref.requestBody = {
         required: true,
         content: toOpenAPIEventIteratorContent(
-          await this.converter.convert(details.yields, { strategy: "input" }),
-          await this.converter.convert(details.returns, { strategy: "input" })
+          await this.converter.convert(details.yields, { ...baseSchemaConvertOptions, strategy: "input" }),
+          await this.converter.convert(details.returns, { ...baseSchemaConvertOptions, strategy: "input" })
         )
       };
       return;
     }
     const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
     const inputStructure = fallbackContractConfig("defaultInputStructure", def.route.inputStructure);
-    let [required, schema] = await this.converter.convert(def.inputSchema, { strategy: "input" });
+    let [required, schema] = await this.converter.convert(
+      def.inputSchema,
+      {
+        ...baseSchemaConvertOptions,
+        strategy: "input",
+        minStructureDepthForRef: dynamicParams?.length || inputStructure === "detailed" ? 1 : 0
+      }
+    );
     if (isAnySchema(schema) && !dynamicParams?.length) {
       return;
     }
@@ -491,7 +553,8 @@ ${errors.join("\n\n")}`
     if (!isObjectSchema(schema)) {
       throw error;
     }
-    if (dynamicParams?.length && (schema.properties?.params === void 0 || !isObjectSchema(schema.properties.params) || !checkParamsSchema(schema.properties.params, dynamicParams))) {
+    const resolvedParamSchema = schema.properties?.params !== void 0 ? resolveOpenAPIJsonSchemaRef(doc, schema.properties.params) : void 0;
+    if (dynamicParams?.length && (resolvedParamSchema === void 0 || !isObjectSchema(resolvedParamSchema) || !checkParamsSchema(resolvedParamSchema, dynamicParams))) {
       throw new OpenAPIGeneratorError(
         'When input structure is "detailed" and path has dynamic params, the "params" schema must be an object with all dynamic params as required.'
       );
@@ -499,12 +562,13 @@ ${errors.join("\n\n")}`
     for (const from of ["params", "query", "headers"]) {
       const fromSchema = schema.properties?.[from];
       if (fromSchema !== void 0) {
-        if (!isObjectSchema(fromSchema)) {
+        const resolvedSchema = resolveOpenAPIJsonSchemaRef(doc, fromSchema);
+        if (!isObjectSchema(resolvedSchema)) {
           throw error;
         }
         const parameterIn = from === "params" ? "path" : from === "headers" ? "header" : "query";
         ref.parameters ??= [];
-        ref.parameters.push(...toOpenAPIParameters(fromSchema, parameterIn));
+        ref.parameters.push(...toOpenAPIParameters(resolvedSchema, parameterIn));
       }
     }
     if (schema.properties?.body !== void 0) {
@@ -514,7 +578,7 @@ ${errors.join("\n\n")}`
       };
     }
   }
-  async #successResponse(ref, def) {
+  async #successResponse(doc, ref, def, baseSchemaConvertOptions) {
     const outputSchema = def.outputSchema;
     const status = fallbackContractConfig("defaultSuccessStatus", def.route.successStatus);
     const description = fallbackContractConfig("defaultSuccessDescription", def.route?.successDescription);
@@ -525,13 +589,20 @@ ${errors.join("\n\n")}`
       ref.responses[status] = {
         description,
         content: toOpenAPIEventIteratorContent(
-          await this.converter.convert(eventIteratorSchemaDetails.yields, { strategy: "output" }),
-          await this.converter.convert(eventIteratorSchemaDetails.returns, { strategy: "output" })
+          await this.converter.convert(eventIteratorSchemaDetails.yields, { ...baseSchemaConvertOptions, strategy: "output" }),
+          await this.converter.convert(eventIteratorSchemaDetails.returns, { ...baseSchemaConvertOptions, strategy: "output" })
         )
       };
       return;
     }
-    const [required, json] = await this.converter.convert(outputSchema, { strategy: "output" });
+    const [required, json] = await this.converter.convert(
+      outputSchema,
+      {
+        ...baseSchemaConvertOptions,
+        strategy: "output",
+        minStructureDepthForRef: outputStructure === "detailed" ? 1 : 0
+      }
+    );
     if (outputStructure === "compact") {
       ref.responses ??= {};
       ref.responses[status] = {
@@ -558,11 +629,12 @@ ${errors.join("\n\n")}`
       let schemaStatus;
       let schemaDescription;
       if (item.properties?.status !== void 0) {
-        if (typeof item.properties.status !== "object" || item.properties.status.const === void 0 || typeof item.properties.status.const !== "number" || !Number.isInteger(item.properties.status.const) || isORPCErrorStatus(item.properties.status.const)) {
+        const statusSchema = resolveOpenAPIJsonSchemaRef(doc, item.properties.status);
+        if (typeof statusSchema !== "object" || statusSchema.const === void 0 || typeof statusSchema.const !== "number" || !Number.isInteger(statusSchema.const) || isORPCErrorStatus(statusSchema.const)) {
           throw error;
         }
-        schemaStatus = item.properties.status.const;
-        schemaDescription = item.properties.status.description;
+        schemaStatus = statusSchema.const;
+        schemaDescription = statusSchema.description;
       }
       const itemStatus = schemaStatus ?? status;
       const itemDescription = schemaDescription ?? description;
@@ -578,16 +650,17 @@ ${errors.join("\n\n")}`
         description: itemDescription
       };
       if (item.properties?.headers !== void 0) {
-        if (!isObjectSchema(item.properties.headers)) {
+        const headersSchema = resolveOpenAPIJsonSchemaRef(doc, item.properties.headers);
+        if (!isObjectSchema(headersSchema)) {
           throw error;
         }
-        for (const key in item.properties.headers.properties) {
-          const headerSchema = item.properties.headers.properties[key];
+        for (const key in headersSchema.properties) {
+          const headerSchema = headersSchema.properties[key];
           if (headerSchema !== void 0) {
             ref.responses[itemStatus].headers ??= {};
             ref.responses[itemStatus].headers[key] = {
               schema: toOpenAPISchema(headerSchema),
-              required: item.properties.headers.required?.includes(key)
+              required: item.required?.includes("headers") && headersSchema.required?.includes(key)
             };
           }
         }
@@ -599,7 +672,7 @@ ${errors.join("\n\n")}`
       }
     }
   }
-  async #errorResponse(ref, def) {
+  async #errorResponse(ref, def, baseSchemaConvertOptions) {
     const errorMap = def.errorMap;
     const errors = {};
     for (const code in errorMap) {
@@ -609,7 +682,7 @@ ${errors.join("\n\n")}`
       }
       const status = fallbackORPCErrorStatus(code, config.status);
       const message = fallbackORPCErrorMessage(code, config.message);
-      const [dataRequired, dataSchema] = await this.converter.convert(config.data, { strategy: "output" });
+      const [dataRequired, dataSchema] = await this.converter.convert(config.data, { ...baseSchemaConvertOptions, strategy: "output" });
       errors[status] ??= [];
       errors[status].push({
         type: "object",
@@ -649,4 +722,4 @@ ${errors.join("\n\n")}`
   }
 }
 
-export { CompositeSchemaConverter as C, LOGIC_KEYWORDS as L, OpenAPIGenerator as O, applyCustomOpenAPIOperation as a, toOpenAPIMethod as b, customOpenAPIOperation as c, toOpenAPIContent as d, toOpenAPIEventIteratorContent as e, toOpenAPIParameters as f, getCustomOpenAPIOperation as g, checkParamsSchema as h, toOpenAPISchema as i, isFileSchema as j, isObjectSchema as k, isAnySchema as l, filterSchemaBranches as m, applySchemaOptionality as n, expandUnionSchema as o, expandArrayableSchema as p, isPrimitiveSchema as q, separateObjectSchema as s, toOpenAPIPath as t };
+export { CompositeSchemaConverter as C, LOGIC_KEYWORDS as L, OpenAPIGenerator as O, applyCustomOpenAPIOperation as a, toOpenAPIMethod as b, customOpenAPIOperation as c, toOpenAPIContent as d, toOpenAPIEventIteratorContent as e, toOpenAPIParameters as f, getCustomOpenAPIOperation as g, checkParamsSchema as h, toOpenAPISchema as i, isFileSchema as j, isObjectSchema as k, isAnySchema as l, filterSchemaBranches as m, applySchemaOptionality as n, expandUnionSchema as o, expandArrayableSchema as p, isPrimitiveSchema as q, resolveOpenAPIJsonSchemaRef as r, separateObjectSchema as s, toOpenAPIPath as t };

package/dist/shared/{openapi.qZLdpE0a.d.mts → openapi.CbIlrReM.d.mts}

@@ -4,8 +4,26 @@ import { AnyProcedure, AnyRouter } from '@orpc/server';
 import { Promisable } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
+interface SchemaConverterComponent {
+    allowedStrategies: SchemaConvertOptions['strategy'][];
+    schema: AnySchema;
+    required: boolean;
+    ref: string;
+}
 interface SchemaConvertOptions {
     strategy: 'input' | 'output';
+    /**
+     * Common components should use `$ref` to represent themselves if matched.
+     */
+    components?: SchemaConverterComponent[];
+    /**
+     * Minimum schema structure depth required before using `$ref` for components.
+     *
+     * For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
+     *
+     * @default 0 - No depth limit;
+     */
+    minStructureDepthForRef?: number;
 }
 interface SchemaConverter {
     convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
@@ -29,6 +47,34 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
      * @default () => false
      */
     exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
+    /**
+     * Common schemas to be used for $ref resolution.
+     */
+    commonSchemas?: Record<string, {
+        /**
+         * Determines which schema definition to use when input and output schemas differ.
+         * This is needed because some schemas transform data differently between input and output,
+         * making it impossible to use a single $ref for both cases.
+         *
+         * @example
+         * ```ts
+         * // This schema transforms a string input into a number output
+         * const Schema = z.string()
+         *   .transform(v => Number(v))
+         *   .pipe(z.number())
+         *
+         * // Input schema:  { type: 'string' }
+         * // Output schema: { type: 'number' }
+         * ```
+         *
+         * When schemas differ between input and output, you must explicitly choose
+         * which version to use for the OpenAPI specification.
+         *
+         * @default 'input' - Uses the input schema definition by default
+         */
+        strategy?: SchemaConvertOptions['strategy'];
+        schema: AnySchema;
+    }>;
 }
 /**
  * The generator that converts oRPC routers/contracts to OpenAPI specifications.
@@ -48,5 +94,5 @@ declare class OpenAPIGenerator {
     generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
 }
 
-export { OpenAPIGenerator as b, CompositeSchemaConverter as d };
-export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConvertOptions as S, OpenAPIGeneratorGenerateOptions as a, SchemaConverter as c };
+export { OpenAPIGenerator as b, CompositeSchemaConverter as e };
+export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConverterComponent as S, OpenAPIGeneratorGenerateOptions as a, SchemaConvertOptions as c, SchemaConverter as d };

package/dist/shared/{openapi.qZLdpE0a.d.ts → openapi.CbIlrReM.d.ts}

@@ -4,8 +4,26 @@ import { AnyProcedure, AnyRouter } from '@orpc/server';
 import { Promisable } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
+interface SchemaConverterComponent {
+    allowedStrategies: SchemaConvertOptions['strategy'][];
+    schema: AnySchema;
+    required: boolean;
+    ref: string;
+}
 interface SchemaConvertOptions {
     strategy: 'input' | 'output';
+    /**
+     * Common components should use `$ref` to represent themselves if matched.
+     */
+    components?: SchemaConverterComponent[];
+    /**
+     * Minimum schema structure depth required before using `$ref` for components.
+     *
+     * For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
+     *
+     * @default 0 - No depth limit;
+     */
+    minStructureDepthForRef?: number;
 }
 interface SchemaConverter {
     convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
@@ -29,6 +47,34 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
      * @default () => false
      */
     exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
+    /**
+     * Common schemas to be used for $ref resolution.
+     */
+    commonSchemas?: Record<string, {
+        /**
+         * Determines which schema definition to use when input and output schemas differ.
+         * This is needed because some schemas transform data differently between input and output,
+         * making it impossible to use a single $ref for both cases.
+         *
+         * @example
+         * ```ts
+         * // This schema transforms a string input into a number output
+         * const Schema = z.string()
+         *   .transform(v => Number(v))
+         *   .pipe(z.number())
+         *
+         * // Input schema:  { type: 'string' }
+         * // Output schema: { type: 'number' }
+         * ```
+         *
+         * When schemas differ between input and output, you must explicitly choose
+         * which version to use for the OpenAPI specification.
+         *
+         * @default 'input' - Uses the input schema definition by default
+         */
+        strategy?: SchemaConvertOptions['strategy'];
+        schema: AnySchema;
+    }>;
 }
 /**
  * The generator that converts oRPC routers/contracts to OpenAPI specifications.
@@ -48,5 +94,5 @@ declare class OpenAPIGenerator {
     generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
 }
 
-export { OpenAPIGenerator as b, CompositeSchemaConverter as d };
-export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConvertOptions as S, OpenAPIGeneratorGenerateOptions as a, SchemaConverter as c };
+export { OpenAPIGenerator as b, CompositeSchemaConverter as e };
+export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConverterComponent as S, OpenAPIGeneratorGenerateOptions as a, SchemaConvertOptions as c, SchemaConverter as d };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "1.4.5",
+  "version": "1.5.1",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -51,15 +51,15 @@
   "dependencies": {
     "json-schema-typed": "^8.0.1",
     "rou3": "^0.6.0",
-    "@orpc/client": "1.4.5",
-    "@orpc/contract": "1.4.5",
-    "@orpc/shared": "1.4.5",
-    "@orpc/openapi-client": "1.4.5",
-    "@orpc/standard-server": "1.4.5",
-    "@orpc/server": "1.4.5"
+    "@orpc/contract": "1.5.1",
+    "@orpc/client": "1.5.1",
+    "@orpc/openapi-client": "1.5.1",
+    "@orpc/shared": "1.5.1",
+    "@orpc/standard-server": "1.5.1",
+    "@orpc/server": "1.5.1"
   },
   "devDependencies": {
-    "zod": "^3.25.49"
+    "zod": "^3.25.63"
   },
   "scripts": {
     "build": "unbuild",