@orpc/openapi 0.0.0-next.f99e554 → 0.0.0-next.f9e5dec

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

@@ -0,0 +1,54 @@
+import { StandardOpenAPISerializer, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
+import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter, Context, Router } from '@orpc/server';
+import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult, StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
+import { ORPCError, HTTPPath } from '@orpc/client';
+import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
+import { Value } from '@orpc/shared';
+
+interface StandardOpenAPICodecOptions {
+    /**
+     * Customize how an ORPC error is encoded into a response body.
+     * Use this if your API needs a different error output structure.
+     *
+     * @remarks
+     * - Return `null | undefined` to fallback to default behavior
+     *
+     * @default ((e) => e.toJSON())
+     */
+    customErrorResponseBodyEncoder?: (error: ORPCError<any, any>) => unknown;
+}
+declare class StandardOpenAPICodec implements StandardCodec {
+    #private;
+    private readonly serializer;
+    private readonly customErrorResponseBodyEncoder;
+    constructor(serializer: StandardOpenAPISerializer, options?: StandardOpenAPICodecOptions);
+    decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
+    encode(output: unknown, procedure: AnyProcedure): StandardResponse;
+    encodeError(error: ORPCError<any, any>): StandardResponse;
+}
+
+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, StandardOpenAPICodecOptions {
+}
+declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
+    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
+}
+
+export { StandardOpenAPICodec as a, StandardOpenAPIHandler as c, StandardOpenAPIMatcher as e };
+export type { StandardOpenAPICodecOptions as S, StandardOpenAPIHandlerOptions as b, StandardOpenAPIMatcherOptions as d };

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

@@ -0,0 +1,54 @@
+import { StandardOpenAPISerializer, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
+import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter, Context, Router } from '@orpc/server';
+import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult, StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
+import { ORPCError, HTTPPath } from '@orpc/client';
+import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
+import { Value } from '@orpc/shared';
+
+interface StandardOpenAPICodecOptions {
+    /**
+     * Customize how an ORPC error is encoded into a response body.
+     * Use this if your API needs a different error output structure.
+     *
+     * @remarks
+     * - Return `null | undefined` to fallback to default behavior
+     *
+     * @default ((e) => e.toJSON())
+     */
+    customErrorResponseBodyEncoder?: (error: ORPCError<any, any>) => unknown;
+}
+declare class StandardOpenAPICodec implements StandardCodec {
+    #private;
+    private readonly serializer;
+    private readonly customErrorResponseBodyEncoder;
+    constructor(serializer: StandardOpenAPISerializer, options?: StandardOpenAPICodecOptions);
+    decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
+    encode(output: unknown, procedure: AnyProcedure): StandardResponse;
+    encodeError(error: ORPCError<any, any>): StandardResponse;
+}
+
+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, StandardOpenAPICodecOptions {
+}
+declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
+    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
+}
+
+export { StandardOpenAPICodec as a, StandardOpenAPIHandler as c, StandardOpenAPIMatcher as e };
+export type { StandardOpenAPICodecOptions as S, StandardOpenAPIHandlerOptions as b, StandardOpenAPIMatcherOptions as d };

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

