@orpc/openapi 0.0.0-next.fd6982a → 0.0.0-next.fe5c63f

package/dist/shared/{openapi.PDTdnRIU.mjs → openapi.BtoY8ZFF.mjs}

@@ -3,8 +3,8 @@ import { toHttpPath } from '@orpc/client/standard';
 import { fallbackContractConfig, getEventIteratorSchemaDetails } from '@orpc/contract';
 import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, getDynamicParams } from '@orpc/openapi-client/standard';
 import { isProcedure, resolveContractProcedures } from '@orpc/server';
-import { isObject, findDeepMatches, toArray, clone, stringifyJSON } from '@orpc/shared';
-import 'json-schema-typed/draft-2020-12';
+import { isObject, stringifyJSON, findDeepMatches, toArray, clone, value } from '@orpc/shared';
+import { TypeName } from 'json-schema-typed/draft-2020-12';
 
 const OPERATION_EXTENDER_SYMBOL = Symbol("ORPC_OPERATION_EXTENDER");
 function customOpenAPIOperation(o, extend) {
@@ -196,6 +196,45 @@ function expandUnionSchema(schema) {
   }
   return [schema];
 }
+function expandArrayableSchema(schema) {
+  const schemas = expandUnionSchema(schema);
+  if (schemas.length !== 2) {
+    return void 0;
+  }
+  const arraySchema = schemas.find(
+    (s) => typeof s === "object" && s.type === "array" && Object.keys(s).filter((k) => LOGIC_KEYWORDS.includes(k)).every((k) => k === "type" || k === "items")
+  );
+  if (arraySchema === void 0) {
+    return void 0;
+  }
+  const items1 = arraySchema.items;
+  const items2 = schemas.find((s) => s !== arraySchema);
+  if (stringifyJSON(items1) !== stringifyJSON(items2)) {
+    return void 0;
+  }
+  return [items2, arraySchema];
+}
+const PRIMITIVE_SCHEMA_TYPES = /* @__PURE__ */ new Set([
+  TypeName.String,
+  TypeName.Number,
+  TypeName.Integer,
+  TypeName.Boolean,
+  TypeName.Null
+]);
+function isPrimitiveSchema(schema) {
+  return expandUnionSchema(schema).every((s) => {
+    if (typeof s === "boolean") {
+      return false;
+    }
+    if (typeof s.type === "string" && PRIMITIVE_SCHEMA_TYPES.has(s.type)) {
+      return true;
+    }
+    if (s.const !== void 0) {
+      return true;
+    }
+    return false;
+  });
+}
 
 function toOpenAPIPath(path) {
   return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/{$1}");
@@ -268,13 +307,26 @@ function toOpenAPIParameters(schema, parameterIn) {
   const parameters = [];
   for (const key in schema.properties) {
     const keySchema = schema.properties[key];
+    let isDeepObjectStyle = true;
+    if (parameterIn !== "query") {
+      isDeepObjectStyle = false;
+    } else if (isPrimitiveSchema(keySchema)) {
+      isDeepObjectStyle = false;
+    } else {
+      const [item] = expandArrayableSchema(keySchema) ?? [];
+      if (item !== void 0 && isPrimitiveSchema(item)) {
+        isDeepObjectStyle = false;
+      }
+    }
     parameters.push({
       name: key,
       in: parameterIn,
       required: schema.required?.includes(key),
-      style: parameterIn === "query" ? "deepObject" : void 0,
-      explode: parameterIn === "query" ? true : void 0,
-      schema: toOpenAPISchema(keySchema)
+      schema: toOpenAPISchema(keySchema),
+      style: isDeepObjectStyle ? "deepObject" : void 0,
+      explode: isDeepObjectStyle ? true : void 0,
+      allowEmptyValue: parameterIn === "query" ? true : void 0,
+      allowReserved: parameterIn === "query" ? true : void 0
     });
   }
   return parameters;
@@ -293,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;
@@ -324,18 +385,24 @@ class OpenAPIGenerator {
    * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
    */
   async generate(router, options = {}) {
-    const exclude = options.exclude ?? (() => false);
+    const filter = options.filter ?? (({ contract, path }) => {
+      return !(options.exclude?.(contract, path) ?? false);
+    });
     const doc = {
       ...clone(options),
       info: options.info ?? { title: "API Reference", version: "0.0.0" },
       openapi: "3.1.1",
-      exclude: void 0
+      exclude: void 0,
+      filter: void 0,
+      commonSchemas: void 0
     };
+    const { baseSchemaConvertOptions, undefinedErrorJsonSchema } = await this.#resolveCommonSchemas(doc, options.commonSchemas);
     const contracts = [];
-    await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
-      if (!exclude(contract, path)) {
-        contracts.push({ contract, path });
+    await resolveContractProcedures({ path: [], router }, (traverseOptions) => {
+      if (!value(filter, traverseOptions)) {
+        return;
       }
+      contracts.push(traverseOptions);
     });
     const errors = [];
     for (const { contract, path } of contracts) {
@@ -344,16 +411,21 @@ class OpenAPIGenerator {
         const def = contract["~orpc"];
         const method = toOpenAPIMethod(fallbackContractConfig("defaultMethod", def.route.method));
         const httpPath = toOpenAPIPath(def.route.path ?? toHttpPath(path));
-        const operationObjectRef = {
-          operationId,
-          summary: def.route.summary,
-          description: def.route.description,
-          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);
+        let operationObjectRef;
+        if (def.route.spec !== void 0) {
+          operationObjectRef = def.route.spec;
+        } else {
+          operationObjectRef = {
+            operationId,
+            summary: def.route.summary,
+            description: def.route.description,
+            deprecated: def.route.deprecated,
+            tags: def.route.tags?.map((tag) => tag)
+          };
+          await this.#request(doc, operationObjectRef, def, baseSchemaConvertOptions);
+          await this.#successResponse(doc, operationObjectRef, def, baseSchemaConvertOptions);
+          await this.#errorResponse(operationObjectRef, def, baseSchemaConvertOptions, undefinedErrorJsonSchema);
+        }
         doc.paths ??= {};
         doc.paths[httpPath] ??= {};
         doc.paths[httpPath][method] = applyCustomOpenAPIOperation(operationObjectRef, contract);
@@ -376,22 +448,96 @@ ${errors.join("\n\n")}`
     }
     return this.serializer.serialize(doc)[0];
   }
-  async #request(ref, def) {
+  async #resolveCommonSchemas(doc, commonSchemas) {
+    let undefinedErrorJsonSchema = {
+      type: "object",
+      properties: {
+        defined: { const: false },
+        code: { type: "string" },
+        status: { type: "number" },
+        message: { type: "string" },
+        data: {}
+      },
+      required: ["defined", "code", "status", "message"]
+    };
+    const baseSchemaConvertOptions = {};
+    if (commonSchemas) {
+      baseSchemaConvertOptions.components = [];
+      for (const key in commonSchemas) {
+        const options = commonSchemas[key];
+        if (options.schema === void 0) {
+          continue;
+        }
+        const { schema, strategy = "input" } = options;
+        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");
+          }
+        }
+        baseSchemaConvertOptions.components.push({
+          schema,
+          required,
+          ref: `#/components/schemas/${key}`,
+          allowedStrategies
+        });
+      }
+      doc.components ??= {};
+      doc.components.schemas ??= {};
+      for (const key in commonSchemas) {
+        const options = commonSchemas[key];
+        if (options.schema === void 0) {
+          if (options.error === "UndefinedError") {
+            doc.components.schemas[key] = toOpenAPISchema(undefinedErrorJsonSchema);
+            undefinedErrorJsonSchema = { $ref: `#/components/schemas/${key}` };
+          }
+          continue;
+        }
+        const { schema, strategy = "input" } = options;
+        const [, json] = await this.converter.convert(
+          schema,
+          {
+            ...baseSchemaConvertOptions,
+            strategy,
+            minStructureDepthForRef: 1
+            // not allow use $ref for root schemas
+          }
+        );
+        doc.components.schemas[key] = toOpenAPISchema(json);
+      }
+    }
+    return { baseSchemaConvertOptions, undefinedErrorJsonSchema };
+  }
+  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;
     }
@@ -434,7 +580,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.'
       );
