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

package/README.md

@@ -0,0 +1,100 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/openapi">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fopenapi?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<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
+
+---
+
+## Highlights
+
+- **🔗 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
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@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).
+- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
+- [@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`
+
+Generate OpenAPI specs and handle OpenAPI requests. Read the [documentation](https://orpc.unnoq.com/docs/openapi/getting-started) for more information.
+
+```ts
+import { createServer } from 'node:http'
+import { OpenAPIHandler } from '@orpc/openapi/node'
+import { CORSPlugin } from '@orpc/server/plugins'
+
+const handler = new OpenAPIHandler(router, {
+  plugins: [new CORSPlugin()]
+})
+
+const server = createServer(async (req, res) => {
+  const result = await handler.handle(req, res, {
+    context: { headers: req.headers }
+  })
+
+  if (!result.matched) {
+    res.statusCode = 404
+    res.end('No procedure matched')
+  }
+})
+
+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

@@ -0,0 +1,17 @@
+import { Context, Router } from '@orpc/server';
+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';
+
+/**
+ * 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

@@ -0,0 +1,17 @@
+import { Context, Router } from '@orpc/server';
+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';
+
+/**
+ * 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

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

@@ -0,0 +1,17 @@
+import { Context, Router } from '@orpc/server';
+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';
+
+/**
+ * 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

@@ -0,0 +1,17 @@
+import { Context, Router } from '@orpc/server';
+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';
+
+/**
+ * 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

@@ -0,0 +1,17 @@
+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 '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
+
+class OpenAPIHandler extends NodeHttpHandler {
+  constructor(router, options = {}) {
+    super(new StandardOpenAPIHandler(router, options), options);
+  }
+}
+
+export { OpenAPIHandler };

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

@@ -0,0 +1,34 @@
+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';
+export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
+
+declare class StandardOpenAPICodec implements StandardCodec {
+    private readonly serializer;
+    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 StandardOpenAPIMatcher implements StandardMatcher {
+    private readonly tree;
+    private pendingRouters;
+    init(router: AnyRouter, path?: readonly string[]): void;
+    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
+}
+
+/**
+ * {@link https://github.com/unjs/rou3}
+ *
+ * @internal
+ */
+declare function toRou3Pattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function decodeParams(params: Record<string, string>): Record<string, string>;
+
+export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };

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

@@ -0,0 +1,34 @@
+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';
+export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
+
+declare class StandardOpenAPICodec implements StandardCodec {
+    private readonly serializer;
+    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 StandardOpenAPIMatcher implements StandardMatcher {
+    private readonly tree;
+    private pendingRouters;
+    init(router: AnyRouter, path?: readonly string[]): void;
+    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
+}
+
+/**
+ * {@link https://github.com/unjs/rou3}
+ *
+ * @internal
+ */
+declare function toRou3Pattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function decodeParams(params: Record<string, string>): Record<string, string>;
+
+export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };

package/dist/adapters/standard/index.mjs

@@ -0,0 +1,8 @@
+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';

package/dist/index.d.mts

@@ -0,0 +1,131 @@
+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;
+
+/**
+ * @internal
+ */
+type ObjectSchema = JSONSchema & {
+    type: 'object';
+} & object;
+/**
+ * @internal
+ */
+type FileSchema = JSONSchema & {
+    type: 'string';
+    contentMediaType: string;
+} & object;
+/**
+ * @internal
+ */
+declare const LOGIC_KEYWORDS: string[];
+
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
+}
+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[];
+}
+/**
+ * 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 toOpenAPIPath(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
+/**
+ * @internal
+ */
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+/**
+ * @internal
+ */
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+/**
+ * @internal
+ */
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
+
+/**
+ *@internal
+ */
+declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
+/**
+ * @internal
+ */
+declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
+/**
+ * @internal
+ */
+declare function isAnySchema(schema: JSONSchema): boolean;
+/**
+ * @internal
+ */
+declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
+/**
+ * @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, 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

@@ -0,0 +1,131 @@
+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;
+
+/**
+ * @internal
+ */
+type ObjectSchema = JSONSchema & {
+    type: 'object';
+} & object;
+/**
+ * @internal
+ */
+type FileSchema = JSONSchema & {
+    type: 'string';
+    contentMediaType: string;
+} & object;
+/**
+ * @internal
+ */
+declare const LOGIC_KEYWORDS: string[];
+
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
+}
+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[];
+}
+/**
+ * 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 toOpenAPIPath(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
+/**
+ * @internal
+ */
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+/**
+ * @internal
+ */
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+/**
+ * @internal
+ */
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
+
+/**
+ *@internal
+ */
+declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
+/**
+ * @internal
+ */
+declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
+/**
+ * @internal
+ */
+declare function isAnySchema(schema: JSONSchema): boolean;
+/**
+ * @internal
+ */
+declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
+/**
+ * @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, 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 };