@orpc/openapi 0.0.0-next.f81b4a2 → 0.0.0-next.f9e0a4c
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 +18 -22
- package/dist/adapters/aws-lambda/index.d.mts +19 -0
- package/dist/adapters/aws-lambda/index.d.ts +19 -0
- package/dist/adapters/aws-lambda/index.mjs +18 -0
- package/dist/adapters/fetch/index.d.mts +4 -2
- package/dist/adapters/fetch/index.d.ts +4 -2
- package/dist/adapters/fetch/index.mjs +2 -1
- package/dist/adapters/node/index.d.mts +4 -2
- package/dist/adapters/node/index.d.ts +4 -2
- package/dist/adapters/node/index.mjs +2 -1
- package/dist/adapters/standard/index.d.mts +6 -11
- package/dist/adapters/standard/index.d.ts +6 -11
- package/dist/adapters/standard/index.mjs +2 -1
- package/dist/index.d.mts +31 -52
- package/dist/index.d.ts +31 -52
- package/dist/index.mjs +31 -535
- package/dist/plugins/index.d.mts +69 -0
- package/dist/plugins/index.d.ts +69 -0
- package/dist/plugins/index.mjs +108 -0
- package/dist/shared/{openapi.p5tsmBXx.mjs → openapi.BVXcB0u4.mjs} +39 -10
- package/dist/shared/openapi.CQmjvnb0.d.mts +31 -0
- package/dist/shared/openapi.CQmjvnb0.d.ts +31 -0
- package/dist/shared/openapi.DRqtR2lw.mjs +750 -0
- package/dist/shared/openapi.TOD62C7O.d.mts +108 -0
- package/dist/shared/openapi.TOD62C7O.d.ts +108 -0
- package/package.json +20 -11
- package/dist/shared/openapi.D3j94c9n.d.mts +0 -12
- package/dist/shared/openapi.D3j94c9n.d.ts +0 -12
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
|
|
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
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
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
|
+
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
|
34
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
|
|
35
|
+
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
36
|
+
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
37
|
+
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
38
|
+
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
|
39
|
+
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
40
|
+
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
41
|
+
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
46
42
|
|
|
47
43
|
## Documentation
|
|
48
44
|
|
|
@@ -53,13 +49,13 @@ 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/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
53
|
+
- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
|
|
54
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
56
55
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
57
|
-
- [@orpc/
|
|
58
|
-
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
|
59
|
-
- [@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
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
|
56
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
|
61
57
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
62
|
-
- [@orpc/
|
|
58
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
63
59
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
64
60
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
65
61
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Context, Router } from '@orpc/server';
|
|
2
|
+
import { AwsLambdaHandler, AwsLambdaHandlerOptions } from '@orpc/server/aws-lambda';
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
|
|
4
|
+
import '@orpc/openapi-client/standard';
|
|
5
|
+
import '@orpc/server/standard';
|
|
6
|
+
import '@orpc/client';
|
|
7
|
+
import '@orpc/shared';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* OpenAPI Handler for AWS Lambda.
|
|
11
|
+
*
|
|
12
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
13
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
|
14
|
+
*/
|
|
15
|
+
declare class OpenAPIHandler<T extends Context> extends AwsLambdaHandler<T> {
|
|
16
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & AwsLambdaHandlerOptions>);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export { OpenAPIHandler };
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Context, Router } from '@orpc/server';
|
|
2
|
+
import { AwsLambdaHandler, AwsLambdaHandlerOptions } from '@orpc/server/aws-lambda';
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
|
|
4
|
+
import '@orpc/openapi-client/standard';
|
|
5
|
+
import '@orpc/server/standard';
|
|
6
|
+
import '@orpc/client';
|
|
7
|
+
import '@orpc/shared';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* OpenAPI Handler for AWS Lambda.
|
|
11
|
+
*
|
|
12
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
13
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
|
14
|
+
*/
|
|
15
|
+
declare class OpenAPIHandler<T extends Context> extends AwsLambdaHandler<T> {
|
|
16
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & AwsLambdaHandlerOptions>);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export { OpenAPIHandler };
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { AwsLambdaHandler } from '@orpc/server/aws-lambda';
|
|
2
|
+
import '@orpc/client';
|
|
3
|
+
import '@orpc/contract';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
import { a as StandardOpenAPIHandler } from '../../shared/openapi.BVXcB0u4.mjs';
|
|
6
|
+
import '@orpc/client/standard';
|
|
7
|
+
import '@orpc/server';
|
|
8
|
+
import 'rou3';
|
|
9
|
+
import '@orpc/openapi-client/standard';
|
|
10
|
+
import '@orpc/server/standard';
|
|
11
|
+
|
|
12
|
+
class OpenAPIHandler extends AwsLambdaHandler {
|
|
13
|
+
constructor(router, options = {}) {
|
|
14
|
+
super(new StandardOpenAPIHandler(router, options), options);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export { OpenAPIHandler };
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
|
+
import '@orpc/client';
|
|
7
|
+
import '@orpc/shared';
|
|
6
8
|
|
|
7
9
|
/**
|
|
8
10
|
* OpenAPI Handler for Fetch Server
|
|
9
11
|
*
|
|
10
12
|
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
11
|
-
* @see {@link https://orpc.unnoq.com/docs/
|
|
13
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
|
12
14
|
*/
|
|
13
15
|
declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
|
|
14
16
|
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
|
+
import '@orpc/client';
|
|
7
|
+
import '@orpc/shared';
|
|
6
8
|
|
|
7
9
|
/**
|
|
8
10
|
* OpenAPI Handler for Fetch Server
|
|
9
11
|
*
|
|
10
12
|
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
11
|
-
* @see {@link https://orpc.unnoq.com/docs/
|
|
13
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
|
12
14
|
*/
|
|
13
15
|
declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
|
|
14
16
|
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { FetchHandler } from '@orpc/server/fetch';
|
|
2
|
+
import '@orpc/client';
|
|
2
3
|
import '@orpc/contract';
|
|
3
4
|
import '@orpc/shared';
|
|
4
|
-
import { a as StandardOpenAPIHandler } from '../../shared/openapi.
|
|
5
|
+
import { a as StandardOpenAPIHandler } from '../../shared/openapi.BVXcB0u4.mjs';
|
|
5
6
|
import '@orpc/client/standard';
|
|
6
7
|
import '@orpc/server';
|
|
7
8
|
import 'rou3';
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
|
+
import '@orpc/client';
|
|
7
|
+
import '@orpc/shared';
|
|
6
8
|
|
|
7
9
|
/**
|
|
8
10
|
* OpenAPI Handler for Node Server
|
|
9
11
|
*
|
|
10
12
|
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
11
|
-
* @see {@link https://orpc.unnoq.com/docs/
|
|
13
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
|
12
14
|
*/
|
|
13
15
|
declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
|
|
14
16
|
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
|
+
import '@orpc/client';
|
|
7
|
+
import '@orpc/shared';
|
|
6
8
|
|
|
7
9
|
/**
|
|
8
10
|
* OpenAPI Handler for Node Server
|
|
9
11
|
*
|
|
10
12
|
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
11
|
-
* @see {@link https://orpc.unnoq.com/docs/
|
|
13
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
|
12
14
|
*/
|
|
13
15
|
declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
|
|
14
16
|
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { NodeHttpHandler } from '@orpc/server/node';
|
|
2
|
+
import '@orpc/client';
|
|
2
3
|
import '@orpc/contract';
|
|
3
4
|
import '@orpc/shared';
|
|
4
|
-
import { a as StandardOpenAPIHandler } from '../../shared/openapi.
|
|
5
|
+
import { a as StandardOpenAPIHandler } from '../../shared/openapi.BVXcB0u4.mjs';
|
|
5
6
|
import '@orpc/client/standard';
|
|
6
7
|
import '@orpc/server';
|
|
7
8
|
import 'rou3';
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { ORPCError, HTTPPath } from '@orpc/client';
|
|
2
2
|
import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
3
|
-
import { AnyProcedure
|
|
4
|
-
import { StandardCodec, StandardParams
|
|
3
|
+
import { AnyProcedure } from '@orpc/server';
|
|
4
|
+
import { StandardCodec, StandardParams } from '@orpc/server/standard';
|
|
5
5
|
import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
|
6
|
-
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
6
|
+
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions, c as StandardOpenAPIMatcher, b as StandardOpenAPIMatcherOptions } from '../../shared/openapi.CQmjvnb0.mjs';
|
|
7
|
+
import '@orpc/shared';
|
|
7
8
|
|
|
8
9
|
declare class StandardOpenAPICodec implements StandardCodec {
|
|
10
|
+
#private;
|
|
9
11
|
private readonly serializer;
|
|
10
12
|
constructor(serializer: StandardOpenAPISerializer);
|
|
11
13
|
decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
|
|
@@ -13,13 +15,6 @@ declare class StandardOpenAPICodec implements StandardCodec {
|
|
|
13
15
|
encodeError(error: ORPCError<any, any>): StandardResponse;
|
|
14
16
|
}
|
|
15
17
|
|
|
16
|
-
declare class StandardOpenAPIMatcher implements StandardMatcher {
|
|
17
|
-
private readonly tree;
|
|
18
|
-
private pendingRouters;
|
|
19
|
-
init(router: AnyRouter, path?: readonly string[]): void;
|
|
20
|
-
match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
18
|
/**
|
|
24
19
|
* {@link https://github.com/unjs/rou3}
|
|
25
20
|
*
|
|
@@ -31,4 +26,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
|
|
|
31
26
|
*/
|
|
32
27
|
declare function decodeParams(params: Record<string, string>): Record<string, string>;
|
|
33
28
|
|
|
34
|
-
export { StandardOpenAPICodec,
|
|
29
|
+
export { StandardOpenAPICodec, decodeParams, toRou3Pattern };
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { ORPCError, HTTPPath } from '@orpc/client';
|
|
2
2
|
import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
3
|
-
import { AnyProcedure
|
|
4
|
-
import { StandardCodec, StandardParams
|
|
3
|
+
import { AnyProcedure } from '@orpc/server';
|
|
4
|
+
import { StandardCodec, StandardParams } from '@orpc/server/standard';
|
|
5
5
|
import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
|
6
|
-
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
6
|
+
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions, c as StandardOpenAPIMatcher, b as StandardOpenAPIMatcherOptions } from '../../shared/openapi.CQmjvnb0.js';
|
|
7
|
+
import '@orpc/shared';
|
|
7
8
|
|
|
8
9
|
declare class StandardOpenAPICodec implements StandardCodec {
|
|
10
|
+
#private;
|
|
9
11
|
private readonly serializer;
|
|
10
12
|
constructor(serializer: StandardOpenAPISerializer);
|
|
11
13
|
decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
|
|
@@ -13,13 +15,6 @@ declare class StandardOpenAPICodec implements StandardCodec {
|
|
|
13
15
|
encodeError(error: ORPCError<any, any>): StandardResponse;
|
|
14
16
|
}
|
|
15
17
|
|
|
16
|
-
declare class StandardOpenAPIMatcher implements StandardMatcher {
|
|
17
|
-
private readonly tree;
|
|
18
|
-
private pendingRouters;
|
|
19
|
-
init(router: AnyRouter, path?: readonly string[]): void;
|
|
20
|
-
match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
18
|
/**
|
|
24
19
|
* {@link https://github.com/unjs/rou3}
|
|
25
20
|
*
|
|
@@ -31,4 +26,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
|
|
|
31
26
|
*/
|
|
32
27
|
declare function decodeParams(params: Record<string, string>): Record<string, string>;
|
|
33
28
|
|
|
34
|
-
export { StandardOpenAPICodec,
|
|
29
|
+
export { StandardOpenAPICodec, decodeParams, toRou3Pattern };
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.
|
|
1
|
+
export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.BVXcB0u4.mjs';
|
|
2
2
|
import '@orpc/openapi-client/standard';
|
|
3
3
|
import '@orpc/server/standard';
|
|
4
|
+
import '@orpc/client';
|
|
4
5
|
import '@orpc/contract';
|
|
5
6
|
import '@orpc/shared';
|
|
6
7
|
import '@orpc/client/standard';
|
package/dist/index.d.mts
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
export {
|
|
4
|
-
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
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';
|
|
1
|
+
import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
|
|
2
|
+
export { OpenAPI } from '@orpc/contract';
|
|
3
|
+
export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.TOD62C7O.mjs';
|
|
9
4
|
import { HTTPPath, HTTPMethod } from '@orpc/client';
|
|
5
|
+
import { JSONSchema } from '@orpc/json-schema-typed/draft-2020-12';
|
|
6
|
+
export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@orpc/json-schema-typed/draft-2020-12';
|
|
7
|
+
import { JsonifiedClient } from '@orpc/openapi-client';
|
|
8
|
+
import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
|
|
9
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
10
|
+
import '@orpc/openapi-client/standard';
|
|
10
11
|
|
|
11
|
-
type OverrideOperationValue = Partial<
|
|
12
|
+
type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
|
|
12
13
|
/**
|
|
13
14
|
* Customize The Operation Object by proxy an error map item or a middleware.
|
|
14
15
|
*
|
|
@@ -16,7 +17,7 @@ type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current:
|
|
|
16
17
|
*/
|
|
17
18
|
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
|
18
19
|
declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
|
|
19
|
-
declare function applyCustomOpenAPIOperation(operation:
|
|
20
|
+
declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
|
|
20
21
|
|
|
21
22
|
/**
|
|
22
23
|
* @internal
|
|
@@ -36,42 +37,6 @@ type FileSchema = JSONSchema & {
|
|
|
36
37
|
*/
|
|
37
38
|
declare const LOGIC_KEYWORDS: string[];
|
|
38
39
|
|
|
39
|
-
interface SchemaConvertOptions {
|
|
40
|
-
strategy: 'input' | 'output';
|
|
41
|
-
}
|
|
42
|
-
interface SchemaConverter {
|
|
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>;
|
|
47
|
-
}
|
|
48
|
-
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
49
|
-
private readonly converters;
|
|
50
|
-
constructor(converters: ConditionalSchemaConverter[]);
|
|
51
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
55
|
-
schemaConverters?: ConditionalSchemaConverter[];
|
|
56
|
-
}
|
|
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);
|
|
67
|
-
/**
|
|
68
|
-
* Generates OpenAPI specifications from oRPC routers/contracts.
|
|
69
|
-
*
|
|
70
|
-
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
71
|
-
*/
|
|
72
|
-
generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
40
|
/**
|
|
76
41
|
* @internal
|
|
77
42
|
*/
|
|
@@ -83,15 +48,15 @@ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
|
|
83
48
|
/**
|
|
84
49
|
* @internal
|
|
85
50
|
*/
|
|
86
|
-
declare function toOpenAPIContent(schema: JSONSchema): Record<string,
|
|
51
|
+
declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
|
|
87
52
|
/**
|
|
88
53
|
* @internal
|
|
89
54
|
*/
|
|
90
|
-
declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string,
|
|
55
|
+
declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
|
|
91
56
|
/**
|
|
92
57
|
* @internal
|
|
93
58
|
*/
|
|
94
|
-
declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'):
|
|
59
|
+
declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
|
|
95
60
|
/**
|
|
96
61
|
* @internal
|
|
97
62
|
*/
|
|
@@ -99,7 +64,10 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
|
|
|
99
64
|
/**
|
|
100
65
|
* @internal
|
|
101
66
|
*/
|
|
102
|
-
declare function toOpenAPISchema(schema: JSONSchema):
|
|
67
|
+
declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
|
|
68
|
+
declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
|
|
69
|
+
|
|
70
|
+
declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
|
|
103
71
|
|
|
104
72
|
/**
|
|
105
73
|
*@internal
|
|
@@ -122,10 +90,21 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
|
|
|
122
90
|
*/
|
|
123
91
|
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
|
124
92
|
declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
|
|
93
|
+
/**
|
|
94
|
+
* Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
|
|
95
|
+
* recursively expands it into an array of its constituent, non-union base schemas.
|
|
96
|
+
* If the schema is not a simple union or is a base type, it's returned as a single-element array.
|
|
97
|
+
*/
|
|
98
|
+
declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
|
|
99
|
+
declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
|
|
100
|
+
type: 'array';
|
|
101
|
+
items?: JSONSchema;
|
|
102
|
+
}];
|
|
103
|
+
declare function isPrimitiveSchema(schema: JSONSchema): boolean;
|
|
125
104
|
|
|
126
105
|
declare const oo: {
|
|
127
106
|
spec: typeof customOpenAPIOperation;
|
|
128
107
|
};
|
|
129
108
|
|
|
130
|
-
export {
|
|
131
|
-
export type {
|
|
109
|
+
export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|
|
110
|
+
export type { FileSchema, ObjectSchema, OverrideOperationValue };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
export {
|
|
4
|
-
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
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';
|
|
1
|
+
import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
|
|
2
|
+
export { OpenAPI } from '@orpc/contract';
|
|
3
|
+
export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.TOD62C7O.js';
|
|
9
4
|
import { HTTPPath, HTTPMethod } from '@orpc/client';
|
|
5
|
+
import { JSONSchema } from '@orpc/json-schema-typed/draft-2020-12';
|
|
6
|
+
export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@orpc/json-schema-typed/draft-2020-12';
|
|
7
|
+
import { JsonifiedClient } from '@orpc/openapi-client';
|
|
8
|
+
import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
|
|
9
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
10
|
+
import '@orpc/openapi-client/standard';
|
|
10
11
|
|
|
11
|
-
type OverrideOperationValue = Partial<
|
|
12
|
+
type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
|
|
12
13
|
/**
|
|
13
14
|
* Customize The Operation Object by proxy an error map item or a middleware.
|
|
14
15
|
*
|
|
@@ -16,7 +17,7 @@ type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current:
|
|
|
16
17
|
*/
|
|
17
18
|
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
|
18
19
|
declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
|
|
19
|
-
declare function applyCustomOpenAPIOperation(operation:
|
|
20
|
+
declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
|
|
20
21
|
|
|
21
22
|
/**
|
|
22
23
|
* @internal
|
|
@@ -36,42 +37,6 @@ type FileSchema = JSONSchema & {
|
|
|
36
37
|
*/
|
|
37
38
|
declare const LOGIC_KEYWORDS: string[];
|
|
38
39
|
|
|
39
|
-
interface SchemaConvertOptions {
|
|
40
|
-
strategy: 'input' | 'output';
|
|
41
|
-
}
|
|
42
|
-
interface SchemaConverter {
|
|
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>;
|
|
47
|
-
}
|
|
48
|
-
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
49
|
-
private readonly converters;
|
|
50
|
-
constructor(converters: ConditionalSchemaConverter[]);
|
|
51
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
55
|
-
schemaConverters?: ConditionalSchemaConverter[];
|
|
56
|
-
}
|
|
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);
|
|
67
|
-
/**
|
|
68
|
-
* Generates OpenAPI specifications from oRPC routers/contracts.
|
|
69
|
-
*
|
|
70
|
-
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
71
|
-
*/
|
|
72
|
-
generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
40
|
/**
|
|
76
41
|
* @internal
|
|
77
42
|
*/
|
|
@@ -83,15 +48,15 @@ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
|
|
83
48
|
/**
|
|
84
49
|
* @internal
|
|
85
50
|
*/
|
|
86
|
-
declare function toOpenAPIContent(schema: JSONSchema): Record<string,
|
|
51
|
+
declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
|
|
87
52
|
/**
|
|
88
53
|
* @internal
|
|
89
54
|
*/
|
|
90
|
-
declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string,
|
|
55
|
+
declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
|
|
91
56
|
/**
|
|
92
57
|
* @internal
|
|
93
58
|
*/
|
|
94
|
-
declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'):
|
|
59
|
+
declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
|
|
95
60
|
/**
|
|
96
61
|
* @internal
|
|
97
62
|
*/
|
|
@@ -99,7 +64,10 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
|
|
|
99
64
|
/**
|
|
100
65
|
* @internal
|
|
101
66
|
*/
|
|
102
|
-
declare function toOpenAPISchema(schema: JSONSchema):
|
|
67
|
+
declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
|
|
68
|
+
declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
|
|
69
|
+
|
|
70
|
+
declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
|
|
103
71
|
|
|
104
72
|
/**
|
|
105
73
|
*@internal
|
|
@@ -122,10 +90,21 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
|
|
|
122
90
|
*/
|
|
123
91
|
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
|
124
92
|
declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
|
|
93
|
+
/**
|
|
94
|
+
* Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
|
|
95
|
+
* recursively expands it into an array of its constituent, non-union base schemas.
|
|
96
|
+
* If the schema is not a simple union or is a base type, it's returned as a single-element array.
|
|
97
|
+
*/
|
|
98
|
+
declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
|
|
99
|
+
declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
|
|
100
|
+
type: 'array';
|
|
101
|
+
items?: JSONSchema;
|
|
102
|
+
}];
|
|
103
|
+
declare function isPrimitiveSchema(schema: JSONSchema): boolean;
|
|
125
104
|
|
|
126
105
|
declare const oo: {
|
|
127
106
|
spec: typeof customOpenAPIOperation;
|
|
128
107
|
};
|
|
129
108
|
|
|
130
|
-
export {
|
|
131
|
-
export type {
|
|
109
|
+
export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|
|
110
|
+
export type { FileSchema, ObjectSchema, OverrideOperationValue };
|