@orpc/openapi 1.14.6 → 2.0.0-beta.10
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 +78 -110
- 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 +111 -108
- package/dist/index.d.ts +111 -108
- package/dist/index.mjs +922 -33
- 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.7vgmPxca.d.ts +82 -0
- package/dist/shared/openapi.B2SK0ZAr.mjs +359 -0
- package/dist/shared/openapi.B9PQzqBn.mjs +49 -0
- package/dist/shared/openapi.BQzzr4-4.d.ts +299 -0
- package/dist/shared/openapi.BcEtAxQj.d.mts +299 -0
- package/dist/shared/openapi.Bt87OzTt.mjs +131 -0
- package/dist/shared/openapi.C7m7NAmH.d.mts +142 -0
- package/dist/shared/openapi.C7m7NAmH.d.ts +142 -0
- package/dist/shared/openapi.CTlpLuKN.mjs +318 -0
- package/dist/shared/openapi.CX6Ri5dP.d.mts +82 -0
- package/dist/shared/openapi.CYgMBSUF.d.mts +18 -0
- package/dist/shared/openapi.CYgMBSUF.d.ts +18 -0
- package/dist/shared/openapi.DmAa7YPO.mjs +275 -0
- package/package.json +30 -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,8 +1,4 @@
|
|
|
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">
|
|
@@ -22,78 +18,48 @@
|
|
|
22
18
|
</a>
|
|
23
19
|
</div>
|
|
24
20
|
|
|
25
|
-
|
|
21
|
+
## Documentation
|
|
22
|
+
|
|
23
|
+
You can read the documentation [here](https://orpc.dev).
|
|
26
24
|
|
|
27
|
-
|
|
25
|
+
## Packages
|
|
28
26
|
|
|
29
|
-
|
|
27
|
+
**Core**
|
|
30
28
|
|
|
31
|
-
|
|
29
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define API contract as the single source of truth.
|
|
30
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
|
|
31
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
|
|
32
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
|
|
32
33
|
|
|
33
|
-
|
|
34
|
-
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
35
|
-
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
|
36
|
-
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
|
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.
|
|
34
|
+
**Schema validation**
|
|
45
35
|
|
|
46
|
-
|
|
36
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
|
|
37
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
38
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
47
39
|
|
|
48
|
-
|
|
40
|
+
**Built-in features**
|
|
49
41
|
|
|
50
|
-
|
|
42
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
|
|
43
|
+
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
|
|
44
|
+
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
45
|
+
|
|
46
|
+
**Framework & ecosystem integrations**
|
|
47
|
+
|
|
48
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
49
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
50
|
+
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
51
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
|
|
52
|
+
- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
|
|
51
53
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
- [@orpc/
|
|
55
|
-
- [@orpc/
|
|
56
|
-
- [@orpc/
|
|
57
|
-
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
58
|
-
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
59
|
-
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
|
60
|
-
- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
|
|
61
|
-
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
62
|
-
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
63
|
-
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
64
|
-
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
65
|
-
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
66
|
-
|
|
67
|
-
## `@orpc/openapi`
|
|
68
|
-
|
|
69
|
-
Generate OpenAPI specs and handle OpenAPI requests. Read the [documentation](https://orpc.dev/docs/openapi/getting-started) for more information.
|
|
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
|
-
```
|
|
54
|
+
**Observability**
|
|
55
|
+
|
|
56
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
|
|
57
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
|
|
58
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
|
|
93
59
|
|
|
94
60
|
## Sponsors
|
|
95
61
|
|
|
96
|
-
|
|
62
|
+
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
63
|
|
|
98
64
|
### 🏆 Platinum Sponsor
|
|
99
65
|
|
|
@@ -111,19 +77,11 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
111
77
|
</tr>
|
|
112
78
|
</table>
|
|
113
79
|
|
|
114
|
-
### 🥉 Bronze Sponsor
|
|
115
|
-
|
|
116
|
-
<table>
|
|
117
|
-
<tr>
|
|
118
|
-
<td align="center"><a href="https://plancraft.com/?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="167" alt="plancraft"/><br />plancraft</a></td>
|
|
119
|
-
</tr>
|
|
120
|
-
</table>
|
|
121
|
-
|
|
122
80
|
### Generous Sponsors
|
|
123
81
|
|
|
124
82
|
<table>
|
|
125
83
|
<tr>
|
|
126
|
-
<td align="center"><a href="https://github.com/ln-markets?ref=orpc" target="_blank" rel="noopener" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="
|
|
84
|
+
<td align="center"><a href="https://github.com/ln-markets?ref=orpc" target="_blank" rel="noopener" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="167" alt="LN Markets"/><br />LN Markets</a></td>
|
|
127
85
|
</tr>
|
|
128
86
|
</table>
|
|
129
87
|
|
|
@@ -131,26 +89,26 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
131
89
|
|
|
132
90
|
<table>
|
|
133
91
|
<tr>
|
|
134
|
-
<td align="center"><a href="https://github.com/hrmcdonald?ref=orpc" target="_blank" rel="noopener" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="
|
|
135
|
-
<td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="noopener" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="
|
|
136
|
-
<td align="center"><a href="https://github.com/supastarter?ref=orpc" target="_blank" rel="noopener" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="
|
|
137
|
-
<td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="noopener" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&v=4" width="
|
|
138
|
-
<td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="noopener" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="
|
|
139
|
-
<td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="
|
|
140
|
-
<td align="center"><a href="https://github.com/dcramer?ref=orpc" target="_blank" rel="noopener" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="119" alt="David Cramer"/><br />David Cramer</a></td>
|
|
92
|
+
<td align="center"><a href="https://github.com/hrmcdonald?ref=orpc" target="_blank" rel="noopener" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="139" alt="Reece McDonald"/><br />Reece McDonald</a></td>
|
|
93
|
+
<td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="noopener" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="139" alt="nk"/><br />nk</a></td>
|
|
94
|
+
<td align="center"><a href="https://github.com/supastarter?ref=orpc" target="_blank" rel="noopener" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="139" alt="supastarter"/><br />supastarter</a></td>
|
|
95
|
+
<td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="noopener" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&v=4" width="139" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
|
|
96
|
+
<td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="noopener" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="139" alt="herrfugbaum"/><br />herrfugbaum</a></td>
|
|
97
|
+
<td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="139" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
|
|
141
98
|
</tr>
|
|
142
99
|
<tr>
|
|
143
|
-
<td align="center"><a href="https://github.com/
|
|
144
|
-
<td align="center"><a href="https://github.com/
|
|
145
|
-
<td align="center"><a href="https://github.com/
|
|
146
|
-
<td align="center"><a href="https://github.com/
|
|
147
|
-
<td align="center"><a href="https://github.com/
|
|
148
|
-
<td align="center"><a href="https://github.com/
|
|
149
|
-
<td align="center"><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="119" alt="Peter Adam"/><br />Peter Adam</a></td>
|
|
100
|
+
<td align="center"><a href="https://github.com/dcramer?ref=orpc" target="_blank" rel="noopener" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="139" alt="David Cramer"/><br />David Cramer</a></td>
|
|
101
|
+
<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>
|
|
102
|
+
<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>
|
|
103
|
+
<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>
|
|
104
|
+
<td align="center"><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="139" alt="Andrew Peters"/><br />Andrew Peters</a></td>
|
|
105
|
+
<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>
|
|
150
106
|
</tr>
|
|
151
107
|
<tr>
|
|
152
|
-
<td align="center"><a href="https://github.com/
|
|
153
|
-
<td align="center"><a href="https://github.com/
|
|
108
|
+
<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>
|
|
109
|
+
<td align="center"><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="139" alt="Peter Adam"/><br />Peter Adam</a></td>
|
|
110
|
+
<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>
|
|
111
|
+
<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>
|
|
154
112
|
</tr>
|
|
155
113
|
</table>
|
|
156
114
|
|
|
@@ -158,28 +116,27 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
158
116
|
|
|
159
117
|
<table>
|
|
160
118
|
<tr>
|
|
161
|
-
<td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="noopener" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="
|
|
162
|
-
<td align="center"><a href="https://github.com/
|
|
163
|
-
<td align="center"><a href="https://github.com/Robbe95?ref=orpc" target="_blank" rel="noopener" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="
|
|
164
|
-
<td align="center"><a href="https://github.com/aidansunbury?ref=orpc" target="_blank" rel="noopener" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="
|
|
165
|
-
<td align="center"><a href="https://github.com/soonoo?ref=orpc" target="_blank" rel="noopener" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="
|
|
166
|
-
<td align="center"><a href="https://github.com/kporten?ref=orpc" target="_blank" rel="noopener" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="
|
|
167
|
-
<td align="center"><a href="https://github.com/pumpkinlink?ref=orpc" target="_blank" rel="noopener" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="
|
|
168
|
-
<td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="104" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
119
|
+
<td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="noopener" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="119" alt="David Walsh"/><br />David Walsh</a></td>
|
|
120
|
+
<td align="center"><a href="https://github.com/Nic13Gamer?ref=orpc" target="_blank" rel="noopener" title="Nicholas"><img src="https://avatars.githubusercontent.com/u/54724556?u=56a7ab430ce7a80d648ab6eba051d454a818ed0b&v=4" width="119" alt="Nicholas"/><br />Nicholas</a></td>
|
|
121
|
+
<td align="center"><a href="https://github.com/Robbe95?ref=orpc" target="_blank" rel="noopener" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="119" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
122
|
+
<td align="center"><a href="https://github.com/aidansunbury?ref=orpc" target="_blank" rel="noopener" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="119" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
|
|
123
|
+
<td align="center"><a href="https://github.com/soonoo?ref=orpc" target="_blank" rel="noopener" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="119" alt="soonoo"/><br />soonoo</a></td>
|
|
124
|
+
<td align="center"><a href="https://github.com/kporten?ref=orpc" target="_blank" rel="noopener" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="119" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
125
|
+
<td align="center"><a href="https://github.com/pumpkinlink?ref=orpc" target="_blank" rel="noopener" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="119" alt="Denis"/><br />Denis</a></td>
|
|
169
126
|
</tr>
|
|
170
127
|
<tr>
|
|
171
|
-
<td align="center"><a href="https://github.com/
|
|
172
|
-
<td align="center"><a href="https://github.com/
|
|
173
|
-
<td align="center"><a href="https://github.com/
|
|
174
|
-
<td align="center"><a href="https://github.com/
|
|
175
|
-
<td align="center"><a href="https://github.com/
|
|
176
|
-
<td align="center"><a href="https://github.com/hanayashiki?ref=orpc" target="_blank" rel="noopener" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="
|
|
177
|
-
<td align="center"><a href="https://github.com/ldub?ref=orpc" target="_blank" rel="noopener" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="
|
|
178
|
-
<td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="104" alt="Alex"/><br />Alex</a></td>
|
|
128
|
+
<td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
129
|
+
<td align="center"><a href="https://github.com/thomasballinger?ref=orpc" target="_blank" rel="noopener" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="119" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
130
|
+
<td align="center"><a href="https://github.com/SSam0419?ref=orpc" target="_blank" rel="noopener" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="119" alt="Sam"/><br />Sam</a></td>
|
|
131
|
+
<td align="center"><a href="https://github.com/Titoine?ref=orpc" target="_blank" rel="noopener" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="119" alt="Titoine"/><br />Titoine</a></td>
|
|
132
|
+
<td align="center"><a href="https://github.com/Mnigos?ref=orpc" target="_blank" rel="noopener" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="119" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
133
|
+
<td align="center"><a href="https://github.com/hanayashiki?ref=orpc" target="_blank" rel="noopener" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="119" alt="hanayashiki"/><br />hanayashiki</a></td>
|
|
134
|
+
<td align="center"><a href="https://github.com/ldub?ref=orpc" target="_blank" rel="noopener" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
|
|
179
135
|
</tr>
|
|
180
136
|
<tr>
|
|
181
|
-
<td align="center"><a href="https://github.com/
|
|
182
|
-
<td align="center"><a href="https://github.com/
|
|
137
|
+
<td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
138
|
+
<td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="119" alt="Alex"/><br />Alex</a></td>
|
|
139
|
+
<td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=29e91400dbd4a9c217048a8f59562c4f740498e6&v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
|
|
183
140
|
</tr>
|
|
184
141
|
</table>
|
|
185
142
|
|
|
@@ -195,7 +152,7 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
195
152
|
<a href="https://github.com/theoludwig?ref=orpc" target="_blank" rel="noopener" title="Théo LUDWIG"><img src="https://avatars.githubusercontent.com/u/25207499?u=a6a9653725a2f574c07893748806668e0598cdbe&v=4" width="32" height="32" alt="Théo LUDWIG" /></a>
|
|
196
153
|
<a href="https://github.com/abhay-ramesh?ref=orpc" target="_blank" rel="noopener" title="Abhay Ramesh"><img src="https://avatars.githubusercontent.com/u/66196314?u=c5c2b0327b26606c2efcfaf17046ab18c3d25c57&v=4" width="32" height="32" alt="Abhay Ramesh" /></a>
|
|
197
154
|
<a href="https://github.com/shr-ink?ref=orpc" target="_blank" rel="noopener" title="shr.ink oü"><img src="https://avatars.githubusercontent.com/u/139700438?v=4" width="32" height="32" alt="shr.ink oü" /></a>
|
|
198
|
-
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=
|
|
155
|
+
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=505e54608466ab53754f702973687b04c6424c1f&v=4" width="32" height="32" alt="0x4e32" /></a>
|
|
199
156
|
<a href="https://github.com/yzuyr?ref=orpc" target="_blank" rel="noopener" title="Ryuz"><img src="https://avatars.githubusercontent.com/u/196539378?u=d38374588d219b6748b16406982f6559411466d4&v=4" width="32" height="32" alt="Ryuz" /></a>
|
|
200
157
|
<a href="https://github.com/happyboy2022?ref=orpc" target="_blank" rel="noopener" title="happyboy"><img src="https://avatars.githubusercontent.com/u/103669586?u=65b49c4b893ed3703909fbb3a7a22313f3f9c121&v=4" width="32" height="32" alt="happyboy" /></a>
|
|
201
158
|
<a href="https://github.com/YiCChi?ref=orpc" target="_blank" rel="noopener" title="yicchi"><img src="https://avatars.githubusercontent.com/u/86967274?u=6c2756f09fe15dd94d572f560e979cd157982852&v=4" width="32" height="32" alt="yicchi" /></a>
|
|
@@ -215,9 +172,20 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
215
172
|
<a href="https://github.com/laduniestu?ref=orpc" target="_blank" rel="noopener" title="Laduni Estu Syalwa"><img src="https://avatars.githubusercontent.com/u/44757637?u=a2fc1ea8f7d827a96721176f79d30592d1c48059&v=4" width="32" height="32" alt="Laduni Estu Syalwa" /></a>
|
|
216
173
|
<a href="https://github.com/yukimotochern?ref=orpc" target="_blank" rel="noopener" title="Chen, Zhi-Yuan"><img src="https://avatars.githubusercontent.com/u/20896173?u=945c33fc21725e4d566a0d02afc54b136ca1d67a&v=4" width="32" height="32" alt="Chen, Zhi-Yuan" /></a>
|
|
217
174
|
<a href="https://github.com/illarionvk?ref=orpc" target="_blank" rel="noopener" title="Illarion Koperski"><img src="https://avatars.githubusercontent.com/u/5012724?u=7cfa13652f7ac5fb3c56d880e3eb3fbe40c3ea34&v=4" width="32" height="32" alt="Illarion Koperski" /></a>
|
|
175
|
+
<a href="https://github.com/steelbrain?ref=orpc" target="_blank" rel="noopener" title="Anees Iqbal"><img src="https://avatars.githubusercontent.com/u/4278113?u=22b80b5399eed68ac76cd58b02961b0481f1db11&v=4" width="32" height="32" alt="Anees Iqbal" /></a>
|
|
218
176
|
<a href="https://github.com/Scrumplex?ref=orpc" target="_blank" rel="noopener" title="Sefa Eyeoglu"><img src="https://avatars.githubusercontent.com/u/11587657?u=ab503582165c0bbff0cca47ce31c9450bb1553c9&v=4" width="32" height="32" alt="Sefa Eyeoglu" /></a>
|
|
177
|
+
<a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="Natt"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&v=4" width="32" height="32" alt="Natt" /></a>
|
|
178
|
+
<a href="https://github.com/ChromeGG?ref=orpc" target="_blank" rel="noopener" title="Adam Tkaczyk"><img src="https://avatars.githubusercontent.com/u/39050595?u=a58ca6042a6950e94e6e92442db76ef584279bc0&v=4" width="32" height="32" alt="Adam Tkaczyk" /></a>
|
|
179
|
+
<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>
|
|
219
180
|
</p>
|
|
220
181
|
|
|
182
|
+
## References
|
|
183
|
+
|
|
184
|
+
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
|
|
185
|
+
|
|
186
|
+
- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
|
|
187
|
+
- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
|
|
188
|
+
|
|
221
189
|
## License
|
|
222
190
|
|
|
223
191
|
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.CX6Ri5dP.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.C7m7NAmH.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.7vgmPxca.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.C7m7NAmH.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.CTlpLuKN.mjs';
|
|
4
|
+
import { FetchLinkTransport } from '@orpc/client/fetch';
|
|
5
|
+
import { StandardLink } from '@orpc/client/standard';
|
|
6
|
+
import { O as OpenAPILinkCodec } from '../../shared/openapi.B2SK0ZAr.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.DmAa7YPO.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.CX6Ri5dP.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.C7m7NAmH.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.7vgmPxca.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.C7m7NAmH.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.CTlpLuKN.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.DmAa7YPO.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.CX6Ri5dP.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.C7m7NAmH.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 };
|