@orpc/openapi 0.0.0-next.e710b76 → 0.0.0-next.e77ba7d

package/dist/shared/{openapi.B3hexduL.d.mts → openapi.dbQeFCUJ.d.mts}

@@ -1,7 +1,7 @@
 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 { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
+import { Promisable, Value } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
@@ -33,7 +33,7 @@ interface ConditionalSchemaConverter extends SchemaConverter {
 }
 declare class CompositeSchemaConverter implements SchemaConverter {
     private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
+    constructor(converters: readonly ConditionalSchemaConverter[]);
     convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
 }
 
@@ -44,9 +44,16 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
     /**
      * 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.
      */
@@ -78,6 +85,18 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
         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.
@@ -94,7 +113,7 @@ declare class OpenAPIGenerator {
      *
      * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
      */
-    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
+    generate(router: AnyContractRouter | AnyRouter, { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
 }
 
 export { OpenAPIGenerator as b, CompositeSchemaConverter as e };

package/dist/shared/{openapi.B3hexduL.d.ts → openapi.dbQeFCUJ.d.ts}

@@ -1,7 +1,7 @@
 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 { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
+import { Promisable, Value } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
@@ -33,7 +33,7 @@ interface ConditionalSchemaConverter extends SchemaConverter {
 }
 declare class CompositeSchemaConverter implements SchemaConverter {
     private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
+    constructor(converters: readonly ConditionalSchemaConverter[]);
     convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
 }
 
@@ -44,9 +44,16 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
     /**
      * 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.
      */
@@ -78,6 +85,18 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
         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.
@@ -94,7 +113,7 @@ declare class OpenAPIGenerator {
      *
      * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
      */
-    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
+    generate(router: AnyContractRouter | AnyRouter, { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
 }
 
 export { OpenAPIGenerator as b, CompositeSchemaConverter as e };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "0.0.0-next.e710b76",
+  "version": "0.0.0-next.e77ba7d",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -39,6 +39,11 @@
       "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",
@@ -49,17 +54,19 @@
     "dist"
   ],
   "dependencies": {
-    "json-schema-typed": "^8.0.1",
-    "rou3": "^0.7.3",
-    "@orpc/client": "0.0.0-next.e710b76",
-    "@orpc/openapi-client": "0.0.0-next.e710b76",
-    "@orpc/contract": "0.0.0-next.e710b76",
-    "@orpc/shared": "0.0.0-next.e710b76",
-    "@orpc/server": "0.0.0-next.e710b76",
-    "@orpc/standard-server": "0.0.0-next.e710b76"
+    "json-schema-typed": "^8.0.2",
+    "rou3": "^0.7.10",
+    "@orpc/contract": "0.0.0-next.e77ba7d",
+    "@orpc/interop": "0.0.0-next.e77ba7d",
+    "@orpc/client": "0.0.0-next.e77ba7d",
+    "@orpc/server": "0.0.0-next.e77ba7d",
+    "@orpc/shared": "0.0.0-next.e77ba7d",
+    "@orpc/standard-server": "0.0.0-next.e77ba7d",
+    "@orpc/openapi-client": "0.0.0-next.e77ba7d"
   },
   "devDependencies": {
-    "zod": "^3.25.67"
+    "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 };