@orpc/openapi 0.0.0-next.15d9202 → 0.0.0-next.16739f4

package/README.md

@@ -21,28 +21,24 @@
 
 <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
 
-**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
 
 ---
 
 ## Highlights
 
-- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
-- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
-- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
-- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
-- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
-- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
-- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
-- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
-- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
-- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
-- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
-- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
-- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
-- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
-- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
-- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
+- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
+- **📝 Contract-First Development**: Optionally define your API contract before implementation.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
+- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
+- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
+- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
+- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
+- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
+- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 
@@ -53,6 +49,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
 - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
 - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
 - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
@@ -60,6 +57,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
 - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
 - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
+- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
 
 ## `@orpc/openapi`
 
@@ -88,6 +87,14 @@ const server = createServer(async (req, res) => {
 server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
 ```
 
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
+  </a>
+</p>
+
 ## License
 
 Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

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

@@ -1,13 +1,17 @@
 import { Context, Router } from '@orpc/server';
-import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
-import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
-import { MaybeOptionalOptions } from '@orpc/shared';
-import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
+import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
+import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
 
-declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
-    private readonly standardHandler;
-    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
-    handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
+/**
+ * OpenAPI Handler for Fetch Server
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
+ * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
+ */
+declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
+    constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };

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

@@ -1,13 +1,17 @@
 import { Context, Router } from '@orpc/server';
-import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
-import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
-import { MaybeOptionalOptions } from '@orpc/shared';
-import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
+import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
+import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
 
-declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
-    private readonly standardHandler;
-    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
-    handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
+/**
+ * OpenAPI Handler for Fetch Server
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
+ * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
+ */
+declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
+    constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };

package/dist/adapters/fetch/index.mjs

@@ -1,11 +1,17 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
-import '@orpc/openapi-client/standard';
-import '@orpc/server/standard';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.CJTe38Ya.mjs';
+import { FetchHandler } from '@orpc/server/fetch';
 import '@orpc/contract';
 import '@orpc/shared';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
+import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
-import 'json-schema-typed/draft-2020-12';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
+
+class OpenAPIHandler extends FetchHandler {
+  constructor(router, options = {}) {
+    super(new StandardOpenAPIHandler(router, options), options);
+  }
+}
+
+export { OpenAPIHandler };

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

@@ -1,13 +1,17 @@
 import { Context, Router } from '@orpc/server';
-import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
-import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
-import { MaybeOptionalOptions } from '@orpc/shared';
-import { SendStandardResponseOptions } from '@orpc/standard-server-node';
+import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
+import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
 
-declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
-    private readonly standardHandler;
-    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
-    handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
+/**
+ * OpenAPI Handler for Node Server
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
+ * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
+ */
+declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
+    constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };

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

@@ -1,13 +1,17 @@
 import { Context, Router } from '@orpc/server';
-import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
-import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
-import { MaybeOptionalOptions } from '@orpc/shared';
-import { SendStandardResponseOptions } from '@orpc/standard-server-node';
+import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
+import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
 
-declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
-    private readonly standardHandler;
-    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
-    handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
+/**
+ * OpenAPI Handler for Node Server
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
+ * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
+ */
+declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
+    constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };

package/dist/adapters/node/index.mjs

@@ -1,32 +1,16 @@
-import { OpenAPISerializer } from '@orpc/openapi-client/standard';
-import { StandardHandler } from '@orpc/server/standard';
-import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
-import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.CJTe38Ya.mjs';
-import '@orpc/shared';
-import 'json-schema-typed/draft-2020-12';
+import { NodeHttpHandler } from '@orpc/server/node';
 import '@orpc/contract';
+import '@orpc/shared';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
+import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
 
-class OpenAPIHandler {
-  standardHandler;
+class OpenAPIHandler extends NodeHttpHandler {
   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(req, res, ...[
-    options = {}
-  ]) {
-    const standardRequest = toStandardLazyRequest(req, res);
-    const result = await this.standardHandler.handle(standardRequest, options);
-    if (!result.matched) {
-      return { matched: false };
-    }
-    await sendStandardResponse(res, result.response, options);
-    return { matched: true };
+    super(new StandardOpenAPIHandler(router, options), options);
   }
 }
 

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

@@ -1,19 +1,19 @@
-import { ORPCError } from '@orpc/client';
-import { OpenAPISerializer } from '@orpc/openapi-client/standard';
+import { ORPCError, HTTPPath } from '@orpc/client';
+import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
 import { AnyProcedure, AnyRouter } from '@orpc/server';
 import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
 import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
-import { HTTPPath } from '@orpc/contract';
+export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
 
-declare class OpenAPICodec implements StandardCodec {
+declare class StandardOpenAPICodec implements StandardCodec {
     private readonly serializer;
-    constructor(serializer: OpenAPISerializer);
+    constructor(serializer: StandardOpenAPISerializer);
     decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
     encode(output: unknown, procedure: AnyProcedure): StandardResponse;
     encodeError(error: ORPCError<any, any>): StandardResponse;
 }
 
-declare class OpenAPIMatcher implements StandardMatcher {
+declare class StandardOpenAPIMatcher implements StandardMatcher {
     private readonly tree;
     private pendingRouters;
     init(router: AnyRouter, path?: readonly string[]): void;
@@ -31,4 +31,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
  */
 declare function decodeParams(params: Record<string, string>): Record<string, string>;
 
-export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
+export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };

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

@@ -1,19 +1,19 @@
-import { ORPCError } from '@orpc/client';
-import { OpenAPISerializer } from '@orpc/openapi-client/standard';
+import { ORPCError, HTTPPath } from '@orpc/client';
+import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
 import { AnyProcedure, AnyRouter } from '@orpc/server';
 import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
 import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
-import { HTTPPath } from '@orpc/contract';
+export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
 
-declare class OpenAPICodec implements StandardCodec {
+declare class StandardOpenAPICodec implements StandardCodec {
     private readonly serializer;
-    constructor(serializer: OpenAPISerializer);
+    constructor(serializer: StandardOpenAPISerializer);
     decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
     encode(output: unknown, procedure: AnyProcedure): StandardResponse;
     encodeError(error: ORPCError<any, any>): StandardResponse;
 }
 
-declare class OpenAPIMatcher implements StandardMatcher {
+declare class StandardOpenAPIMatcher implements StandardMatcher {
     private readonly tree;
     private pendingRouters;
     init(router: AnyRouter, path?: readonly string[]): void;
@@ -31,4 +31,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
  */
 declare function decodeParams(params: Record<string, string>): Record<string, string>;
 
-export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
+export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };

package/dist/adapters/standard/index.mjs

@@ -1,7 +1,8 @@
-export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.CJTe38Ya.mjs';
+export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.p5tsmBXx.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
 import '@orpc/contract';
 import '@orpc/shared';
+import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
-import 'json-schema-typed/draft-2020-12';

package/dist/index.d.mts

@@ -1,11 +1,19 @@
-import { AnyContractProcedure, AnySchema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
+import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
 import { OpenAPIV3_1 } from 'openapi-types';
 export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
 import { AnyRouter } from '@orpc/server';
+import { Promisable } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+import { HTTPPath, HTTPMethod } from '@orpc/client';
 
 type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+/**
+ * Customize The Operation Object by proxy an error map item or a middleware.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
+ */
 declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
 declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
 declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
@@ -32,32 +40,38 @@ interface SchemaConvertOptions {
     strategy: 'input' | 'output';
 }
 interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
 }
 interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
+    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): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
 }
 
-interface OpenAPIGeneratorOptions {
+interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
     schemaConverters?: ConditionalSchemaConverter[];
 }
+/**
+ * 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, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
 }
 
-/**
- * @internal
- */
-declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
 /**
  * @internal
  */
@@ -66,10 +80,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
  * @internal
  */
 declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
-/**
- * @internal
- */
-declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
 /**
  * @internal
  */
@@ -111,9 +121,11 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
  * @internal
  */
 declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
+declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
 
 declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, getDynamicParams, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, standardizeHTTPPath, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };

package/dist/index.d.ts

@@ -1,11 +1,19 @@
-import { AnyContractProcedure, AnySchema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
+import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
 import { OpenAPIV3_1 } from 'openapi-types';
 export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
 import { AnyRouter } from '@orpc/server';
+import { Promisable } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+import { HTTPPath, HTTPMethod } from '@orpc/client';
 
 type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+/**
+ * Customize The Operation Object by proxy an error map item or a middleware.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
+ */
 declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
 declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
 declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
@@ -32,32 +40,38 @@ interface SchemaConvertOptions {
     strategy: 'input' | 'output';
 }
 interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
 }
 interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
+    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): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
 }
 
-interface OpenAPIGeneratorOptions {
+interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
     schemaConverters?: ConditionalSchemaConverter[];
 }
+/**
+ * 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, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
 }
 
-/**
- * @internal
- */
-declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
 /**
  * @internal
  */
@@ -66,10 +80,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
  * @internal
  */
 declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
-/**
- * @internal
- */
-declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
 /**
  * @internal
  */
@@ -111,9 +121,11 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
  * @internal
  */
 declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
+declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
 
 declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, getDynamicParams, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, standardizeHTTPPath, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };