@orpc/openapi 0.0.0-next.b0f324e → 0.0.0-next.b11d127

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -21,28 +21,24 @@
21
21
 
22
22
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
23
 
24
- **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.
24
+ **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
25
25
 
26
26
  ---
27
27
 
28
28
  ## Highlights
29
29
 
30
- - **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
31
- - **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
32
- - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
- - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
- - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
36
- - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
- - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
- - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
39
- - **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
40
- - **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
41
- - **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
42
- - **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
43
- - **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
44
- - **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
45
- - **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
30
+ - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
+ - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
+ - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
34
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
37
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
38
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
+ - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
46
42
 
47
43
  ## Documentation
48
44
 
@@ -53,11 +49,16 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
+ - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
56
53
  - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
57
54
  - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
55
+ - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
56
+ - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
58
57
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
58
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
60
59
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
60
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
61
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
61
62
 
62
63
  ## `@orpc/openapi`
63
64
 
@@ -86,6 +87,14 @@ const server = createServer(async (req, res) => {
86
87
  server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
87
88
  ```
88
89
 
90
+ ## Sponsors
91
+
92
+ <p align="center">
93
+ <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
94
+ <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
95
+ </a>
96
+ </p>
97
+
89
98
  ## License
90
99
 
91
100
  Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
@@ -1,14 +1,17 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
3
- import { StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
6
- import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.mjs';
2
+ import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
7
6
 
8
- declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
9
- private readonly standardHandler;
10
- constructor(router: Router<T, any>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
11
- handle(request: Request, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
7
+ /**
8
+ * OpenAPI Handler for Fetch Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
12
15
  }
13
16
 
14
17
  export { OpenAPIHandler };
@@ -1,14 +1,17 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
3
- import { StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
6
- import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.js';
2
+ import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
7
6
 
8
- declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
9
- private readonly standardHandler;
10
- constructor(router: Router<T, any>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
11
- handle(request: Request, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
7
+ /**
8
+ * OpenAPI Handler for Fetch Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
12
15
  }
13
16
 
14
17
  export { OpenAPIHandler };
@@ -1,10 +1,17 @@
1
- export { O as OpenAPIHandler } from '../../shared/openapi.D0VMNR6V.mjs';
2
- import '@orpc/server/standard';
3
- import '@orpc/standard-server-fetch';
4
- import '../../shared/openapi.CDsfPHgw.mjs';
1
+ import { FetchHandler } from '@orpc/server/fetch';
5
2
  import '@orpc/contract';
6
- import '@orpc/openapi-client/standard';
7
3
  import '@orpc/shared';
4
+ import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
5
+ import '@orpc/client/standard';
8
6
  import '@orpc/server';
9
7
  import 'rou3';
10
- import '../../shared/openapi.BHG_gu5Z.mjs';
8
+ import '@orpc/openapi-client/standard';
9
+ import '@orpc/server/standard';
10
+
11
+ class OpenAPIHandler extends FetchHandler {
12
+ constructor(router, options = {}) {
13
+ super(new StandardOpenAPIHandler(router, options), options);
14
+ }
15
+ }
16
+
17
+ export { OpenAPIHandler };
@@ -1,14 +1,17 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
3
- import { StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { SendStandardResponseOptions } from '@orpc/standard-server-node';
6
- import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.mjs';
2
+ import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
7
6
 
8
- declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
9
- private readonly standardHandler;
10
- constructor(router: Router<T, any>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
11
- handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
7
+ /**
8
+ * OpenAPI Handler for Node Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
12
15
  }
13
16
 
14
17
  export { OpenAPIHandler };
@@ -1,14 +1,17 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
3
- import { StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { SendStandardResponseOptions } from '@orpc/standard-server-node';
6
- import { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.js';
2
+ import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
7
6
 
8
- declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
9
- private readonly standardHandler;
10
- constructor(router: Router<T, any>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
11
- handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
7
+ /**
8
+ * OpenAPI Handler for Node Server
9
+ *
10
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
11
+ * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
12
+ */
13
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
14
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
12
15
  }
13
16
 
14
17
  export { OpenAPIHandler };
@@ -1,28 +1,16 @@
1
- import { StandardHandler } from '@orpc/server/standard';
2
- import { toStandardRequest, sendStandardResponse } from '@orpc/standard-server-node';
3
- import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.CDsfPHgw.mjs';
1
+ import { NodeHttpHandler } from '@orpc/server/node';
4
2
  import '@orpc/contract';
5
- import '@orpc/openapi-client/standard';
6
3
  import '@orpc/shared';
4
+ import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
5
+ import '@orpc/client/standard';
7
6
  import '@orpc/server';
8
7
  import 'rou3';
9
- import '../../shared/openapi.BHG_gu5Z.mjs';
8
+ import '@orpc/openapi-client/standard';
9
+ import '@orpc/server/standard';
10
10
 
11
- class OpenAPIHandler {
12
- standardHandler;
13
- constructor(router, options) {
14
- const matcher = options?.matcher ?? new OpenAPIMatcher();
15
- const codec = options?.codec ?? new OpenAPICodec();
16
- this.standardHandler = new StandardHandler(router, matcher, codec, { ...options });
17
- }
18
- async handle(req, res, ...[options]) {
19
- const standardRequest = toStandardRequest(req, res);
20
- const result = await this.standardHandler.handle(standardRequest, options);
21
- if (!result.matched) {
22
- return { matched: false };
23
- }
24
- await sendStandardResponse(res, result.response, options);
25
- return { matched: true };
11
+ class OpenAPIHandler extends NodeHttpHandler {
12
+ constructor(router, options = {}) {
13
+ super(new StandardOpenAPIHandler(router, options), options);
26
14
  }
27
15
  }
28
16
 
@@ -1,24 +1,34 @@
1
- import { ORPCError } from '@orpc/client';
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
2
3
  import { AnyProcedure, AnyRouter } from '@orpc/server';
3
4
  import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
4
- import { StandardRequest, StandardResponse } from '@orpc/standard-server';
5
- import { OpenAPISerializer } from '@orpc/openapi-client/standard';
6
- export { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.mjs';
7
- import { HTTPPath } from '@orpc/contract';
5
+ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
+ export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
8
7
 
9
- declare class OpenAPICodec implements StandardCodec {
8
+ declare class StandardOpenAPICodec implements StandardCodec {
10
9
  private readonly serializer;
11
- constructor(serializer?: OpenAPISerializer);
12
- decode(request: StandardRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
10
+ constructor(serializer: StandardOpenAPISerializer);
11
+ decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
13
12
  encode(output: unknown, procedure: AnyProcedure): StandardResponse;
14
13
  encodeError(error: ORPCError<any, any>): StandardResponse;
15
14
  }
16
15
 
17
- declare class OpenAPIMatcher implements StandardMatcher {
16
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
18
17
  private readonly tree;
19
18
  private pendingRouters;
20
- init(router: AnyRouter, path?: string[]): void;
19
+ init(router: AnyRouter, path?: readonly string[]): void;
21
20
  match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
22
21
  }
23
22
 
24
- export { OpenAPICodec, OpenAPIMatcher };
23
+ /**
24
+ * {@link https://github.com/unjs/rou3}
25
+ *
26
+ * @internal
27
+ */
28
+ declare function toRou3Pattern(path: HTTPPath): string;
29
+ /**
30
+ * @internal
31
+ */
32
+ declare function decodeParams(params: Record<string, string>): Record<string, string>;
33
+
34
+ export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };
@@ -1,24 +1,34 @@
1
- import { ORPCError } from '@orpc/client';
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
2
3
  import { AnyProcedure, AnyRouter } from '@orpc/server';
3
4
  import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
4
- import { StandardRequest, StandardResponse } from '@orpc/standard-server';
5
- import { OpenAPISerializer } from '@orpc/openapi-client/standard';
6
- export { O as OpenAPIHandlerOptions } from '../../shared/openapi.Dz_6xooR.js';
7
- import { HTTPPath } from '@orpc/contract';
5
+ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
+ export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
8
7
 
9
- declare class OpenAPICodec implements StandardCodec {
8
+ declare class StandardOpenAPICodec implements StandardCodec {
10
9
  private readonly serializer;
11
- constructor(serializer?: OpenAPISerializer);
12
- decode(request: StandardRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
10
+ constructor(serializer: StandardOpenAPISerializer);
11
+ decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
13
12
  encode(output: unknown, procedure: AnyProcedure): StandardResponse;
14
13
  encodeError(error: ORPCError<any, any>): StandardResponse;
15
14
  }
16
15
 
17
- declare class OpenAPIMatcher implements StandardMatcher {
16
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
18
17
  private readonly tree;
19
18
  private pendingRouters;
20
- init(router: AnyRouter, path?: string[]): void;
19
+ init(router: AnyRouter, path?: readonly string[]): void;
21
20
  match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
22
21
  }
23
22
 
24
- export { OpenAPICodec, OpenAPIMatcher };
23
+ /**
24
+ * {@link https://github.com/unjs/rou3}
25
+ *
26
+ * @internal
27
+ */
28
+ declare function toRou3Pattern(path: HTTPPath): string;
29
+ /**
30
+ * @internal
31
+ */
32
+ declare function decodeParams(params: Record<string, string>): Record<string, string>;
33
+
34
+ export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };
@@ -1,7 +1,8 @@
1
- export { O as OpenAPICodec, a as OpenAPIMatcher } from '../../shared/openapi.CDsfPHgw.mjs';
2
- import '@orpc/contract';
1
+ export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.p5tsmBXx.mjs';
3
2
  import '@orpc/openapi-client/standard';
3
+ import '@orpc/server/standard';
4
+ import '@orpc/contract';
4
5
  import '@orpc/shared';
6
+ import '@orpc/client/standard';
5
7
  import '@orpc/server';
6
8
  import 'rou3';
7
- import '../../shared/openapi.BHG_gu5Z.mjs';
package/dist/index.d.mts CHANGED
@@ -1,169 +1,131 @@
1
- import { AnyContractProcedure, Schema, ContractRouter, HTTPPath } from '@orpc/contract';
2
- import * as OpenAPI from 'openapi3-ts/oas31';
3
- export { OpenAPI };
4
- export { OpenApiBuilder } from 'openapi3-ts/oas31';
5
- import * as JSONSchema from 'json-schema-typed/draft-2020-12';
6
- export { JSONSchema };
7
- export { Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
8
- import { OpenAPIJsonSerializer } from '@orpc/openapi-client/standard';
1
+ import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
2
+ import { OpenAPIV3_1 } from 'openapi-types';
3
+ export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
4
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
9
5
  import { AnyRouter } from '@orpc/server';
6
+ import { Promisable } from '@orpc/shared';
7
+ import { JSONSchema } from 'json-schema-typed/draft-2020-12';
8
+ export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
9
+ import { HTTPPath, HTTPMethod } from '@orpc/client';
10
10
 
11
- type OverrideOperationValue = OpenAPI.OperationObject | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
12
- declare function setOperationExtender<T extends object>(o: T, extend: OverrideOperationValue): T;
13
- declare function getOperationExtender(o: object): OverrideOperationValue | undefined;
14
- declare function extendOperation(operation: OpenAPI.OperationObject, procedure: AnyContractProcedure): OpenAPI.OperationObject;
11
+ type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
12
+ /**
13
+ * Customize The Operation Object by proxy an error map item or a middleware.
14
+ *
15
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
16
+ */
17
+ declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
18
+ declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
19
+ declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
15
20
 
16
- type ObjectSchema = JSONSchema.JSONSchema & {
21
+ /**
22
+ * @internal
23
+ */
24
+ type ObjectSchema = JSONSchema & {
17
25
  type: 'object';
18
26
  } & object;
19
- type FileSchema = JSONSchema.JSONSchema & {
27
+ /**
28
+ * @internal
29
+ */
30
+ type FileSchema = JSONSchema & {
20
31
  type: 'string';
21
32
  contentMediaType: string;
22
33
  } & object;
23
- declare const NON_LOGIC_KEYWORDS: string[];
24
-
25
- declare class SchemaUtils {
26
- isFileSchema(schema: JSONSchema.JSONSchema): schema is FileSchema;
27
- isObjectSchema(schema: JSONSchema.JSONSchema): schema is ObjectSchema;
28
- isAnySchema(schema: JSONSchema.JSONSchema): boolean;
29
- isUndefinableSchema(schema: JSONSchema.JSONSchema): boolean;
30
- separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
31
- filterSchemaBranches(schema: JSONSchema.JSONSchema, check: (schema: JSONSchema.JSONSchema) => boolean, matches?: JSONSchema.JSONSchema[]): [matches: JSONSchema.JSONSchema[], rest: JSONSchema.JSONSchema | undefined];
32
- }
33
- type PublicSchemaUtils = Pick<SchemaUtils, keyof SchemaUtils>;
34
-
35
- declare class OpenAPIContentBuilder {
36
- private readonly schemaUtils;
37
- constructor(schemaUtils: PublicSchemaUtils);
38
- build(jsonSchema: JSONSchema.JSONSchema, options?: Partial<OpenAPI.MediaTypeObject>): OpenAPI.ContentObject;
39
- }
40
- type PublicOpenAPIContentBuilder = Pick<OpenAPIContentBuilder, keyof OpenAPIContentBuilder>;
41
-
42
- declare class OpenAPIPathParser {
43
- parseDynamicParams(path: string): {
44
- name: string;
45
- raw: string;
46
- }[];
47
- }
48
- type PublicOpenAPIPathParser = Pick<OpenAPIPathParser, keyof OpenAPIPathParser>;
34
+ /**
35
+ * @internal
36
+ */
37
+ declare const LOGIC_KEYWORDS: string[];
49
38
 
50
39
  interface SchemaConvertOptions {
51
40
  strategy: 'input' | 'output';
52
41
  }
53
42
  interface SchemaConverter {
54
- condition(schema: Schema, options: SchemaConvertOptions): boolean;
55
- convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
43
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
44
+ }
45
+ interface ConditionalSchemaConverter extends SchemaConverter {
46
+ condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
56
47
  }
57
48
  declare class CompositeSchemaConverter implements SchemaConverter {
58
49
  private readonly converters;
59
- constructor(converters: SchemaConverter[]);
60
- condition(): boolean;
61
- convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
50
+ constructor(converters: ConditionalSchemaConverter[]);
51
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
62
52
  }
63
53
 
64
- interface OpenAPIInputStructureParseResult {
65
- paramsSchema: ObjectSchema | undefined;
66
- querySchema: ObjectSchema | undefined;
67
- headersSchema: ObjectSchema | undefined;
68
- bodySchema: JSONSchema.JSONSchema | undefined;
69
- }
70
- declare class OpenAPIInputStructureParser {
71
- private readonly schemaConverter;
72
- private readonly schemaUtils;
73
- private readonly pathParser;
74
- constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils, pathParser: PublicOpenAPIPathParser);
75
- parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIInputStructureParseResult;
76
- private parseDetailedSchema;
77
- private parseCompactSchema;
54
+ interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
55
+ schemaConverters?: ConditionalSchemaConverter[];
78
56
  }
79
- type PublicOpenAPIInputStructureParser = Pick<OpenAPIInputStructureParser, keyof OpenAPIInputStructureParser>;
80
-
81
- interface OpenAPIOutputStructureParseResult {
82
- headersSchema: ObjectSchema | undefined;
83
- bodySchema: JSONSchema.JSONSchema | undefined;
84
- }
85
- declare class OpenAPIOutputStructureParser {
86
- private readonly schemaConverter;
87
- private readonly schemaUtils;
88
- constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils);
89
- parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIOutputStructureParseResult;
90
- private parseDetailedSchema;
91
- private parseCompactSchema;
92
- }
93
- type PublicOpenAPIOutputStructureParser = Pick<OpenAPIOutputStructureParser, keyof OpenAPIOutputStructureParser>;
94
-
95
- declare class OpenAPIParametersBuilder {
96
- build(paramIn: OpenAPI.ParameterObject['in'], jsonSchema: JSONSchema.JSONSchema & {
97
- type: 'object';
98
- } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.ParameterObject[];
99
- buildHeadersObject(jsonSchema: JSONSchema.JSONSchema & {
100
- type: 'object';
101
- } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.HeadersObject;
102
- }
103
- type PublicOpenAPIParametersBuilder = Pick<OpenAPIParametersBuilder, keyof OpenAPIParametersBuilder>;
104
-
105
- type ErrorHandlerStrategy = 'throw' | 'log' | 'ignore';
106
- interface OpenAPIGeneratorOptions {
107
- contentBuilder?: PublicOpenAPIContentBuilder;
108
- parametersBuilder?: PublicOpenAPIParametersBuilder;
109
- schemaConverters?: SchemaConverter[];
110
- schemaUtils?: PublicSchemaUtils;
111
- jsonSerializer?: OpenAPIJsonSerializer;
112
- pathParser?: PublicOpenAPIPathParser;
113
- inputStructureParser?: PublicOpenAPIInputStructureParser;
114
- outputStructureParser?: PublicOpenAPIOutputStructureParser;
115
- /**
116
- * Throw error when you missing define tag definition on OpenAPI root tags
117
- *
118
- * Example: if procedure has tags ['foo', 'bar'], and OpenAPI root tags is ['foo'], then error will be thrown
119
- * Because OpenAPI root tags is missing 'bar' tag
120
- *
121
- * @default false
122
- */
123
- considerMissingTagDefinitionAsError?: boolean;
124
- /**
125
- * Weather ignore procedures that has no path defined.
126
- *
127
- * @default false
128
- */
129
- ignoreUndefinedPathProcedures?: boolean;
130
- /**
131
- * What to do when we found an error with our router
132
- *
133
- * @default 'throw'
134
- */
135
- errorHandlerStrategy?: ErrorHandlerStrategy;
57
+ /**
58
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
59
+ *
60
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
61
+ */
62
+ declare class OpenAPIGenerator {
63
+ #private;
64
+ private readonly serializer;
65
+ private readonly converter;
66
+ constructor(options?: OpenAPIGeneratorOptions);
136
67
  /**
137
- * Strict error response
68
+ * Generates OpenAPI specifications from oRPC routers/contracts.
138
69
  *
139
- * @default true
70
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
140
71
  */
141
- strictErrorResponses?: boolean;
142
- }
143
- declare class OpenAPIGenerator {
144
- private readonly contentBuilder;
145
- private readonly parametersBuilder;
146
- private readonly schemaConverter;
147
- private readonly schemaUtils;
148
- private readonly jsonSerializer;
149
- private readonly pathParser;
150
- private readonly inputStructureParser;
151
- private readonly outputStructureParser;
152
- private readonly errorHandlerStrategy;
153
- private readonly ignoreUndefinedPathProcedures;
154
- private readonly considerMissingTagDefinitionAsError;
155
- private readonly strictErrorResponses;
156
- constructor(options?: OpenAPIGeneratorOptions);
157
- generate(router: ContractRouter<any> | AnyRouter, doc: Omit<OpenAPI.OpenAPIObject, 'openapi'>): Promise<OpenAPI.OpenAPIObject>;
72
+ generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
158
73
  }
159
74
 
160
- declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
161
- declare function toOpenAPI31RoutePattern(path: HTTPPath): string;
75
+ /**
76
+ * @internal
77
+ */
78
+ declare function toOpenAPIPath(path: HTTPPath): string;
79
+ /**
80
+ * @internal
81
+ */
82
+ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
83
+ /**
84
+ * @internal
85
+ */
86
+ declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
87
+ /**
88
+ * @internal
89
+ */
90
+ declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
91
+ /**
92
+ * @internal
93
+ */
94
+ declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
95
+ /**
96
+ * @internal
97
+ */
98
+ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
99
+ /**
100
+ * @internal
101
+ */
102
+ declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
162
103
 
163
- /** unnoq */
104
+ /**
105
+ *@internal
106
+ */
107
+ declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
108
+ /**
109
+ * @internal
110
+ */
111
+ declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
112
+ /**
113
+ * @internal
114
+ */
115
+ declare function isAnySchema(schema: JSONSchema): boolean;
116
+ /**
117
+ * @internal
118
+ */
119
+ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
120
+ /**
121
+ * @internal
122
+ */
123
+ declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
124
+ declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
164
125
 
165
126
  declare const oo: {
166
- spec: typeof setOperationExtender;
127
+ spec: typeof customOpenAPIOperation;
167
128
  };
168
129
 
169
- export { CompositeSchemaConverter, type FileSchema, NON_LOGIC_KEYWORDS, type ObjectSchema, OpenAPIContentBuilder, OpenAPIGenerator, type OpenAPIGeneratorOptions, OpenAPIParametersBuilder, OpenAPIPathParser, type OverrideOperationValue, type PublicOpenAPIContentBuilder, type PublicOpenAPIParametersBuilder, type PublicOpenAPIPathParser, type PublicSchemaUtils, type SchemaConvertOptions, type SchemaConverter, SchemaUtils, extendOperation, getOperationExtender, oo, setOperationExtender, standardizeHTTPPath, toOpenAPI31RoutePattern };
130
+ export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
131
+ export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };