@orpc/openapi 0.0.0-next.4534675 → 0.0.0-next.460b50b

package/dist/shared/{openapi.DFXD6scT.mjs → openapi.C_UtQ8Us.mjs}

@@ -1,10 +1,13 @@
+import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
+import { StandardHandler } from '@orpc/server/standard';
+import { isORPCErrorStatus } from '@orpc/client';
 import { fallbackContractConfig } from '@orpc/contract';
-import { isObject } from '@orpc/shared';
-import { eachContractProcedure, convertPathToHttpPath, isProcedure, getLazyRouterPrefix, unlazy, getRouterChild, createContractedProcedure } from '@orpc/server';
+import { isObject, stringifyJSON } from '@orpc/shared';
+import { toHttpPath } from '@orpc/client/standard';
+import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
 import { createRouter, addRoute, findRoute } from 'rou3';
-import { s as standardizeHTTPPath } from './openapi.DZzpQAb-.mjs';
 
-class OpenAPICodec {
+class StandardOpenAPICodec {
   constructor(serializer) {
     this.serializer = serializer;
   }
@@ -50,13 +53,21 @@ class OpenAPICodec {
         body: this.serializer.serialize(output)
       };
     }
-    if (!isObject(output)) {
-      throw new Error(
-        'Invalid output structure for "detailed" output. Expected format: { body: any, headers?: Record<string, string | string[] | undefined> }'
-      );
+    if (!this.#isDetailedOutput(output)) {
+      throw new Error(`
+        Invalid "detailed" output structure:
+        \u2022 Expected an object with optional properties:
+          - status (number 200-399)
+          - headers (Record<string, string | string[]>)
+          - body (any)
+        \u2022 No extra keys allowed.
+
+        Actual value:
+          ${stringifyJSON(output)}
+      `);
     }
     return {
-      status: successStatus,
+      status: output.status ?? successStatus,
       headers: output.headers ?? {},
       body: this.serializer.serialize(output.body)
     };
@@ -65,9 +76,21 @@ class OpenAPICodec {
     return {
       status: error.status,
       headers: {},
-      body: this.serializer.serialize(error.toJSON())
+      body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
     };
   }
+  #isDetailedOutput(output) {
+    if (!isObject(output)) {
+      return false;
+    }
+    if (output.headers && !isObject(output.headers)) {
+      return false;
+    }
+    if (output.status !== void 0 && (typeof output.status !== "number" || !Number.isInteger(output.status) || isORPCErrorStatus(output.status))) {
+      return false;
+    }
+    return true;
+  }
 }
 
 function toRou3Pattern(path) {
@@ -77,16 +100,13 @@ function decodeParams(params) {
   return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
 }
 
-class OpenAPIMatcher {
+class StandardOpenAPIMatcher {
   tree = createRouter();
   pendingRouters = [];
   init(router, path = []) {
-    const laziedOptions = eachContractProcedure({
-      router,
-      path
-    }, ({ path: path2, contract }) => {
+    const laziedOptions = traverseContractProcedures({ router, path }, ({ path: path2, contract }) => {
       const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
-      const httpPath = contract["~orpc"].route.path ? toRou3Pattern(contract["~orpc"].route.path) : convertPathToHttpPath(path2);
+      const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
       if (isProcedure(contract)) {
         addRoute(this.tree, method, httpPath, {
           path: path2,
@@ -106,8 +126,8 @@ class OpenAPIMatcher {
     });
     this.pendingRouters.push(...laziedOptions.map((option) => ({
       ...option,
-      httpPathPrefix: convertPathToHttpPath(option.path),
-      laziedPrefix: getLazyRouterPrefix(option.lazied)
+      httpPathPrefix: toHttpPath(option.path),
+      laziedPrefix: getLazyMeta(option.router).prefix
     })));
   }
   async match(method, pathname) {
@@ -115,7 +135,7 @@ class OpenAPIMatcher {
       const newPendingRouters = [];
       for (const pendingRouter of this.pendingRouters) {
         if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
-          const { default: router } = await unlazy(pendingRouter.lazied);
+          const { default: router } = await unlazy(pendingRouter.router);
           this.init(router, pendingRouter.path);
         } else {
           newPendingRouters.push(pendingRouter);
@@ -128,14 +148,14 @@ class OpenAPIMatcher {
       return void 0;
     }
     if (!match.data.procedure) {
-      const { default: maybeProcedure } = await unlazy(getRouterChild(match.data.router, ...match.data.path));
+      const { default: maybeProcedure } = await unlazy(getRouter(match.data.router, match.data.path));
       if (!isProcedure(maybeProcedure)) {
         throw new Error(`
-          [Contract-First] Missing or invalid implementation for procedure at path: ${convertPathToHttpPath(match.data.path)}.
+          [Contract-First] Missing or invalid implementation for procedure at path: ${toHttpPath(match.data.path)}.
           Ensure that the procedure is correctly defined and matches the expected contract.
         `);
       }
-      match.data.procedure = createContractedProcedure(match.data.contract, maybeProcedure);
+      match.data.procedure = createContractedProcedure(maybeProcedure, match.data.contract);
     }
     return {
       path: match.data.path,
@@ -145,4 +165,15 @@ class OpenAPIMatcher {
   }
 }
 
-export { OpenAPICodec as O, OpenAPIMatcher as a, decodeParams as d, toRou3Pattern as t };
+class StandardOpenAPIHandler extends StandardHandler {
+  constructor(router, options) {
+    const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
+    const bracketNotationSerializer = new StandardBracketNotationSerializer();
+    const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
+    const matcher = new StandardOpenAPIMatcher();
+    const codec = new StandardOpenAPICodec(serializer);
+    super(router, matcher, codec, options);
+  }
+}
+
+export { StandardOpenAPICodec as S, StandardOpenAPIHandler as a, StandardOpenAPIMatcher as b, decodeParams as d, toRou3Pattern as t };

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

@@ -0,0 +1,98 @@
+import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+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]>;
+}
+interface ConditionalSchemaConverter extends SchemaConverter {
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
+}
+declare class CompositeSchemaConverter implements SchemaConverter {
+    private readonly converters;
+    constructor(converters: 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.
+     *
+     * @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.
+ *
+ * @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 };

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

@@ -0,0 +1,98 @@
+import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+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]>;
+}
+interface ConditionalSchemaConverter extends SchemaConverter {
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
+}
+declare class CompositeSchemaConverter implements SchemaConverter {
+    private readonly converters;
+    constructor(converters: 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.
+     *
+     * @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.
+ *
+ * @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 };

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

@@ -0,0 +1,12 @@
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+import { Context, Router } from '@orpc/server';
+import { StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
+
+interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
+}
+declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
+    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
+}
+
+export { StandardOpenAPIHandler as a };
+export type { StandardOpenAPIHandlerOptions as S };

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

@@ -0,0 +1,12 @@
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+import { Context, Router } from '@orpc/server';
+import { StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
+
+interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
+}
+declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
+    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
+}
+
+export { StandardOpenAPIHandler as a };
+export type { StandardOpenAPIHandlerOptions as S };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "0.0.0-next.4534675",
+  "version": "0.0.0-next.460b50b",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -19,6 +19,11 @@
       "import": "./dist/index.mjs",
       "default": "./dist/index.mjs"
     },
+    "./plugins": {
+      "types": "./dist/plugins/index.d.mts",
+      "import": "./dist/plugins/index.mjs",
+      "default": "./dist/plugins/index.mjs"
+    },
     "./standard": {
       "types": "./dist/adapters/standard/index.d.mts",
       "import": "./dist/adapters/standard/index.mjs",
@@ -29,20 +34,15 @@
       "import": "./dist/adapters/fetch/index.mjs",
       "default": "./dist/adapters/fetch/index.mjs"
     },
-    "./hono": {
-      "types": "./dist/adapters/hono/index.d.mts",
-      "import": "./dist/adapters/hono/index.mjs",
-      "default": "./dist/adapters/hono/index.mjs"
-    },
-    "./next": {
-      "types": "./dist/adapters/next/index.d.mts",
-      "import": "./dist/adapters/next/index.mjs",
-      "default": "./dist/adapters/next/index.mjs"
-    },
     "./node": {
       "types": "./dist/adapters/node/index.d.mts",
       "import": "./dist/adapters/node/index.mjs",
       "default": "./dist/adapters/node/index.mjs"
+    },
+    "./aws-lambda": {
+      "types": "./dist/adapters/aws-lambda/index.d.mts",
+      "import": "./dist/adapters/aws-lambda/index.mjs",
+      "default": "./dist/adapters/aws-lambda/index.mjs"
     }
   },
   "files": [
@@ -50,19 +50,16 @@
   ],
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "openapi-types": "^12.1.3",
-    "rou3": "^0.5.1",
-    "@orpc/client": "0.0.0-next.4534675",
-    "@orpc/contract": "0.0.0-next.4534675",
-    "@orpc/openapi-client": "0.0.0-next.4534675",
-    "@orpc/standard-server": "0.0.0-next.4534675",
-    "@orpc/server": "0.0.0-next.4534675",
-    "@orpc/shared": "0.0.0-next.4534675",
-    "@orpc/standard-server-node": "0.0.0-next.4534675",
-    "@orpc/standard-server-fetch": "0.0.0-next.4534675"
+    "rou3": "^0.6.0",
+    "@orpc/client": "0.0.0-next.460b50b",
+    "@orpc/openapi-client": "0.0.0-next.460b50b",
+    "@orpc/contract": "0.0.0-next.460b50b",
+    "@orpc/server": "0.0.0-next.460b50b",
+    "@orpc/shared": "0.0.0-next.460b50b",
+    "@orpc/standard-server": "0.0.0-next.460b50b"
   },
   "devDependencies": {
-    "zod": "^3.24.2"
+    "zod": "^3.25.63"
   },
   "scripts": {
     "build": "unbuild",

package/dist/adapters/hono/index.d.mts

@@ -1,6 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.mjs';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';

package/dist/adapters/hono/index.d.ts

@@ -1,6 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.js';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';

package/dist/adapters/hono/index.mjs

@@ -1,11 +0,0 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
-import '@orpc/openapi-client/standard';
-import '@orpc/server/standard';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.DFXD6scT.mjs';
-import '@orpc/contract';
-import '@orpc/shared';
-import '@orpc/server';
-import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
-import 'json-schema-typed/draft-2020-12';

package/dist/adapters/next/index.d.mts

@@ -1,6 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.mjs';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';

package/dist/adapters/next/index.d.ts

@@ -1,6 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.js';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';

package/dist/adapters/next/index.mjs

@@ -1,11 +0,0 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
-import '@orpc/openapi-client/standard';
-import '@orpc/server/standard';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.DFXD6scT.mjs';
-import '@orpc/contract';
-import '@orpc/shared';
-import '@orpc/server';
-import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
-import 'json-schema-typed/draft-2020-12';

package/dist/shared/openapi.C015V43J.mjs

@@ -1,31 +0,0 @@
-import { OpenAPISerializer } from '@orpc/openapi-client/standard';
-import { StandardHandler } from '@orpc/server/standard';
-import { toStandardLazyRequest, toFetchResponse } from '@orpc/standard-server-fetch';
-import { a as OpenAPIMatcher, O as OpenAPICodec } from './openapi.DFXD6scT.mjs';
-import '@orpc/shared';
-import 'json-schema-typed/draft-2020-12';
-
-class OpenAPIHandler {
-  standardHandler;
-  constructor(router, options = {}) {
-    const serializer = new OpenAPISerializer();
-    const matcher = new OpenAPIMatcher();
-    const codec = new OpenAPICodec(serializer);
-    this.standardHandler = new StandardHandler(router, matcher, codec, options);
-  }
-  async handle(request, ...[
-    options = {}
-  ]) {
-    const standardRequest = toStandardLazyRequest(request);
-    const result = await this.standardHandler.handle(standardRequest, options);
-    if (!result.matched) {
-      return result;
-    }
-    return {
-      matched: true,
-      response: toFetchResponse(result.response, options)
-    };
-  }
-}
-
-export { OpenAPIHandler as O };