@orpc/react-query 0.0.0-next.a439c82 β 0.0.0-next.a45fc95
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +133 -19
- package/dist/index.d.mts +23 -24
- package/dist/index.d.ts +23 -24
- package/dist/index.mjs +22 -14
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -1,22 +1,25 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<image align="center" src="https://orpc.
|
|
2
|
+
<image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
|
|
3
3
|
</div>
|
|
4
4
|
|
|
5
5
|
<h1></h1>
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
|
-
<a href="https://codecov.io/gh/
|
|
9
|
-
<img alt="codecov" src="https://codecov.io/gh/
|
|
8
|
+
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
9
|
+
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
|
|
10
10
|
</a>
|
|
11
11
|
<a href="https://www.npmjs.com/package/@orpc/react-query">
|
|
12
12
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Freact-query?logo=npm" />
|
|
13
13
|
</a>
|
|
14
|
-
<a href="https://github.com/
|
|
15
|
-
<img alt="MIT License" src="https://img.shields.io/github/license/
|
|
14
|
+
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
15
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
16
16
|
</a>
|
|
17
17
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
18
18
|
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
19
19
|
</a>
|
|
20
|
+
<a href="https://deepwiki.com/middleapi/orpc">
|
|
21
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
22
|
+
</a>
|
|
20
23
|
</div>
|
|
21
24
|
|
|
22
25
|
<h3 align="center">Typesafe APIs Made Simple πͺ</h3>
|
|
@@ -30,7 +33,8 @@
|
|
|
30
33
|
- **π End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
31
34
|
- **π First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
32
35
|
- **π Contract-First Development**: Optionally define your API contract before implementation.
|
|
33
|
-
-
|
|
36
|
+
- **π First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
|
37
|
+
- **βοΈ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
|
|
34
38
|
- **π Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
35
39
|
- **π Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
36
40
|
- **ποΈ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
@@ -38,31 +42,31 @@
|
|
|
38
42
|
- **π‘ SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
39
43
|
- **π Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
40
44
|
- **π Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
41
|
-
- **π‘οΈ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
|
|
42
45
|
|
|
43
46
|
## Documentation
|
|
44
47
|
|
|
45
|
-
You can find the full documentation [here](https://orpc.
|
|
48
|
+
You can find the full documentation [here](https://orpc.dev).
|
|
46
49
|
|
|
47
50
|
## Packages
|
|
48
51
|
|
|
49
52
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
50
53
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
51
54
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
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/).
|
|
52
58
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
53
|
-
- [@orpc/
|
|
54
|
-
- [@orpc/
|
|
55
|
-
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
|
56
|
-
- [@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.
|
|
57
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
58
|
-
- [@orpc/
|
|
62
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
59
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
60
64
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
61
65
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
62
66
|
|
|
63
67
|
## `@orpc/react-query`
|
|
64
68
|
|
|
65
|
-
Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview). Read the [documentation](https://orpc.
|
|
69
|
+
Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview). Read the [documentation](https://orpc.dev/docs/integrations/tanstack-query-old/react) for more information.
|
|
66
70
|
|
|
67
71
|
```ts
|
|
68
72
|
export function Example() {
|
|
@@ -108,12 +112,122 @@ export function Example() {
|
|
|
108
112
|
|
|
109
113
|
## Sponsors
|
|
110
114
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
+
If you find oRPC valuable and would like to support its development, you can do so here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh).
|
|
116
|
+
|
|
117
|
+
### π Platinum Sponsor
|
|
118
|
+
|
|
119
|
+
<table>
|
|
120
|
+
<tr>
|
|
121
|
+
<td align="center"><a href="https://screenshotone.com/?ref=orpc" target="_blank" rel="noopener" title="ScreenshotOne.com"><img src="https://avatars.githubusercontent.com/u/97035603?v=4" width="279" alt="ScreenshotOne.com"/><br />ScreenshotOne.com</a></td>
|
|
122
|
+
</tr>
|
|
123
|
+
</table>
|
|
124
|
+
|
|
125
|
+
### π₯ Gold Sponsor
|
|
126
|
+
|
|
127
|
+
<table>
|
|
128
|
+
<tr>
|
|
129
|
+
<td align="center"><a href="https://zuplo.link/orpc?ref=orpc" target="_blank" rel="noopener" title="Zuplo"><img src="https://avatars.githubusercontent.com/u/85497839?v=4" width="209" alt="Zuplo"/><br />Zuplo</a></td>
|
|
130
|
+
</tr>
|
|
131
|
+
</table>
|
|
132
|
+
|
|
133
|
+
### π₯ Silver Sponsor
|
|
134
|
+
|
|
135
|
+
<table>
|
|
136
|
+
<tr>
|
|
137
|
+
<td align="center"><a href="https://misskey.io/?ref=orpc" target="_blank" rel="noopener" title="ζδΈγγ"><img src="https://avatars.githubusercontent.com/u/37681609?u=0dd4c7e4ba937cbb52b068c55914b1d8164dc0c7&v=4" width="167" alt="ζδΈγγ"/><br />ζδΈγγ</a></td>
|
|
138
|
+
<td align="center"><a href="https://valerii15298.github.io/?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&v=4" width="167" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
|
|
139
|
+
<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="167" alt="christ12938"/><br />christ12938</a></td>
|
|
140
|
+
</tr>
|
|
141
|
+
</table>
|
|
142
|
+
|
|
143
|
+
### Generous Sponsors
|
|
144
|
+
|
|
145
|
+
<table>
|
|
146
|
+
<tr>
|
|
147
|
+
<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>
|
|
148
|
+
</tr>
|
|
149
|
+
</table>
|
|
150
|
+
|
|
151
|
+
### Sponsors
|
|
152
|
+
|
|
153
|
+
<table>
|
|
154
|
+
<tr>
|
|
155
|
+
<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>
|
|
156
|
+
<td align="center"><a href="https://github.com/Scrumplex?ref=orpc" target="_blank" rel="noopener" title="Sefa Eyeoglu"><img src="https://avatars.githubusercontent.com/u/11587657?u=ab503582165c0bbff0cca47ce31c9450bb1553c9&v=4" width="119" alt="Sefa Eyeoglu"/><br />Sefa Eyeoglu</a></td>
|
|
157
|
+
<td align="center"><a href="https://github.com/u1-liquid?ref=orpc" target="_blank" rel="noopener" title="γγγγγ¨γΌγ«γ
"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&v=4" width="119" alt="γγγγγ¨γΌγ«γ
"/><br />γγγγγ¨γΌγ«γ
</a></td>
|
|
158
|
+
<td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="noopener" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="119" alt="nk"/><br />nk</a></td>
|
|
159
|
+
<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>
|
|
160
|
+
<td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="noopener" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&v=4" width="119" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
|
|
161
|
+
<td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="noopener" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="119" alt="herrfugbaum"/><br />herrfugbaum</a></td>
|
|
162
|
+
</tr>
|
|
163
|
+
<tr>
|
|
164
|
+
<td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="119" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
|
|
165
|
+
<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>
|
|
166
|
+
<td align="center"><a href="https://github.com/happyboy2022?ref=orpc" target="_blank" rel="noopener" title="happyboy"><img src="https://avatars.githubusercontent.com/u/103669586?u=65b49c4b893ed3703909fbb3a7a22313f3f9c121&v=4" width="119" alt="happyboy"/><br />happyboy</a></td>
|
|
167
|
+
<td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&v=4" width="119" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
168
|
+
<td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&v=4" width="119" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
169
|
+
<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>
|
|
170
|
+
<td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="119" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
|
|
171
|
+
</tr>
|
|
172
|
+
<tr>
|
|
173
|
+
<td align="center"><a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="119" alt="Peter Adam"/><br />Peter Adam</a></td>
|
|
174
|
+
<td align="center"><a href="https://github.com/yukimotochern?ref=orpc" target="_blank" rel="noopener" title="Chen, Zhi-Yuan"><img src="https://avatars.githubusercontent.com/u/20896173?u=945c33fc21725e4d566a0d02afc54b136ca1d67a&v=4" width="119" alt="Chen, Zhi-Yuan"/><br />Chen, Zhi-Yuan</a></td>
|
|
175
|
+
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="119" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
176
|
+
</tr>
|
|
177
|
+
</table>
|
|
178
|
+
|
|
179
|
+
### Backers
|
|
180
|
+
|
|
181
|
+
<table>
|
|
182
|
+
<tr>
|
|
183
|
+
<td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="noopener" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="104" alt="David Walsh"/><br />David Walsh</a></td>
|
|
184
|
+
<td align="center"><a href="https://github.com/Robbe95?ref=orpc" target="_blank" rel="noopener" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="104" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
185
|
+
<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>
|
|
186
|
+
<td align="center"><a href="https://github.com/soonoo?ref=orpc" target="_blank" rel="noopener" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="104" alt="soonoo"/><br />soonoo</a></td>
|
|
187
|
+
<td align="center"><a href="https://github.com/kporten?ref=orpc" target="_blank" rel="noopener" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="104" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
188
|
+
<td align="center"><a href="https://github.com/pumpkinlink?ref=orpc" target="_blank" rel="noopener" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="104" alt="Denis"/><br />Denis</a></td>
|
|
189
|
+
<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?v=4" width="104" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
190
|
+
<td align="center"><a href="https://github.com/thomasballinger?ref=orpc" target="_blank" rel="noopener" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="104" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
191
|
+
</tr>
|
|
192
|
+
<tr>
|
|
193
|
+
<td align="center"><a href="https://github.com/SSam0419?ref=orpc" target="_blank" rel="noopener" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="104" alt="Sam"/><br />Sam</a></td>
|
|
194
|
+
<td align="center"><a href="https://github.com/Titoine?ref=orpc" target="_blank" rel="noopener" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="104" alt="Titoine"/><br />Titoine</a></td>
|
|
195
|
+
<td align="center"><a href="https://github.com/Mnigos?ref=orpc" target="_blank" rel="noopener" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="104" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
196
|
+
<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&v=4" width="104" alt="Anees Iqbal"/><br />Anees Iqbal</a></td>
|
|
197
|
+
<td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="104" alt="Alex"/><br />Alex</a></td>
|
|
198
|
+
</tr>
|
|
199
|
+
</table>
|
|
200
|
+
|
|
201
|
+
### Past Sponsors
|
|
202
|
+
|
|
203
|
+
<p>
|
|
204
|
+
<a href="https://github.com/MrMaxie?ref=orpc" target="_blank" rel="noopener" title="Maxie"><img src="https://avatars.githubusercontent.com/u/3857836?u=5e6b57973d4385d655663ffdd836e487856f2984&v=4" width="32" height="32" alt="Maxie" /></a>
|
|
205
|
+
<a href="https://github.com/Stijn-Timmer?ref=orpc" target="_blank" rel="noopener" title="Stijn Timmer"><img src="https://avatars.githubusercontent.com/u/100147665?u=106b2c18e9c98a61861b4ee7fc100f5b9906a6c9&v=4" width="32" height="32" alt="Stijn Timmer" /></a>
|
|
206
|
+
<a href="https://github.com/motopods?ref=orpc" target="_blank" rel="noopener" title="motopods"><img src="https://avatars.githubusercontent.com/u/58200641?u=18833983d65b481ae90a4adec2373064ec58bcf3&v=4" width="32" height="32" alt="motopods" /></a>
|
|
207
|
+
<a href="https://github.com/franciscohermida?ref=orpc" target="_blank" rel="noopener" title="Francisco Hermida"><img src="https://avatars.githubusercontent.com/u/483242?u=bbcbc80eb9d8781ff401f7dafc3b59cd7bea0561&v=4" width="32" height="32" alt="Francisco Hermida" /></a>
|
|
208
|
+
<a href="https://github.com/theoludwig?ref=orpc" target="_blank" rel="noopener" title="ThΓ©o LUDWIG"><img src="https://avatars.githubusercontent.com/u/25207499?u=a6a9653725a2f574c07893748806668e0598cdbe&v=4" width="32" height="32" alt="ThΓ©o LUDWIG" /></a>
|
|
209
|
+
<a href="https://github.com/abhay-ramesh?ref=orpc" target="_blank" rel="noopener" title="Abhay Ramesh"><img src="https://avatars.githubusercontent.com/u/66196314?u=c5c2b0327b26606c2efcfaf17046ab18c3d25c57&v=4" width="32" height="32" alt="Abhay Ramesh" /></a>
|
|
210
|
+
<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>
|
|
211
|
+
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=24e8dd943cfc862aa284d858a023532c75071ade&v=4" width="32" height="32" alt="0x4e32" /></a>
|
|
212
|
+
<a href="https://github.com/yzuyr?ref=orpc" target="_blank" rel="noopener" title="Ryuz"><img src="https://avatars.githubusercontent.com/u/196539378?u=d38374588d219b6748b16406982f6559411466d4&v=4" width="32" height="32" alt="Ryuz" /></a>
|
|
213
|
+
<a href="https://github.com/YiCChi?ref=orpc" target="_blank" rel="noopener" title="yicchi"><img src="https://avatars.githubusercontent.com/u/86967274?u=6c2756f09fe15dd94d572f560e979cd157982852&v=4" width="32" height="32" alt="yicchi" /></a>
|
|
214
|
+
<a href="https://github.com/cloudycotton?ref=orpc" target="_blank" rel="noopener" title="Saksham"><img src="https://avatars.githubusercontent.com/u/168998965?u=9b9634a5aed66a51c1b880663272725b00b92b14&v=4" width="32" height="32" alt="Saksham" /></a>
|
|
215
|
+
<a href="https://github.com/hrynevychroman?ref=orpc" target="_blank" rel="noopener" title="Roman Hrynevych"><img src="https://avatars.githubusercontent.com/u/82209198?u=1a1d111ab3d589855b9cc8a7fefb1b5c6a4fbbaf&v=4" width="32" height="32" alt="Roman Hrynevych" /></a>
|
|
216
|
+
<a href="https://github.com/rokitgg?ref=orpc" target="_blank" rel="noopener" title="rokitg"><img src="https://avatars.githubusercontent.com/u/125133357?u=06c74aefaa2236b06a2e5fba5a5c612339f45912&v=4" width="32" height="32" alt="rokitg" /></a>
|
|
217
|
+
<a href="https://github.com/omarkhatibgg?ref=orpc" target="_blank" rel="noopener" title="Omar Khatib"><img src="https://avatars.githubusercontent.com/u/9054278?u=afbba7331b85c51b8eee4130f5fd31b1017dc919&v=4" width="32" height="32" alt="Omar Khatib" /></a>
|
|
218
|
+
<a href="https://github.com/YuSabo90002?ref=orpc" target="_blank" rel="noopener" title="Yu-Sabo"><img src="https://avatars.githubusercontent.com/u/13120582?v=4" width="32" height="32" alt="Yu-Sabo" /></a>
|
|
219
|
+
<a href="https://github.com/bapspatil?ref=orpc" target="_blank" rel="noopener" title="Bapusaheb Patil"><img src="https://avatars.githubusercontent.com/u/16699418?v=4" width="32" height="32" alt="Bapusaheb Patil" /></a>
|
|
220
|
+
<a href="https://github.com/ripgrim?ref=orpc" target="_blank" rel="noopener" title="grim"><img src="https://avatars.githubusercontent.com/u/75869731?u=b17c42ec2309552fdb822a86b25a2f99146a4d72&v=4" width="32" height="32" alt="grim" /></a>
|
|
221
|
+
<a href="https://github.com/nelsonlaidev?ref=orpc" target="_blank" rel="noopener" title="Nelson Lai"><img src="https://avatars.githubusercontent.com/u/75498339?u=2fc0e0b95dd184c5ffb744df977cb15a18b60672&v=4" width="32" height="32" alt="Nelson Lai" /></a>
|
|
222
|
+
<a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="LΓͺ Cao NguyΓͺn"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&v=4" width="32" height="32" alt="LΓͺ Cao NguyΓͺn" /></a>
|
|
223
|
+
<a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&v=4" width="32" height="32" alt="Robert Soriano" /></a>
|
|
224
|
+
<a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
|
|
225
|
+
<a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
|
|
226
|
+
<a href="https://github.com/NovakAnton?ref=orpc" target="_blank" rel="noopener" title="Novak Antonijevic"><img src="https://avatars.githubusercontent.com/u/157126729?u=ae49fa22292d55c0434ff0ca008206155b18663b&v=4" width="32" height="32" alt="Novak Antonijevic" /></a>
|
|
227
|
+
<a href="https://github.com/laduniestu?ref=orpc" target="_blank" rel="noopener" title="Laduni Estu Syalwa"><img src="https://avatars.githubusercontent.com/u/44757637?u=a2fc1ea8f7d827a96721176f79d30592d1c48059&v=4" width="32" height="32" alt="Laduni Estu Syalwa" /></a>
|
|
228
|
+
<a href="https://github.com/illarionvk?ref=orpc" target="_blank" rel="noopener" title="Illarion Koperski"><img src="https://avatars.githubusercontent.com/u/5012724?u=7cfa13652f7ac5fb3c56d880e3eb3fbe40c3ea34&v=4" width="32" height="32" alt="Illarion Koperski" /></a>
|
|
115
229
|
</p>
|
|
116
230
|
|
|
117
231
|
## License
|
|
118
232
|
|
|
119
|
-
Distributed under the MIT License. See [LICENSE](https://github.com/
|
|
233
|
+
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,13 +1,8 @@
|
|
|
1
1
|
import { ClientContext, Client, NestedClient } from '@orpc/client';
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
interface BuildKeyOptions<TType extends KeyType, TInput> {
|
|
7
|
-
type?: TType;
|
|
8
|
-
input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
|
|
9
|
-
}
|
|
10
|
-
declare function buildKey<TType extends KeyType, TInput>(path: string[], options?: BuildKeyOptions<TType, TInput>): QueryKey;
|
|
2
|
+
import { OperationType, OperationKeyOptions } from '@orpc/tanstack-query';
|
|
3
|
+
export { OperationKeyOptions as BuildKeyOptions, OperationType as KeyType, generateOperationKey as buildKey } from '@orpc/tanstack-query';
|
|
4
|
+
import { QueryKey, SkipToken, UseQueryOptions, QueryFunctionContext, UseInfiniteQueryOptions, UseMutationOptions, InfiniteData } from '@tanstack/react-query';
|
|
5
|
+
import { SetOptional, MaybeOptionalOptions } from '@orpc/shared';
|
|
11
6
|
|
|
12
7
|
/**
|
|
13
8
|
* Utils at any level (procedure or router)
|
|
@@ -16,16 +11,16 @@ interface GeneralUtils<TInput> {
|
|
|
16
11
|
/**
|
|
17
12
|
* Generate a query/mutation key for checking status, invalidate, set, get, etc.
|
|
18
13
|
*
|
|
19
|
-
* @see {@link https://orpc.
|
|
14
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
20
15
|
*/
|
|
21
|
-
key<UType extends
|
|
16
|
+
key<UType extends OperationType>(options?: OperationKeyOptions<UType, TInput>): QueryKey;
|
|
22
17
|
}
|
|
23
18
|
declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
|
|
24
19
|
|
|
25
20
|
type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = (undefined extends TInput ? {
|
|
26
|
-
input?: TInput;
|
|
21
|
+
input?: TInput | SkipToken;
|
|
27
22
|
} : {
|
|
28
|
-
input: TInput;
|
|
23
|
+
input: TInput | SkipToken;
|
|
29
24
|
}) & (Record<never, never> extends TClientContext ? {
|
|
30
25
|
context?: TClientContext;
|
|
31
26
|
} : {
|
|
@@ -34,19 +29,23 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
|
|
|
34
29
|
interface QueryOptionsBase<TOutput, TError> {
|
|
35
30
|
queryKey: QueryKey;
|
|
36
31
|
queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
|
|
37
|
-
|
|
32
|
+
throwOnError?(error: TError): boolean;
|
|
33
|
+
retryDelay?: (count: number, error: TError) => number;
|
|
34
|
+
enabled?: boolean;
|
|
38
35
|
}
|
|
39
36
|
type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
|
|
40
|
-
input: (pageParam: TPageParam) => TInput;
|
|
37
|
+
input: ((pageParam: TPageParam) => TInput) | SkipToken;
|
|
41
38
|
} & (Record<never, never> extends TClientContext ? {
|
|
42
39
|
context?: TClientContext;
|
|
43
40
|
} : {
|
|
44
41
|
context: TClientContext;
|
|
45
|
-
}) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData,
|
|
42
|
+
}) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData, QueryKey, TPageParam>, 'queryKey'>;
|
|
46
43
|
interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
|
|
47
44
|
queryKey: QueryKey;
|
|
48
45
|
queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
|
|
49
|
-
|
|
46
|
+
throwOnError?(error: TError): boolean;
|
|
47
|
+
retryDelay?: (count: number, error: TError) => number;
|
|
48
|
+
enabled?: boolean;
|
|
50
49
|
}
|
|
51
50
|
type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
|
|
52
51
|
context?: TClientContext;
|
|
@@ -59,25 +58,25 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
|
|
|
59
58
|
/**
|
|
60
59
|
* Calling corresponding procedure client
|
|
61
60
|
*
|
|
62
|
-
* @see {@link https://orpc.
|
|
61
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#calling-procedure-clients Tanstack Calling Procedure Client Docs}
|
|
63
62
|
*/
|
|
64
63
|
call: Client<TClientContext, TInput, TOutput, TError>;
|
|
65
64
|
/**
|
|
66
65
|
* Generate options used for useQuery/useSuspenseQuery/prefetchQuery/...
|
|
67
66
|
*
|
|
68
|
-
* @see {@link https://orpc.
|
|
67
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs}
|
|
69
68
|
*/
|
|
70
69
|
queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
|
|
71
70
|
/**
|
|
72
71
|
* Generate options used for useInfiniteQuery/useSuspenseInfiniteQuery/prefetchInfiniteQuery/...
|
|
73
72
|
*
|
|
74
|
-
* @see {@link https://orpc.
|
|
73
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#infinite-query-options-utility Tanstack Infinite Query Options Utility Docs}
|
|
75
74
|
*/
|
|
76
75
|
infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
|
|
77
76
|
/**
|
|
78
77
|
* Generate options used for useMutation/...
|
|
79
78
|
*
|
|
80
|
-
* @see {@link https://orpc.
|
|
79
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#mutation-options Tanstack Mutation Options Docs}
|
|
81
80
|
*/
|
|
82
81
|
mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
|
|
83
82
|
}
|
|
@@ -96,9 +95,9 @@ interface CreateRouterUtilsOptions {
|
|
|
96
95
|
* Create a router utils from a client.
|
|
97
96
|
*
|
|
98
97
|
* @info Both client-side and server-side clients are supported.
|
|
99
|
-
* @see {@link https://orpc.
|
|
98
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/react Tanstack Query React Docs}
|
|
100
99
|
*/
|
|
101
100
|
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
|
|
102
101
|
|
|
103
|
-
export {
|
|
104
|
-
export type {
|
|
102
|
+
export { createGeneralUtils, createRouterUtils as createORPCReactQueryUtils, createProcedureUtils, createRouterUtils };
|
|
103
|
+
export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,13 +1,8 @@
|
|
|
1
1
|
import { ClientContext, Client, NestedClient } from '@orpc/client';
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
interface BuildKeyOptions<TType extends KeyType, TInput> {
|
|
7
|
-
type?: TType;
|
|
8
|
-
input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
|
|
9
|
-
}
|
|
10
|
-
declare function buildKey<TType extends KeyType, TInput>(path: string[], options?: BuildKeyOptions<TType, TInput>): QueryKey;
|
|
2
|
+
import { OperationType, OperationKeyOptions } from '@orpc/tanstack-query';
|
|
3
|
+
export { OperationKeyOptions as BuildKeyOptions, OperationType as KeyType, generateOperationKey as buildKey } from '@orpc/tanstack-query';
|
|
4
|
+
import { QueryKey, SkipToken, UseQueryOptions, QueryFunctionContext, UseInfiniteQueryOptions, UseMutationOptions, InfiniteData } from '@tanstack/react-query';
|
|
5
|
+
import { SetOptional, MaybeOptionalOptions } from '@orpc/shared';
|
|
11
6
|
|
|
12
7
|
/**
|
|
13
8
|
* Utils at any level (procedure or router)
|
|
@@ -16,16 +11,16 @@ interface GeneralUtils<TInput> {
|
|
|
16
11
|
/**
|
|
17
12
|
* Generate a query/mutation key for checking status, invalidate, set, get, etc.
|
|
18
13
|
*
|
|
19
|
-
* @see {@link https://orpc.
|
|
14
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
20
15
|
*/
|
|
21
|
-
key<UType extends
|
|
16
|
+
key<UType extends OperationType>(options?: OperationKeyOptions<UType, TInput>): QueryKey;
|
|
22
17
|
}
|
|
23
18
|
declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
|
|
24
19
|
|
|
25
20
|
type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = (undefined extends TInput ? {
|
|
26
|
-
input?: TInput;
|
|
21
|
+
input?: TInput | SkipToken;
|
|
27
22
|
} : {
|
|
28
|
-
input: TInput;
|
|
23
|
+
input: TInput | SkipToken;
|
|
29
24
|
}) & (Record<never, never> extends TClientContext ? {
|
|
30
25
|
context?: TClientContext;
|
|
31
26
|
} : {
|
|
@@ -34,19 +29,23 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
|
|
|
34
29
|
interface QueryOptionsBase<TOutput, TError> {
|
|
35
30
|
queryKey: QueryKey;
|
|
36
31
|
queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
|
|
37
|
-
|
|
32
|
+
throwOnError?(error: TError): boolean;
|
|
33
|
+
retryDelay?: (count: number, error: TError) => number;
|
|
34
|
+
enabled?: boolean;
|
|
38
35
|
}
|
|
39
36
|
type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
|
|
40
|
-
input: (pageParam: TPageParam) => TInput;
|
|
37
|
+
input: ((pageParam: TPageParam) => TInput) | SkipToken;
|
|
41
38
|
} & (Record<never, never> extends TClientContext ? {
|
|
42
39
|
context?: TClientContext;
|
|
43
40
|
} : {
|
|
44
41
|
context: TClientContext;
|
|
45
|
-
}) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData,
|
|
42
|
+
}) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData, QueryKey, TPageParam>, 'queryKey'>;
|
|
46
43
|
interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
|
|
47
44
|
queryKey: QueryKey;
|
|
48
45
|
queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
|
|
49
|
-
|
|
46
|
+
throwOnError?(error: TError): boolean;
|
|
47
|
+
retryDelay?: (count: number, error: TError) => number;
|
|
48
|
+
enabled?: boolean;
|
|
50
49
|
}
|
|
51
50
|
type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
|
|
52
51
|
context?: TClientContext;
|
|
@@ -59,25 +58,25 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
|
|
|
59
58
|
/**
|
|
60
59
|
* Calling corresponding procedure client
|
|
61
60
|
*
|
|
62
|
-
* @see {@link https://orpc.
|
|
61
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#calling-procedure-clients Tanstack Calling Procedure Client Docs}
|
|
63
62
|
*/
|
|
64
63
|
call: Client<TClientContext, TInput, TOutput, TError>;
|
|
65
64
|
/**
|
|
66
65
|
* Generate options used for useQuery/useSuspenseQuery/prefetchQuery/...
|
|
67
66
|
*
|
|
68
|
-
* @see {@link https://orpc.
|
|
67
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs}
|
|
69
68
|
*/
|
|
70
69
|
queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
|
|
71
70
|
/**
|
|
72
71
|
* Generate options used for useInfiniteQuery/useSuspenseInfiniteQuery/prefetchInfiniteQuery/...
|
|
73
72
|
*
|
|
74
|
-
* @see {@link https://orpc.
|
|
73
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#infinite-query-options-utility Tanstack Infinite Query Options Utility Docs}
|
|
75
74
|
*/
|
|
76
75
|
infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
|
|
77
76
|
/**
|
|
78
77
|
* Generate options used for useMutation/...
|
|
79
78
|
*
|
|
80
|
-
* @see {@link https://orpc.
|
|
79
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#mutation-options Tanstack Mutation Options Docs}
|
|
81
80
|
*/
|
|
82
81
|
mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
|
|
83
82
|
}
|
|
@@ -96,9 +95,9 @@ interface CreateRouterUtilsOptions {
|
|
|
96
95
|
* Create a router utils from a client.
|
|
97
96
|
*
|
|
98
97
|
* @info Both client-side and server-side clients are supported.
|
|
99
|
-
* @see {@link https://orpc.
|
|
98
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/react Tanstack Query React Docs}
|
|
100
99
|
*/
|
|
101
100
|
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
|
|
102
101
|
|
|
103
|
-
export {
|
|
104
|
-
export type {
|
|
102
|
+
export { createGeneralUtils, createRouterUtils as createORPCReactQueryUtils, createProcedureUtils, createRouterUtils };
|
|
103
|
+
export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils };
|
package/dist/index.mjs
CHANGED
|
@@ -1,16 +1,11 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
return [path, {
|
|
5
|
-
...withInput,
|
|
6
|
-
...withType
|
|
7
|
-
}];
|
|
8
|
-
}
|
|
1
|
+
import { generateOperationKey } from '@orpc/tanstack-query';
|
|
2
|
+
export { generateOperationKey as buildKey } from '@orpc/tanstack-query';
|
|
3
|
+
import { skipToken } from '@tanstack/react-query';
|
|
9
4
|
|
|
10
5
|
function createGeneralUtils(path) {
|
|
11
6
|
return {
|
|
12
7
|
key(options) {
|
|
13
|
-
return
|
|
8
|
+
return generateOperationKey(path, options);
|
|
14
9
|
}
|
|
15
10
|
};
|
|
16
11
|
}
|
|
@@ -20,23 +15,36 @@ function createProcedureUtils(client, options) {
|
|
|
20
15
|
call: client,
|
|
21
16
|
queryOptions(...[optionsIn = {}]) {
|
|
22
17
|
return {
|
|
23
|
-
queryKey:
|
|
24
|
-
queryFn: ({ signal }) =>
|
|
18
|
+
queryKey: generateOperationKey(options.path, { type: "query", input: optionsIn.input }),
|
|
19
|
+
queryFn: ({ signal }) => {
|
|
20
|
+
if (optionsIn.input === skipToken) {
|
|
21
|
+
throw new Error("queryFn should not be called with skipToken used as input");
|
|
22
|
+
}
|
|
23
|
+
return client(optionsIn.input, { signal, context: optionsIn.context });
|
|
24
|
+
},
|
|
25
|
+
...optionsIn.input === skipToken ? { enabled: false } : {},
|
|
25
26
|
...optionsIn
|
|
26
27
|
};
|
|
27
28
|
},
|
|
28
29
|
infiniteOptions(optionsIn) {
|
|
29
30
|
return {
|
|
30
|
-
queryKey:
|
|
31
|
+
queryKey: generateOperationKey(options.path, {
|
|
32
|
+
type: "infinite",
|
|
33
|
+
input: optionsIn.input === skipToken ? skipToken : optionsIn.input(optionsIn.initialPageParam)
|
|
34
|
+
}),
|
|
31
35
|
queryFn: ({ pageParam, signal }) => {
|
|
36
|
+
if (optionsIn.input === skipToken) {
|
|
37
|
+
throw new Error("queryFn should not be called with skipToken used as input");
|
|
38
|
+
}
|
|
32
39
|
return client(optionsIn.input(pageParam), { signal, context: optionsIn.context });
|
|
33
40
|
},
|
|
41
|
+
...optionsIn.input === skipToken ? { enabled: false } : {},
|
|
34
42
|
...optionsIn
|
|
35
43
|
};
|
|
36
44
|
},
|
|
37
45
|
mutationOptions(...[optionsIn = {}]) {
|
|
38
46
|
return {
|
|
39
|
-
mutationKey:
|
|
47
|
+
mutationKey: generateOperationKey(options.path, { type: "mutation" }),
|
|
40
48
|
mutationFn: (input) => client(input, { context: optionsIn.context }),
|
|
41
49
|
...optionsIn
|
|
42
50
|
};
|
|
@@ -71,4 +79,4 @@ function createRouterUtils(client, options = {}) {
|
|
|
71
79
|
return recursive;
|
|
72
80
|
}
|
|
73
81
|
|
|
74
|
-
export {
|
|
82
|
+
export { createGeneralUtils, createRouterUtils as createORPCReactQueryUtils, createProcedureUtils, createRouterUtils };
|
package/package.json
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/react-query",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.a45fc95",
|
|
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-query"
|
|
11
11
|
},
|
|
12
12
|
"keywords": [
|
|
13
|
-
"unnoq",
|
|
14
13
|
"orpc",
|
|
15
14
|
"react-query",
|
|
16
15
|
"tanstack query",
|
|
@@ -27,17 +26,18 @@
|
|
|
27
26
|
"dist"
|
|
28
27
|
],
|
|
29
28
|
"peerDependencies": {
|
|
30
|
-
"@tanstack/react-query": ">=5.
|
|
29
|
+
"@tanstack/react-query": ">=5.80.2",
|
|
31
30
|
"react": ">=18.3.0",
|
|
32
|
-
"@orpc/client": "0.0.0-next.
|
|
31
|
+
"@orpc/client": "0.0.0-next.a45fc95"
|
|
33
32
|
},
|
|
34
33
|
"dependencies": {
|
|
35
|
-
"@orpc/shared": "0.0.0-next.
|
|
34
|
+
"@orpc/shared": "0.0.0-next.a45fc95",
|
|
35
|
+
"@orpc/tanstack-query": "0.0.0-next.a45fc95"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@tanstack/
|
|
39
|
-
"react": "^19.
|
|
40
|
-
"zod": "^3.
|
|
38
|
+
"@tanstack/react-query": "^5.90.21",
|
|
39
|
+
"react": "^19.2.4",
|
|
40
|
+
"zod": "^4.3.6"
|
|
41
41
|
},
|
|
42
42
|
"scripts": {
|
|
43
43
|
"build": "unbuild",
|