@@ -0,0 +1,120 @@
+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;
+    }>;
+    /**
+     * Define a custom JSON schema for the error response body when using
+     * type-safe errors. Helps align ORPC error formatting with existing API
+     * response standards or conventions.
+     *
+     * @remarks
+     * - Return `null | undefined` to use the default error response body shaper.
+     */
+    customErrorResponseBodySchema?: Value<JSONSchema | undefined | null, [
+        definedErrors: [code: string, defaultMessage: string, dataRequired: boolean, dataSchema: JSONSchema][],
+        status: number
+    ]>;
+}
+/**
+ * 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, { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }?: 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.dbQeFCUJ.d.ts

@@ -0,0 +1,120 @@
+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;
+    }>;
+    /**
+     * Define a custom JSON schema for the error response body when using
+     * type-safe errors. Helps align ORPC error formatting with existing API
+     * response standards or conventions.
+     *
+     * @remarks
+     * - Return `null | undefined` to use the default error response body shaper.
+     */
+    customErrorResponseBodySchema?: Value<JSONSchema | undefined | null, [
+        definedErrors: [code: string, defaultMessage: string, dataRequired: boolean, dataSchema: JSONSchema][],
+        status: number
+    ]>;
+}
+/**
+ * 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, { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }?: 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "0.0.0-next.f99e554",
+  "version": "0.0.0-next.f9e5dec",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -15,50 +15,61 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/src/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
+      "types": "./dist/index.d.mts",
+      "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",
+      "default": "./dist/adapters/standard/index.mjs"
     },
     "./fetch": {
-      "types": "./dist/src/adapters/fetch/index.d.ts",
-      "import": "./dist/fetch.js",
-      "default": "./dist/fetch.js"
+      "types": "./dist/adapters/fetch/index.d.mts",
+      "import": "./dist/adapters/fetch/index.mjs",
+      "default": "./dist/adapters/fetch/index.mjs"
     },
     "./node": {
-      "types": "./dist/src/adapters/node/index.d.ts",
-      "import": "./dist/node.js",
-      "default": "./dist/node.js"
+      "types": "./dist/adapters/node/index.d.mts",
+      "import": "./dist/adapters/node/index.mjs",
+      "default": "./dist/adapters/node/index.mjs"
+    },
+    "./fastify": {
+      "types": "./dist/adapters/fastify/index.d.mts",
+      "import": "./dist/adapters/fastify/index.mjs",
+      "default": "./dist/adapters/fastify/index.mjs"
     },
-    "./🔒/*": {
-      "types": "./dist/src/*.d.ts"
+    "./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": [
-    "!**/*.map",
-    "!**/*.tsbuildinfo",
     "dist"
   ],
   "dependencies": {
-    "@mjackson/node-fetch-server": "^0.5.0",
-    "@standard-schema/spec": "1.0.0-beta.4",
-    "@types/content-disposition": "^0.5.8",
-    "content-disposition": "^0.5.4",
-    "escape-string-regexp": "^5.0.0",
-    "fast-content-type-parse": "^2.0.0",
-    "hono": "^4.6.12",
-    "json-schema-typed": "^8.0.1",
-    "openapi3-ts": "^4.4.0",
-    "wildcard-match": "^5.1.3",
-    "@orpc/contract": "0.0.0-next.f99e554",
-    "@orpc/shared": "0.0.0-next.f99e554",
-    "@orpc/server": "0.0.0-next.f99e554"
+    "json-schema-typed": "^8.0.2",
+    "rou3": "^0.7.10",
+    "@orpc/contract": "0.0.0-next.f9e5dec",
+    "@orpc/client": "0.0.0-next.f9e5dec",
+    "@orpc/interop": "0.0.0-next.f9e5dec",
+    "@orpc/openapi-client": "0.0.0-next.f9e5dec",
+    "@orpc/server": "0.0.0-next.f9e5dec",
+    "@orpc/shared": "0.0.0-next.f9e5dec",
+    "@orpc/standard-server": "0.0.0-next.f9e5dec"
   },
   "devDependencies": {
-    "@readme/openapi-parser": "^2.6.0",
-    "zod": "^3.24.1"
+    "fastify": "^5.6.2",
+    "zod": "^4.1.12"
   },
   "scripts": {
-    "build": "tsup --clean --sourcemap --entry.index=src/index.ts --entry.fetch=src/adapters/fetch/index.ts --entry.node=src/adapters/node/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
+    "build": "unbuild",
     "build:watch": "pnpm run build --watch",
     "type:check": "tsc -b"
   }

package/dist/chunk-KNYXLM77.js

@@ -1,107 +0,0 @@
-// src/json-serializer.ts
-import { isPlainObject } from "@orpc/shared";
-var JSONSerializer = class {
-  serialize(payload) {
-    if (payload instanceof Set)
-      return this.serialize([...payload]);
-    if (payload instanceof Map)
-      return this.serialize([...payload.entries()]);
-    if (Array.isArray(payload)) {
-      return payload.map((v) => v === void 0 ? "undefined" : this.serialize(v));
-    }
-    if (Number.isNaN(payload))
-      return "NaN";
-    if (typeof payload === "bigint")
-      return payload.toString();
-    if (payload instanceof Date && Number.isNaN(payload.getTime())) {
-      return "Invalid Date";
-    }
-    if (payload instanceof RegExp)
-      return payload.toString();
-    if (payload instanceof URL)
-      return payload.toString();
-    if (!isPlainObject(payload))
-      return payload;
-    return Object.keys(payload).reduce(
-      (carry, key) => {
-        const val = payload[key];
-        carry[key] = this.serialize(val);
-        return carry;
-      },
-      {}
-    );
-  }
-};
-
-// src/utils.ts
-import { isContractProcedure } from "@orpc/contract";
-import { getRouterContract, isLazy, isProcedure, unlazy } from "@orpc/server";
-function forEachContractProcedure(options, callback, result = [], isCurrentRouterContract = false) {
-  const hiddenContract = getRouterContract(options.router);
-  if (!isCurrentRouterContract && hiddenContract) {
-    return forEachContractProcedure(
-      {
-        path: options.path,
-        router: hiddenContract
-      },
-      callback,
-      result,
-      true
-    );
-  }
-  if (isLazy(options.router)) {
-    result.push({
-      router: options.router,
-      path: options.path
-    });
-  } else if (isProcedure(options.router)) {
-    callback({
-      contract: options.router["~orpc"].contract,
-      path: options.path
-    });
-  } else if (isContractProcedure(options.router)) {
-    callback({
-      contract: options.router,
-      path: options.path
-    });
-  } else {
-    for (const key in options.router) {
-      forEachContractProcedure(
-        {
-          router: options.router[key],
-          path: [...options.path, key]
-        },
-        callback,
-        result
-      );
-    }
-  }
-  return result;
-}
-async function forEachAllContractProcedure(router, callback) {
-  const pending = [{
-    path: [],
-    router
-  }];
-  for (const item of pending) {
-    const lazies = forEachContractProcedure(item, callback);
-    for (const lazy of lazies) {
-      const { default: router2 } = await unlazy(lazy.router);
-      pending.push({
-        path: lazy.path,
-        router: router2
-      });
-    }
-  }
-}
-function standardizeHTTPPath(path) {
-  return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
-}
-
-export {
-  JSONSerializer,
-  forEachContractProcedure,
-  forEachAllContractProcedure,
-  standardizeHTTPPath
-};
-//# sourceMappingURL=chunk-KNYXLM77.js.map