@@ -442,12 +589,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) {
@@ -457,7 +605,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);
@@ -468,13 +616,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] = {
@@ -501,11 +656,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;
@@ -521,16 +677,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)
             };
           }
         }
@@ -542,7 +699,7 @@ ${errors.join("\n\n")}`
       }
     }
   }
-  async #errorResponse(ref, def) {
+  async #errorResponse(ref, def, baseSchemaConvertOptions, undefinedErrorSchema) {
     const errorMap = def.errorMap;
     const errors = {};
     for (const code in errorMap) {
@@ -552,7 +709,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",
@@ -574,17 +731,7 @@ ${errors.join("\n\n")}`
         content: toOpenAPIContent({
           oneOf: [
             ...schemas,
-            {
-              type: "object",
-              properties: {
-                defined: { const: false },
-                code: { type: "string" },
-                status: { type: "number" },
-                message: { type: "string" },
-                data: {}
-              },
-              required: ["defined", "code", "status", "message"]
-            }
+            undefinedErrorSchema
           ]
         })
       };
@@ -592,4 +739,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, 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.CQmjvnb0.d.mts

@@ -0,0 +1,31 @@
+import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
+import { TraverseContractProcedureCallbackOptions, AnyRouter, Context, Router } from '@orpc/server';
+import { StandardMatcher, StandardMatchResult, StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
+import { HTTPPath } from '@orpc/client';
+import { Value } from '@orpc/shared';
+
+interface StandardOpenAPIMatcherOptions {
+    /**
+     * Filter procedures. Return `false` to exclude a procedure from matching.
+     *
+     * @default true
+     */
+    filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
+}
+declare class StandardOpenAPIMatcher implements StandardMatcher {
+    private readonly filter;
+    private readonly tree;
+    private pendingRouters;
+    constructor(options?: StandardOpenAPIMatcherOptions);
+    init(router: AnyRouter, path?: readonly string[]): void;
+    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
+}
+
+interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPIMatcherOptions {
+}
+declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
+    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
+}
+
+export { StandardOpenAPIHandler as a, StandardOpenAPIMatcher as c };
+export type { StandardOpenAPIHandlerOptions as S, StandardOpenAPIMatcherOptions as b };

