@orpc/openapi 0.0.0-next.f710cd7 → 0.0.0-next.f724c58

package/dist/shared/{openapi.p5tsmBXx.mjs → openapi.DIt-Z9W1.mjs}

@@ -1,15 +1,18 @@
 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 { isObject, stringifyJSON, tryDecodeURIComponent, value } 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';
 
 class StandardOpenAPICodec {
-  constructor(serializer) {
+  constructor(serializer, options = {}) {
     this.serializer = serializer;
+    this.customErrorResponseBodyEncoder = options.customErrorResponseBodyEncoder;
   }
+  customErrorResponseBodyEncoder;
   async decode(request, params, procedure) {
     const inputStructure = fallbackContractConfig("defaultInputStructure", procedure["~orpc"].route.inputStructure);
     if (inputStructure === "compact") {
@@ -52,38 +55,67 @@ class StandardOpenAPICodec {
         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)
     };
   }
   encodeError(error) {
+    const body = this.customErrorResponseBodyEncoder?.(error) ?? error.toJSON();
     return {
       status: error.status,
       headers: {},
-      body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
+      body: this.serializer.serialize(body, { 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) {
   return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/**:$1").replace(/\/\{([^}]+)\}/g, "/:$1");
 }
 function decodeParams(params) {
-  return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
+  return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, tryDecodeURIComponent(value)]));
 }
 
 class StandardOpenAPIMatcher {
+  filter;
   tree = createRouter();
   pendingRouters = [];
+  constructor(options = {}) {
+    this.filter = options.filter ?? true;
+  }
   init(router, path = []) {
-    const laziedOptions = traverseContractProcedures({ router, path }, ({ path: path2, contract }) => {
+    const laziedOptions = traverseContractProcedures({ router, path }, (traverseOptions) => {
+      if (!value(this.filter, traverseOptions)) {
+        return;
+      }
+      const { path: path2, contract } = traverseOptions;
       const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
       const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
       if (isProcedure(contract)) {
@@ -147,10 +179,10 @@ class StandardOpenAPIMatcher {
 class StandardOpenAPIHandler extends StandardHandler {
   constructor(router, options) {
     const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
-    const bracketNotationSerializer = new StandardBracketNotationSerializer();
+    const bracketNotationSerializer = new StandardBracketNotationSerializer(options);
     const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
-    const matcher = new StandardOpenAPIMatcher();
-    const codec = new StandardOpenAPICodec(serializer);
+    const matcher = new StandardOpenAPIMatcher(options);
+    const codec = new StandardOpenAPICodec(serializer, options);
     super(router, matcher, codec, options);
   }
 }

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/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "0.0.0-next.f710cd7",
+  "version": "0.0.0-next.f724c58",
   "license": "MIT",
-  "homepage": "https://orpc.unnoq.com",
+  "homepage": "https://orpc.dev",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/unnoq/orpc.git",
@@ -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",
@@ -33,24 +38,35 @@
       "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"
+    },
+    "./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": [
     "dist"
   ],
   "dependencies": {
-    "json-schema-typed": "^8.0.1",
-    "openapi-types": "^12.1.3",
-    "rou3": "^0.6.0",
-    "@orpc/client": "0.0.0-next.f710cd7",
-    "@orpc/contract": "0.0.0-next.f710cd7",
-    "@orpc/openapi-client": "0.0.0-next.f710cd7",
-    "@orpc/server": "0.0.0-next.f710cd7",
-    "@orpc/shared": "0.0.0-next.f710cd7",
-    "@orpc/standard-server": "0.0.0-next.f710cd7"
+    "json-schema-typed": "^8.0.2",
+    "rou3": "^0.7.10",
+    "@orpc/client": "0.0.0-next.f724c58",
+    "@orpc/contract": "0.0.0-next.f724c58",
+    "@orpc/openapi-client": "0.0.0-next.f724c58",
+    "@orpc/interop": "0.0.0-next.f724c58",
+    "@orpc/server": "0.0.0-next.f724c58",
+    "@orpc/standard-server": "0.0.0-next.f724c58",
+    "@orpc/shared": "0.0.0-next.f724c58"
   },
   "devDependencies": {
-    "zod": "^3.24.2"
+    "fastify": "^5.6.2",
+    "zod": "^4.1.12"
   },
   "scripts": {
     "build": "unbuild",

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

@@ -1,12 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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 };