@orpc/nest 0.0.0-next.324fc97 β 0.0.0-next.325aa5d
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 +133 -16
- package/dist/index.d.mts +43 -23
- package/dist/index.d.ts +43 -23
- package/dist/index.mjs +69 -64
- package/package.json +24 -23
package/README.md
CHANGED
|
@@ -1,22 +1,25 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<image align="center" src="https://orpc.
|
|
2
|
+
<image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
|
|
3
3
|
</div>
|
|
4
4
|
|
|
5
5
|
<h1></h1>
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
|
-
<a href="https://codecov.io/gh/
|
|
9
|
-
<img alt="codecov" src="https://codecov.io/gh/
|
|
8
|
+
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
9
|
+
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
|
|
10
10
|
</a>
|
|
11
11
|
<a href="https://www.npmjs.com/package/@orpc/nest">
|
|
12
12
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fnest?logo=npm" />
|
|
13
13
|
</a>
|
|
14
|
-
<a href="https://github.com/
|
|
15
|
-
<img alt="MIT License" src="https://img.shields.io/github/license/
|
|
14
|
+
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
15
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
16
16
|
</a>
|
|
17
17
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
18
18
|
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
19
19
|
</a>
|
|
20
|
+
<a href="https://deepwiki.com/middleapi/orpc">
|
|
21
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
22
|
+
</a>
|
|
20
23
|
</div>
|
|
21
24
|
|
|
22
25
|
<h3 align="center">Typesafe APIs Made Simple πͺ</h3>
|
|
@@ -30,7 +33,8 @@
|
|
|
30
33
|
- **π End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
31
34
|
- **π First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
32
35
|
- **π Contract-First Development**: Optionally define your API contract before implementation.
|
|
33
|
-
-
|
|
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.
|
|
34
38
|
- **π Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
35
39
|
- **π Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
36
40
|
- **ποΈ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
@@ -38,11 +42,10 @@
|
|
|
38
42
|
- **π‘ SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
39
43
|
- **π Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
40
44
|
- **π Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
41
|
-
- **π‘οΈ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
|
|
42
45
|
|
|
43
46
|
## Documentation
|
|
44
47
|
|
|
45
|
-
You can find the full documentation [here](https://orpc.
|
|
48
|
+
You can find the full documentation [here](https://orpc.dev).
|
|
46
49
|
|
|
47
50
|
## Packages
|
|
48
51
|
|
|
@@ -50,9 +53,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
50
53
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
51
54
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
52
55
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
56
|
+
- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
|
|
53
57
|
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
54
58
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
55
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.
|
|
56
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
57
62
|
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
58
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
@@ -61,11 +66,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
61
66
|
|
|
62
67
|
## `@orpc/nest`
|
|
63
68
|
|
|
64
|
-
Deeply integrate oRPC with [NestJS](https://nestjs.com/). Read the [documentation](https://orpc.
|
|
69
|
+
Deeply integrate oRPC with [NestJS](https://nestjs.com/). Read the [documentation](https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest) for more information.
|
|
65
70
|
|
|
66
71
|
### Implement Contract
|
|
67
72
|
|
|
68
|
-
An overview of how to implement an [oRPC contract](https://orpc.
|
|
73
|
+
An overview of how to implement an [oRPC contract](https://orpc.dev/docs/contract-first/define-contract) in NestJS.
|
|
69
74
|
|
|
70
75
|
```ts
|
|
71
76
|
import { Implement, implement, ORPCError } from '@orpc/nest'
|
|
@@ -85,7 +90,7 @@ export class PlanetController {
|
|
|
85
90
|
}
|
|
86
91
|
|
|
87
92
|
/**
|
|
88
|
-
* Implement entire
|
|
93
|
+
* Implement entire contract
|
|
89
94
|
*/
|
|
90
95
|
@Implement(contract.planet)
|
|
91
96
|
planet() {
|
|
@@ -119,12 +124,124 @@ export class PlanetController {
|
|
|
119
124
|
|
|
120
125
|
## Sponsors
|
|
121
126
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
127
|
+
If you find oRPC valuable and would like to support its development, you can do so here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh).
|
|
128
|
+
|
|
129
|
+
### π Platinum Sponsor
|
|
130
|
+
|
|
131
|
+
<table>
|
|
132
|
+
<tr>
|
|
133
|
+
<td align="center"><a href="https://screenshotone.com/?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="ScreenshotOne.com"><img src="https://avatars.githubusercontent.com/u/97035603?v=4" width="220" alt="ScreenshotOne.com"/><br />ScreenshotOne.com</a></td>
|
|
134
|
+
</tr>
|
|
135
|
+
</table>
|
|
136
|
+
|
|
137
|
+
### π₯ Gold Sponsor
|
|
138
|
+
|
|
139
|
+
<table>
|
|
140
|
+
<tr>
|
|
141
|
+
<td align="center"><a href="https://zuplo.link/orpc?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Zuplo"><img src="https://avatars.githubusercontent.com/u/85497839?v=4" width="170" alt="Zuplo"/><br />Zuplo</a></td>
|
|
142
|
+
</tr>
|
|
143
|
+
</table>
|
|
144
|
+
|
|
145
|
+
### π₯ Silver Sponsor
|
|
146
|
+
|
|
147
|
+
<table>
|
|
148
|
+
<tr>
|
|
149
|
+
<td align="center"><a href="https://misskey.io/?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="ζδΈγγ"><img src="https://avatars.githubusercontent.com/u/37681609?u=0dd4c7e4ba937cbb52b068c55914b1d8164dc0c7&v=4" width="120" alt="ζδΈγγ"/><br />ζδΈγγ</a></td>
|
|
150
|
+
<td align="center"><a href="https://valerii15298.github.io/?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&v=4" width="120" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
|
|
151
|
+
<td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="120" alt="christ12938"/><br />christ12938</a></td>
|
|
152
|
+
</tr>
|
|
153
|
+
</table>
|
|
154
|
+
|
|
155
|
+
### Generous Sponsors
|
|
156
|
+
|
|
157
|
+
<table>
|
|
158
|
+
<tr>
|
|
159
|
+
<td align="center"><a href="https://github.com/ln-markets?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="88" alt="LN Markets"/><br />LN Markets</a></td>
|
|
160
|
+
</tr>
|
|
161
|
+
</table>
|
|
162
|
+
|
|
163
|
+
### Sponsors
|
|
164
|
+
|
|
165
|
+
<table>
|
|
166
|
+
<tr>
|
|
167
|
+
<td align="center"><a href="https://github.com/hrmcdonald?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="76" alt="Reece McDonald"/><br />Reece McDonald</a></td>
|
|
168
|
+
<td align="center"><a href="https://github.com/Scrumplex?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Sefa Eyeoglu"><img src="https://avatars.githubusercontent.com/u/11587657?u=ab503582165c0bbff0cca47ce31c9450bb1553c9&v=4" width="76" alt="Sefa Eyeoglu"/><br />Sefa Eyeoglu</a></td>
|
|
169
|
+
<td align="center"><a href="https://github.com/u1-liquid?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="γγγγγ¨γΌγ«γ
"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&v=4" width="76" alt="γγγγγ¨γΌγ«γ
"/><br />γγγγγ¨γΌγ«γ
</a></td>
|
|
170
|
+
<td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="76" alt="nk"/><br />nk</a></td>
|
|
171
|
+
<td align="center"><a href="https://github.com/supastarter?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="76" alt="supastarter"/><br />supastarter</a></td>
|
|
172
|
+
<td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&v=4" width="76" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
|
|
173
|
+
</tr>
|
|
174
|
+
<tr>
|
|
175
|
+
<td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="76" alt="herrfugbaum"/><br />herrfugbaum</a></td>
|
|
176
|
+
<td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="76" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
|
|
177
|
+
<td align="center"><a href="https://github.com/dcramer?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="76" alt="David Cramer"/><br />David Cramer</a></td>
|
|
178
|
+
<td align="center"><a href="https://github.com/happyboy2022?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="happyboy"><img src="https://avatars.githubusercontent.com/u/103669586?u=65b49c4b893ed3703909fbb3a7a22313f3f9c121&v=4" width="76" alt="happyboy"/><br />happyboy</a></td>
|
|
179
|
+
<td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&v=4" width="76" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
180
|
+
<td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&v=4" width="76" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
181
|
+
</tr>
|
|
182
|
+
<tr>
|
|
183
|
+
<td align="center"><a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="76" alt="Andrew Peters"/><br />Andrew Peters</a></td>
|
|
184
|
+
<td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="76" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
|
|
185
|
+
<td align="center"><a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="76" alt="Peter Adam"/><br />Peter Adam</a></td>
|
|
186
|
+
<td align="center"><a href="https://github.com/yukimotochern?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Chen, Zhi-Yuan"><img src="https://avatars.githubusercontent.com/u/20896173?u=945c33fc21725e4d566a0d02afc54b136ca1d67a&v=4" width="76" alt="Chen, Zhi-Yuan"/><br />Chen, Zhi-Yuan</a></td>
|
|
187
|
+
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="76" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
188
|
+
</tr>
|
|
189
|
+
</table>
|
|
190
|
+
|
|
191
|
+
### Backers
|
|
192
|
+
|
|
193
|
+
<table>
|
|
194
|
+
<tr>
|
|
195
|
+
<td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="54" alt="David Walsh"/><br />David Walsh</a></td>
|
|
196
|
+
<td align="center"><a href="https://github.com/Robbe95?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="54" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
197
|
+
<td align="center"><a href="https://github.com/aidansunbury?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="54" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
|
|
198
|
+
<td align="center"><a href="https://github.com/soonoo?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="54" alt="soonoo"/><br />soonoo</a></td>
|
|
199
|
+
<td align="center"><a href="https://github.com/kporten?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="54" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
200
|
+
<td align="center"><a href="https://github.com/pumpkinlink?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="54" alt="Denis"/><br />Denis</a></td>
|
|
201
|
+
</tr>
|
|
202
|
+
<tr>
|
|
203
|
+
<td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?v=4" width="54" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
204
|
+
<td align="center"><a href="https://github.com/thomasballinger?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="54" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
205
|
+
<td align="center"><a href="https://github.com/SSam0419?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="54" alt="Sam"/><br />Sam</a></td>
|
|
206
|
+
<td align="center"><a href="https://github.com/Titoine?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="54" alt="Titoine"/><br />Titoine</a></td>
|
|
207
|
+
<td align="center"><a href="https://github.com/Mnigos?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="54" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
208
|
+
<td align="center"><a href="https://github.com/steelbrain?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Anees Iqbal"><img src="https://avatars.githubusercontent.com/u/4278113?u=22b80b5399eed68ac76cd58b02961b0481f1db11&v=4" width="54" alt="Anees Iqbal"/><br />Anees Iqbal</a></td>
|
|
209
|
+
</tr>
|
|
210
|
+
<tr>
|
|
211
|
+
<td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="54" alt="Alex"/><br />Alex</a></td>
|
|
212
|
+
</tr>
|
|
213
|
+
</table>
|
|
214
|
+
|
|
215
|
+
### Past Sponsors
|
|
216
|
+
|
|
217
|
+
<p>
|
|
218
|
+
<a href="https://github.com/MrMaxie?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Maxie"><img src="https://avatars.githubusercontent.com/u/3857836?u=5e6b57973d4385d655663ffdd836e487856f2984&v=4" width="32" height="32" alt="Maxie" /></a>
|
|
219
|
+
<a href="https://github.com/Stijn-Timmer?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Stijn Timmer"><img src="https://avatars.githubusercontent.com/u/100147665?u=106b2c18e9c98a61861b4ee7fc100f5b9906a6c9&v=4" width="32" height="32" alt="Stijn Timmer" /></a>
|
|
220
|
+
<a href="https://github.com/motopods?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="motopods"><img src="https://avatars.githubusercontent.com/u/58200641?u=18833983d65b481ae90a4adec2373064ec58bcf3&v=4" width="32" height="32" alt="motopods" /></a>
|
|
221
|
+
<a href="https://github.com/franciscohermida?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Francisco Hermida"><img src="https://avatars.githubusercontent.com/u/483242?u=bbcbc80eb9d8781ff401f7dafc3b59cd7bea0561&v=4" width="32" height="32" alt="Francisco Hermida" /></a>
|
|
222
|
+
<a href="https://github.com/theoludwig?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" 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>
|
|
223
|
+
<a href="https://github.com/abhay-ramesh?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Abhay Ramesh"><img src="https://avatars.githubusercontent.com/u/66196314?u=c5c2b0327b26606c2efcfaf17046ab18c3d25c57&v=4" width="32" height="32" alt="Abhay Ramesh" /></a>
|
|
224
|
+
<a href="https://github.com/shr-ink?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="shr.ink oΓΌ"><img src="https://avatars.githubusercontent.com/u/139700438?v=4" width="32" height="32" alt="shr.ink oΓΌ" /></a>
|
|
225
|
+
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=24e8dd943cfc862aa284d858a023532c75071ade&v=4" width="32" height="32" alt="0x4e32" /></a>
|
|
226
|
+
<a href="https://github.com/yzuyr?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Ryuz"><img src="https://avatars.githubusercontent.com/u/196539378?u=d38374588d219b6748b16406982f6559411466d4&v=4" width="32" height="32" alt="Ryuz" /></a>
|
|
227
|
+
<a href="https://github.com/YiCChi?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="yicchi"><img src="https://avatars.githubusercontent.com/u/86967274?u=6c2756f09fe15dd94d572f560e979cd157982852&v=4" width="32" height="32" alt="yicchi" /></a>
|
|
228
|
+
<a href="https://github.com/cloudycotton?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Saksham"><img src="https://avatars.githubusercontent.com/u/168998965?u=9b9634a5aed66a51c1b880663272725b00b92b14&v=4" width="32" height="32" alt="Saksham" /></a>
|
|
229
|
+
<a href="https://github.com/hrynevychroman?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Roman Hrynevych"><img src="https://avatars.githubusercontent.com/u/82209198?u=1a1d111ab3d589855b9cc8a7fefb1b5c6a4fbbaf&v=4" width="32" height="32" alt="Roman Hrynevych" /></a>
|
|
230
|
+
<a href="https://github.com/rokitgg?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="rokitg"><img src="https://avatars.githubusercontent.com/u/125133357?u=06c74aefaa2236b06a2e5fba5a5c612339f45912&v=4" width="32" height="32" alt="rokitg" /></a>
|
|
231
|
+
<a href="https://github.com/omarkhatibgg?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Omar Khatib"><img src="https://avatars.githubusercontent.com/u/9054278?u=afbba7331b85c51b8eee4130f5fd31b1017dc919&v=4" width="32" height="32" alt="Omar Khatib" /></a>
|
|
232
|
+
<a href="https://github.com/YuSabo90002?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Yu-Sabo"><img src="https://avatars.githubusercontent.com/u/13120582?v=4" width="32" height="32" alt="Yu-Sabo" /></a>
|
|
233
|
+
<a href="https://github.com/bapspatil?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Bapusaheb Patil"><img src="https://avatars.githubusercontent.com/u/16699418?v=4" width="32" height="32" alt="Bapusaheb Patil" /></a>
|
|
234
|
+
<a href="https://github.com/ripgrim?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="grim"><img src="https://avatars.githubusercontent.com/u/75869731?u=b17c42ec2309552fdb822a86b25a2f99146a4d72&v=4" width="32" height="32" alt="grim" /></a>
|
|
235
|
+
<a href="https://github.com/nelsonlaidev?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Nelson Lai"><img src="https://avatars.githubusercontent.com/u/75498339?u=2fc0e0b95dd184c5ffb744df977cb15a18b60672&v=4" width="32" height="32" alt="Nelson Lai" /></a>
|
|
236
|
+
<a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" 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>
|
|
237
|
+
<a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&v=4" width="32" height="32" alt="Robert Soriano" /></a>
|
|
238
|
+
<a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
|
|
239
|
+
<a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
|
|
240
|
+
<a href="https://github.com/NovakAnton?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Novak Antonijevic"><img src="https://avatars.githubusercontent.com/u/157126729?u=ae49fa22292d55c0434ff0ca008206155b18663b&v=4" width="32" height="32" alt="Novak Antonijevic" /></a>
|
|
241
|
+
<a href="https://github.com/laduniestu?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" 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>
|
|
242
|
+
<a href="https://github.com/illarionvk?ref=orpc" target="_blank" rel="sponsored noopener noreferrer" title="Illarion Koperski"><img src="https://avatars.githubusercontent.com/u/5012724?u=7cfa13652f7ac5fb3c56d880e3eb3fbe40c3ea34&v=4" width="32" height="32" alt="Illarion Koperski" /></a>
|
|
126
243
|
</p>
|
|
127
244
|
|
|
128
245
|
## License
|
|
129
246
|
|
|
130
|
-
Distributed under the MIT License. See [LICENSE](https://github.com/
|
|
247
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
|
package/dist/index.d.mts
CHANGED
|
@@ -1,46 +1,66 @@
|
|
|
1
|
+
import { AnySchema, ContractRouter, HTTPPath, AnyContractRouter } from '@orpc/contract';
|
|
2
|
+
export { PopulateContractRouterPathsOptions, PopulatedContractRouterPaths, populateContractRouterPaths } from '@orpc/contract';
|
|
3
|
+
import { CreateProcedureClientOptions, Router, Context, BuilderConfig, Implementer } from '@orpc/server';
|
|
4
|
+
export { ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, ORPCError, ProcedureImplementer, RouterImplementer, RouterImplementerWithMiddlewares, onError, onFinish, onStart, onSuccess } from '@orpc/server';
|
|
1
5
|
import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
import { Promisable } from '@orpc/shared';
|
|
6
|
-
import {
|
|
6
|
+
import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
|
|
7
|
+
import { StandardOpenAPICodecOptions } from '@orpc/openapi/standard';
|
|
8
|
+
import { StandardHandlerOptions } from '@orpc/server/standard';
|
|
9
|
+
import { Interceptor, Promisable } from '@orpc/shared';
|
|
10
|
+
import { StandardResponse } from '@orpc/standard-server';
|
|
7
11
|
import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
|
12
|
+
import { Observable } from 'rxjs';
|
|
8
13
|
|
|
9
14
|
declare const ORPC_MODULE_CONFIG_SYMBOL: unique symbol;
|
|
10
|
-
|
|
15
|
+
/**
|
|
16
|
+
* You can extend this interface to add global context properties.
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* declare module '@orpc/nest' {
|
|
20
|
+
* interface ORPCGlobalContext {
|
|
21
|
+
* user: { id: string; name: string }
|
|
22
|
+
* }
|
|
23
|
+
* }
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
interface ORPCGlobalContext {
|
|
27
|
+
}
|
|
28
|
+
interface ORPCModuleConfig extends CreateProcedureClientOptions<ORPCGlobalContext, AnySchema, object, object, object>, SendStandardResponseOptions, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPICodecOptions {
|
|
29
|
+
plugins?: StandardHandlerOptions<ORPCGlobalContext>['plugins'];
|
|
30
|
+
sendResponseInterceptors?: Interceptor<{
|
|
31
|
+
request: any;
|
|
32
|
+
response: any;
|
|
33
|
+
standardResponse: StandardResponse;
|
|
34
|
+
}, unknown>[];
|
|
11
35
|
}
|
|
12
36
|
declare class ORPCModule {
|
|
13
37
|
static forRoot(config: ORPCModuleConfig): DynamicModule;
|
|
38
|
+
static forRootAsync(options: {
|
|
39
|
+
imports?: any[];
|
|
40
|
+
useFactory: (...args: any[]) => Promise<ORPCModuleConfig> | ORPCModuleConfig;
|
|
41
|
+
inject?: any[];
|
|
42
|
+
}): DynamicModule;
|
|
14
43
|
}
|
|
15
44
|
|
|
16
45
|
/**
|
|
17
46
|
* Decorator in controller handler to implement a oRPC contract.
|
|
18
47
|
*
|
|
19
|
-
* @see {@link https://orpc.
|
|
48
|
+
* @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
|
|
20
49
|
*/
|
|
21
|
-
declare function Implement<T extends ContractRouter<any>>(contract: T): <U extends Promisable<Router<T,
|
|
50
|
+
declare function Implement<T extends ContractRouter<any>>(contract: T): <U extends Promisable<Router<T, ORPCGlobalContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
|
|
22
51
|
declare class ImplementInterceptor implements NestInterceptor {
|
|
23
52
|
private readonly config;
|
|
53
|
+
private readonly codec;
|
|
24
54
|
constructor(config: ORPCModuleConfig | undefined);
|
|
25
55
|
intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
|
|
26
56
|
}
|
|
27
57
|
|
|
28
58
|
declare function toNestPattern(path: HTTPPath): string;
|
|
29
|
-
|
|
30
|
-
[K in keyof T]: T[K] extends AnyContractRouter ? PopulatedContractRouterPaths<T[K]> : never;
|
|
31
|
-
};
|
|
32
|
-
interface PopulateContractRouterPathsOptions {
|
|
33
|
-
path?: readonly string[];
|
|
34
|
-
}
|
|
59
|
+
|
|
35
60
|
/**
|
|
36
|
-
*
|
|
37
|
-
* because the procedure's path is required for NestJS implementation.
|
|
38
|
-
* This utility automatically populates any missing paths
|
|
39
|
-
* Using the router's keys + `/`.
|
|
40
|
-
*
|
|
41
|
-
* @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#define-your-contract NestJS Implement Contract Docs}
|
|
61
|
+
* Alias for `implement` from `@orpc/server` with default context set to `ORPCGlobalContext`
|
|
42
62
|
*/
|
|
43
|
-
declare function
|
|
63
|
+
declare function implement<T extends AnyContractRouter, TContext extends Context = ORPCGlobalContext>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
|
|
44
64
|
|
|
45
|
-
export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL,
|
|
46
|
-
export type {
|
|
65
|
+
export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
|
|
66
|
+
export type { ORPCGlobalContext, ORPCModuleConfig };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,46 +1,66 @@
|
|
|
1
|
+
import { AnySchema, ContractRouter, HTTPPath, AnyContractRouter } from '@orpc/contract';
|
|
2
|
+
export { PopulateContractRouterPathsOptions, PopulatedContractRouterPaths, populateContractRouterPaths } from '@orpc/contract';
|
|
3
|
+
import { CreateProcedureClientOptions, Router, Context, BuilderConfig, Implementer } from '@orpc/server';
|
|
4
|
+
export { ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, ORPCError, ProcedureImplementer, RouterImplementer, RouterImplementerWithMiddlewares, onError, onFinish, onStart, onSuccess } from '@orpc/server';
|
|
1
5
|
import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
import { Promisable } from '@orpc/shared';
|
|
6
|
-
import {
|
|
6
|
+
import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
|
|
7
|
+
import { StandardOpenAPICodecOptions } from '@orpc/openapi/standard';
|
|
8
|
+
import { StandardHandlerOptions } from '@orpc/server/standard';
|
|
9
|
+
import { Interceptor, Promisable } from '@orpc/shared';
|
|
10
|
+
import { StandardResponse } from '@orpc/standard-server';
|
|
7
11
|
import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
|
12
|
+
import { Observable } from 'rxjs';
|
|
8
13
|
|
|
9
14
|
declare const ORPC_MODULE_CONFIG_SYMBOL: unique symbol;
|
|
10
|
-
|
|
15
|
+
/**
|
|
16
|
+
* You can extend this interface to add global context properties.
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* declare module '@orpc/nest' {
|
|
20
|
+
* interface ORPCGlobalContext {
|
|
21
|
+
* user: { id: string; name: string }
|
|
22
|
+
* }
|
|
23
|
+
* }
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
interface ORPCGlobalContext {
|
|
27
|
+
}
|
|
28
|
+
interface ORPCModuleConfig extends CreateProcedureClientOptions<ORPCGlobalContext, AnySchema, object, object, object>, SendStandardResponseOptions, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPICodecOptions {
|
|
29
|
+
plugins?: StandardHandlerOptions<ORPCGlobalContext>['plugins'];
|
|
30
|
+
sendResponseInterceptors?: Interceptor<{
|
|
31
|
+
request: any;
|
|
32
|
+
response: any;
|
|
33
|
+
standardResponse: StandardResponse;
|
|
34
|
+
}, unknown>[];
|
|
11
35
|
}
|
|
12
36
|
declare class ORPCModule {
|
|
13
37
|
static forRoot(config: ORPCModuleConfig): DynamicModule;
|
|
38
|
+
static forRootAsync(options: {
|
|
39
|
+
imports?: any[];
|
|
40
|
+
useFactory: (...args: any[]) => Promise<ORPCModuleConfig> | ORPCModuleConfig;
|
|
41
|
+
inject?: any[];
|
|
42
|
+
}): DynamicModule;
|
|
14
43
|
}
|
|
15
44
|
|
|
16
45
|
/**
|
|
17
46
|
* Decorator in controller handler to implement a oRPC contract.
|
|
18
47
|
*
|
|
19
|
-
* @see {@link https://orpc.
|
|
48
|
+
* @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
|
|
20
49
|
*/
|
|
21
|
-
declare function Implement<T extends ContractRouter<any>>(contract: T): <U extends Promisable<Router<T,
|
|
50
|
+
declare function Implement<T extends ContractRouter<any>>(contract: T): <U extends Promisable<Router<T, ORPCGlobalContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
|
|
22
51
|
declare class ImplementInterceptor implements NestInterceptor {
|
|
23
52
|
private readonly config;
|
|
53
|
+
private readonly codec;
|
|
24
54
|
constructor(config: ORPCModuleConfig | undefined);
|
|
25
55
|
intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
|
|
26
56
|
}
|
|
27
57
|
|
|
28
58
|
declare function toNestPattern(path: HTTPPath): string;
|
|
29
|
-
|
|
30
|
-
[K in keyof T]: T[K] extends AnyContractRouter ? PopulatedContractRouterPaths<T[K]> : never;
|
|
31
|
-
};
|
|
32
|
-
interface PopulateContractRouterPathsOptions {
|
|
33
|
-
path?: readonly string[];
|
|
34
|
-
}
|
|
59
|
+
|
|
35
60
|
/**
|
|
36
|
-
*
|
|
37
|
-
* because the procedure's path is required for NestJS implementation.
|
|
38
|
-
* This utility automatically populates any missing paths
|
|
39
|
-
* Using the router's keys + `/`.
|
|
40
|
-
*
|
|
41
|
-
* @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#define-your-contract NestJS Implement Contract Docs}
|
|
61
|
+
* Alias for `implement` from `@orpc/server` with default context set to `ORPCGlobalContext`
|
|
42
62
|
*/
|
|
43
|
-
declare function
|
|
63
|
+
declare function implement<T extends AnyContractRouter, TContext extends Context = ORPCGlobalContext>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
|
|
44
64
|
|
|
45
|
-
export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL,
|
|
46
|
-
export type {
|
|
65
|
+
export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
|
|
66
|
+
export type { ORPCGlobalContext, ORPCModuleConfig };
|
package/dist/index.mjs
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
import {
|
|
1
|
+
import { getRouter, unlazy, isProcedure, implement as implement$1 } from '@orpc/server';
|
|
2
|
+
export { ORPCError, onError, onFinish, onStart, onSuccess } from '@orpc/server';
|
|
3
|
+
import { Module, Injectable, Inject, Optional, applyDecorators, Delete, Patch, Put, Post, Get, Head, HttpCode, UseInterceptors } from '@nestjs/common';
|
|
4
|
+
import { isContractProcedure, fallbackContractConfig } from '@orpc/contract';
|
|
5
|
+
export { populateContractRouterPaths } from '@orpc/contract';
|
|
4
6
|
import { standardizeHTTPPath, StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
|
|
5
7
|
import { StandardOpenAPICodec } from '@orpc/openapi/standard';
|
|
6
|
-
import {
|
|
7
|
-
|
|
8
|
-
import
|
|
9
|
-
import
|
|
10
|
-
import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
|
|
8
|
+
import { StandardHandler } from '@orpc/server/standard';
|
|
9
|
+
import { get, toArray, intercept } from '@orpc/shared';
|
|
10
|
+
import * as StandardServerFastify from '@orpc/standard-server-fastify';
|
|
11
|
+
import * as StandardServerNode from '@orpc/standard-server-node';
|
|
11
12
|
import { mergeMap } from 'rxjs';
|
|
12
|
-
import { toHttpPath } from '@orpc/client/standard';
|
|
13
13
|
|
|
14
14
|
var __getOwnPropDesc$1 = Object.getOwnPropertyDescriptor;
|
|
15
15
|
var __decorateClass$1 = (decorators, target, key, kind) => {
|
|
@@ -35,6 +35,22 @@ let ORPCModule = class {
|
|
|
35
35
|
global: true
|
|
36
36
|
};
|
|
37
37
|
}
|
|
38
|
+
static forRootAsync(options) {
|
|
39
|
+
return {
|
|
40
|
+
module: ORPCModule,
|
|
41
|
+
imports: options.imports,
|
|
42
|
+
providers: [
|
|
43
|
+
{
|
|
44
|
+
provide: ORPC_MODULE_CONFIG_SYMBOL,
|
|
45
|
+
useFactory: options.useFactory,
|
|
46
|
+
inject: options.inject
|
|
47
|
+
},
|
|
48
|
+
ImplementInterceptor
|
|
49
|
+
],
|
|
50
|
+
exports: [ORPC_MODULE_CONFIG_SYMBOL, ImplementInterceptor],
|
|
51
|
+
global: true
|
|
52
|
+
};
|
|
53
|
+
}
|
|
38
54
|
};
|
|
39
55
|
ORPCModule = __decorateClass$1([
|
|
40
56
|
Module({})
|
|
@@ -43,26 +59,6 @@ ORPCModule = __decorateClass$1([
|
|
|
43
59
|
function toNestPattern(path) {
|
|
44
60
|
return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/*$1").replace(/\/\{([^}]+)\}/g, "/:$1");
|
|
45
61
|
}
|
|
46
|
-
function populateContractRouterPaths(router, options = {}) {
|
|
47
|
-
const path = toArray(options.path);
|
|
48
|
-
if (isContractProcedure(router)) {
|
|
49
|
-
if (router["~orpc"].route.path === void 0) {
|
|
50
|
-
return new ContractProcedure({
|
|
51
|
-
...router["~orpc"],
|
|
52
|
-
route: {
|
|
53
|
-
...router["~orpc"].route,
|
|
54
|
-
path: toHttpPath(path)
|
|
55
|
-
}
|
|
56
|
-
});
|
|
57
|
-
}
|
|
58
|
-
return router;
|
|
59
|
-
}
|
|
60
|
-
const populated = {};
|
|
61
|
-
for (const key in router) {
|
|
62
|
-
populated[key] = populateContractRouterPaths(router[key], { ...options, path: [...path, key] });
|
|
63
|
-
}
|
|
64
|
-
return populated;
|
|
65
|
-
}
|
|
66
62
|
|
|
67
63
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
68
64
|
var __decorateClass = (decorators, target, key, kind) => {
|
|
@@ -89,12 +85,13 @@ function Implement(contract) {
|
|
|
89
85
|
throw new Error(`
|
|
90
86
|
@Implement decorator requires contract to have a 'path'.
|
|
91
87
|
Please define one using 'path' property on the '.route' method.
|
|
92
|
-
Or use "populateContractRouterPaths" utility to automatically fill in any missing paths.
|
|
88
|
+
Or use "populateContractRouterPaths" from "@orpc/contract" utility to automatically fill in any missing paths.
|
|
93
89
|
`);
|
|
94
90
|
}
|
|
95
91
|
return (target, propertyKey, descriptor) => {
|
|
96
92
|
applyDecorators(
|
|
97
93
|
MethodDecoratorMap[method](toNestPattern(path)),
|
|
94
|
+
HttpCode(fallbackContractConfig("defaultSuccessStatus", contract["~orpc"].route.successStatus)),
|
|
98
95
|
UseInterceptors(ImplementInterceptor)
|
|
99
96
|
)(target, propertyKey, descriptor);
|
|
100
97
|
};
|
|
@@ -120,15 +117,18 @@ function Implement(contract) {
|
|
|
120
117
|
}
|
|
121
118
|
};
|
|
122
119
|
}
|
|
123
|
-
const codec = new StandardOpenAPICodec(
|
|
124
|
-
new StandardOpenAPISerializer(
|
|
125
|
-
new StandardOpenAPIJsonSerializer(),
|
|
126
|
-
new StandardBracketNotationSerializer()
|
|
127
|
-
)
|
|
128
|
-
);
|
|
129
120
|
let ImplementInterceptor = class {
|
|
121
|
+
config;
|
|
122
|
+
codec;
|
|
130
123
|
constructor(config) {
|
|
131
|
-
this.config = config;
|
|
124
|
+
this.config = config ?? {};
|
|
125
|
+
this.codec = new StandardOpenAPICodec(
|
|
126
|
+
new StandardOpenAPISerializer(
|
|
127
|
+
new StandardOpenAPIJsonSerializer(this.config),
|
|
128
|
+
new StandardBracketNotationSerializer(this.config)
|
|
129
|
+
),
|
|
130
|
+
this.config
|
|
131
|
+
);
|
|
132
132
|
}
|
|
133
133
|
intercept(ctx, next) {
|
|
134
134
|
return next.handle().pipe(
|
|
@@ -141,32 +141,33 @@ let ImplementInterceptor = class {
|
|
|
141
141
|
}
|
|
142
142
|
const req = ctx.switchToHttp().getRequest();
|
|
143
143
|
const res = ctx.switchToHttp().getResponse();
|
|
144
|
-
const
|
|
145
|
-
const
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
144
|
+
const standardRequest = "raw" in req ? StandardServerFastify.toStandardLazyRequest(req, res) : StandardServerNode.toStandardLazyRequest(req, res);
|
|
145
|
+
const handler = new StandardHandler(procedure, {
|
|
146
|
+
init: () => {
|
|
147
|
+
},
|
|
148
|
+
match: () => Promise.resolve({ path: toArray(this.config.path), procedure, params: flattenParams(req.params) })
|
|
149
|
+
}, this.codec, {
|
|
150
|
+
// Since plugins can modify options directly, so we need to clone to avoid affecting other handlers/requests
|
|
151
|
+
// TODO: improve plugins system to avoid this cloning
|
|
152
|
+
clientInterceptors: [...toArray(this.config.interceptors)],
|
|
153
|
+
plugins: [...toArray(this.config.plugins)]
|
|
154
|
+
});
|
|
155
|
+
const result = await handler.handle(standardRequest, {
|
|
156
|
+
context: this.config.context
|
|
157
|
+
});
|
|
158
|
+
if (result.matched) {
|
|
159
|
+
return intercept(
|
|
160
|
+
toArray(this.config.sendResponseInterceptors),
|
|
161
|
+
{ request: req, response: res, standardResponse: result.response },
|
|
162
|
+
async ({ response, standardResponse }) => {
|
|
163
|
+
if ("raw" in response) {
|
|
164
|
+
await StandardServerFastify.sendStandardResponse(response, standardResponse, this.config);
|
|
165
|
+
} else {
|
|
166
|
+
await StandardServerNode.sendStandardResponse(response, standardResponse, this.config);
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
);
|
|
170
|
+
}
|
|
170
171
|
})
|
|
171
172
|
);
|
|
172
173
|
}
|
|
@@ -188,4 +189,8 @@ function flattenParams(params) {
|
|
|
188
189
|
return flatten;
|
|
189
190
|
}
|
|
190
191
|
|
|
191
|
-
|
|
192
|
+
function implement(contract, config = {}) {
|
|
193
|
+
return implement$1(contract, config);
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
|
package/package.json
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/nest",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.325aa5d",
|
|
5
5
|
"license": "MIT",
|
|
6
|
-
"homepage": "https://orpc.
|
|
6
|
+
"homepage": "https://orpc.dev",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/
|
|
9
|
+
"url": "git+https://github.com/middleapi/orpc.git",
|
|
10
10
|
"directory": "packages/nest"
|
|
11
11
|
},
|
|
12
12
|
"keywords": [
|
|
13
|
-
"unnoq",
|
|
14
13
|
"orpc"
|
|
15
14
|
],
|
|
16
15
|
"exports": {
|
|
@@ -39,28 +38,30 @@
|
|
|
39
38
|
}
|
|
40
39
|
},
|
|
41
40
|
"dependencies": {
|
|
42
|
-
"@orpc/client": "0.0.0-next.
|
|
43
|
-
"@orpc/contract": "0.0.0-next.
|
|
44
|
-
"@orpc/openapi": "0.0.0-next.
|
|
45
|
-
"@orpc/openapi-client": "0.0.0-next.
|
|
46
|
-
"@orpc/server": "0.0.0-next.
|
|
47
|
-
"@orpc/
|
|
48
|
-
"@orpc/standard-server": "0.0.0-next.
|
|
49
|
-
"@orpc/
|
|
41
|
+
"@orpc/client": "0.0.0-next.325aa5d",
|
|
42
|
+
"@orpc/contract": "0.0.0-next.325aa5d",
|
|
43
|
+
"@orpc/openapi": "0.0.0-next.325aa5d",
|
|
44
|
+
"@orpc/openapi-client": "0.0.0-next.325aa5d",
|
|
45
|
+
"@orpc/standard-server": "0.0.0-next.325aa5d",
|
|
46
|
+
"@orpc/server": "0.0.0-next.325aa5d",
|
|
47
|
+
"@orpc/standard-server-fastify": "0.0.0-next.325aa5d",
|
|
48
|
+
"@orpc/shared": "0.0.0-next.325aa5d",
|
|
49
|
+
"@orpc/standard-server-node": "0.0.0-next.325aa5d"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
|
-
"@
|
|
53
|
-
"@nestjs/
|
|
54
|
-
"@nestjs/
|
|
55
|
-
"@nestjs/platform-
|
|
56
|
-
"@nestjs/
|
|
52
|
+
"@fastify/cookie": "^11.0.2",
|
|
53
|
+
"@nestjs/common": "^11.1.16",
|
|
54
|
+
"@nestjs/core": "^11.1.16",
|
|
55
|
+
"@nestjs/platform-express": "^11.1.16",
|
|
56
|
+
"@nestjs/platform-fastify": "^11.1.16",
|
|
57
|
+
"@nestjs/testing": "^11.1.16",
|
|
57
58
|
"@ts-rest/core": "^3.52.1",
|
|
58
|
-
"@types/express": "^5.0.
|
|
59
|
-
"express": "^5.
|
|
60
|
-
"fastify": "^5.
|
|
61
|
-
"rxjs": "^7.8.
|
|
62
|
-
"supertest": "^7.1.
|
|
63
|
-
"zod": "^4.
|
|
59
|
+
"@types/express": "^5.0.6",
|
|
60
|
+
"express": "^5.2.1",
|
|
61
|
+
"fastify": "^5.8.2",
|
|
62
|
+
"rxjs": "^7.8.2",
|
|
63
|
+
"supertest": "^7.1.4",
|
|
64
|
+
"zod": "^4.3.6"
|
|
64
65
|
},
|
|
65
66
|
"scripts": {
|
|
66
67
|
"build": "unbuild",
|