@orpc/nest 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.
Files changed (5) hide show
  1. package/README.md +78 -141
  2. package/dist/index.d.mts +34 -47
  3. package/dist/index.d.ts +34 -47
  4. package/dist/index.mjs +144 -85
  5. package/package.json +22 -35
package/README.md CHANGED
@@ -1,8 +1,4 @@
1
- <div align="center">
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,109 +18,48 @@
22
18
  </a>
23
19
  </div>
24
20
 
25
- <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
21
+ ## Documentation
22
+
23
+ You can read the documentation [here](https://orpc.dev).
26
24
 
27
- **oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
25
+ ## Packages
28
26
 
29
- ---
27
+ **Core**
30
28
 
31
- ## Highlights
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
- - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
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
- ## Documentation
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
- You can find the full documentation [here](https://orpc.dev).
40
+ **Built-in features**
49
41
 
50
- ## Packages
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
- - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
53
- - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
54
- - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
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.
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/nest`
68
-
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.
70
-
71
- ### Implement Contract
72
-
73
- An overview of how to implement an [oRPC contract](https://orpc.dev/docs/contract-first/define-contract) in NestJS.
74
-
75
- ```ts
76
- import { Implement, implement, ORPCError } from '@orpc/nest'
77
-
78
- @Controller()
79
- export class PlanetController {
80
- /**
81
- * Implement a standalone procedure
82
- */
83
- @Implement(contract.planet.list)
84
- list() {
85
- return implement(contract.planet.list).handler(({ input }) => {
86
- // Implement logic here
87
-
88
- return []
89
- })
90
- }
91
-
92
- /**
93
- * Implement entire contract
94
- */
95
- @Implement(contract.planet)
96
- planet() {
97
- return {
98
- list: implement(contract.planet.list).handler(({ input }) => {
99
- // Implement logic here
100
- return []
101
- }),
102
- find: implement(contract.planet.find).handler(({ input }) => {
103
- // Implement logic here
104
- return {
105
- id: 1,
106
- name: 'Earth',
107
- description: 'The planet Earth',
108
- }
109
- }),
110
- create: implement(contract.planet.create).handler(({ input }) => {
111
- // Implement logic here
112
- return {
113
- id: 1,
114
- name: 'Earth',
115
- description: 'The planet Earth',
116
- }
117
- }),
118
- }
119
- }
120
-
121
- // other handlers...
122
- }
123
- ```
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.
124
59
 
125
60
  ## Sponsors
126
61
 
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).
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! 🚀
128
63
 
129
64
  ### 🏆 Platinum Sponsor
130
65
 
@@ -142,19 +77,11 @@ If you find oRPC valuable and would like to support its development, you can do
142
77
  </tr>
143
78
  </table>
144
79
 
145
- ### 🥉 Bronze Sponsor
146
-
147
- <table>
148
- <tr>
149
- <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>
150
- </tr>
151
- </table>
152
-
153
80
  ### Generous Sponsors
154
81
 
155
82
  <table>
156
83
  <tr>
157
- <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="139" alt="LN Markets"/><br />LN Markets</a></td>
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>
158
85
  </tr>
159
86
  </table>
160
87
 
@@ -162,26 +89,26 @@ If you find oRPC valuable and would like to support its development, you can do
162
89
 
163
90
  <table>
164
91
  <tr>
165
- <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="119" alt="Reece McDonald"/><br />Reece McDonald</a></td>
166
- <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&amp;v=4" width="119" alt="nk"/><br />nk</a></td>
167
- <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="119" alt="supastarter"/><br />supastarter</a></td>
168
- <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&amp;v=4" width="119" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
169
- <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&amp;v=4" width="119" alt="herrfugbaum"/><br />herrfugbaum</a></td>
170
- <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&amp;v=4" width="119" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
171
- <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&amp;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&amp;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&amp;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&amp;v=4" width="139" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
172
98
  </tr>
173
99
  <tr>
174
- <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&amp;v=4" width="119" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
175
- <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&amp;v=4" width="119" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
176
- <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&amp;v=4" width="119" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
177
- <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="119" alt="Andrew Peters"/><br />Andrew Peters</a></td>
178
- <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&amp;v=4" width="119" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
179
- <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="119" alt="christ12938"/><br />christ12938</a></td>
180
- <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&amp;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&amp;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&amp;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&amp;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&amp;v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
181
106
  </tr>
182
107
  <tr>
183
- <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&amp;v=4" width="119" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
184
- <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&amp;v=4" width="119" alt="shota"/><br />shota</a></td>
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&amp;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&amp;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&amp;v=4" width="139" alt="shota"/><br />shota</a></td>
185
112
  </tr>
186
113
  </table>
187
114
 
@@ -189,28 +116,27 @@ If you find oRPC valuable and would like to support its development, you can do
189
116
 
190
117
  <table>
191
118
  <tr>
192
- <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&amp;v=4" width="104" alt="David Walsh"/><br />David Walsh</a></td>
193
- <td align="center"><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&amp;v=4" width="104" alt="Adam Tkaczyk"/><br />Adam Tkaczyk</a></td>
194
- <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&amp;v=4" width="104" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
195
- <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="104" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
196
- <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&amp;v=4" width="104" alt="soonoo"/><br />soonoo</a></td>
197
- <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&amp;v=4" width="104" alt="Kevin Porten"/><br />Kevin Porten</a></td>
198
- <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&amp;v=4" width="104" alt="Denis"/><br />Denis</a></td>
199
- <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&amp;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&amp;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&amp;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&amp;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&amp;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&amp;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&amp;v=4" width="119" alt="Denis"/><br />Denis</a></td>
200
126
  </tr>
201
127
  <tr>
202
- <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&amp;v=4" width="104" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
203
- <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&amp;v=4" width="104" alt="Sam"/><br />Sam</a></td>
204
- <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&amp;v=4" width="104" alt="Titoine"/><br />Titoine</a></td>
205
- <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&amp;v=4" width="104" alt="Igor Makowski"/><br />Igor Makowski</a></td>
206
- <td align="center"><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&amp;v=4" width="104" alt="Anees Iqbal"/><br />Anees Iqbal</a></td>
207
- <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&amp;v=4" width="104" alt="hanayashiki"/><br />hanayashiki</a></td>
208
- <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&amp;v=4" width="104" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
209
- <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&amp;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&amp;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&amp;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&amp;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&amp;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&amp;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&amp;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&amp;v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
210
135
  </tr>
211
136
  <tr>
212
- <td align="center"><a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="nattstack"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&amp;v=4" width="104" alt="nattstack"/><br />nattstack</a></td>
213
- <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&amp;v=4" width="104" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
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&amp;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&amp;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&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
214
140
  </tr>
215
141
  </table>
216
142
 
@@ -226,7 +152,7 @@ If you find oRPC valuable and would like to support its development, you can do
226
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&amp;v=4" width="32" height="32" alt="Théo LUDWIG" /></a>
227
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&amp;v=4" width="32" height="32" alt="Abhay Ramesh" /></a>
228
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>
229
- <a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=24e8dd943cfc862aa284d858a023532c75071ade&amp;v=4" width="32" height="32" alt="0x4e32" /></a>
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&amp;v=4" width="32" height="32" alt="0x4e32" /></a>
230
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&amp;v=4" width="32" height="32" alt="Ryuz" /></a>
231
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&amp;v=4" width="32" height="32" alt="happyboy" /></a>
232
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&amp;v=4" width="32" height="32" alt="yicchi" /></a>
@@ -246,9 +172,20 @@ If you find oRPC valuable and would like to support its development, you can do
246
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&amp;v=4" width="32" height="32" alt="Laduni Estu Syalwa" /></a>
247
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&amp;v=4" width="32" height="32" alt="Chen, Zhi-Yuan" /></a>
248
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&amp;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&amp;v=4" width="32" height="32" alt="Anees Iqbal" /></a>
249
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&amp;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&amp;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&amp;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>
250
180
  </p>
251
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
+
252
189
  ## License
253
190
 
254
191
  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,38 +1,35 @@
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';
5
1
  import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
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';
11
- import { SendStandardResponseOptions } from '@orpc/standard-server-node';
2
+ import { RouterContract } from '@orpc/contract';
3
+ import { DefaultInitialContext, ContractedRouter } from '@orpc/server';
4
+ import { Promisable } from '@orpc/shared';
12
5
  import { Observable } from 'rxjs';
6
+ import { OpenAPIHandlerCodecCoreOptions } from '@orpc/openapi/standard';
7
+ import { StandardHandlerOptions } from '@orpc/server/standard';
8
+ import { StandardLazyRequest } from '@standardserver/core';
9
+ import { ToEventStreamOptions } from '@standardserver/node';
10
+ import { HttpAdapterHost } from '@nestjs/core';
13
11
 
14
12
  declare const ORPC_MODULE_CONFIG_SYMBOL: unique symbol;
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>[];
35
- }
13
+ type ORPCModuleConfig = OpenAPIHandlerCodecCoreOptions<DefaultInitialContext> & StandardHandlerOptions<DefaultInitialContext> & (object extends DefaultInitialContext ? {
14
+ context?: DefaultInitialContext;
15
+ } : {
16
+ context: DefaultInitialContext;
17
+ }) & {
18
+ /**
19
+ * Customize how convert next.js req and res to StandardLazyRequest,
20
+ * You might need define this if you not using express or fastify adapters
21
+ */
22
+ toStandardLazyRequest?: undefined | ((req: any, res: any) => StandardLazyRequest);
23
+ /**
24
+ * Options for how to convert the Standard Response to a Nest Response (returning value), like event iterator options, etc.
25
+ */
26
+ toNestResponse?: undefined | {
27
+ /**
28
+ * Options for the event stream, like keep-alive settings, initial comment, etc.
29
+ */
30
+ eventStream?: undefined | ToEventStreamOptions;
31
+ };
32
+ };
36
33
  declare class ORPCModule {
37
34
  static forRoot(config: ORPCModuleConfig): DynamicModule;
38
35
  static forRootAsync(options: {
@@ -42,25 +39,15 @@ declare class ORPCModule {
42
39
  }): DynamicModule;
43
40
  }
44
41
 
45
- /**
46
- * Decorator in controller handler to implement a oRPC contract.
47
- *
48
- * @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
49
- */
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;
42
+ declare function Implement<T extends RouterContract>(contract: T): <U extends Promisable<ContractedRouter<T, DefaultInitialContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
51
43
  declare class ImplementInterceptor implements NestInterceptor {
52
44
  private readonly config;
53
45
  private readonly codec;
54
- constructor(config: ORPCModuleConfig | undefined);
46
+ private readonly toStandardLazyRequest;
47
+ private readonly httpAdapterHost;
48
+ constructor(config: ORPCModuleConfig | undefined, httpAdapterHost: HttpAdapterHost);
55
49
  intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
56
50
  }
57
51
 
58
- declare function toNestPattern(path: HTTPPath): string;
59
-
60
- /**
61
- * Alias for `implement` from `@orpc/server` with default context set to `ORPCGlobalContext`
62
- */
63
- declare function implement<T extends AnyContractRouter, TContext extends Context = ORPCGlobalContext>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
64
-
65
- export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
66
- export type { ORPCGlobalContext, ORPCModuleConfig };
52
+ export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL };
53
+ export type { ORPCModuleConfig };
package/dist/index.d.ts CHANGED
@@ -1,38 +1,35 @@
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';
5
1
  import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
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';
11
- import { SendStandardResponseOptions } from '@orpc/standard-server-node';
2
+ import { RouterContract } from '@orpc/contract';
3
+ import { DefaultInitialContext, ContractedRouter } from '@orpc/server';
4
+ import { Promisable } from '@orpc/shared';
12
5
  import { Observable } from 'rxjs';
6
+ import { OpenAPIHandlerCodecCoreOptions } from '@orpc/openapi/standard';
7
+ import { StandardHandlerOptions } from '@orpc/server/standard';
8
+ import { StandardLazyRequest } from '@standardserver/core';
9
+ import { ToEventStreamOptions } from '@standardserver/node';
10
+ import { HttpAdapterHost } from '@nestjs/core';
13
11
 
14
12
  declare const ORPC_MODULE_CONFIG_SYMBOL: unique symbol;
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>[];
35
- }
13
+ type ORPCModuleConfig = OpenAPIHandlerCodecCoreOptions<DefaultInitialContext> & StandardHandlerOptions<DefaultInitialContext> & (object extends DefaultInitialContext ? {
14
+ context?: DefaultInitialContext;
15
+ } : {
16
+ context: DefaultInitialContext;
17
+ }) & {
18
+ /**
19
+ * Customize how convert next.js req and res to StandardLazyRequest,
20
+ * You might need define this if you not using express or fastify adapters
21
+ */
22
+ toStandardLazyRequest?: undefined | ((req: any, res: any) => StandardLazyRequest);
23
+ /**
24
+ * Options for how to convert the Standard Response to a Nest Response (returning value), like event iterator options, etc.
25
+ */
26
+ toNestResponse?: undefined | {
27
+ /**
28
+ * Options for the event stream, like keep-alive settings, initial comment, etc.
29
+ */
30
+ eventStream?: undefined | ToEventStreamOptions;
31
+ };
32
+ };
36
33
  declare class ORPCModule {
37
34
  static forRoot(config: ORPCModuleConfig): DynamicModule;
38
35
  static forRootAsync(options: {
@@ -42,25 +39,15 @@ declare class ORPCModule {
42
39
  }): DynamicModule;
43
40
  }
44
41
 
45
- /**
46
- * Decorator in controller handler to implement a oRPC contract.
47
- *
48
- * @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
49
- */
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;
42
+ declare function Implement<T extends RouterContract>(contract: T): <U extends Promisable<ContractedRouter<T, DefaultInitialContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
51
43
  declare class ImplementInterceptor implements NestInterceptor {
52
44
  private readonly config;
53
45
  private readonly codec;
54
- constructor(config: ORPCModuleConfig | undefined);
46
+ private readonly toStandardLazyRequest;
47
+ private readonly httpAdapterHost;
48
+ constructor(config: ORPCModuleConfig | undefined, httpAdapterHost: HttpAdapterHost);
55
49
  intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
56
50
  }
57
51
 
58
- declare function toNestPattern(path: HTTPPath): string;
59
-
60
- /**
61
- * Alias for `implement` from `@orpc/server` with default context set to `ORPCGlobalContext`
62
- */
63
- declare function implement<T extends AnyContractRouter, TContext extends Context = ORPCGlobalContext>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
64
-
65
- export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
66
- export type { ORPCGlobalContext, ORPCModuleConfig };
52
+ export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL };
53
+ export type { ORPCModuleConfig };
package/dist/index.mjs CHANGED
@@ -1,15 +1,14 @@
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, applyDecorators, Options, Delete, Patch, Put, Post, Get, Head, HttpCode, UseInterceptors, Injectable, Inject, Optional } from '@nestjs/common';
4
- import { isContractProcedure, fallbackContractConfig } from '@orpc/contract';
5
- export { populateContractRouterPaths } from '@orpc/contract';
6
- import { standardizeHTTPPath, StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
7
- import { StandardOpenAPICodec } from '@orpc/openapi/standard';
1
+ import { Readable } from 'node:stream';
2
+ import { Module, applyDecorators, Options, Delete, Patch, Put, Post, Get, Head, HttpCode, UseInterceptors, StreamableFile, HttpException, Injectable, Inject, Optional } from '@nestjs/common';
3
+ import { HttpAdapterHost } from '@nestjs/core';
4
+ import { ProcedureContract, getPathMeta } from '@orpc/contract';
5
+ import { getOpenAPIMeta, DEFAULT_OPENAPI_METHOD, getDynamicPathParams } from '@orpc/openapi';
6
+ import { OpenAPIHandlerCodecCore } from '@orpc/openapi/standard';
7
+ import { DEFAULT_SUCCESS_STATUS, getRouter, unlazy, Procedure } from '@orpc/server';
8
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 StandardServerFetch from '@orpc/standard-server-fetch';
12
- import * as StandardServerNode from '@orpc/standard-server-node';
9
+ import { mergeHttpPath, get, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
10
+ import { flattenStandardHeader, generateContentDisposition } from '@standardserver/core';
11
+ import { toStandardLazyRequest, toEventStream } from '@standardserver/node';
13
12
  import { mergeMap } from 'rxjs';
14
13
 
15
14
  var __getOwnPropDesc$1 = Object.getOwnPropertyDescriptor;
@@ -20,7 +19,7 @@ var __decorateClass$1 = (decorators, target, key, kind) => {
20
19
  result = (decorator(result)) || result;
21
20
  return result;
22
21
  };
23
- const ORPC_MODULE_CONFIG_SYMBOL = Symbol("ORPC_MODULE_CONFIG");
22
+ const ORPC_MODULE_CONFIG_SYMBOL = Symbol.for("ORPC_NEST_MODULE_CONFIG");
24
23
  let ORPCModule = class {
25
24
  static forRoot(config) {
26
25
  return {
@@ -57,10 +56,6 @@ ORPCModule = __decorateClass$1([
57
56
  Module({})
58
57
  ], ORPCModule);
59
58
 
60
- function toNestPattern(path) {
61
- return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/*$1").replace(/\/\{([^}]+)\}/g, "/:$1");
62
- }
63
-
64
59
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
65
60
  var __decorateClass = (decorators, target, key, kind) => {
66
61
  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
@@ -80,20 +75,22 @@ const MethodDecoratorMap = {
80
75
  OPTIONS: Options
81
76
  };
82
77
  function Implement(contract) {
83
- if (isContractProcedure(contract)) {
84
- const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
85
- const path = contract["~orpc"].route.path;
86
- if (path === void 0) {
87
- throw new Error(`
88
- @Implement decorator requires contract to have a 'path'.
89
- Please define one using 'path' property on the '.route' method.
90
- Or use "populateContractRouterPaths" from "@orpc/contract" utility to automatically fill in any missing paths.
78
+ if (contract instanceof ProcedureContract) {
79
+ const meta = getOpenAPIMeta(contract);
80
+ if (meta?.path === void 0) {
81
+ throw new TypeError(`
82
+ @Implement decorator requires contract to have a 'openapi.path' meta.
83
+ Please define one using '.meta(openapi({ path: '/example' }))'.
84
+ Or use "populateRouterContractOpenAPIPaths" from "@orpc/openapi" utility to automatically fill in any missing paths.
91
85
  `);
92
86
  }
87
+ const method = meta.method ?? DEFAULT_OPENAPI_METHOD;
88
+ const path = toNestPattern(meta.prefix ? mergeHttpPath(meta.prefix, meta.path) : meta.path);
89
+ const successStatus = meta.successStatus ?? DEFAULT_SUCCESS_STATUS;
93
90
  return (target, propertyKey, descriptor) => {
94
91
  applyDecorators(
95
- MethodDecoratorMap[method](toNestPattern(path)),
96
- HttpCode(fallbackContractConfig("defaultSuccessStatus", contract["~orpc"].route.successStatus)),
92
+ MethodDecoratorMap[method](path),
93
+ HttpCode(successStatus),
97
94
  UseInterceptors(ImplementInterceptor)
98
95
  )(target, propertyKey, descriptor);
99
96
  };
@@ -122,67 +119,110 @@ function Implement(contract) {
122
119
  let ImplementInterceptor = class {
123
120
  config;
124
121
  codec;
125
- constructor(config) {
122
+ toStandardLazyRequest;
123
+ httpAdapterHost;
124
+ constructor(config, httpAdapterHost) {
126
125
  this.config = config ?? {};
127
- this.codec = new StandardOpenAPICodec(
128
- new StandardOpenAPISerializer(
129
- new StandardOpenAPIJsonSerializer(this.config),
130
- new StandardBracketNotationSerializer(this.config)
131
- ),
132
- this.config
133
- );
126
+ this.httpAdapterHost = httpAdapterHost;
127
+ this.codec = new OpenAPIHandlerCodecCore(this.config);
128
+ this.toStandardLazyRequest = this.config.toStandardLazyRequest ?? ((req, res) => {
129
+ const standardRequest = toStandardLazyRequest(
130
+ "raw" in req ? req.raw : req,
131
+ "raw" in res ? res.raw : res
132
+ );
133
+ if (req.body !== void 0) {
134
+ standardRequest.resolveBody = () => Promise.resolve(req.body);
135
+ }
136
+ return standardRequest;
137
+ });
134
138
  }
135
139
  intercept(ctx, next) {
136
140
  return next.handle().pipe(
137
141
  mergeMap(async (impl) => {
138
142
  const { default: procedure } = await unlazy(impl);
139
- if (!isProcedure(procedure)) {
140
- throw new Error(`
143
+ if (!(procedure instanceof Procedure)) {
144
+ throw new TypeError(`
141
145
  The return value of the @Implement controller handler must be a corresponding implemented router or procedure.
142
146
  `);
143
147
  }
144
148
  const req = ctx.switchToHttp().getRequest();
145
149
  const res = ctx.switchToHttp().getResponse();
146
- const isHono = "finalized" in res && typeof res.newResponse === "function";
147
- const isFastify = "raw" in req && !isHono;
148
- const standardRequest = (() => {
149
- if (isHono) {
150
- return StandardServerFetch.toStandardLazyRequest(req.raw);
151
- }
152
- if (isFastify) {
153
- return StandardServerFastify.toStandardLazyRequest(req, res);
154
- }
155
- return StandardServerNode.toStandardLazyRequest(req, res);
156
- })();
157
- const handler = new StandardHandler(procedure, {
158
- init: () => {
159
- },
160
- match: () => Promise.resolve({ path: toArray(this.config.path), procedure, params: flattenParams(req.params) })
161
- }, this.codec, {
162
- // Since plugins can modify options directly, so we need to clone to avoid affecting other handlers/requests
163
- // TODO: improve plugins system to avoid this cloning
164
- clientInterceptors: [...toArray(this.config.interceptors)],
165
- plugins: [...toArray(this.config.plugins)]
166
- });
150
+ const standardRequest = this.toStandardLazyRequest(req, res);
151
+ const handler = new StandardHandler({
152
+ resolveProcedure: () => Promise.resolve({
153
+ path: getPathMeta(procedure) ?? [],
154
+ procedure,
155
+ decodeInput: () => this.codec.decodeInput({
156
+ procedure,
157
+ params: toORPCOpenAPIParams(procedure, req.params)
158
+ }, standardRequest)
159
+ }),
160
+ encodeError: this.codec.encodeError.bind(this.codec),
161
+ encodeOutput: this.codec.encodeOutput.bind(this.codec)
162
+ }, this.config);
167
163
  const result = await handler.handle(standardRequest, {
168
- context: this.config.context
164
+ context: this.config.context ?? {}
169
165
  });
170
- if (result.matched) {
171
- return intercept(
172
- toArray(this.config.sendResponseInterceptors),
173
- { request: req, response: res, standardResponse: result.response },
174
- async ({ response, standardResponse }) => {
175
- if (isHono) {
176
- const fetchResponse = StandardServerFetch.toFetchResponse(standardResponse, this.config);
177
- return response.newResponse(fetchResponse.body, fetchResponse);
178
- } else if (isFastify) {
179
- await StandardServerFastify.sendStandardResponse(response, standardResponse, this.config);
166
+ if (!result.matched) {
167
+ throw new TypeError(
168
+ "oRPC NestJS handler returned an unmatched result, which should never happen. Please check your plugins/interceptors or report a bug."
169
+ );
170
+ }
171
+ const httpAdapter = this.httpAdapterHost.httpAdapter;
172
+ httpAdapter.status(res, result.response.status);
173
+ for (const key in result.response.headers) {
174
+ const value = result.response.headers[key];
175
+ if (typeof value === "string") {
176
+ httpAdapter.setHeader(res, key, value);
177
+ } else {
178
+ value?.forEach((value2, index) => {
179
+ if (index === 0) {
180
+ httpAdapter.setHeader(res, key, value2);
180
181
  } else {
181
- await StandardServerNode.sendStandardResponse(response, standardResponse, this.config);
182
+ httpAdapter.appendHeader(res, key, value2);
182
183
  }
183
- }
184
- );
184
+ });
185
+ }
186
+ }
187
+ const body = result.response.body;
188
+ if (body instanceof ReadableStream) {
189
+ httpAdapter.setHeader(res, "standard-server", "octet-stream");
190
+ return new StreamableFile(Readable.fromWeb(body), {
191
+ type: flattenStandardHeader(result.response.headers["content-type"]) ?? "application/octet-stream"
192
+ });
193
+ }
194
+ if (isAsyncIteratorObject(body)) {
195
+ return new StreamableFile(toEventStream(body, this.config.toNestResponse?.eventStream), {
196
+ type: "text/event-stream"
197
+ });
185
198
  }
199
+ if (body instanceof Blob) {
200
+ httpAdapter.setHeader(res, "standard-server", "file");
201
+ return new StreamableFile(Readable.fromWeb(body.stream()), {
202
+ type: body.type,
203
+ disposition: flattenStandardHeader(result.response.headers["content-disposition"]) ?? generateContentDisposition(body instanceof File ? body.name : "blob"),
204
+ // BunS3 can use NaN for the size
205
+ length: Number.isNaN(body.size) ? void 0 : body.size
206
+ });
207
+ }
208
+ if (body instanceof FormData) {
209
+ const response = new Response(body);
210
+ return new StreamableFile(Readable.fromWeb(response.body), {
211
+ type: response.headers.get("content-type")
212
+ });
213
+ }
214
+ if (body instanceof URLSearchParams) {
215
+ httpAdapter.setHeader(res, "content-type", "application/x-www-form-urlencoded");
216
+ return body.toString();
217
+ }
218
+ if (body === void 0) {
219
+ return body;
220
+ }
221
+ if (result.response.status >= 300 && typeof body === "object" && body !== null && !Array.isArray(body)) {
222
+ throw new HttpException(body, result.response.status);
223
+ }
224
+ httpAdapter.setHeader(res, "content-type", "application/json");
225
+ return typeof body === "string" || body === null ? stringifyJSON(body) : body;
186
226
  })
187
227
  );
188
228
  }
@@ -190,22 +230,41 @@ let ImplementInterceptor = class {
190
230
  ImplementInterceptor = __decorateClass([
191
231
  Injectable(),
192
232
  __decorateParam(0, Inject(ORPC_MODULE_CONFIG_SYMBOL)),
193
- __decorateParam(0, Optional())
233
+ __decorateParam(0, Optional()),
234
+ __decorateParam(1, Inject(HttpAdapterHost))
194
235
  ], ImplementInterceptor);
195
- function flattenParams(params) {
196
- const flatten = {};
197
- for (const [key, value] of Object.entries(params ?? {})) {
198
- if (Array.isArray(value)) {
199
- flatten[key] = value.join("/");
200
- } else {
201
- flatten[key] = value;
202
- }
236
+ function flattenParamValue(value) {
237
+ return Array.isArray(value) ? value.join("/") : value;
238
+ }
239
+ function toORPCOpenAPIParams(contract, params) {
240
+ const meta = getOpenAPIMeta(contract);
241
+ if (!params || meta?.path === void 0) {
242
+ return void 0;
203
243
  }
204
- return flatten;
244
+ const dynamicParams = getDynamicPathParams(meta.prefix ? mergeHttpPath(meta.prefix, meta.path) : meta.path);
245
+ if (!dynamicParams) {
246
+ return void 0;
247
+ }
248
+ return dynamicParams.reduce((acc, config) => {
249
+ const value = config.allowsSlash ? flattenParamValue(params?.["*"] ?? params?.path) : flattenParamValue(params?.[config.parameterName]);
250
+ if (value === void 0) {
251
+ return acc;
252
+ }
253
+ acc[config.parameterName] = value;
254
+ return acc;
255
+ }, {});
205
256
  }
206
-
207
- function implement(contract, config = {}) {
208
- return implement$1(contract, config);
257
+ function toNestPattern(path) {
258
+ const params = getDynamicPathParams(path);
259
+ if (!params?.length) {
260
+ return path;
261
+ }
262
+ for (let i = params.length - 1; i >= 0; i--) {
263
+ const param = params[i];
264
+ const pattern = param.allowsSlash ? `*` : `:${param.parameterName}`;
265
+ path = path.slice(0, param.startIndex) + pattern + path.slice(param.startIndex + param.segment.length);
266
+ }
267
+ return path;
209
268
  }
210
269
 
211
- export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
270
+ export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/nest",
3
3
  "type": "module",
4
- "version": "1.14.6",
4
+ "version": "2.0.0-beta.10",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.dev",
7
7
  "repository": {
@@ -9,11 +9,9 @@
9
9
  "url": "git+https://github.com/middleapi/orpc.git",
10
10
  "directory": "packages/nest"
11
11
  },
12
- "keywords": [
13
- "orpc"
14
- ],
15
12
  "sideEffects": false,
16
13
  "exports": {
14
+ "./package.json": "./package.json",
17
15
  ".": {
18
16
  "types": "./dist/index.d.mts",
19
17
  "import": "./dist/index.mjs",
@@ -24,11 +22,11 @@
24
22
  "dist"
25
23
  ],
26
24
  "peerDependencies": {
27
- "@nestjs/common": ">=11.0.0",
28
- "@nestjs/core": ">=11.0.0",
29
- "express": ">=5.0.0",
30
- "fastify": ">=5.0.0",
31
- "rxjs": ">=7.0.0"
25
+ "@nestjs/common": ">=11.1.27",
26
+ "@nestjs/core": ">=11.1.27",
27
+ "express": ">=5.2.1",
28
+ "fastify": ">=5.8.5",
29
+ "rxjs": ">=7.8.2"
32
30
  },
33
31
  "peerDependenciesMeta": {
34
32
  "express": {
@@ -39,39 +37,28 @@
39
37
  }
40
38
  },
41
39
  "dependencies": {
42
- "@orpc/client": "1.14.6",
43
- "@orpc/openapi": "1.14.6",
44
- "@orpc/openapi-client": "1.14.6",
45
- "@orpc/server": "1.14.6",
46
- "@orpc/shared": "1.14.6",
47
- "@orpc/standard-server": "1.14.6",
48
- "@orpc/standard-server-fastify": "1.14.6",
49
- "@orpc/standard-server-fetch": "1.14.6",
50
- "@orpc/contract": "1.14.6",
51
- "@orpc/standard-server-node": "1.14.6"
40
+ "@standardserver/core": "^0.0.25",
41
+ "@standardserver/node": "^0.0.25",
42
+ "@orpc/contract": "2.0.0-beta.10",
43
+ "@orpc/server": "2.0.0-beta.10",
44
+ "@orpc/client": "2.0.0-beta.10",
45
+ "@orpc/shared": "2.0.0-beta.10",
46
+ "@orpc/openapi": "2.0.0-beta.10"
52
47
  },
53
48
  "devDependencies": {
54
49
  "@fastify/cookie": "^11.0.2",
55
- "@hono/node-server": "^1.19.11",
56
- "@mnigos/platform-hono": "^0.1.3",
57
- "@nestjs/common": "^11.1.16",
58
- "@nestjs/core": "^11.1.16",
59
- "@nestjs/platform-express": "^11.1.16",
60
- "@nestjs/platform-fastify": "^11.1.16",
61
- "@nestjs/testing": "^11.1.16",
62
- "@ts-rest/core": "^3.52.1",
50
+ "@nestjs/common": "^11.1.27",
51
+ "@nestjs/core": "^11.1.27",
52
+ "@nestjs/platform-express": "^11.1.27",
53
+ "@nestjs/platform-fastify": "^11.1.27",
54
+ "@nestjs/testing": "^11.1.27",
63
55
  "@types/express": "^5.0.6",
64
56
  "express": "^5.2.1",
65
- "fastify": "^5.8.3",
66
- "hono": "^4.10.7",
67
- "rxjs": "^7.8.2",
68
- "supertest": "^7.1.4",
69
- "zod": "^4.3.6"
57
+ "fastify": "^5.8.5",
58
+ "rxjs": "^7.8.2"
70
59
  },
71
60
  "scripts": {
72
61
  "build": "unbuild",
73
- "build:watch": "pnpm run build --watch",
74
- "type:check": "tsc -b",
75
- "type:check:test": "tsc -p tsconfig.test.json --noEmit"
62
+ "type:check": "tsc -b"
76
63
  }
77
64
  }