@orpc/openapi 0.0.0-next.f4d410a → 0.0.0-next.f4ed9ab
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 +25 -17
- package/dist/adapters/fetch/index.d.mts +11 -9
- package/dist/adapters/fetch/index.d.ts +11 -9
- package/dist/adapters/fetch/index.mjs +14 -7
- package/dist/adapters/node/index.d.mts +11 -9
- package/dist/adapters/node/index.d.ts +11 -9
- package/dist/adapters/node/index.mjs +9 -26
- package/dist/adapters/standard/index.d.mts +3 -3
- package/dist/adapters/standard/index.d.ts +3 -3
- package/dist/adapters/standard/index.mjs +5 -3
- package/dist/index.d.mts +24 -39
- package/dist/index.d.ts +24 -39
- package/dist/index.mjs +30 -292
- package/dist/plugins/index.d.mts +70 -0
- package/dist/plugins/index.d.ts +70 -0
- package/dist/plugins/index.mjs +108 -0
- package/dist/shared/{openapi.BNHmrMe2.mjs → openapi.C_UtQ8Us.mjs} +44 -10
- package/dist/shared/openapi.CwdCLgSU.d.mts +53 -0
- package/dist/shared/openapi.CwdCLgSU.d.ts +53 -0
- package/dist/shared/openapi.D3j94c9n.d.mts +12 -0
- package/dist/shared/openapi.D3j94c9n.d.ts +12 -0
- package/dist/shared/openapi.PDTdnRIU.mjs +595 -0
- package/package.json +14 -21
- package/dist/adapters/hono/index.d.mts +0 -8
- package/dist/adapters/hono/index.d.ts +0 -8
- package/dist/adapters/hono/index.mjs +0 -11
- package/dist/adapters/next/index.d.mts +0 -8
- package/dist/adapters/next/index.d.ts +0 -8
- package/dist/adapters/next/index.mjs +0 -11
- package/dist/shared/openapi.DZzpQAb-.mjs +0 -231
- package/dist/shared/openapi.Dv-KT_Bx.mjs +0 -33
- package/dist/shared/openapi.IfmmOyba.d.mts +0 -8
- package/dist/shared/openapi.IfmmOyba.d.ts +0 -8
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
|
+
- **⚙️ 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,6 +49,8 @@ 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/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
|
|
53
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
56
54
|
- [@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
55
|
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
|
58
56
|
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
|
@@ -60,6 +58,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
60
58
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
61
59
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
62
60
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
61
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
62
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
63
63
|
|
|
64
64
|
## `@orpc/openapi`
|
|
65
65
|
|
|
@@ -88,6 +88,14 @@ const server = createServer(async (req, res) => {
|
|
|
88
88
|
server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
+
## Sponsors
|
|
92
|
+
|
|
93
|
+
<p align="center">
|
|
94
|
+
<a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
|
|
95
|
+
<img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
|
|
96
|
+
</a>
|
|
97
|
+
</p>
|
|
98
|
+
|
|
91
99
|
## License
|
|
92
100
|
|
|
93
101
|
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import { FetchHandler,
|
|
3
|
-
import {
|
|
4
|
-
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
5
|
-
import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
|
6
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.mjs';
|
|
2
|
+
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
|
|
7
4
|
import '@orpc/openapi-client/standard';
|
|
5
|
+
import '@orpc/server/standard';
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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/adapters/http HTTP Adapter Docs}
|
|
12
|
+
*/
|
|
13
|
+
declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
|
|
14
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
|
|
13
15
|
}
|
|
14
16
|
|
|
15
17
|
export { OpenAPIHandler };
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import { FetchHandler,
|
|
3
|
-
import {
|
|
4
|
-
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
5
|
-
import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
|
6
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.js';
|
|
2
|
+
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
|
|
7
4
|
import '@orpc/openapi-client/standard';
|
|
5
|
+
import '@orpc/server/standard';
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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/adapters/http HTTP Adapter Docs}
|
|
12
|
+
*/
|
|
13
|
+
declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
|
|
14
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
|
|
13
15
|
}
|
|
14
16
|
|
|
15
17
|
export { OpenAPIHandler };
|
|
@@ -1,11 +1,18 @@
|
|
|
1
|
-
|
|
2
|
-
import '@orpc/
|
|
3
|
-
import '@orpc/server/standard';
|
|
4
|
-
import '@orpc/standard-server-fetch';
|
|
5
|
-
import '../../shared/openapi.BNHmrMe2.mjs';
|
|
1
|
+
import { FetchHandler } from '@orpc/server/fetch';
|
|
2
|
+
import '@orpc/client';
|
|
6
3
|
import '@orpc/contract';
|
|
7
4
|
import '@orpc/shared';
|
|
5
|
+
import { a as StandardOpenAPIHandler } from '../../shared/openapi.C_UtQ8Us.mjs';
|
|
6
|
+
import '@orpc/client/standard';
|
|
8
7
|
import '@orpc/server';
|
|
9
8
|
import 'rou3';
|
|
10
|
-
import '
|
|
11
|
-
import '
|
|
9
|
+
import '@orpc/openapi-client/standard';
|
|
10
|
+
import '@orpc/server/standard';
|
|
11
|
+
|
|
12
|
+
class OpenAPIHandler extends FetchHandler {
|
|
13
|
+
constructor(router, options = {}) {
|
|
14
|
+
super(new StandardOpenAPIHandler(router, options), options);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export { OpenAPIHandler };
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import { NodeHttpHandler,
|
|
3
|
-
import {
|
|
4
|
-
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
5
|
-
import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
|
6
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.mjs';
|
|
2
|
+
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
|
|
7
4
|
import '@orpc/openapi-client/standard';
|
|
5
|
+
import '@orpc/server/standard';
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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/adapters/http HTTP Adapter Docs}
|
|
12
|
+
*/
|
|
13
|
+
declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
|
|
14
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
|
|
13
15
|
}
|
|
14
16
|
|
|
15
17
|
export { OpenAPIHandler };
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import { NodeHttpHandler,
|
|
3
|
-
import {
|
|
4
|
-
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
5
|
-
import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
|
6
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.js';
|
|
2
|
+
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
|
|
7
4
|
import '@orpc/openapi-client/standard';
|
|
5
|
+
import '@orpc/server/standard';
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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/adapters/http HTTP Adapter Docs}
|
|
12
|
+
*/
|
|
13
|
+
declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
|
|
14
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
|
|
13
15
|
}
|
|
14
16
|
|
|
15
17
|
export { OpenAPIHandler };
|
|
@@ -1,34 +1,17 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import
|
|
3
|
-
import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
|
|
4
|
-
import { a as StandardOpenAPIMatcher, S as StandardOpenAPICodec } from '../../shared/openapi.BNHmrMe2.mjs';
|
|
5
|
-
import '@orpc/shared';
|
|
6
|
-
import 'json-schema-typed/draft-2020-12';
|
|
1
|
+
import { NodeHttpHandler } from '@orpc/server/node';
|
|
2
|
+
import '@orpc/client';
|
|
7
3
|
import '@orpc/contract';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
import { a as StandardOpenAPIHandler } from '../../shared/openapi.C_UtQ8Us.mjs';
|
|
6
|
+
import '@orpc/client/standard';
|
|
8
7
|
import '@orpc/server';
|
|
9
8
|
import 'rou3';
|
|
10
|
-
import '
|
|
9
|
+
import '@orpc/openapi-client/standard';
|
|
10
|
+
import '@orpc/server/standard';
|
|
11
11
|
|
|
12
|
-
class OpenAPIHandler {
|
|
13
|
-
standardHandler;
|
|
12
|
+
class OpenAPIHandler extends NodeHttpHandler {
|
|
14
13
|
constructor(router, options = {}) {
|
|
15
|
-
|
|
16
|
-
const bracketNotationSerializer = new StandardBracketNotationSerializer();
|
|
17
|
-
const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
|
|
18
|
-
const matcher = new StandardOpenAPIMatcher();
|
|
19
|
-
const codec = new StandardOpenAPICodec(serializer);
|
|
20
|
-
this.standardHandler = new StandardHandler(router, matcher, codec, options);
|
|
21
|
-
}
|
|
22
|
-
async handle(req, res, ...[
|
|
23
|
-
options = {}
|
|
24
|
-
]) {
|
|
25
|
-
const standardRequest = toStandardLazyRequest(req, res);
|
|
26
|
-
const result = await this.standardHandler.handle(standardRequest, options);
|
|
27
|
-
if (!result.matched) {
|
|
28
|
-
return { matched: false };
|
|
29
|
-
}
|
|
30
|
-
await sendStandardResponse(res, result.response, options);
|
|
31
|
-
return { matched: true };
|
|
14
|
+
super(new StandardOpenAPIHandler(router, options), options);
|
|
32
15
|
}
|
|
33
16
|
}
|
|
34
17
|
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { ORPCError } from '@orpc/client';
|
|
1
|
+
import { ORPCError, HTTPPath } from '@orpc/client';
|
|
2
2
|
import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
3
3
|
import { AnyProcedure, AnyRouter } from '@orpc/server';
|
|
4
4
|
import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
|
|
5
5
|
import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
|
6
|
-
export { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
7
|
-
import { HTTPPath } from '@orpc/contract';
|
|
6
|
+
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
|
|
8
7
|
|
|
9
8
|
declare class StandardOpenAPICodec implements StandardCodec {
|
|
9
|
+
#private;
|
|
10
10
|
private readonly serializer;
|
|
11
11
|
constructor(serializer: StandardOpenAPISerializer);
|
|
12
12
|
decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { ORPCError } from '@orpc/client';
|
|
1
|
+
import { ORPCError, HTTPPath } from '@orpc/client';
|
|
2
2
|
import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
3
3
|
import { AnyProcedure, AnyRouter } from '@orpc/server';
|
|
4
4
|
import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
|
|
5
5
|
import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
|
6
|
-
export { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
7
|
-
import { HTTPPath } from '@orpc/contract';
|
|
6
|
+
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
|
|
8
7
|
|
|
9
8
|
declare class StandardOpenAPICodec implements StandardCodec {
|
|
9
|
+
#private;
|
|
10
10
|
private readonly serializer;
|
|
11
11
|
constructor(serializer: StandardOpenAPISerializer);
|
|
12
12
|
decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
export { S as StandardOpenAPICodec, a 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.C_UtQ8Us.mjs';
|
|
2
|
+
import '@orpc/openapi-client/standard';
|
|
3
|
+
import '@orpc/server/standard';
|
|
4
|
+
import '@orpc/client';
|
|
2
5
|
import '@orpc/contract';
|
|
3
6
|
import '@orpc/shared';
|
|
7
|
+
import '@orpc/client/standard';
|
|
4
8
|
import '@orpc/server';
|
|
5
9
|
import 'rou3';
|
|
6
|
-
import '../../shared/openapi.DZzpQAb-.mjs';
|
|
7
|
-
import 'json-schema-typed/draft-2020-12';
|
package/dist/index.d.mts
CHANGED
|
@@ -1,12 +1,21 @@
|
|
|
1
|
-
import { AnyContractProcedure
|
|
1
|
+
import { AnyContractProcedure } from '@orpc/contract';
|
|
2
2
|
import { OpenAPIV3_1 } from 'openapi-types';
|
|
3
3
|
export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
|
|
4
|
-
|
|
5
|
-
import {
|
|
4
|
+
export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.CwdCLgSU.mjs';
|
|
5
|
+
import { HTTPPath, HTTPMethod } from '@orpc/client';
|
|
6
6
|
import { JSONSchema } from 'json-schema-typed/draft-2020-12';
|
|
7
|
-
export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
|
7
|
+
export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
|
8
|
+
import { JsonifiedClient } from '@orpc/openapi-client';
|
|
9
|
+
import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
|
|
10
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
11
|
+
import '@orpc/openapi-client/standard';
|
|
8
12
|
|
|
9
13
|
type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
|
|
14
|
+
/**
|
|
15
|
+
* Customize The Operation Object by proxy an error map item or a middleware.
|
|
16
|
+
*
|
|
17
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
|
|
18
|
+
*/
|
|
10
19
|
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
|
11
20
|
declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
|
|
12
21
|
declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
|
|
@@ -29,36 +38,6 @@ type FileSchema = JSONSchema & {
|
|
|
29
38
|
*/
|
|
30
39
|
declare const LOGIC_KEYWORDS: string[];
|
|
31
40
|
|
|
32
|
-
interface SchemaConvertOptions {
|
|
33
|
-
strategy: 'input' | 'output';
|
|
34
|
-
}
|
|
35
|
-
interface SchemaConverter {
|
|
36
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
37
|
-
}
|
|
38
|
-
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
39
|
-
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
|
|
40
|
-
}
|
|
41
|
-
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
42
|
-
private readonly converters;
|
|
43
|
-
constructor(converters: ConditionalSchemaConverter[]);
|
|
44
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
48
|
-
schemaConverters?: ConditionalSchemaConverter[];
|
|
49
|
-
}
|
|
50
|
-
declare class OpenAPIGenerator {
|
|
51
|
-
#private;
|
|
52
|
-
private readonly serializer;
|
|
53
|
-
private readonly converter;
|
|
54
|
-
constructor(options?: OpenAPIGeneratorOptions);
|
|
55
|
-
generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* @internal
|
|
60
|
-
*/
|
|
61
|
-
declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
|
|
62
41
|
/**
|
|
63
42
|
* @internal
|
|
64
43
|
*/
|
|
@@ -67,10 +46,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
|
|
|
67
46
|
* @internal
|
|
68
47
|
*/
|
|
69
48
|
declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
|
70
|
-
/**
|
|
71
|
-
* @internal
|
|
72
|
-
*/
|
|
73
|
-
declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
|
|
74
49
|
/**
|
|
75
50
|
* @internal
|
|
76
51
|
*/
|
|
@@ -92,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
|
|
|
92
67
|
*/
|
|
93
68
|
declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
|
|
94
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>>;
|
|
71
|
+
|
|
95
72
|
/**
|
|
96
73
|
*@internal
|
|
97
74
|
*/
|
|
@@ -112,9 +89,17 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
|
|
|
112
89
|
* @internal
|
|
113
90
|
*/
|
|
114
91
|
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
|
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[];
|
|
115
99
|
|
|
116
100
|
declare const oo: {
|
|
117
101
|
spec: typeof customOpenAPIOperation;
|
|
118
102
|
};
|
|
119
103
|
|
|
120
|
-
export {
|
|
104
|
+
export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|
|
105
|
+
export type { FileSchema, ObjectSchema, OverrideOperationValue };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,12 +1,21 @@
|
|
|
1
|
-
import { AnyContractProcedure
|
|
1
|
+
import { AnyContractProcedure } from '@orpc/contract';
|
|
2
2
|
import { OpenAPIV3_1 } from 'openapi-types';
|
|
3
3
|
export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
|
|
4
|
-
|
|
5
|
-
import {
|
|
4
|
+
export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.CwdCLgSU.js';
|
|
5
|
+
import { HTTPPath, HTTPMethod } from '@orpc/client';
|
|
6
6
|
import { JSONSchema } from 'json-schema-typed/draft-2020-12';
|
|
7
|
-
export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
|
7
|
+
export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
|
8
|
+
import { JsonifiedClient } from '@orpc/openapi-client';
|
|
9
|
+
import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
|
|
10
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
11
|
+
import '@orpc/openapi-client/standard';
|
|
8
12
|
|
|
9
13
|
type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
|
|
14
|
+
/**
|
|
15
|
+
* Customize The Operation Object by proxy an error map item or a middleware.
|
|
16
|
+
*
|
|
17
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
|
|
18
|
+
*/
|
|
10
19
|
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
|
11
20
|
declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
|
|
12
21
|
declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
|
|
@@ -29,36 +38,6 @@ type FileSchema = JSONSchema & {
|
|
|
29
38
|
*/
|
|
30
39
|
declare const LOGIC_KEYWORDS: string[];
|
|
31
40
|
|
|
32
|
-
interface SchemaConvertOptions {
|
|
33
|
-
strategy: 'input' | 'output';
|
|
34
|
-
}
|
|
35
|
-
interface SchemaConverter {
|
|
36
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
37
|
-
}
|
|
38
|
-
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
39
|
-
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
|
|
40
|
-
}
|
|
41
|
-
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
42
|
-
private readonly converters;
|
|
43
|
-
constructor(converters: ConditionalSchemaConverter[]);
|
|
44
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
48
|
-
schemaConverters?: ConditionalSchemaConverter[];
|
|
49
|
-
}
|
|
50
|
-
declare class OpenAPIGenerator {
|
|
51
|
-
#private;
|
|
52
|
-
private readonly serializer;
|
|
53
|
-
private readonly converter;
|
|
54
|
-
constructor(options?: OpenAPIGeneratorOptions);
|
|
55
|
-
generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* @internal
|
|
60
|
-
*/
|
|
61
|
-
declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
|
|
62
41
|
/**
|
|
63
42
|
* @internal
|
|
64
43
|
*/
|
|
@@ -67,10 +46,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
|
|
|
67
46
|
* @internal
|
|
68
47
|
*/
|
|
69
48
|
declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
|
70
|
-
/**
|
|
71
|
-
* @internal
|
|
72
|
-
*/
|
|
73
|
-
declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
|
|
74
49
|
/**
|
|
75
50
|
* @internal
|
|
76
51
|
*/
|
|
@@ -92,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
|
|
|
92
67
|
*/
|
|
93
68
|
declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
|
|
94
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>>;
|
|
71
|
+
|
|
95
72
|
/**
|
|
96
73
|
*@internal
|
|
97
74
|
*/
|
|
@@ -112,9 +89,17 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
|
|
|
112
89
|
* @internal
|
|
113
90
|
*/
|
|
114
91
|
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
|
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[];
|
|
115
99
|
|
|
116
100
|
declare const oo: {
|
|
117
101
|
spec: typeof customOpenAPIOperation;
|
|
118
102
|
};
|
|
119
103
|
|
|
120
|
-
export {
|
|
104
|
+
export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|
|
105
|
+
export type { FileSchema, ObjectSchema, OverrideOperationValue };
|