@orpc/openapi 1.14.10 → 1.14.11
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 +52 -71
- package/dist/adapters/fetch/index.d.mts +20 -16
- package/dist/adapters/fetch/index.d.ts +20 -16
- package/dist/adapters/fetch/index.mjs +24 -8
- package/dist/adapters/node/index.d.mts +8 -13
- package/dist/adapters/node/index.d.ts +8 -13
- package/dist/adapters/node/index.mjs +10 -7
- package/dist/adapters/standard/index.d.mts +46 -16
- package/dist/adapters/standard/index.d.ts +46 -16
- package/dist/adapters/standard/index.mjs +9 -6
- package/dist/extensions/route.d.mts +43 -0
- package/dist/extensions/route.d.ts +43 -0
- package/dist/extensions/route.mjs +14 -0
- package/dist/helpers/index.d.mts +51 -0
- package/dist/helpers/index.d.ts +51 -0
- package/dist/helpers/index.mjs +39 -0
- package/dist/index.d.mts +117 -105
- package/dist/index.d.ts +117 -105
- package/dist/index.mjs +850 -32
- package/dist/plugins/index.d.mts +55 -51
- package/dist/plugins/index.d.ts +55 -51
- package/dist/plugins/index.mjs +147 -142
- package/dist/shared/openapi.B6hEbRyF.d.ts +83 -0
- package/dist/shared/openapi.B9PQzqBn.mjs +49 -0
- package/dist/shared/openapi.BOOA-bde.d.mts +142 -0
- package/dist/shared/openapi.BOOA-bde.d.ts +142 -0
- package/dist/shared/openapi.BafbB3uM.d.mts +83 -0
- package/dist/shared/openapi.Bt87OzTt.mjs +131 -0
- package/dist/shared/openapi.ByT4oUeY.d.mts +18 -0
- package/dist/shared/openapi.ByT4oUeY.d.ts +18 -0
- package/dist/shared/openapi.C-p_Q2lb.mjs +359 -0
- package/dist/shared/openapi.CVgUshDP.mjs +318 -0
- package/dist/shared/openapi.DNNo0V-l.d.ts +313 -0
- package/dist/shared/openapi.hg_rhZ4x.d.mts +313 -0
- package/dist/shared/openapi.zZH_UksW.mjs +278 -0
- package/package.json +46 -24
- package/dist/adapters/aws-lambda/index.d.mts +0 -20
- package/dist/adapters/aws-lambda/index.d.ts +0 -20
- package/dist/adapters/aws-lambda/index.mjs +0 -18
- package/dist/adapters/fastify/index.d.mts +0 -23
- package/dist/adapters/fastify/index.d.ts +0 -23
- package/dist/adapters/fastify/index.mjs +0 -18
- package/dist/shared/openapi.BB-W-NKv.mjs +0 -204
- package/dist/shared/openapi.BGy4N6eR.d.mts +0 -120
- package/dist/shared/openapi.BGy4N6eR.d.ts +0 -120
- package/dist/shared/openapi.BwdtJjDu.mjs +0 -878
- package/dist/shared/openapi.DwaweYRb.d.mts +0 -54
- package/dist/shared/openapi.DwaweYRb.d.ts +0 -54
package/README.md
CHANGED
|
@@ -1,17 +1,16 @@
|
|
|
1
|
-
<
|
|
2
|
-
<image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
|
|
3
|
-
</div>
|
|
4
|
-
|
|
5
|
-
<h1></h1>
|
|
1
|
+
<h1 align="center">oRPC - Typesafe APIs Made Simple 🪄</h1>
|
|
6
2
|
|
|
7
3
|
<div align="center">
|
|
8
4
|
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
9
|
-
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/
|
|
5
|
+
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
|
|
10
6
|
</a>
|
|
11
7
|
<a href="https://www.npmjs.com/package/@orpc/openapi">
|
|
12
8
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fopenapi?logo=npm" />
|
|
13
9
|
</a>
|
|
14
|
-
<a href="https://
|
|
10
|
+
<a href="https://app.codspeed.io/middleapi/orpc?utm_source=badge">
|
|
11
|
+
<img alt="CodSpeed" src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" />
|
|
12
|
+
</a>
|
|
13
|
+
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
15
14
|
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
16
15
|
</a>
|
|
17
16
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
@@ -22,78 +21,53 @@
|
|
|
22
21
|
</a>
|
|
23
22
|
</div>
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
## Documentation
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
You can read the documentation [here](https://orpc.dev).
|
|
28
27
|
|
|
29
|
-
|
|
28
|
+
## Packages
|
|
30
29
|
|
|
31
|
-
|
|
30
|
+
**Core**
|
|
32
31
|
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
|
|
38
|
-
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
39
|
-
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
40
|
-
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
41
|
-
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
|
42
|
-
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
43
|
-
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
44
|
-
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
32
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define API contract as the single source of truth.
|
|
33
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
|
|
34
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
|
|
35
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
|
|
45
36
|
|
|
46
|
-
|
|
37
|
+
**Schema validation**
|
|
47
38
|
|
|
48
|
-
|
|
39
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
|
|
40
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
41
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
49
42
|
|
|
50
|
-
|
|
43
|
+
**Built-in features**
|
|
44
|
+
|
|
45
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
|
|
46
|
+
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
|
|
47
|
+
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
51
48
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
- [@orpc/
|
|
55
|
-
- [@orpc/
|
|
56
|
-
- [@orpc/
|
|
57
|
-
- [@orpc/
|
|
58
|
-
- [@orpc/
|
|
59
|
-
- [@orpc/
|
|
60
|
-
- [@orpc/
|
|
61
|
-
- [@orpc/
|
|
62
|
-
- [@orpc/
|
|
63
|
-
- [@orpc/
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
```ts
|
|
72
|
-
import { createServer } from 'node:http'
|
|
73
|
-
import { OpenAPIHandler } from '@orpc/openapi/node'
|
|
74
|
-
import { CORSPlugin } from '@orpc/server/plugins'
|
|
75
|
-
|
|
76
|
-
const handler = new OpenAPIHandler(router, {
|
|
77
|
-
plugins: [new CORSPlugin()]
|
|
78
|
-
})
|
|
79
|
-
|
|
80
|
-
const server = createServer(async (req, res) => {
|
|
81
|
-
const result = await handler.handle(req, res, {
|
|
82
|
-
context: { headers: req.headers }
|
|
83
|
-
})
|
|
84
|
-
|
|
85
|
-
if (!result.matched) {
|
|
86
|
-
res.statusCode = 404
|
|
87
|
-
res.end('No procedure matched')
|
|
88
|
-
}
|
|
89
|
-
})
|
|
90
|
-
|
|
91
|
-
server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
|
|
92
|
-
```
|
|
49
|
+
**Framework & ecosystem integrations**
|
|
50
|
+
|
|
51
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
52
|
+
- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
|
|
53
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
54
|
+
- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
55
|
+
- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
|
|
56
|
+
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
57
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
|
|
58
|
+
- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
|
|
59
|
+
- [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
|
|
60
|
+
- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
|
|
61
|
+
|
|
62
|
+
**Observability**
|
|
63
|
+
|
|
64
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
|
|
65
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
|
|
66
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
|
|
93
67
|
|
|
94
68
|
## Sponsors
|
|
95
69
|
|
|
96
|
-
|
|
70
|
+
Like what we build over at [middleapi](https://github.com/middleapi)? You can help keep it going here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh). Every bit helps! 🚀
|
|
97
71
|
|
|
98
72
|
### 🏆 Platinum Sponsor
|
|
99
73
|
|
|
@@ -135,11 +109,10 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
135
109
|
<td align="center"><a href="https://github.com/valerii15298?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&v=4" width="139" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
|
|
136
110
|
<td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&v=4" width="139" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
137
111
|
<td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&v=4" width="139" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
138
|
-
<td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
|
|
139
112
|
<td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
|
|
113
|
+
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
140
114
|
</tr>
|
|
141
115
|
<tr>
|
|
142
|
-
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
143
116
|
<td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&v=4" width="139" alt="shota"/><br />shota</a></td>
|
|
144
117
|
</tr>
|
|
145
118
|
</table>
|
|
@@ -199,6 +172,7 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
199
172
|
<a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="Lê Cao Nguyên"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&v=4" width="32" height="32" alt="Lê Cao Nguyên" /></a>
|
|
200
173
|
<a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&v=4" width="32" height="32" alt="Robert Soriano" /></a>
|
|
201
174
|
<a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="32" height="32" alt="Andrew Peters" /></a>
|
|
175
|
+
<a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="32" height="32" alt="Ryan Vogel" /></a>
|
|
202
176
|
<a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
|
|
203
177
|
<a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="32" height="32" alt="Peter Adam" /></a>
|
|
204
178
|
<a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
|
|
@@ -213,6 +187,13 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
213
187
|
<a href="https://github.com/plancraft?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="32" height="32" alt="plancraft" /></a>
|
|
214
188
|
</p>
|
|
215
189
|
|
|
190
|
+
## References
|
|
191
|
+
|
|
192
|
+
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
|
|
193
|
+
|
|
194
|
+
- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
|
|
195
|
+
- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
|
|
196
|
+
|
|
216
197
|
## License
|
|
217
198
|
|
|
218
|
-
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/
|
|
199
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
|
|
@@ -1,23 +1,27 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import '
|
|
5
|
-
import '@orpc/
|
|
6
|
-
import '@orpc/client';
|
|
7
|
-
import '@orpc/standard
|
|
2
|
+
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
+
import { StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
|
+
import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.BafbB3uM.mjs';
|
|
5
|
+
import { ClientContext } from '@orpc/client';
|
|
6
|
+
import { FetchLinkTransportOptions } from '@orpc/client/fetch';
|
|
7
|
+
import { StandardLink, StandardLinkOptions } from '@orpc/client/standard';
|
|
8
|
+
import { RouterContract } from '@orpc/contract';
|
|
9
|
+
import { OpenAPILinkCodecOptions } from '../standard/index.mjs';
|
|
8
10
|
import '@orpc/shared';
|
|
11
|
+
import '@standardserver/core';
|
|
12
|
+
import '../../shared/openapi.BOOA-bde.mjs';
|
|
9
13
|
|
|
10
|
-
interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<
|
|
14
|
+
interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, OpenAPIHandlerCodecOptions<T> {
|
|
11
15
|
}
|
|
12
|
-
/**
|
|
13
|
-
* OpenAPI Handler for Fetch Server
|
|
14
|
-
*
|
|
15
|
-
* @see {@link https://orpc.dev/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
16
|
-
* @see {@link https://orpc.dev/docs/adapters/http HTTP Adapter Docs}
|
|
17
|
-
*/
|
|
18
16
|
declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
|
|
19
|
-
constructor(router: Router<
|
|
17
|
+
constructor(router: Router<T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
|
|
20
18
|
}
|
|
21
19
|
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
interface OpenAPILinkOptions<T extends ClientContext> extends Omit<StandardLinkOptions<T>, 'plugins'>, FetchLinkTransportOptions<T>, OpenAPILinkCodecOptions<T> {
|
|
21
|
+
}
|
|
22
|
+
declare class OpenAPILink<T extends ClientContext> extends StandardLink<T> {
|
|
23
|
+
constructor(router: RouterContract, options?: OpenAPILinkOptions<T>);
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export { OpenAPIHandler, OpenAPILink };
|
|
27
|
+
export type { OpenAPIHandlerOptions, OpenAPILinkOptions };
|
|
@@ -1,23 +1,27 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import '
|
|
5
|
-
import '@orpc/
|
|
6
|
-
import '@orpc/client';
|
|
7
|
-
import '@orpc/standard
|
|
2
|
+
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
+
import { StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
|
+
import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.B6hEbRyF.js';
|
|
5
|
+
import { ClientContext } from '@orpc/client';
|
|
6
|
+
import { FetchLinkTransportOptions } from '@orpc/client/fetch';
|
|
7
|
+
import { StandardLink, StandardLinkOptions } from '@orpc/client/standard';
|
|
8
|
+
import { RouterContract } from '@orpc/contract';
|
|
9
|
+
import { OpenAPILinkCodecOptions } from '../standard/index.js';
|
|
8
10
|
import '@orpc/shared';
|
|
11
|
+
import '@standardserver/core';
|
|
12
|
+
import '../../shared/openapi.BOOA-bde.js';
|
|
9
13
|
|
|
10
|
-
interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<
|
|
14
|
+
interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, OpenAPIHandlerCodecOptions<T> {
|
|
11
15
|
}
|
|
12
|
-
/**
|
|
13
|
-
* OpenAPI Handler for Fetch Server
|
|
14
|
-
*
|
|
15
|
-
* @see {@link https://orpc.dev/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
16
|
-
* @see {@link https://orpc.dev/docs/adapters/http HTTP Adapter Docs}
|
|
17
|
-
*/
|
|
18
16
|
declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
|
|
19
|
-
constructor(router: Router<
|
|
17
|
+
constructor(router: Router<T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
|
|
20
18
|
}
|
|
21
19
|
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
interface OpenAPILinkOptions<T extends ClientContext> extends Omit<StandardLinkOptions<T>, 'plugins'>, FetchLinkTransportOptions<T>, OpenAPILinkCodecOptions<T> {
|
|
21
|
+
}
|
|
22
|
+
declare class OpenAPILink<T extends ClientContext> extends StandardLink<T> {
|
|
23
|
+
constructor(router: RouterContract, options?: OpenAPILinkOptions<T>);
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export { OpenAPIHandler, OpenAPILink };
|
|
27
|
+
export type { OpenAPIHandlerOptions, OpenAPILinkOptions };
|
|
@@ -1,18 +1,34 @@
|
|
|
1
1
|
import { FetchHandler } from '@orpc/server/fetch';
|
|
2
|
-
import {
|
|
3
|
-
import '
|
|
4
|
-
import '@orpc/
|
|
2
|
+
import { StandardHandler } from '@orpc/server/standard';
|
|
3
|
+
import { O as OpenAPIHandlerCodec } from '../../shared/openapi.CVgUshDP.mjs';
|
|
4
|
+
import { FetchLinkTransport } from '@orpc/client/fetch';
|
|
5
|
+
import { StandardLink } from '@orpc/client/standard';
|
|
6
|
+
import { O as OpenAPILinkCodec } from '../../shared/openapi.C-p_Q2lb.mjs';
|
|
5
7
|
import '@orpc/client';
|
|
6
|
-
import '@orpc/contract';
|
|
7
|
-
import '@orpc/shared';
|
|
8
|
-
import '@orpc/client/standard';
|
|
9
8
|
import '@orpc/server';
|
|
9
|
+
import '@orpc/shared';
|
|
10
|
+
import '@standardserver/core';
|
|
11
|
+
import '../../shared/openapi.zZH_UksW.mjs';
|
|
12
|
+
import '../../shared/openapi.Bt87OzTt.mjs';
|
|
13
|
+
import '../../shared/openapi.B9PQzqBn.mjs';
|
|
10
14
|
import 'rou3';
|
|
15
|
+
import '@orpc/contract';
|
|
16
|
+
import '@standardserver/fetch';
|
|
11
17
|
|
|
12
18
|
class OpenAPIHandler extends FetchHandler {
|
|
13
19
|
constructor(router, options = {}) {
|
|
14
|
-
|
|
20
|
+
const codec = new OpenAPIHandlerCodec(router, options);
|
|
21
|
+
const handler = new StandardHandler(codec, options);
|
|
22
|
+
super(handler, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
class OpenAPILink extends StandardLink {
|
|
27
|
+
constructor(router, options = {}) {
|
|
28
|
+
const codec = new OpenAPILinkCodec(router, options);
|
|
29
|
+
const transport = new FetchLinkTransport(options);
|
|
30
|
+
super(codec, transport, options);
|
|
15
31
|
}
|
|
16
32
|
}
|
|
17
33
|
|
|
18
|
-
export { OpenAPIHandler };
|
|
34
|
+
export { OpenAPIHandler, OpenAPILink };
|
|
@@ -1,22 +1,17 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import '
|
|
5
|
-
import '@orpc/server/standard';
|
|
2
|
+
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
+
import { StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
|
+
import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.BafbB3uM.mjs';
|
|
6
5
|
import '@orpc/client';
|
|
7
|
-
import '@orpc/standard-server';
|
|
8
6
|
import '@orpc/shared';
|
|
7
|
+
import '@standardserver/core';
|
|
8
|
+
import '@orpc/contract';
|
|
9
|
+
import '../../shared/openapi.BOOA-bde.mjs';
|
|
9
10
|
|
|
10
|
-
interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<
|
|
11
|
+
interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, OpenAPIHandlerCodecOptions<T> {
|
|
11
12
|
}
|
|
12
|
-
/**
|
|
13
|
-
* OpenAPI Handler for Node Server
|
|
14
|
-
*
|
|
15
|
-
* @see {@link https://orpc.dev/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
16
|
-
* @see {@link https://orpc.dev/docs/adapters/http HTTP Adapter Docs}
|
|
17
|
-
*/
|
|
18
13
|
declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
|
|
19
|
-
constructor(router: Router<
|
|
14
|
+
constructor(router: Router<T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
|
|
20
15
|
}
|
|
21
16
|
|
|
22
17
|
export { OpenAPIHandler };
|
|
@@ -1,22 +1,17 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import '
|
|
5
|
-
import '@orpc/server/standard';
|
|
2
|
+
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
+
import { StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
|
+
import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.B6hEbRyF.js';
|
|
6
5
|
import '@orpc/client';
|
|
7
|
-
import '@orpc/standard-server';
|
|
8
6
|
import '@orpc/shared';
|
|
7
|
+
import '@standardserver/core';
|
|
8
|
+
import '@orpc/contract';
|
|
9
|
+
import '../../shared/openapi.BOOA-bde.js';
|
|
9
10
|
|
|
10
|
-
interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<
|
|
11
|
+
interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, OpenAPIHandlerCodecOptions<T> {
|
|
11
12
|
}
|
|
12
|
-
/**
|
|
13
|
-
* OpenAPI Handler for Node Server
|
|
14
|
-
*
|
|
15
|
-
* @see {@link https://orpc.dev/docs/openapi/openapi-handler OpenAPI Handler Docs}
|
|
16
|
-
* @see {@link https://orpc.dev/docs/adapters/http HTTP Adapter Docs}
|
|
17
|
-
*/
|
|
18
13
|
declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
|
|
19
|
-
constructor(router: Router<
|
|
14
|
+
constructor(router: Router<T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
|
|
20
15
|
}
|
|
21
16
|
|
|
22
17
|
export { OpenAPIHandler };
|
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
import { NodeHttpHandler } from '@orpc/server/node';
|
|
2
|
-
import {
|
|
3
|
-
import '
|
|
4
|
-
import '@orpc/server/standard';
|
|
2
|
+
import { StandardHandler } from '@orpc/server/standard';
|
|
3
|
+
import { O as OpenAPIHandlerCodec } from '../../shared/openapi.CVgUshDP.mjs';
|
|
5
4
|
import '@orpc/client';
|
|
6
|
-
import '@orpc/contract';
|
|
7
|
-
import '@orpc/shared';
|
|
8
|
-
import '@orpc/client/standard';
|
|
9
5
|
import '@orpc/server';
|
|
6
|
+
import '@orpc/shared';
|
|
7
|
+
import '@standardserver/core';
|
|
8
|
+
import '../../shared/openapi.zZH_UksW.mjs';
|
|
9
|
+
import '../../shared/openapi.Bt87OzTt.mjs';
|
|
10
|
+
import '../../shared/openapi.B9PQzqBn.mjs';
|
|
10
11
|
import 'rou3';
|
|
11
12
|
|
|
12
13
|
class OpenAPIHandler extends NodeHttpHandler {
|
|
13
14
|
constructor(router, options = {}) {
|
|
14
|
-
|
|
15
|
+
const codec = new OpenAPIHandlerCodec(router, options);
|
|
16
|
+
const handler = new StandardHandler(codec, options);
|
|
17
|
+
super(handler, options);
|
|
15
18
|
}
|
|
16
19
|
}
|
|
17
20
|
|
|
@@ -1,20 +1,50 @@
|
|
|
1
|
-
export { a as
|
|
2
|
-
import {
|
|
3
|
-
import '@orpc/
|
|
1
|
+
export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.BafbB3uM.mjs';
|
|
2
|
+
import { ClientContext, ClientOptions, AnyORPCError } from '@orpc/client';
|
|
3
|
+
import { StandardLinkCodec, StandardLinkCodecDecodedResponse } from '@orpc/client/standard';
|
|
4
|
+
import { RouterContract } from '@orpc/contract';
|
|
5
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
6
|
+
import { StandardUrl, StandardHeaders, StandardLazyResponse, StandardRequest } from '@standardserver/core';
|
|
7
|
+
import { O as OpenAPISerializer } from '../../shared/openapi.BOOA-bde.mjs';
|
|
4
8
|
import '@orpc/server';
|
|
5
9
|
import '@orpc/server/standard';
|
|
6
|
-
import '@orpc/standard-server';
|
|
7
|
-
import '@orpc/shared';
|
|
8
10
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
11
|
+
declare class OpenAPILinkCodecError extends TypeError {
|
|
12
|
+
}
|
|
13
|
+
interface OpenAPILinkCodecOptions<T extends ClientContext> {
|
|
14
|
+
/**
|
|
15
|
+
* Base URL for all requests, without origin. Should match the OpenAPI handler mount path.
|
|
16
|
+
*
|
|
17
|
+
* @example '/api'
|
|
18
|
+
* @default '/'
|
|
19
|
+
*/
|
|
20
|
+
url?: Value<Promisable<StandardUrl>, [options: ClientOptions<T>, path: string[], input: unknown]>;
|
|
21
|
+
/**
|
|
22
|
+
* Inject headers into the request.
|
|
23
|
+
*/
|
|
24
|
+
headers?: Value<Promisable<StandardHeaders | Headers>, [options: ClientOptions<T>, path: string[], input: unknown]>;
|
|
25
|
+
/**
|
|
26
|
+
* Override the default OpenAPI serializer.
|
|
27
|
+
*/
|
|
28
|
+
serializer?: Pick<OpenAPISerializer, keyof OpenAPISerializer>;
|
|
29
|
+
/**
|
|
30
|
+
* Customize how an error response body is converted into an ORPC error.
|
|
31
|
+
* Return `null` or `undefined` to fall back to the default decoding behavior.
|
|
32
|
+
*/
|
|
33
|
+
customErrorResponseBodyDecoder?: (deserializedBody: unknown, response: StandardLazyResponse) => AnyORPCError | null | undefined;
|
|
34
|
+
}
|
|
35
|
+
declare class OpenAPILinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
36
|
+
private readonly router;
|
|
37
|
+
private readonly baseUrl;
|
|
38
|
+
private readonly headers;
|
|
39
|
+
private readonly serializer;
|
|
40
|
+
private readonly customErrorResponseBodyDecoder;
|
|
41
|
+
constructor(router: RouterContract, options?: OpenAPILinkCodecOptions<T>);
|
|
42
|
+
encodeInput(input: unknown, path: string[], options: ClientOptions<T>): Promise<StandardRequest>;
|
|
43
|
+
private encodePathParam;
|
|
44
|
+
private serializeQueryString;
|
|
45
|
+
decodeResponse(response: StandardLazyResponse, path: string[], _options: ClientOptions<T>): Promise<StandardLinkCodecDecodedResponse>;
|
|
46
|
+
private resolveProcedure;
|
|
47
|
+
}
|
|
19
48
|
|
|
20
|
-
export {
|
|
49
|
+
export { OpenAPILinkCodec, OpenAPILinkCodecError };
|
|
50
|
+
export type { OpenAPILinkCodecOptions };
|
|
@@ -1,20 +1,50 @@
|
|
|
1
|
-
export { a as
|
|
2
|
-
import {
|
|
3
|
-
import '@orpc/
|
|
1
|
+
export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.B6hEbRyF.js';
|
|
2
|
+
import { ClientContext, ClientOptions, AnyORPCError } from '@orpc/client';
|
|
3
|
+
import { StandardLinkCodec, StandardLinkCodecDecodedResponse } from '@orpc/client/standard';
|
|
4
|
+
import { RouterContract } from '@orpc/contract';
|
|
5
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
6
|
+
import { StandardUrl, StandardHeaders, StandardLazyResponse, StandardRequest } from '@standardserver/core';
|
|
7
|
+
import { O as OpenAPISerializer } from '../../shared/openapi.BOOA-bde.js';
|
|
4
8
|
import '@orpc/server';
|
|
5
9
|
import '@orpc/server/standard';
|
|
6
|
-
import '@orpc/standard-server';
|
|
7
|
-
import '@orpc/shared';
|
|
8
10
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
11
|
+
declare class OpenAPILinkCodecError extends TypeError {
|
|
12
|
+
}
|
|
13
|
+
interface OpenAPILinkCodecOptions<T extends ClientContext> {
|
|
14
|
+
/**
|
|
15
|
+
* Base URL for all requests, without origin. Should match the OpenAPI handler mount path.
|
|
16
|
+
*
|
|
17
|
+
* @example '/api'
|
|
18
|
+
* @default '/'
|
|
19
|
+
*/
|
|
20
|
+
url?: Value<Promisable<StandardUrl>, [options: ClientOptions<T>, path: string[], input: unknown]>;
|
|
21
|
+
/**
|
|
22
|
+
* Inject headers into the request.
|
|
23
|
+
*/
|
|
24
|
+
headers?: Value<Promisable<StandardHeaders | Headers>, [options: ClientOptions<T>, path: string[], input: unknown]>;
|
|
25
|
+
/**
|
|
26
|
+
* Override the default OpenAPI serializer.
|
|
27
|
+
*/
|
|
28
|
+
serializer?: Pick<OpenAPISerializer, keyof OpenAPISerializer>;
|
|
29
|
+
/**
|
|
30
|
+
* Customize how an error response body is converted into an ORPC error.
|
|
31
|
+
* Return `null` or `undefined` to fall back to the default decoding behavior.
|
|
32
|
+
*/
|
|
33
|
+
customErrorResponseBodyDecoder?: (deserializedBody: unknown, response: StandardLazyResponse) => AnyORPCError | null | undefined;
|
|
34
|
+
}
|
|
35
|
+
declare class OpenAPILinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
36
|
+
private readonly router;
|
|
37
|
+
private readonly baseUrl;
|
|
38
|
+
private readonly headers;
|
|
39
|
+
private readonly serializer;
|
|
40
|
+
private readonly customErrorResponseBodyDecoder;
|
|
41
|
+
constructor(router: RouterContract, options?: OpenAPILinkCodecOptions<T>);
|
|
42
|
+
encodeInput(input: unknown, path: string[], options: ClientOptions<T>): Promise<StandardRequest>;
|
|
43
|
+
private encodePathParam;
|
|
44
|
+
private serializeQueryString;
|
|
45
|
+
decodeResponse(response: StandardLazyResponse, path: string[], _options: ClientOptions<T>): Promise<StandardLinkCodecDecodedResponse>;
|
|
46
|
+
private resolveProcedure;
|
|
47
|
+
}
|
|
19
48
|
|
|
20
|
-
export {
|
|
49
|
+
export { OpenAPILinkCodec, OpenAPILinkCodecError };
|
|
50
|
+
export type { OpenAPILinkCodecOptions };
|
|
@@ -1,9 +1,12 @@
|
|
|
1
|
-
export {
|
|
2
|
-
|
|
3
|
-
import '@orpc/server/standard';
|
|
1
|
+
export { O as OpenAPIHandlerCodec, a as OpenAPIHandlerCodecCore, b as OpenAPIMatcher } from '../../shared/openapi.CVgUshDP.mjs';
|
|
2
|
+
export { O as OpenAPILinkCodec, a as OpenAPILinkCodecError } from '../../shared/openapi.C-p_Q2lb.mjs';
|
|
4
3
|
import '@orpc/client';
|
|
5
|
-
import '@orpc/contract';
|
|
6
|
-
import '@orpc/shared';
|
|
7
|
-
import '@orpc/client/standard';
|
|
8
4
|
import '@orpc/server';
|
|
5
|
+
import '@orpc/shared';
|
|
6
|
+
import '@standardserver/core';
|
|
7
|
+
import '../../shared/openapi.zZH_UksW.mjs';
|
|
8
|
+
import '../../shared/openapi.Bt87OzTt.mjs';
|
|
9
|
+
import '../../shared/openapi.B9PQzqBn.mjs';
|
|
9
10
|
import 'rou3';
|
|
11
|
+
import '@orpc/contract';
|
|
12
|
+
import '@standardserver/fetch';
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { AnyORPCError } from '@orpc/client';
|
|
2
|
+
import { ErrorMap, AnySchema } from '@orpc/contract';
|
|
3
|
+
import { Context } from '@orpc/server';
|
|
4
|
+
import { O as OpenAPIMeta } from '../shared/openapi.hg_rhZ4x.mjs';
|
|
5
|
+
import '@orpc/shared';
|
|
6
|
+
import '@standardserver/core';
|
|
7
|
+
import '../shared/openapi.ByT4oUeY.mjs';
|
|
8
|
+
import '@hey-api/spec-types';
|
|
9
|
+
|
|
10
|
+
declare module '@orpc/contract' {
|
|
11
|
+
interface ContractBuilder<TErrorMap extends ErrorMap> {
|
|
12
|
+
route(meta: OpenAPIMeta): ContractBuilder<TErrorMap>;
|
|
13
|
+
}
|
|
14
|
+
interface ProcedureContractBuilderWithInput<TInputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
15
|
+
route(meta: OpenAPIMeta): ProcedureContractBuilderWithInput<TInputSchema, TErrorMap>;
|
|
16
|
+
}
|
|
17
|
+
interface ProcedureContractBuilderWithOutput<TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
18
|
+
route(meta: OpenAPIMeta): ProcedureContractBuilderWithOutput<TOutputSchema, TErrorMap>;
|
|
19
|
+
}
|
|
20
|
+
interface ProcedureContractBuilderWithInputOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
21
|
+
route(meta: OpenAPIMeta): ProcedureContractBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap>;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
declare module '@orpc/server' {
|
|
25
|
+
interface Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {
|
|
26
|
+
route(meta: OpenAPIMeta): Builder<TInitialContext, TErrorMap>;
|
|
27
|
+
}
|
|
28
|
+
interface BuilderWithMiddlewares<TInitialContext extends Context, TInjectedContext extends Context, TErrorMap extends ErrorMap> {
|
|
29
|
+
route(meta: OpenAPIMeta): BuilderWithMiddlewares<TInitialContext, TInjectedContext, TErrorMap>;
|
|
30
|
+
}
|
|
31
|
+
interface BuilderWithInput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
32
|
+
route(meta: OpenAPIMeta): BuilderWithInput<TInitialContext, TInjectedContext, TInputSchema, TErrorMap>;
|
|
33
|
+
}
|
|
34
|
+
interface BuilderWithOutput<TInitialContext extends Context, TInjectedContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
35
|
+
route(meta: OpenAPIMeta): BuilderWithOutput<TInitialContext, TInjectedContext, TOutputSchema, TErrorMap>;
|
|
36
|
+
}
|
|
37
|
+
interface BuilderWithInputOutput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
38
|
+
route(meta: OpenAPIMeta): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
39
|
+
}
|
|
40
|
+
interface DecoratedProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TReturnedError extends AnyORPCError> {
|
|
41
|
+
route(meta: OpenAPIMeta): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, TReturnedError>;
|
|
42
|
+
}
|
|
43
|
+
}
|