@orpc/react 0.0.0-next.3191601 → 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 +146 -34
- package/dist/hooks/index.d.mts +20 -4
- package/dist/hooks/index.d.ts +20 -4
- package/dist/hooks/index.mjs +71 -45
- package/dist/index.d.mts +28 -3
- package/dist/index.d.ts +28 -3
- package/dist/index.mjs +34 -4
- package/package.json +10 -11
package/README.md
CHANGED
|
@@ -1,72 +1,72 @@
|
|
|
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/react">
|
|
12
12
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Freact?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>
|
|
23
26
|
|
|
24
|
-
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
|
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
28
|
|
|
26
29
|
---
|
|
27
30
|
|
|
28
31
|
## Highlights
|
|
29
32
|
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
|
|
43
|
-
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
|
|
44
|
-
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
|
|
45
|
-
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
|
|
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.
|
|
46
45
|
|
|
47
46
|
## Documentation
|
|
48
47
|
|
|
49
|
-
You can find the full documentation [here](https://orpc.
|
|
48
|
+
You can find the full documentation [here](https://orpc.dev).
|
|
50
49
|
|
|
51
50
|
## Packages
|
|
52
51
|
|
|
53
52
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
54
53
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
55
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/).
|
|
56
58
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
57
|
-
- [@orpc/
|
|
58
|
-
- [@orpc/
|
|
59
|
-
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
|
60
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
|
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
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
62
|
-
- [@orpc/
|
|
62
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
63
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
64
64
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
65
65
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
66
66
|
|
|
67
67
|
## `@orpc/react`
|
|
68
68
|
|
|
69
|
-
Provides utilities for integrating oRPC with React and React Server Actions. Read the [documentation](https://orpc.
|
|
69
|
+
Provides utilities for integrating oRPC with React and React Server Actions. Read the [documentation](https://orpc.dev/docs/server-action) for more information.
|
|
70
70
|
|
|
71
71
|
### `useServerAction` Hook
|
|
72
72
|
|
|
@@ -145,12 +145,124 @@ export function MyComponent() {
|
|
|
145
145
|
|
|
146
146
|
## Sponsors
|
|
147
147
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
148
|
+
If you find oRPC valuable and would like to support its development, you can do so here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh).
|
|
149
|
+
|
|
150
|
+
### 🏆 Platinum Sponsor
|
|
151
|
+
|
|
152
|
+
<table>
|
|
153
|
+
<tr>
|
|
154
|
+
<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>
|
|
155
|
+
</tr>
|
|
156
|
+
</table>
|
|
157
|
+
|
|
158
|
+
### 🥇 Gold Sponsor
|
|
159
|
+
|
|
160
|
+
<table>
|
|
161
|
+
<tr>
|
|
162
|
+
<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>
|
|
163
|
+
</tr>
|
|
164
|
+
</table>
|
|
165
|
+
|
|
166
|
+
### 🥈 Silver Sponsor
|
|
167
|
+
|
|
168
|
+
<table>
|
|
169
|
+
<tr>
|
|
170
|
+
<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>
|
|
171
|
+
<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>
|
|
172
|
+
<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>
|
|
173
|
+
</tr>
|
|
174
|
+
</table>
|
|
175
|
+
|
|
176
|
+
### Generous Sponsors
|
|
177
|
+
|
|
178
|
+
<table>
|
|
179
|
+
<tr>
|
|
180
|
+
<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>
|
|
181
|
+
</tr>
|
|
182
|
+
</table>
|
|
183
|
+
|
|
184
|
+
### Sponsors
|
|
185
|
+
|
|
186
|
+
<table>
|
|
187
|
+
<tr>
|
|
188
|
+
<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>
|
|
189
|
+
<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>
|
|
190
|
+
<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>
|
|
191
|
+
<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>
|
|
192
|
+
<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>
|
|
193
|
+
<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>
|
|
194
|
+
</tr>
|
|
195
|
+
<tr>
|
|
196
|
+
<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>
|
|
197
|
+
<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>
|
|
198
|
+
<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>
|
|
199
|
+
<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>
|
|
200
|
+
<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>
|
|
201
|
+
<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>
|
|
202
|
+
</tr>
|
|
203
|
+
<tr>
|
|
204
|
+
<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>
|
|
205
|
+
<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>
|
|
206
|
+
<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>
|
|
207
|
+
<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>
|
|
208
|
+
<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>
|
|
209
|
+
</tr>
|
|
210
|
+
</table>
|
|
211
|
+
|
|
212
|
+
### Backers
|
|
213
|
+
|
|
214
|
+
<table>
|
|
215
|
+
<tr>
|
|
216
|
+
<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>
|
|
217
|
+
<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>
|
|
218
|
+
<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>
|
|
219
|
+
<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>
|
|
220
|
+
<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>
|
|
221
|
+
<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>
|
|
222
|
+
</tr>
|
|
223
|
+
<tr>
|
|
224
|
+
<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>
|
|
225
|
+
<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>
|
|
226
|
+
<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>
|
|
227
|
+
<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>
|
|
228
|
+
<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>
|
|
229
|
+
<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>
|
|
230
|
+
</tr>
|
|
231
|
+
<tr>
|
|
232
|
+
<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>
|
|
233
|
+
</tr>
|
|
234
|
+
</table>
|
|
235
|
+
|
|
236
|
+
### Past Sponsors
|
|
237
|
+
|
|
238
|
+
<p>
|
|
239
|
+
<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>
|
|
240
|
+
<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>
|
|
241
|
+
<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>
|
|
242
|
+
<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>
|
|
243
|
+
<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>
|
|
244
|
+
<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>
|
|
245
|
+
<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>
|
|
246
|
+
<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>
|
|
247
|
+
<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>
|
|
248
|
+
<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>
|
|
249
|
+
<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>
|
|
250
|
+
<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>
|
|
251
|
+
<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>
|
|
252
|
+
<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>
|
|
253
|
+
<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>
|
|
254
|
+
<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>
|
|
255
|
+
<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>
|
|
256
|
+
<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>
|
|
257
|
+
<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>
|
|
258
|
+
<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>
|
|
259
|
+
<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>
|
|
260
|
+
<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>
|
|
261
|
+
<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>
|
|
262
|
+
<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>
|
|
263
|
+
<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>
|
|
152
264
|
</p>
|
|
153
265
|
|
|
154
266
|
## License
|
|
155
267
|
|
|
156
|
-
Distributed under the MIT License. See [LICENSE](https://github.com/
|
|
268
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
|
package/dist/hooks/index.d.mts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { SafeResult, ORPCErrorJSON } from '@orpc/client';
|
|
2
2
|
import { ActionableClient, UnactionableError } from '@orpc/server';
|
|
3
|
-
import { Interceptor } from '@orpc/shared';
|
|
3
|
+
import { Interceptor, PromiseWithError } from '@orpc/shared';
|
|
4
4
|
|
|
5
5
|
interface UseServerActionOptions<TInput, TOutput, TError> {
|
|
6
6
|
interceptors?: Interceptor<{
|
|
7
7
|
input: TInput;
|
|
8
|
-
}, TOutput, TError
|
|
8
|
+
}, PromiseWithError<TOutput, TError>>[];
|
|
9
9
|
}
|
|
10
10
|
interface UseServerActionExecuteOptions<TInput, TOutput, TError> extends Pick<UseServerActionOptions<TInput, TOutput, TError>, 'interceptors'> {
|
|
11
11
|
}
|
|
@@ -58,6 +58,22 @@ interface UseServerActionErrorResult<TInput, TOutput, TError> extends UseServerA
|
|
|
58
58
|
status: 'error';
|
|
59
59
|
executedAt: Date;
|
|
60
60
|
}
|
|
61
|
-
|
|
61
|
+
type UseServerActionResult<TInput, TOutput, TError> = UseServerActionIdleResult<TInput, TOutput, TError> | UseServerActionSuccessResult<TInput, TOutput, TError> | UseServerActionErrorResult<TInput, TOutput, TError> | UseServerActionPendingResult<TInput, TOutput, TError>;
|
|
62
|
+
/**
|
|
63
|
+
* Use a Server Action Hook
|
|
64
|
+
*
|
|
65
|
+
* @see {@link https://orpc.dev/docs/server-action#useserveraction-hook Server Action Hook Docs}
|
|
66
|
+
*/
|
|
67
|
+
declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>): UseServerActionResult<TInput, TOutput, UnactionableError<TError>>;
|
|
62
68
|
|
|
63
|
-
|
|
69
|
+
interface UseOptimisticServerActionOptions<TInput, TOutput, TError, TOptimisticState> extends UseServerActionOptions<TInput, TOutput, TError> {
|
|
70
|
+
optimisticPassthrough: TOptimisticState;
|
|
71
|
+
optimisticReducer: (state: TOptimisticState, input: TInput) => TOptimisticState;
|
|
72
|
+
}
|
|
73
|
+
type UseOptimisticServerActionResult<TInput, TOutput, TError, TOptimisticState> = UseServerActionResult<TInput, TOutput, TError> & {
|
|
74
|
+
optimisticState: TOptimisticState;
|
|
75
|
+
};
|
|
76
|
+
declare function useOptimisticServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>, TOptimisticState>(action: ActionableClient<TInput, TOutput, TError>, options: UseOptimisticServerActionOptions<TInput, TOutput, UnactionableError<TError>, TOptimisticState>): UseOptimisticServerActionResult<TInput, TOutput, UnactionableError<TError>, TOptimisticState>;
|
|
77
|
+
|
|
78
|
+
export { useOptimisticServerAction, useServerAction };
|
|
79
|
+
export type { UseOptimisticServerActionOptions, UseOptimisticServerActionResult, UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResult, UseServerActionResultBase, UseServerActionSuccessResult };
|
package/dist/hooks/index.d.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { SafeResult, ORPCErrorJSON } from '@orpc/client';
|
|
2
2
|
import { ActionableClient, UnactionableError } from '@orpc/server';
|
|
3
|
-
import { Interceptor } from '@orpc/shared';
|
|
3
|
+
import { Interceptor, PromiseWithError } from '@orpc/shared';
|
|
4
4
|
|
|
5
5
|
interface UseServerActionOptions<TInput, TOutput, TError> {
|
|
6
6
|
interceptors?: Interceptor<{
|
|
7
7
|
input: TInput;
|
|
8
|
-
}, TOutput, TError
|
|
8
|
+
}, PromiseWithError<TOutput, TError>>[];
|
|
9
9
|
}
|
|
10
10
|
interface UseServerActionExecuteOptions<TInput, TOutput, TError> extends Pick<UseServerActionOptions<TInput, TOutput, TError>, 'interceptors'> {
|
|
11
11
|
}
|
|
@@ -58,6 +58,22 @@ interface UseServerActionErrorResult<TInput, TOutput, TError> extends UseServerA
|
|
|
58
58
|
status: 'error';
|
|
59
59
|
executedAt: Date;
|
|
60
60
|
}
|
|
61
|
-
|
|
61
|
+
type UseServerActionResult<TInput, TOutput, TError> = UseServerActionIdleResult<TInput, TOutput, TError> | UseServerActionSuccessResult<TInput, TOutput, TError> | UseServerActionErrorResult<TInput, TOutput, TError> | UseServerActionPendingResult<TInput, TOutput, TError>;
|
|
62
|
+
/**
|
|
63
|
+
* Use a Server Action Hook
|
|
64
|
+
*
|
|
65
|
+
* @see {@link https://orpc.dev/docs/server-action#useserveraction-hook Server Action Hook Docs}
|
|
66
|
+
*/
|
|
67
|
+
declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>): UseServerActionResult<TInput, TOutput, UnactionableError<TError>>;
|
|
62
68
|
|
|
63
|
-
|
|
69
|
+
interface UseOptimisticServerActionOptions<TInput, TOutput, TError, TOptimisticState> extends UseServerActionOptions<TInput, TOutput, TError> {
|
|
70
|
+
optimisticPassthrough: TOptimisticState;
|
|
71
|
+
optimisticReducer: (state: TOptimisticState, input: TInput) => TOptimisticState;
|
|
72
|
+
}
|
|
73
|
+
type UseOptimisticServerActionResult<TInput, TOutput, TError, TOptimisticState> = UseServerActionResult<TInput, TOutput, TError> & {
|
|
74
|
+
optimisticState: TOptimisticState;
|
|
75
|
+
};
|
|
76
|
+
declare function useOptimisticServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>, TOptimisticState>(action: ActionableClient<TInput, TOutput, TError>, options: UseOptimisticServerActionOptions<TInput, TOutput, UnactionableError<TError>, TOptimisticState>): UseOptimisticServerActionResult<TInput, TOutput, UnactionableError<TError>, TOptimisticState>;
|
|
77
|
+
|
|
78
|
+
export { useOptimisticServerAction, useServerAction };
|
|
79
|
+
export type { UseOptimisticServerActionOptions, UseOptimisticServerActionResult, UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResult, UseServerActionResultBase, UseServerActionSuccessResult };
|
package/dist/hooks/index.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { intercept, toArray, onStart } from '@orpc/shared';
|
|
2
|
+
import { useState, useRef, useTransition, useCallback, useMemo, useOptimistic } from 'react';
|
|
3
|
+
import { safe, createORPCErrorFromJson } from '@orpc/client';
|
|
4
4
|
|
|
5
5
|
const INITIAL_STATE = {
|
|
6
6
|
data: void 0,
|
|
@@ -9,57 +9,83 @@ const INITIAL_STATE = {
|
|
|
9
9
|
isPending: false,
|
|
10
10
|
isSuccess: false,
|
|
11
11
|
isError: false,
|
|
12
|
-
status: "idle"
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
status: "idle"
|
|
13
|
+
};
|
|
14
|
+
const PENDING_STATE = {
|
|
15
|
+
data: void 0,
|
|
16
|
+
error: null,
|
|
17
|
+
isIdle: false,
|
|
18
|
+
isPending: true,
|
|
19
|
+
isSuccess: false,
|
|
20
|
+
isError: false,
|
|
21
|
+
status: "pending"
|
|
15
22
|
};
|
|
16
23
|
function useServerAction(action, options = {}) {
|
|
17
24
|
const [state, setState] = useState(INITIAL_STATE);
|
|
25
|
+
const executedAtRef = useRef(void 0);
|
|
26
|
+
const [input, setInput] = useState(void 0);
|
|
27
|
+
const [isPending, startTransition] = useTransition();
|
|
18
28
|
const reset = useCallback(() => {
|
|
19
|
-
|
|
29
|
+
executedAtRef.current = void 0;
|
|
30
|
+
setInput(void 0);
|
|
31
|
+
setState({ ...INITIAL_STATE });
|
|
20
32
|
}, []);
|
|
21
|
-
const execute = useCallback(async (
|
|
33
|
+
const execute = useCallback(async (input2, executeOptions = {}) => {
|
|
22
34
|
const executedAt = /* @__PURE__ */ new Date();
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
35
|
+
executedAtRef.current = executedAt;
|
|
36
|
+
setInput(input2);
|
|
37
|
+
return new Promise((resolve) => {
|
|
38
|
+
startTransition(async () => {
|
|
39
|
+
const result2 = await safe(intercept(
|
|
40
|
+
[...toArray(options.interceptors), ...toArray(executeOptions.interceptors)],
|
|
41
|
+
{ input: input2 },
|
|
42
|
+
async ({ input: input3 }) => action(input3).then(([error, data]) => {
|
|
43
|
+
if (error) {
|
|
44
|
+
throw createORPCErrorFromJson(error);
|
|
45
|
+
}
|
|
46
|
+
return data;
|
|
47
|
+
})
|
|
48
|
+
));
|
|
49
|
+
if (executedAtRef.current === executedAt) {
|
|
50
|
+
setState({
|
|
51
|
+
data: result2.data,
|
|
52
|
+
error: result2.error,
|
|
53
|
+
isIdle: false,
|
|
54
|
+
isPending: false,
|
|
55
|
+
isSuccess: !result2.error,
|
|
56
|
+
isError: !!result2.error,
|
|
57
|
+
status: !result2.error ? "success" : "error"
|
|
58
|
+
});
|
|
40
59
|
}
|
|
41
|
-
|
|
42
|
-
})
|
|
43
|
-
));
|
|
44
|
-
setState({
|
|
45
|
-
data: result2.data,
|
|
46
|
-
error: result2.error,
|
|
47
|
-
isIdle: false,
|
|
48
|
-
isPending: false,
|
|
49
|
-
isSuccess: !result2.error,
|
|
50
|
-
isError: !!result2.error,
|
|
51
|
-
status: !result2.error ? "success" : "error",
|
|
52
|
-
executedAt,
|
|
53
|
-
input
|
|
60
|
+
resolve(result2);
|
|
61
|
+
});
|
|
54
62
|
});
|
|
55
|
-
return result2;
|
|
56
63
|
}, [action, ...toArray(options.interceptors)]);
|
|
57
|
-
const result = useMemo(() =>
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
64
|
+
const result = useMemo(() => {
|
|
65
|
+
const currentState = isPending && executedAtRef.current !== void 0 ? PENDING_STATE : state;
|
|
66
|
+
return {
|
|
67
|
+
...currentState,
|
|
68
|
+
executedAt: executedAtRef.current,
|
|
69
|
+
input,
|
|
70
|
+
reset,
|
|
71
|
+
execute
|
|
72
|
+
};
|
|
73
|
+
}, [isPending, state, input, reset, execute]);
|
|
62
74
|
return result;
|
|
63
75
|
}
|
|
64
76
|
|
|
65
|
-
|
|
77
|
+
function useOptimisticServerAction(action, options) {
|
|
78
|
+
const [optimisticState, addOptimistic] = useOptimistic(options.optimisticPassthrough, options.optimisticReducer);
|
|
79
|
+
const state = useServerAction(action, {
|
|
80
|
+
...options,
|
|
81
|
+
interceptors: [
|
|
82
|
+
useCallback(onStart(({ input }) => {
|
|
83
|
+
addOptimistic(input);
|
|
84
|
+
}), [addOptimistic]),
|
|
85
|
+
...toArray(options.interceptors)
|
|
86
|
+
]
|
|
87
|
+
});
|
|
88
|
+
return useMemo(() => ({ ...state, optimisticState }), [state, optimisticState]);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export { useOptimisticServerAction, useServerAction };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,11 +1,36 @@
|
|
|
1
1
|
import { AnySchema } from '@orpc/contract';
|
|
2
2
|
import { Context, ErrorMap, Meta, Lazyable, Procedure, CreateProcedureClientOptions } from '@orpc/server';
|
|
3
|
-
import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
+
import { Interceptor, MaybeOptionalOptions, onStart, onSuccess, onError, onFinish } from '@orpc/shared';
|
|
4
|
+
export { getIssueMessage, parseFormData } from '@orpc/openapi-client/standard';
|
|
4
5
|
|
|
5
6
|
interface FormAction {
|
|
6
7
|
(form: FormData): Promise<void>;
|
|
7
8
|
}
|
|
8
|
-
declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, any
|
|
9
|
+
declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, Promise<any>>;
|
|
10
|
+
/**
|
|
11
|
+
* Create a server action accept a form data and deserialize with bracket notation.
|
|
12
|
+
*
|
|
13
|
+
* @see {@link https://orpc.dev/docs/server-action#createformaction-utility Create Form Action Utility Docs}
|
|
14
|
+
* @see {@link https://orpc.dev/docs/openapi/bracket-notation Bracket Notation Docs}
|
|
15
|
+
*/
|
|
9
16
|
declare function createFormAction<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): FormAction;
|
|
10
17
|
|
|
11
|
-
|
|
18
|
+
/**
|
|
19
|
+
* Like `onStart`, but defers execution, useful for updating states.
|
|
20
|
+
*/
|
|
21
|
+
declare const onStartDeferred: typeof onStart;
|
|
22
|
+
/**
|
|
23
|
+
* Like `onSuccess`, but defers execution, useful for updating states.
|
|
24
|
+
*/
|
|
25
|
+
declare const onSuccessDeferred: typeof onSuccess;
|
|
26
|
+
/**
|
|
27
|
+
* Like `onError`, but defers execution, useful for updating states.
|
|
28
|
+
*/
|
|
29
|
+
declare const onErrorDeferred: typeof onError;
|
|
30
|
+
/**
|
|
31
|
+
* Like `onFinish`, but defers execution, useful for updating states.
|
|
32
|
+
*/
|
|
33
|
+
declare const onFinishDeferred: typeof onFinish;
|
|
34
|
+
|
|
35
|
+
export { createFormAction, onErrorDeferred, onFinishDeferred, onStartDeferred, onSuccessDeferred, orpcErrorToNextHttpFallbackInterceptor };
|
|
36
|
+
export type { FormAction };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,11 +1,36 @@
|
|
|
1
1
|
import { AnySchema } from '@orpc/contract';
|
|
2
2
|
import { Context, ErrorMap, Meta, Lazyable, Procedure, CreateProcedureClientOptions } from '@orpc/server';
|
|
3
|
-
import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
+
import { Interceptor, MaybeOptionalOptions, onStart, onSuccess, onError, onFinish } from '@orpc/shared';
|
|
4
|
+
export { getIssueMessage, parseFormData } from '@orpc/openapi-client/standard';
|
|
4
5
|
|
|
5
6
|
interface FormAction {
|
|
6
7
|
(form: FormData): Promise<void>;
|
|
7
8
|
}
|
|
8
|
-
declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, any
|
|
9
|
+
declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, Promise<any>>;
|
|
10
|
+
/**
|
|
11
|
+
* Create a server action accept a form data and deserialize with bracket notation.
|
|
12
|
+
*
|
|
13
|
+
* @see {@link https://orpc.dev/docs/server-action#createformaction-utility Create Form Action Utility Docs}
|
|
14
|
+
* @see {@link https://orpc.dev/docs/openapi/bracket-notation Bracket Notation Docs}
|
|
15
|
+
*/
|
|
9
16
|
declare function createFormAction<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): FormAction;
|
|
10
17
|
|
|
11
|
-
|
|
18
|
+
/**
|
|
19
|
+
* Like `onStart`, but defers execution, useful for updating states.
|
|
20
|
+
*/
|
|
21
|
+
declare const onStartDeferred: typeof onStart;
|
|
22
|
+
/**
|
|
23
|
+
* Like `onSuccess`, but defers execution, useful for updating states.
|
|
24
|
+
*/
|
|
25
|
+
declare const onSuccessDeferred: typeof onSuccess;
|
|
26
|
+
/**
|
|
27
|
+
* Like `onError`, but defers execution, useful for updating states.
|
|
28
|
+
*/
|
|
29
|
+
declare const onErrorDeferred: typeof onError;
|
|
30
|
+
/**
|
|
31
|
+
* Like `onFinish`, but defers execution, useful for updating states.
|
|
32
|
+
*/
|
|
33
|
+
declare const onFinishDeferred: typeof onFinish;
|
|
34
|
+
|
|
35
|
+
export { createFormAction, onErrorDeferred, onFinishDeferred, onStartDeferred, onSuccessDeferred, orpcErrorToNextHttpFallbackInterceptor };
|
|
36
|
+
export type { FormAction };
|
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import { ORPCError } from '@orpc/client';
|
|
1
|
+
import { ORPCError, createORPCErrorFromJson } from '@orpc/client';
|
|
2
2
|
import { StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
|
|
3
|
+
export { getIssueMessage, parseFormData } from '@orpc/openapi-client/standard';
|
|
3
4
|
import { createProcedureClient } from '@orpc/server';
|
|
4
|
-
import { onError, resolveMaybeOptionalOptions, toArray } from '@orpc/shared';
|
|
5
|
+
import { onError, resolveMaybeOptionalOptions, toArray, onStart, onSuccess, onFinish } from '@orpc/shared';
|
|
5
6
|
|
|
6
7
|
const orpcErrorToNextHttpFallbackInterceptor = onError((error) => {
|
|
7
8
|
if (error instanceof ORPCError && [401, 403, 404].includes(error.status)) {
|
|
8
|
-
const nextError =
|
|
9
|
+
const nextError = createORPCErrorFromJson(error.toJSON());
|
|
9
10
|
nextError.cause = error;
|
|
10
11
|
nextError.digest = `NEXT_HTTP_ERROR_FALLBACK;${error.status}`;
|
|
11
12
|
throw nextError;
|
|
@@ -24,4 +25,33 @@ function createFormAction(lazyableProcedure, ...rest) {
|
|
|
24
25
|
};
|
|
25
26
|
}
|
|
26
27
|
|
|
27
|
-
|
|
28
|
+
const onStartDeferred = (callback, ...rest) => {
|
|
29
|
+
return onStart((...args) => {
|
|
30
|
+
setTimeout(() => {
|
|
31
|
+
callback(...args);
|
|
32
|
+
}, 6);
|
|
33
|
+
}, ...rest);
|
|
34
|
+
};
|
|
35
|
+
const onSuccessDeferred = (callback, ...rest) => {
|
|
36
|
+
return onSuccess((...args) => {
|
|
37
|
+
setTimeout(() => {
|
|
38
|
+
callback(...args);
|
|
39
|
+
}, 6);
|
|
40
|
+
}, ...rest);
|
|
41
|
+
};
|
|
42
|
+
const onErrorDeferred = (callback, ...rest) => {
|
|
43
|
+
return onError((...args) => {
|
|
44
|
+
setTimeout(() => {
|
|
45
|
+
callback(...args);
|
|
46
|
+
}, 6);
|
|
47
|
+
}, ...rest);
|
|
48
|
+
};
|
|
49
|
+
const onFinishDeferred = (callback, ...rest) => {
|
|
50
|
+
return onFinish((...args) => {
|
|
51
|
+
setTimeout(() => {
|
|
52
|
+
callback(...args);
|
|
53
|
+
}, 6);
|
|
54
|
+
}, ...rest);
|
|
55
|
+
};
|
|
56
|
+
|
|
57
|
+
export { createFormAction, onErrorDeferred, onFinishDeferred, onStartDeferred, onSuccessDeferred, orpcErrorToNextHttpFallbackInterceptor };
|
package/package.json
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/react",
|
|
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/react"
|
|
11
11
|
},
|
|
12
12
|
"keywords": [
|
|
13
|
-
"unnoq",
|
|
14
13
|
"orpc",
|
|
15
14
|
"react",
|
|
16
15
|
"nextjs"
|
|
@@ -34,15 +33,15 @@
|
|
|
34
33
|
"react": ">=18.0.0"
|
|
35
34
|
},
|
|
36
35
|
"dependencies": {
|
|
37
|
-
"@orpc/client": "0.0.0-next.
|
|
38
|
-
"@orpc/contract": "0.0.0-next.
|
|
39
|
-
"@orpc/
|
|
40
|
-
"@orpc/server": "0.0.0-next.
|
|
41
|
-
"@orpc/
|
|
36
|
+
"@orpc/client": "0.0.0-next.325aa5d",
|
|
37
|
+
"@orpc/contract": "0.0.0-next.325aa5d",
|
|
38
|
+
"@orpc/shared": "0.0.0-next.325aa5d",
|
|
39
|
+
"@orpc/server": "0.0.0-next.325aa5d",
|
|
40
|
+
"@orpc/openapi-client": "0.0.0-next.325aa5d"
|
|
42
41
|
},
|
|
43
42
|
"devDependencies": {
|
|
44
|
-
"react": "^19.
|
|
45
|
-
"zod": "^3.
|
|
43
|
+
"react": "^19.2.4",
|
|
44
|
+
"zod": "^4.3.6"
|
|
46
45
|
},
|
|
47
46
|
"scripts": {
|
|
48
47
|
"build": "unbuild",
|