package/dist/shared/openapi.CQmjvnb0.d.ts

@@ -0,0 +1,31 @@
+import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
+import { TraverseContractProcedureCallbackOptions, AnyRouter, Context, Router } from '@orpc/server';
+import { StandardMatcher, StandardMatchResult, StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
+import { HTTPPath } from '@orpc/client';
+import { Value } from '@orpc/shared';
+
+interface StandardOpenAPIMatcherOptions {
+    /**
+     * Filter procedures. Return `false` to exclude a procedure from matching.
+     *
+     * @default true
+     */
+    filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
+}
+declare class StandardOpenAPIMatcher implements StandardMatcher {
+    private readonly filter;
+    private readonly tree;
+    private pendingRouters;
+    constructor(options?: StandardOpenAPIMatcherOptions);
+    init(router: AnyRouter, path?: readonly string[]): void;
+    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
+}
+
+interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPIMatcherOptions {
+}
+declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
+    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
+}
+
+export { StandardOpenAPIHandler as a, StandardOpenAPIMatcher as c };
+export type { StandardOpenAPIHandlerOptions as S, StandardOpenAPIMatcherOptions as b };

package/dist/shared/openapi.DPAN3GVs.d.mts

@@ -0,0 +1,108 @@
+import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
+import { Promisable, Value } from '@orpc/shared';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+
+interface SchemaConverterComponent {
+    allowedStrategies: readonly SchemaConvertOptions['strategy'][];
+    schema: AnySchema;
+    required: boolean;
+    ref: string;
+}
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
+    /**
+     * Common components should use `$ref` to represent themselves if matched.
+     */
+    components?: readonly 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]>;
+}
+interface ConditionalSchemaConverter extends SchemaConverter {
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
+}
+declare class CompositeSchemaConverter implements SchemaConverter {
+    private readonly converters;
+    constructor(converters: readonly ConditionalSchemaConverter[]);
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
+}
+
+interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
+    schemaConverters?: ConditionalSchemaConverter[];
+}
+interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document, 'openapi'>> {
+    /**
+     * Exclude procedures from the OpenAPI specification.
+     *
+     * @deprecated Use `filter` option instead.
+     * @default () => false
+     */
+    exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
+    /**
+     * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
+     *
+     * @default true
+     */
+    filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
+    /**
+     * 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;
+    } | {
+        error: 'UndefinedError';
+        schema?: never;
+    }>;
+}
+/**
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+ */
+declare class OpenAPIGenerator {
+    #private;
+    private readonly serializer;
+    private readonly converter;
+    constructor(options?: OpenAPIGeneratorOptions);
+    /**
+     * Generates OpenAPI specifications from oRPC routers/contracts.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+     */
+    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
+}
+
+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 };