@orpc/pinia-colada 2.0.0-beta.44 → 2.0.0-beta.46
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 +100 -62
- package/dist/index.d.mts +75 -77
- package/dist/index.d.ts +75 -77
- package/dist/index.mjs +40 -22
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -21,9 +21,40 @@
|
|
|
21
21
|
</a>
|
|
22
22
|
</div>
|
|
23
23
|
|
|
24
|
+
**oRPC** is a TypeScript framework for building end-to-end typesafe APIs. Write your API once as plain TypeScript functions, and oRPC gives you a fully typed client, a REST API with an OpenAPI document, and MCP tools for AI agents, with no code generation. It runs on Node.js, Bun, Deno, Cloudflare Workers, and more.
|
|
25
|
+
|
|
26
|
+
Define procedures on the server and serve them with an [RPC handler](https://orpc.dev/docs/rpc/handler):
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import { os } from '@orpc/server'
|
|
30
|
+
import * as z from 'zod'
|
|
31
|
+
|
|
32
|
+
export const router = {
|
|
33
|
+
planet: {
|
|
34
|
+
find: os
|
|
35
|
+
.input(z.object({ id: z.number() }))
|
|
36
|
+
.handler(({ input }) => ({ id: input.id, name: 'Earth' })),
|
|
37
|
+
},
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Then call them from a client that knows every input and output, without generating anything:
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
import type { RouterClient } from '@orpc/server'
|
|
45
|
+
import type { router } from './router'
|
|
46
|
+
import { createORPCClient } from '@orpc/client'
|
|
47
|
+
import { RPCLink } from '@orpc/client/fetch'
|
|
48
|
+
|
|
49
|
+
const link = new RPCLink({ origin: 'http://localhost:3000', url: '/rpc' })
|
|
50
|
+
const client: RouterClient<typeof router> = createORPCClient(link)
|
|
51
|
+
|
|
52
|
+
const planet = await client.planet.find({ id: 1 }) // { id: number, name: string }
|
|
53
|
+
```
|
|
54
|
+
|
|
24
55
|
## Documentation
|
|
25
56
|
|
|
26
|
-
|
|
57
|
+
Read the full documentation at [orpc.dev](https://orpc.dev), starting with the [Getting Started guide](https://orpc.dev/docs/getting-started).
|
|
27
58
|
|
|
28
59
|
## Packages
|
|
29
60
|
|
|
@@ -56,20 +87,21 @@ You can read the documentation [here](https://orpc.dev).
|
|
|
56
87
|
|
|
57
88
|
**Framework & ecosystem integrations**
|
|
58
89
|
|
|
59
|
-
| Package
|
|
60
|
-
|
|
|
61
|
-
| [@orpc/next](https://www.npmjs.com/package/@orpc/next)
|
|
62
|
-
| [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk)
|
|
63
|
-
| [@orpc/
|
|
64
|
-
| [@orpc/
|
|
65
|
-
| [@orpc/
|
|
66
|
-
| [@orpc/
|
|
67
|
-
| [@orpc/
|
|
68
|
-
| [@orpc/
|
|
69
|
-
| [@orpc/
|
|
70
|
-
| [@orpc/
|
|
71
|
-
| [@orpc/
|
|
72
|
-
| [@orpc/
|
|
90
|
+
| Package | Purpose | Docs |
|
|
91
|
+
| -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
92
|
+
| [@orpc/next](https://www.npmjs.com/package/@orpc/next) | Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data). | [Next.js](https://orpc.dev/docs/integrations/next) |
|
|
93
|
+
| [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk) | Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools. | [AI SDK](https://orpc.dev/docs/integrations/ai-sdk) |
|
|
94
|
+
| [@orpc/mcp](https://www.npmjs.com/package/@orpc/mcp) | Expose procedures as [MCP](https://modelcontextprotocol.io/) tools. | [MCP](https://orpc.dev/docs/integrations/mcp) |
|
|
95
|
+
| [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query) | Integrate with [TanStack Query](https://tanstack.com/query/latest). | [TanStack Query](https://orpc.dev/docs/integrations/tanstack-query) |
|
|
96
|
+
| [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada) | Integrate with [Pinia Colada](https://pinia-colada.esm.dev/). | [Pinia Colada](https://orpc.dev/docs/integrations/pinia-colada) |
|
|
97
|
+
| [@orpc/swr](https://www.npmjs.com/package/@orpc/swr) | Integrate with [SWR](https://swr.vercel.app/). | [SWR](https://orpc.dev/docs/integrations/swr) |
|
|
98
|
+
| [@orpc/msw](https://www.npmjs.com/package/@orpc/msw) | Mock procedures with [Mock Service Worker](https://mswjs.io/). | [MSW](https://orpc.dev/docs/integrations/msw) |
|
|
99
|
+
| [@orpc/effect](https://www.npmjs.com/package/@orpc/effect) | Integrate with [Effect](https://effect.website/). | [Effect](https://orpc.dev/docs/integrations/effect) |
|
|
100
|
+
| [@orpc/nest](https://www.npmjs.com/package/@orpc/nest) | Implement your contract with [NestJS](https://nestjs.com/). | [NestJS](https://orpc.dev/docs/integrations/nest) |
|
|
101
|
+
| [@orpc/node](https://www.npmjs.com/package/@orpc/node) | [Node.js](https://nodejs.org/) plugins for static file serving and large uploads. | [Static File](https://orpc.dev/docs/plugins/static-file), [Tmp File Upload](https://orpc.dev/docs/plugins/tmp-file-upload), [Batch Response Compression](https://orpc.dev/docs/plugins/batch-response-compression) |
|
|
102
|
+
| [@orpc/bun](https://www.npmjs.com/package/@orpc/bun) | Adapters for [Bun's Redis](https://bun.sh/). | [Publisher](https://orpc.dev/docs/helpers/publisher), [Rate Limit](https://orpc.dev/docs/helpers/ratelimit), [Lock](https://orpc.dev/docs/helpers/lock) |
|
|
103
|
+
| [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare) | Adapters for [Cloudflare Workers](https://developers.cloudflare.com/workers/). | [Publisher](https://orpc.dev/docs/helpers/publisher), [Rate Limit](https://orpc.dev/docs/helpers/ratelimit), [Lock](https://orpc.dev/docs/helpers/lock), [Traces](https://orpc.dev/docs/integrations/cloudflare-traces) |
|
|
104
|
+
| [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc) | Reuse existing [tRPC](https://trpc.io/) routers within oRPC. | [tRPC](https://orpc.dev/docs/integrations/trpc) |
|
|
73
105
|
|
|
74
106
|
**Observability**
|
|
75
107
|
|
|
@@ -95,19 +127,11 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
95
127
|
</tr>
|
|
96
128
|
</table>
|
|
97
129
|
|
|
98
|
-
### Premium Sponsors
|
|
99
|
-
|
|
100
|
-
<table>
|
|
101
|
-
<tr>
|
|
102
|
-
<td align="center"><a href="https://github.com/nexa-ca?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Nexa"><img src="https://avatars.githubusercontent.com/u/199146462?v=4" width="209" alt="Nexa"/><br />Nexa</a></td>
|
|
103
|
-
</tr>
|
|
104
|
-
</table>
|
|
105
|
-
|
|
106
130
|
### Organization Sponsors
|
|
107
131
|
|
|
108
132
|
<table>
|
|
109
133
|
<tr>
|
|
110
|
-
<td align="center"><a href="https://lnmarkets.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="
|
|
134
|
+
<td align="center"><a href="https://lnmarkets.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="209" alt="LN Markets"/><br />LN Markets</a></td>
|
|
111
135
|
</tr>
|
|
112
136
|
</table>
|
|
113
137
|
|
|
@@ -115,27 +139,29 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
115
139
|
|
|
116
140
|
<table>
|
|
117
141
|
<tr>
|
|
118
|
-
<td align="center"><a href="https://github.com/hrmcdonald?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="
|
|
119
|
-
<td align="center"><a href="https://soymilk.party/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="あわわわとーにゅ"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&v=4" width="
|
|
120
|
-
<td align="center"><a href="https://github.com/nicognaW?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="
|
|
121
|
-
<td align="center"><a href="https://supastarter.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="
|
|
122
|
-
<td align="center"><a href="https://github.com/herrfugbaum?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="
|
|
123
|
-
|
|
142
|
+
<td align="center"><a href="https://github.com/hrmcdonald?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="167" alt="Reece McDonald"/><br />Reece McDonald</a></td>
|
|
143
|
+
<td align="center"><a href="https://soymilk.party/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="あわわわとーにゅ"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&v=4" width="167" alt="あわわわとーにゅ"/><br />あわわわとーにゅ</a></td>
|
|
144
|
+
<td align="center"><a href="https://github.com/nicognaW?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="167" alt="nk"/><br />nk</a></td>
|
|
145
|
+
<td align="center"><a href="https://supastarter.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="167" alt="supastarter"/><br />supastarter</a></td>
|
|
146
|
+
<td align="center"><a href="https://github.com/herrfugbaum?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="167" alt="herrfugbaum"/><br />herrfugbaum</a></td>
|
|
147
|
+
</tr>
|
|
148
|
+
<tr>
|
|
149
|
+
<td align="center"><a href="https://laststance.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="167" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
|
|
150
|
+
<td align="center"><a href="https://cra.mr/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="167" alt="David Cramer"/><br />David Cramer</a></td>
|
|
151
|
+
<td align="center"><a href="https://valerii15298.github.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" 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>
|
|
152
|
+
<td align="center"><a href="https://letstri.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&v=4" width="167" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
153
|
+
<td align="center"><a href="https://blacklight.sh/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&v=4" width="167" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
124
154
|
</tr>
|
|
125
155
|
<tr>
|
|
126
|
-
<td align="center"><a href="https://
|
|
127
|
-
<td align="center"><a href="https://
|
|
128
|
-
<td align="center"><a href="https://
|
|
129
|
-
<td align="center"><a href="https://
|
|
130
|
-
<td align="center"><a href="https://github.com/
|
|
131
|
-
<td align="center"><a href="https://github.com/Ryanjso?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
156
|
+
<td align="center"><a href="https://github.com/christ12938?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="167" alt="christ12938"/><br />christ12938</a></td>
|
|
157
|
+
<td align="center"><a href="https://github.com/Ryanjso?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="167" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
158
|
+
<td align="center"><a href="https://github.com/itigoore01?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&v=4" width="167" alt="shota"/><br />shota</a></td>
|
|
159
|
+
<td align="center"><a href="https://github.com/ellis-driscoll?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&v=4" width="167" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
|
|
160
|
+
<td align="center"><a href="https://github.com/hoangbn?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Hoang Nguyen"><img src="https://avatars.githubusercontent.com/u/38968280?u=c90084c6de65c56facabab7ba13a72a49ddbc3e4&v=4" width="167" alt="Hoang Nguyen"/><br />Hoang Nguyen</a></td>
|
|
132
161
|
</tr>
|
|
133
162
|
<tr>
|
|
134
|
-
<td align="center"><a href="https://
|
|
135
|
-
<td align="center"><a href="https://
|
|
136
|
-
<td align="center"><a href="https://github.com/hoangbn?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Hoang Nguyen"><img src="https://avatars.githubusercontent.com/u/38968280?u=c90084c6de65c56facabab7ba13a72a49ddbc3e4&v=4" width="139" alt="Hoang Nguyen"/><br />Hoang Nguyen</a></td>
|
|
137
|
-
<td align="center"><a href="https://opencollective.com/guest-ac41de3b?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Orestis Ioannou"><img src="https://images.opencollective.com/guest-ac41de3b/avatar/460.png" width="139" alt="Orestis Ioannou"/><br />Orestis Ioannou</a></td>
|
|
138
|
-
<td align="center"><a href="https://automatio.ai/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Stefan Smiljkovic"><img src="https://avatars.githubusercontent.com/u/1984909?u=b7bf5bc40ed49df3c22f69d2da7b8d78709c49ed&v=4" width="139" alt="Stefan Smiljkovic"/><br />Stefan Smiljkovic</a></td>
|
|
163
|
+
<td align="center"><a href="https://opencollective.com/guest-ac41de3b?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Orestis Ioannou"><img src="https://images.opencollective.com/guest-ac41de3b/avatar/460.png" width="167" alt="Orestis Ioannou"/><br />Orestis Ioannou</a></td>
|
|
164
|
+
<td align="center"><a href="https://automatio.ai/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Stefan Smiljkovic"><img src="https://avatars.githubusercontent.com/u/1984909?u=b7bf5bc40ed49df3c22f69d2da7b8d78709c49ed&v=4" width="167" alt="Stefan Smiljkovic"/><br />Stefan Smiljkovic</a></td>
|
|
139
165
|
</tr>
|
|
140
166
|
</table>
|
|
141
167
|
|
|
@@ -143,34 +169,46 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
143
169
|
|
|
144
170
|
<table>
|
|
145
171
|
<tr>
|
|
146
|
-
<td align="center"><a href="https://github.com/rhinodavid?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="
|
|
147
|
-
<td align="center"><a href="https://github.com/IPv4Addr?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="IPv4Addr"><img src="https://avatars.githubusercontent.com/u/100147665?u=59996b72f69bb53063cb7e9ff8b8f898616cd94d&v=4" width="
|
|
148
|
-
<td align="center"><a href="https://robbevaes.be/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="
|
|
149
|
-
<td align="center"><a href="https://github.com/aidansunbury?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="
|
|
150
|
-
<td align="center"><a href="https://github.com/soonoo?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="
|
|
151
|
-
<td align="center"><a href="https://kevinporten.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="
|
|
152
|
-
<td align="center"><a href="https://github.com/pumpkinlink?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="119" alt="Denis"/><br />Denis</a></td>
|
|
172
|
+
<td align="center"><a href="https://github.com/rhinodavid?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="139" alt="David Walsh"/><br />David Walsh</a></td>
|
|
173
|
+
<td align="center"><a href="https://github.com/IPv4Addr?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="IPv4Addr"><img src="https://avatars.githubusercontent.com/u/100147665?u=59996b72f69bb53063cb7e9ff8b8f898616cd94d&v=4" width="139" alt="IPv4Addr"/><br />IPv4Addr</a></td>
|
|
174
|
+
<td align="center"><a href="https://robbevaes.be/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="139" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
175
|
+
<td align="center"><a href="https://github.com/aidansunbury?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="139" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
|
|
176
|
+
<td align="center"><a href="https://github.com/soonoo?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="139" alt="soonoo"/><br />soonoo</a></td>
|
|
177
|
+
<td align="center"><a href="https://kevinporten.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="139" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
153
178
|
</tr>
|
|
154
179
|
<tr>
|
|
155
|
-
<td align="center"><a href="https://github.com/
|
|
156
|
-
<td align="center"><a href="
|
|
157
|
-
<td align="center"><a href="
|
|
158
|
-
<td align="center"><a href="https://
|
|
159
|
-
<td align="center"><a href="https://
|
|
160
|
-
<td align="center"><a href="https://
|
|
161
|
-
<td align="center"><a href="https://dubinets.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
|
|
180
|
+
<td align="center"><a href="https://github.com/pumpkinlink?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="139" alt="Denis"/><br />Denis</a></td>
|
|
181
|
+
<td align="center"><a href="https://github.com/christopher-kapic?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="139" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
182
|
+
<td align="center"><a href="http://ballingt.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="139" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
183
|
+
<td align="center"><a href="https://lee-sam.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="139" alt="Sam"/><br />Sam</a></td>
|
|
184
|
+
<td align="center"><a href="https://github.com/Titoine?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="139" alt="Titoine"/><br />Titoine</a></td>
|
|
185
|
+
<td align="center"><a href="https://rigtch.fm/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="139" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
162
186
|
</tr>
|
|
163
187
|
<tr>
|
|
164
|
-
<td align="center"><a href="https://
|
|
165
|
-
<td align="center"><a href="https://
|
|
166
|
-
<td align="center"><a href="https://
|
|
167
|
-
<td align="center"><a href="https://
|
|
168
|
-
<td align="center"><a href="https://
|
|
169
|
-
<td align="center"><a href="https://
|
|
188
|
+
<td align="center"><a href="https://blog.cwang.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="139" alt="hanayashiki"/><br />hanayashiki</a></td>
|
|
189
|
+
<td align="center"><a href="https://dubinets.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="139" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
|
|
190
|
+
<td align="center"><a href="https://kellychan.im/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="139" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
191
|
+
<td align="center"><a href="https://guyariely.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&v=4" width="139" alt="Guy Ariely"/><br />Guy Ariely</a></td>
|
|
192
|
+
<td align="center"><a href="https://paulsenon.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="PaulSenon"><img src="https://avatars.githubusercontent.com/u/19531087?u=6385741eb91d200b8c513ec6045482e301767ca6&v=4" width="139" alt="PaulSenon"/><br />PaulSenon</a></td>
|
|
193
|
+
<td align="center"><a href="https://nakasyou.how/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Shotaro Nakamura"><img src="https://avatars.githubusercontent.com/u/79000684?u=f644df3f29f0e8677a90967115774564f1d9d6ab&v=4" width="139" alt="Shotaro Nakamura"/><br />Shotaro Nakamura</a></td>
|
|
194
|
+
</tr>
|
|
195
|
+
<tr>
|
|
196
|
+
<td align="center"><a href="https://piscis.dev/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="139" alt="Alex"/><br />Alex</a></td>
|
|
197
|
+
<td align="center"><a href="https://opensource.gubanov.eu/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=c5f2daf7ebece498e85c83367bb37b4e10e2649d&v=4" width="139" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
|
|
170
198
|
</tr>
|
|
171
199
|
</table>
|
|
172
200
|
|
|
173
|
-
With thanks to [
|
|
201
|
+
With thanks to [40 past sponsors](https://orpc.dev/sponsors#past-sponsors) who helped get oRPC here.
|
|
202
|
+
|
|
203
|
+
## Open Source Programs
|
|
204
|
+
|
|
205
|
+
[middleapi](https://github.com/middleapi) is supported by these open source programs:
|
|
206
|
+
|
|
207
|
+
<table>
|
|
208
|
+
<tr>
|
|
209
|
+
<td align="center"><a href="https://claude.com/contact-sales/claude-for-oss" target="_blank" rel="noopener" title="Claude for Open Source"><img src="https://cdn.simpleicons.org/claude" width="64" alt="Claude"/><br />Claude for Open Source</a></td>
|
|
210
|
+
</tr>
|
|
211
|
+
</table>
|
|
174
212
|
|
|
175
213
|
## References
|
|
176
214
|
|
package/dist/index.d.mts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
|
|
1
|
+
import { ClientContext, RPCJsonSerializer, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
|
|
2
|
+
export { AnyNestedClient } from '@orpc/client';
|
|
2
3
|
import { RouterContract, RouterContractClient, ContractClientFactory, AnySchema, ErrorMap, MetaPlugin, Meta, InferSchemaInput, InferSchemaOutput, ORPCErrorFromErrorMap } from '@orpc/contract';
|
|
3
|
-
import { JsonifiedClient } from '@orpc/openapi';
|
|
4
|
-
import {
|
|
5
|
-
|
|
4
|
+
import { JsonifiedClient, ContractJsonifiedClientFactory } from '@orpc/openapi';
|
|
5
|
+
import { Public, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, ThrowableError } from '@orpc/shared';
|
|
6
|
+
export { Public } from '@orpc/shared';
|
|
7
|
+
import { EntryKey, UseQueryOptions, DefineQueryOptions, UseInfiniteQueryData, DefineInfiniteQueryOptions, UseMutationOptions, UseMutationOptionsGlobal, DefineQueryOptionsTagged, DefineInfiniteQueryOptionsTagged, DefineMutationOptionsTagged, UseInfiniteQueryFnContext, EntryKeyTagged, _EmptyObject } from '@pinia/colada';
|
|
6
8
|
|
|
7
9
|
type InferStreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
|
|
8
10
|
type InferLiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
|
|
@@ -44,7 +46,7 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
|
|
|
44
46
|
} : {
|
|
45
47
|
input: TInput;
|
|
46
48
|
}) & (object extends TClientContext ? {
|
|
47
|
-
context?: TClientContext;
|
|
49
|
+
context?: TClientContext | undefined;
|
|
48
50
|
} : {
|
|
49
51
|
context: TClientContext;
|
|
50
52
|
}) & Omit<DefineQueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'> & Partial<Pick<DefineQueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'>>;
|
|
@@ -54,12 +56,12 @@ type StreamedKeyOptions<TInput> = ((undefined extends TInput ? {
|
|
|
54
56
|
} : {
|
|
55
57
|
input: TInput;
|
|
56
58
|
}) & {
|
|
57
|
-
fnOptions?: SerializableStreamedQueryOptions;
|
|
59
|
+
fnOptions?: SerializableStreamedQueryOptions | undefined;
|
|
58
60
|
}) | {
|
|
59
61
|
key: EntryKey;
|
|
60
62
|
};
|
|
61
63
|
type StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TInitialData extends TOutput | undefined> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TInitialData> & {
|
|
62
|
-
fnOptions?: SerializableStreamedQueryOptions;
|
|
64
|
+
fnOptions?: SerializableStreamedQueryOptions | undefined;
|
|
63
65
|
};
|
|
64
66
|
type StreamedOptionsOut<TOutput, TError, TInitialData extends TOutput | undefined> = QueryOptionsOut<TOutput, TError, TInitialData>;
|
|
65
67
|
type InfiniteKeyOptions<TInput, TPageParam> = Pick<InfiniteOptionsIn<any, TInput, any, any, TPageParam, any>, 'input' | 'initialPageParam'> | {
|
|
@@ -68,14 +70,14 @@ type InfiniteKeyOptions<TInput, TPageParam> = Pick<InfiniteOptionsIn<any, TInput
|
|
|
68
70
|
type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TPageParam, TInitialData extends UseInfiniteQueryData<TOutput, TPageParam> | undefined> = {
|
|
69
71
|
input: (pageParam: TPageParam) => TInput;
|
|
70
72
|
} & (object extends TClientContext ? {
|
|
71
|
-
context?: TClientContext;
|
|
73
|
+
context?: TClientContext | undefined;
|
|
72
74
|
} : {
|
|
73
75
|
context: TClientContext;
|
|
74
76
|
}) & Omit<DefineInfiniteQueryOptions<TOutput, TError, TPageParam, TInitialData>, 'key' | 'query'> & Partial<Pick<DefineInfiniteQueryOptions<TOutput, TError, TPageParam, TInitialData>, 'key' | 'query'>>;
|
|
75
77
|
type InfiniteOptionsOut<TOutput, TError, TPageParam, TInitialData extends UseInfiniteQueryData<TOutput, TPageParam> | undefined> = DefineInfiniteQueryOptionsTagged<TOutput, TError, TPageParam, TInitialData>;
|
|
76
78
|
type MutationKeyOptions<TInput> = Pick<MutationOptionsIn<any, TInput, any, any, any>, 'key'>;
|
|
77
79
|
type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext extends Record<any, any>> = (object extends TClientContext ? {
|
|
78
|
-
context?: TClientContext;
|
|
80
|
+
context?: TClientContext | undefined;
|
|
79
81
|
} : {
|
|
80
82
|
context: TClientContext;
|
|
81
83
|
}) & Omit<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'> & Partial<Pick<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'>>;
|
|
@@ -91,58 +93,57 @@ interface SerializableStreamedQueryOptions {
|
|
|
91
93
|
*
|
|
92
94
|
* @default 'reset'
|
|
93
95
|
*/
|
|
94
|
-
refetchMode?: 'append' | 'reset' | 'replace';
|
|
96
|
+
refetchMode?: 'append' | 'reset' | 'replace' | undefined;
|
|
95
97
|
/**
|
|
96
98
|
* Limits the number of data chunks stored in the query result.
|
|
97
99
|
* Older chunks are removed when the limit is reached.
|
|
98
100
|
*
|
|
99
101
|
* @default Number.POSITIVE_INFINITY (unlimited)
|
|
100
102
|
*/
|
|
101
|
-
maxChunks?: number;
|
|
103
|
+
maxChunks?: number | undefined;
|
|
102
104
|
}
|
|
103
|
-
/**
|
|
104
|
-
* A Pinia Colada query function that accumulates streamed chunks into an array,
|
|
105
|
-
* publishing each chunk to the cache entry as it arrives.
|
|
106
|
-
*
|
|
107
|
-
* Inspired by [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery) where:
|
|
108
|
-
* - Options are serializable
|
|
109
|
-
* - The output is predictable
|
|
110
|
-
*/
|
|
111
|
-
declare function serializableStreamedQuery<T>(queryFn: (context: UseQueryFnContext) => Promisable<AsyncIterable<T>>, { refetchMode, maxChunks }?: SerializableStreamedQueryOptions): (context: UseQueryFnContext) => Promise<T[]>;
|
|
112
105
|
|
|
113
106
|
interface OperationKeyPrefixOptions {
|
|
114
107
|
/**
|
|
115
108
|
* Prepended as the first element of the key when present.
|
|
116
109
|
* Use this to avoid key conflicts when multiple router utils share the same client.
|
|
117
110
|
*/
|
|
118
|
-
prefix?: string;
|
|
111
|
+
prefix?: string | undefined;
|
|
112
|
+
}
|
|
113
|
+
interface OperationKeyBaseOptions extends OperationKeyPrefixOptions {
|
|
114
|
+
/**
|
|
115
|
+
* Serializes inputs into JSON-compatible values when building keys.
|
|
116
|
+
* Pass the serializer your link uses so custom types produce consistent keys.
|
|
117
|
+
*
|
|
118
|
+
* @default new RPCJsonSerializer()
|
|
119
|
+
*/
|
|
120
|
+
serializer?: Public<RPCJsonSerializer> | undefined;
|
|
119
121
|
}
|
|
120
|
-
type OperationKeyOptions<TType extends OperationType, TInput> =
|
|
121
|
-
type?: TType;
|
|
122
|
-
input?: PartialDeep<TInput
|
|
123
|
-
fnOptions?: TType extends 'streamed' ? SerializableStreamedQueryOptions : never;
|
|
122
|
+
type OperationKeyOptions<TType extends OperationType, TInput> = OperationKeyBaseOptions & {
|
|
123
|
+
type?: TType | undefined;
|
|
124
|
+
input?: PartialDeep<TInput> | undefined;
|
|
125
|
+
fnOptions?: (TType extends 'streamed' ? SerializableStreamedQueryOptions : never) | undefined;
|
|
124
126
|
};
|
|
125
|
-
type
|
|
126
|
-
/**
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
|
|
127
|
+
type OperationKeyContent<TType extends OperationType, TInput> = Omit<OperationKeyOptions<TType, TInput>, keyof OperationKeyBaseOptions> & {
|
|
128
|
+
/**
|
|
129
|
+
* Serializer types of non-JSON values in `input`, keyed by their JSON-encoded path,
|
|
130
|
+
* so inputs with the same JSON form (like a `Date` and its ISO string) produce different keys.
|
|
131
|
+
* Keyed by path (not a list) so partial keys still match.
|
|
132
|
+
*/
|
|
133
|
+
inputMeta?: Record<string, string[]> | undefined;
|
|
134
|
+
};
|
|
135
|
+
type OperationKey<TType extends OperationType, TInput> = EntryKey & ([path: string[], options: OperationKeyContent<TType, TInput>] | [prefix: string, path: string[], options: OperationKeyContent<TType, TInput>]);
|
|
135
136
|
|
|
136
137
|
declare class SharedUtils<TInput> {
|
|
137
138
|
protected readonly path: string[];
|
|
138
|
-
protected readonly options:
|
|
139
|
-
constructor(path: string[], options:
|
|
139
|
+
protected readonly options: OperationKeyBaseOptions;
|
|
140
|
+
constructor(path: string[], options: OperationKeyBaseOptions);
|
|
140
141
|
/**
|
|
141
142
|
* Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
|
|
142
143
|
*
|
|
143
144
|
* @see {@link https://orpc.dev/docs/integrations/pinia-colada#querymutation-key | Pinia Colada Integration - Query/Mutation Key}
|
|
144
145
|
*/
|
|
145
|
-
key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>,
|
|
146
|
+
key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>, keyof OperationKeyBaseOptions>): OperationKey<TType, TInput>;
|
|
146
147
|
}
|
|
147
148
|
|
|
148
149
|
interface ProcedureUtilsQueryInterceptorOptions<TClientContext extends ClientContext, TInput> {
|
|
@@ -177,79 +178,78 @@ type ProcedureUtilsMutationInterceptor<TClientContext extends ClientContext, TIn
|
|
|
177
178
|
* or a function that receives per-call options and returns overridden this.options.
|
|
178
179
|
*/
|
|
179
180
|
type ProcedureUtilsModifier<T extends object> = Partial<T> | ((options: T) => T);
|
|
180
|
-
interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> extends
|
|
181
|
+
interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> extends OperationKeyBaseOptions {
|
|
181
182
|
/**
|
|
182
183
|
* Key options modifier for .queryKey and .queryOptions
|
|
183
184
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
184
185
|
*/
|
|
185
|
-
queryKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput
|
|
186
|
+
queryKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput>> | undefined;
|
|
186
187
|
/**
|
|
187
188
|
* Interceptors that intercept query inside .queryOptions, guaranteed to be executed.
|
|
188
189
|
*/
|
|
189
|
-
queryInterceptors?: ProcedureUtilsQueryInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
190
|
+
queryInterceptors?: ProcedureUtilsQueryInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
190
191
|
/**
|
|
191
192
|
* Options modifier for .queryOptions
|
|
192
193
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
193
194
|
*/
|
|
194
|
-
queryOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, TOutput, TError, TOutput | undefined
|
|
195
|
+
queryOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, TOutput, TError, TOutput | undefined>> | undefined;
|
|
195
196
|
/**
|
|
196
197
|
* Key options modifier for .streamedKey and .streamedOptions
|
|
197
198
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
198
199
|
*/
|
|
199
|
-
streamedKey?: ProcedureUtilsModifier<StreamedKeyOptions<TInput
|
|
200
|
+
streamedKey?: ProcedureUtilsModifier<StreamedKeyOptions<TInput>> | undefined;
|
|
200
201
|
/**
|
|
201
202
|
* Interceptors that intercept query inside .streamedOptions, guaranteed to be executed.
|
|
202
203
|
*/
|
|
203
|
-
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
204
|
+
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
204
205
|
/**
|
|
205
206
|
* Options modifier for .streamedOptions
|
|
206
207
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
207
208
|
*/
|
|
208
|
-
streamedOptions?: ProcedureUtilsModifier<StreamedOptionsIn<TClientContext, TInput, InferStreamedQueryOutput<TOutput>, TError, InferStreamedQueryOutput<TOutput> | undefined
|
|
209
|
+
streamedOptions?: ProcedureUtilsModifier<StreamedOptionsIn<TClientContext, TInput, InferStreamedQueryOutput<TOutput>, TError, InferStreamedQueryOutput<TOutput> | undefined>> | undefined;
|
|
209
210
|
/**
|
|
210
211
|
* Key options modifier for .liveKey and .liveOptions
|
|
211
212
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
212
213
|
*/
|
|
213
|
-
liveKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput
|
|
214
|
+
liveKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput>> | undefined;
|
|
214
215
|
/**
|
|
215
216
|
* Interceptors that intercept query inside .liveOptions, guaranteed to be executed.
|
|
216
217
|
*/
|
|
217
|
-
liveInterceptors?: ProcedureUtilsLiveInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
218
|
+
liveInterceptors?: ProcedureUtilsLiveInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
218
219
|
/**
|
|
219
220
|
* Options modifier for .liveOptions
|
|
220
221
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
221
222
|
*/
|
|
222
|
-
liveOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, InferLiveQueryOutput<TOutput>, TError, InferLiveQueryOutput<TOutput> | undefined
|
|
223
|
+
liveOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, InferLiveQueryOutput<TOutput>, TError, InferLiveQueryOutput<TOutput> | undefined>> | undefined;
|
|
223
224
|
/**
|
|
224
225
|
* Key options modifier for .infiniteKey and .infiniteOptions
|
|
225
226
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
226
227
|
*/
|
|
227
|
-
infiniteKey?: ProcedureUtilsModifier<InfiniteKeyOptions<TInput, unknown
|
|
228
|
+
infiniteKey?: ProcedureUtilsModifier<InfiniteKeyOptions<TInput, unknown>> | undefined;
|
|
228
229
|
/**
|
|
229
230
|
* Interceptors that intercept query inside .infiniteOptions, guaranteed to be executed.
|
|
230
231
|
*/
|
|
231
|
-
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
232
|
+
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
232
233
|
/**
|
|
233
234
|
* Options modifier for .infiniteOptions
|
|
234
235
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
235
236
|
*/
|
|
236
|
-
infiniteOptions?: ProcedureUtilsModifier<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, UseInfiniteQueryData<TOutput, unknown> | undefined
|
|
237
|
+
infiniteOptions?: ProcedureUtilsModifier<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, UseInfiniteQueryData<TOutput, unknown> | undefined>> | undefined;
|
|
237
238
|
/**
|
|
238
239
|
* Key options modifier for .mutationKey and .mutationOptions
|
|
239
240
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
240
241
|
*/
|
|
241
|
-
mutationKey?: ProcedureUtilsModifier<MutationKeyOptions<TInput
|
|
242
|
+
mutationKey?: ProcedureUtilsModifier<MutationKeyOptions<TInput>> | undefined;
|
|
242
243
|
/**
|
|
243
244
|
* Interceptors that intercept mutation inside .mutationOptions, guaranteed to be executed.
|
|
244
245
|
*/
|
|
245
|
-
mutationInterceptors?: ProcedureUtilsMutationInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
246
|
+
mutationInterceptors?: ProcedureUtilsMutationInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
246
247
|
/**
|
|
247
248
|
* Options modifier for .mutationOptions
|
|
248
249
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
249
250
|
*/
|
|
250
|
-
mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, Record<any, any
|
|
251
|
+
mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, Record<any, any>>> | undefined;
|
|
251
252
|
}
|
|
252
|
-
declare function isProcedureUtilsOptions(value: unknown): value is ProcedureUtilsOptions<any, any, any, any>;
|
|
253
253
|
/**
|
|
254
254
|
* Merge two procedure utils options where `override` takes priority.
|
|
255
255
|
* A key explicitly set to `undefined` in `override` resets the base value.
|
|
@@ -364,13 +364,6 @@ interface RouterUtilsPlugin<T extends AnyNestedClient> extends OrderablePlugin {
|
|
|
364
364
|
*/
|
|
365
365
|
initProcedureOptions?(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
|
|
366
366
|
}
|
|
367
|
-
declare class CompositeRouterUtilsPlugin<T extends AnyNestedClient> implements RouterUtilsPlugin<T> {
|
|
368
|
-
protected readonly plugins: RouterUtilsPlugin<T>[];
|
|
369
|
-
readonly name = "~composite";
|
|
370
|
-
constructor(plugins?: RouterUtilsPlugin<T>[]);
|
|
371
|
-
init(options: RouterUtilsOptions<T>): RouterUtilsOptions<T>;
|
|
372
|
-
initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
|
|
373
|
-
}
|
|
374
367
|
|
|
375
368
|
/**
|
|
376
369
|
* The utils shape derived from a client: procedure clients map to procedure
|
|
@@ -382,9 +375,9 @@ type RouterUtils<T extends AnyNestedClient> = T extends Client<infer UClientCont
|
|
|
382
375
|
[K in keyof T]: T[K] extends AnyNestedClient ? RouterUtils<T[K]> : never;
|
|
383
376
|
} & Public<SharedUtils<unknown>>;
|
|
384
377
|
type RouterUtilsScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtilsOptions<UClientContext, UInput, UOutput, UError> : {
|
|
385
|
-
[K in keyof T]?: T[K] extends AnyNestedClient ? RouterUtilsScoped<T[K]> : never;
|
|
378
|
+
[K in keyof T]?: (T[K] extends AnyNestedClient ? RouterUtilsScoped<T[K]> : never) | undefined;
|
|
386
379
|
};
|
|
387
|
-
interface RouterUtilsOptions<T extends AnyNestedClient> extends
|
|
380
|
+
interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyBaseOptions {
|
|
388
381
|
/**
|
|
389
382
|
* Base path for all query keys.
|
|
390
383
|
*
|
|
@@ -394,23 +387,23 @@ interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyPref
|
|
|
394
387
|
/**
|
|
395
388
|
* Interceptors that intercept query inside .queryOptions
|
|
396
389
|
*/
|
|
397
|
-
queryInterceptors?: ProcedureUtilsQueryInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
390
|
+
queryInterceptors?: ProcedureUtilsQueryInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
398
391
|
/**
|
|
399
392
|
* Interceptors that intercept query inside .streamedOptions
|
|
400
393
|
*/
|
|
401
|
-
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
394
|
+
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
402
395
|
/**
|
|
403
396
|
* Interceptors that intercept query inside .liveOptions
|
|
404
397
|
*/
|
|
405
|
-
liveInterceptors?: ProcedureUtilsLiveInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
398
|
+
liveInterceptors?: ProcedureUtilsLiveInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
406
399
|
/**
|
|
407
400
|
* Interceptors that intercept query inside .infiniteOptions
|
|
408
401
|
*/
|
|
409
|
-
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
402
|
+
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
410
403
|
/**
|
|
411
404
|
* Interceptors that intercept mutation inside .mutationOptions
|
|
412
405
|
*/
|
|
413
|
-
mutationInterceptors?: ProcedureUtilsMutationInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
406
|
+
mutationInterceptors?: ProcedureUtilsMutationInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
414
407
|
/**
|
|
415
408
|
* Per-procedure options following the shape of the router.
|
|
416
409
|
* Allows fine-grained configuration of individual procedure utils
|
|
@@ -454,15 +447,20 @@ interface ContractJsonifiedUtilsFactory<TClientContext extends ClientContext> {
|
|
|
454
447
|
}
|
|
455
448
|
interface ContractJsonifiedUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>>, 'path'> {
|
|
456
449
|
}
|
|
457
|
-
declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
|
|
458
|
-
|
|
459
450
|
/**
|
|
460
|
-
*
|
|
461
|
-
*
|
|
451
|
+
* Like `createContractUtilsFactory`, but for clients whose types are wrapped in `JsonifiedClient`,
|
|
452
|
+
* such as clients using OpenAPI Link.
|
|
453
|
+
*
|
|
454
|
+
* @remarks
|
|
455
|
+
* Takes a client factory created by `createContractJsonifiedClientFactory` from `@orpc/openapi`.
|
|
456
|
+
*
|
|
457
|
+
* **Note**: The contract must define a `path` meta matching its position in the root router contract.
|
|
458
|
+
*
|
|
459
|
+
* @see {@link https://orpc.dev/docs/contract/client-factory#pinia-colada-integration | Contract Client Factory - Pinia Colada Integration}
|
|
462
460
|
*/
|
|
463
|
-
declare function
|
|
461
|
+
declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractJsonifiedClientFactory<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
|
|
464
462
|
|
|
465
|
-
type PiniaColadaMetaOptions<TClientContext extends ClientContext, TInput, TOutput, TError> = Omit<ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>,
|
|
463
|
+
type PiniaColadaMetaOptions<TClientContext extends ClientContext, TInput, TOutput, TError> = Omit<ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>, keyof OperationKeyBaseOptions>;
|
|
466
464
|
interface PiniaColadaMetaPlugin<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> extends MetaPlugin<TInputSchema, TOutputSchema, TErrorMap> {
|
|
467
465
|
name: '~pinia-colada';
|
|
468
466
|
}
|
|
@@ -499,5 +497,5 @@ declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedCl
|
|
|
499
497
|
initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
|
|
500
498
|
}
|
|
501
499
|
|
|
502
|
-
export {
|
|
503
|
-
export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, PiniaColadaMetaOptions, PiniaColadaMetaPlugin, OperationContext as PiniaColadaOperationContext, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsPlugin, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, UseMutationFnContext, UseQueryFnContext };
|
|
500
|
+
export { ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createORPCVueColadaUtils, createRouterUtils as createPiniaColadaUtils, createRouterUtils, getPiniaColadaMeta, mergeProcedureUtilsOptions, piniaColada };
|
|
501
|
+
export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyBaseOptions, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, PiniaColadaMetaOptions, PiniaColadaMetaPlugin, OperationContext as PiniaColadaOperationContext, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsPlugin, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, UseMutationFnContext, UseQueryFnContext };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
import { ClientContext, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
|
|
1
|
+
import { ClientContext, RPCJsonSerializer, Client, AnyNestedClient, InferClientContext, InferClientError } from '@orpc/client';
|
|
2
|
+
export { AnyNestedClient } from '@orpc/client';
|
|
2
3
|
import { RouterContract, RouterContractClient, ContractClientFactory, AnySchema, ErrorMap, MetaPlugin, Meta, InferSchemaInput, InferSchemaOutput, ORPCErrorFromErrorMap } from '@orpc/contract';
|
|
3
|
-
import { JsonifiedClient } from '@orpc/openapi';
|
|
4
|
-
import {
|
|
5
|
-
|
|
4
|
+
import { JsonifiedClient, ContractJsonifiedClientFactory } from '@orpc/openapi';
|
|
5
|
+
import { Public, PartialDeep, Interceptor, PromiseWithError, MaybeOptionalOptions, OrderablePlugin, ThrowableError } from '@orpc/shared';
|
|
6
|
+
export { Public } from '@orpc/shared';
|
|
7
|
+
import { EntryKey, UseQueryOptions, DefineQueryOptions, UseInfiniteQueryData, DefineInfiniteQueryOptions, UseMutationOptions, UseMutationOptionsGlobal, DefineQueryOptionsTagged, DefineInfiniteQueryOptionsTagged, DefineMutationOptionsTagged, UseInfiniteQueryFnContext, EntryKeyTagged, _EmptyObject } from '@pinia/colada';
|
|
6
8
|
|
|
7
9
|
type InferStreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
|
|
8
10
|
type InferLiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
|
|
@@ -44,7 +46,7 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
|
|
|
44
46
|
} : {
|
|
45
47
|
input: TInput;
|
|
46
48
|
}) & (object extends TClientContext ? {
|
|
47
|
-
context?: TClientContext;
|
|
49
|
+
context?: TClientContext | undefined;
|
|
48
50
|
} : {
|
|
49
51
|
context: TClientContext;
|
|
50
52
|
}) & Omit<DefineQueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'> & Partial<Pick<DefineQueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'>>;
|
|
@@ -54,12 +56,12 @@ type StreamedKeyOptions<TInput> = ((undefined extends TInput ? {
|
|
|
54
56
|
} : {
|
|
55
57
|
input: TInput;
|
|
56
58
|
}) & {
|
|
57
|
-
fnOptions?: SerializableStreamedQueryOptions;
|
|
59
|
+
fnOptions?: SerializableStreamedQueryOptions | undefined;
|
|
58
60
|
}) | {
|
|
59
61
|
key: EntryKey;
|
|
60
62
|
};
|
|
61
63
|
type StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TInitialData extends TOutput | undefined> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TInitialData> & {
|
|
62
|
-
fnOptions?: SerializableStreamedQueryOptions;
|
|
64
|
+
fnOptions?: SerializableStreamedQueryOptions | undefined;
|
|
63
65
|
};
|
|
64
66
|
type StreamedOptionsOut<TOutput, TError, TInitialData extends TOutput | undefined> = QueryOptionsOut<TOutput, TError, TInitialData>;
|
|
65
67
|
type InfiniteKeyOptions<TInput, TPageParam> = Pick<InfiniteOptionsIn<any, TInput, any, any, TPageParam, any>, 'input' | 'initialPageParam'> | {
|
|
@@ -68,14 +70,14 @@ type InfiniteKeyOptions<TInput, TPageParam> = Pick<InfiniteOptionsIn<any, TInput
|
|
|
68
70
|
type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TPageParam, TInitialData extends UseInfiniteQueryData<TOutput, TPageParam> | undefined> = {
|
|
69
71
|
input: (pageParam: TPageParam) => TInput;
|
|
70
72
|
} & (object extends TClientContext ? {
|
|
71
|
-
context?: TClientContext;
|
|
73
|
+
context?: TClientContext | undefined;
|
|
72
74
|
} : {
|
|
73
75
|
context: TClientContext;
|
|
74
76
|
}) & Omit<DefineInfiniteQueryOptions<TOutput, TError, TPageParam, TInitialData>, 'key' | 'query'> & Partial<Pick<DefineInfiniteQueryOptions<TOutput, TError, TPageParam, TInitialData>, 'key' | 'query'>>;
|
|
75
77
|
type InfiniteOptionsOut<TOutput, TError, TPageParam, TInitialData extends UseInfiniteQueryData<TOutput, TPageParam> | undefined> = DefineInfiniteQueryOptionsTagged<TOutput, TError, TPageParam, TInitialData>;
|
|
76
78
|
type MutationKeyOptions<TInput> = Pick<MutationOptionsIn<any, TInput, any, any, any>, 'key'>;
|
|
77
79
|
type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext extends Record<any, any>> = (object extends TClientContext ? {
|
|
78
|
-
context?: TClientContext;
|
|
80
|
+
context?: TClientContext | undefined;
|
|
79
81
|
} : {
|
|
80
82
|
context: TClientContext;
|
|
81
83
|
}) & Omit<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'> & Partial<Pick<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'>>;
|
|
@@ -91,58 +93,57 @@ interface SerializableStreamedQueryOptions {
|
|
|
91
93
|
*
|
|
92
94
|
* @default 'reset'
|
|
93
95
|
*/
|
|
94
|
-
refetchMode?: 'append' | 'reset' | 'replace';
|
|
96
|
+
refetchMode?: 'append' | 'reset' | 'replace' | undefined;
|
|
95
97
|
/**
|
|
96
98
|
* Limits the number of data chunks stored in the query result.
|
|
97
99
|
* Older chunks are removed when the limit is reached.
|
|
98
100
|
*
|
|
99
101
|
* @default Number.POSITIVE_INFINITY (unlimited)
|
|
100
102
|
*/
|
|
101
|
-
maxChunks?: number;
|
|
103
|
+
maxChunks?: number | undefined;
|
|
102
104
|
}
|
|
103
|
-
/**
|
|
104
|
-
* A Pinia Colada query function that accumulates streamed chunks into an array,
|
|
105
|
-
* publishing each chunk to the cache entry as it arrives.
|
|
106
|
-
*
|
|
107
|
-
* Inspired by [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery) where:
|
|
108
|
-
* - Options are serializable
|
|
109
|
-
* - The output is predictable
|
|
110
|
-
*/
|
|
111
|
-
declare function serializableStreamedQuery<T>(queryFn: (context: UseQueryFnContext) => Promisable<AsyncIterable<T>>, { refetchMode, maxChunks }?: SerializableStreamedQueryOptions): (context: UseQueryFnContext) => Promise<T[]>;
|
|
112
105
|
|
|
113
106
|
interface OperationKeyPrefixOptions {
|
|
114
107
|
/**
|
|
115
108
|
* Prepended as the first element of the key when present.
|
|
116
109
|
* Use this to avoid key conflicts when multiple router utils share the same client.
|
|
117
110
|
*/
|
|
118
|
-
prefix?: string;
|
|
111
|
+
prefix?: string | undefined;
|
|
112
|
+
}
|
|
113
|
+
interface OperationKeyBaseOptions extends OperationKeyPrefixOptions {
|
|
114
|
+
/**
|
|
115
|
+
* Serializes inputs into JSON-compatible values when building keys.
|
|
116
|
+
* Pass the serializer your link uses so custom types produce consistent keys.
|
|
117
|
+
*
|
|
118
|
+
* @default new RPCJsonSerializer()
|
|
119
|
+
*/
|
|
120
|
+
serializer?: Public<RPCJsonSerializer> | undefined;
|
|
119
121
|
}
|
|
120
|
-
type OperationKeyOptions<TType extends OperationType, TInput> =
|
|
121
|
-
type?: TType;
|
|
122
|
-
input?: PartialDeep<TInput
|
|
123
|
-
fnOptions?: TType extends 'streamed' ? SerializableStreamedQueryOptions : never;
|
|
122
|
+
type OperationKeyOptions<TType extends OperationType, TInput> = OperationKeyBaseOptions & {
|
|
123
|
+
type?: TType | undefined;
|
|
124
|
+
input?: PartialDeep<TInput> | undefined;
|
|
125
|
+
fnOptions?: (TType extends 'streamed' ? SerializableStreamedQueryOptions : never) | undefined;
|
|
124
126
|
};
|
|
125
|
-
type
|
|
126
|
-
/**
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
declare function generateOperationKey<TType extends OperationType, TInput>(path: string[], options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
|
|
127
|
+
type OperationKeyContent<TType extends OperationType, TInput> = Omit<OperationKeyOptions<TType, TInput>, keyof OperationKeyBaseOptions> & {
|
|
128
|
+
/**
|
|
129
|
+
* Serializer types of non-JSON values in `input`, keyed by their JSON-encoded path,
|
|
130
|
+
* so inputs with the same JSON form (like a `Date` and its ISO string) produce different keys.
|
|
131
|
+
* Keyed by path (not a list) so partial keys still match.
|
|
132
|
+
*/
|
|
133
|
+
inputMeta?: Record<string, string[]> | undefined;
|
|
134
|
+
};
|
|
135
|
+
type OperationKey<TType extends OperationType, TInput> = EntryKey & ([path: string[], options: OperationKeyContent<TType, TInput>] | [prefix: string, path: string[], options: OperationKeyContent<TType, TInput>]);
|
|
135
136
|
|
|
136
137
|
declare class SharedUtils<TInput> {
|
|
137
138
|
protected readonly path: string[];
|
|
138
|
-
protected readonly options:
|
|
139
|
-
constructor(path: string[], options:
|
|
139
|
+
protected readonly options: OperationKeyBaseOptions;
|
|
140
|
+
constructor(path: string[], options: OperationKeyBaseOptions);
|
|
140
141
|
/**
|
|
141
142
|
* Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
|
|
142
143
|
*
|
|
143
144
|
* @see {@link https://orpc.dev/docs/integrations/pinia-colada#querymutation-key | Pinia Colada Integration - Query/Mutation Key}
|
|
144
145
|
*/
|
|
145
|
-
key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>,
|
|
146
|
+
key<TType extends OperationType>(options?: Omit<OperationKeyOptions<TType, TInput>, keyof OperationKeyBaseOptions>): OperationKey<TType, TInput>;
|
|
146
147
|
}
|
|
147
148
|
|
|
148
149
|
interface ProcedureUtilsQueryInterceptorOptions<TClientContext extends ClientContext, TInput> {
|
|
@@ -177,79 +178,78 @@ type ProcedureUtilsMutationInterceptor<TClientContext extends ClientContext, TIn
|
|
|
177
178
|
* or a function that receives per-call options and returns overridden this.options.
|
|
178
179
|
*/
|
|
179
180
|
type ProcedureUtilsModifier<T extends object> = Partial<T> | ((options: T) => T);
|
|
180
|
-
interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> extends
|
|
181
|
+
interface ProcedureUtilsOptions<TClientContext extends ClientContext, TInput, TOutput, TError> extends OperationKeyBaseOptions {
|
|
181
182
|
/**
|
|
182
183
|
* Key options modifier for .queryKey and .queryOptions
|
|
183
184
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
184
185
|
*/
|
|
185
|
-
queryKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput
|
|
186
|
+
queryKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput>> | undefined;
|
|
186
187
|
/**
|
|
187
188
|
* Interceptors that intercept query inside .queryOptions, guaranteed to be executed.
|
|
188
189
|
*/
|
|
189
|
-
queryInterceptors?: ProcedureUtilsQueryInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
190
|
+
queryInterceptors?: ProcedureUtilsQueryInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
190
191
|
/**
|
|
191
192
|
* Options modifier for .queryOptions
|
|
192
193
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
193
194
|
*/
|
|
194
|
-
queryOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, TOutput, TError, TOutput | undefined
|
|
195
|
+
queryOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, TOutput, TError, TOutput | undefined>> | undefined;
|
|
195
196
|
/**
|
|
196
197
|
* Key options modifier for .streamedKey and .streamedOptions
|
|
197
198
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
198
199
|
*/
|
|
199
|
-
streamedKey?: ProcedureUtilsModifier<StreamedKeyOptions<TInput
|
|
200
|
+
streamedKey?: ProcedureUtilsModifier<StreamedKeyOptions<TInput>> | undefined;
|
|
200
201
|
/**
|
|
201
202
|
* Interceptors that intercept query inside .streamedOptions, guaranteed to be executed.
|
|
202
203
|
*/
|
|
203
|
-
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
204
|
+
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
204
205
|
/**
|
|
205
206
|
* Options modifier for .streamedOptions
|
|
206
207
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
207
208
|
*/
|
|
208
|
-
streamedOptions?: ProcedureUtilsModifier<StreamedOptionsIn<TClientContext, TInput, InferStreamedQueryOutput<TOutput>, TError, InferStreamedQueryOutput<TOutput> | undefined
|
|
209
|
+
streamedOptions?: ProcedureUtilsModifier<StreamedOptionsIn<TClientContext, TInput, InferStreamedQueryOutput<TOutput>, TError, InferStreamedQueryOutput<TOutput> | undefined>> | undefined;
|
|
209
210
|
/**
|
|
210
211
|
* Key options modifier for .liveKey and .liveOptions
|
|
211
212
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
212
213
|
*/
|
|
213
|
-
liveKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput
|
|
214
|
+
liveKey?: ProcedureUtilsModifier<QueryKeyOptions<TInput>> | undefined;
|
|
214
215
|
/**
|
|
215
216
|
* Interceptors that intercept query inside .liveOptions, guaranteed to be executed.
|
|
216
217
|
*/
|
|
217
|
-
liveInterceptors?: ProcedureUtilsLiveInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
218
|
+
liveInterceptors?: ProcedureUtilsLiveInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
218
219
|
/**
|
|
219
220
|
* Options modifier for .liveOptions
|
|
220
221
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
221
222
|
*/
|
|
222
|
-
liveOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, InferLiveQueryOutput<TOutput>, TError, InferLiveQueryOutput<TOutput> | undefined
|
|
223
|
+
liveOptions?: ProcedureUtilsModifier<QueryOptionsIn<TClientContext, TInput, InferLiveQueryOutput<TOutput>, TError, InferLiveQueryOutput<TOutput> | undefined>> | undefined;
|
|
223
224
|
/**
|
|
224
225
|
* Key options modifier for .infiniteKey and .infiniteOptions
|
|
225
226
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
226
227
|
*/
|
|
227
|
-
infiniteKey?: ProcedureUtilsModifier<InfiniteKeyOptions<TInput, unknown
|
|
228
|
+
infiniteKey?: ProcedureUtilsModifier<InfiniteKeyOptions<TInput, unknown>> | undefined;
|
|
228
229
|
/**
|
|
229
230
|
* Interceptors that intercept query inside .infiniteOptions, guaranteed to be executed.
|
|
230
231
|
*/
|
|
231
|
-
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
232
|
+
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
232
233
|
/**
|
|
233
234
|
* Options modifier for .infiniteOptions
|
|
234
235
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
235
236
|
*/
|
|
236
|
-
infiniteOptions?: ProcedureUtilsModifier<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, UseInfiniteQueryData<TOutput, unknown> | undefined
|
|
237
|
+
infiniteOptions?: ProcedureUtilsModifier<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, UseInfiniteQueryData<TOutput, unknown> | undefined>> | undefined;
|
|
237
238
|
/**
|
|
238
239
|
* Key options modifier for .mutationKey and .mutationOptions
|
|
239
240
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
240
241
|
*/
|
|
241
|
-
mutationKey?: ProcedureUtilsModifier<MutationKeyOptions<TInput
|
|
242
|
+
mutationKey?: ProcedureUtilsModifier<MutationKeyOptions<TInput>> | undefined;
|
|
242
243
|
/**
|
|
243
244
|
* Interceptors that intercept mutation inside .mutationOptions, guaranteed to be executed.
|
|
244
245
|
*/
|
|
245
|
-
mutationInterceptors?: ProcedureUtilsMutationInterceptor<TClientContext, TInput, TOutput, TError>[];
|
|
246
|
+
mutationInterceptors?: ProcedureUtilsMutationInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
|
|
246
247
|
/**
|
|
247
248
|
* Options modifier for .mutationOptions
|
|
248
249
|
* Can be partial options or a function that receives per-call options and returns override this.options.
|
|
249
250
|
*/
|
|
250
|
-
mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, Record<any, any
|
|
251
|
+
mutationOptions?: ProcedureUtilsModifier<MutationOptionsIn<TClientContext, TInput, TOutput, TError, Record<any, any>>> | undefined;
|
|
251
252
|
}
|
|
252
|
-
declare function isProcedureUtilsOptions(value: unknown): value is ProcedureUtilsOptions<any, any, any, any>;
|
|
253
253
|
/**
|
|
254
254
|
* Merge two procedure utils options where `override` takes priority.
|
|
255
255
|
* A key explicitly set to `undefined` in `override` resets the base value.
|
|
@@ -364,13 +364,6 @@ interface RouterUtilsPlugin<T extends AnyNestedClient> extends OrderablePlugin {
|
|
|
364
364
|
*/
|
|
365
365
|
initProcedureOptions?(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
|
|
366
366
|
}
|
|
367
|
-
declare class CompositeRouterUtilsPlugin<T extends AnyNestedClient> implements RouterUtilsPlugin<T> {
|
|
368
|
-
protected readonly plugins: RouterUtilsPlugin<T>[];
|
|
369
|
-
readonly name = "~composite";
|
|
370
|
-
constructor(plugins?: RouterUtilsPlugin<T>[]);
|
|
371
|
-
init(options: RouterUtilsOptions<T>): RouterUtilsOptions<T>;
|
|
372
|
-
initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
|
|
373
|
-
}
|
|
374
367
|
|
|
375
368
|
/**
|
|
376
369
|
* The utils shape derived from a client: procedure clients map to procedure
|
|
@@ -382,9 +375,9 @@ type RouterUtils<T extends AnyNestedClient> = T extends Client<infer UClientCont
|
|
|
382
375
|
[K in keyof T]: T[K] extends AnyNestedClient ? RouterUtils<T[K]> : never;
|
|
383
376
|
} & Public<SharedUtils<unknown>>;
|
|
384
377
|
type RouterUtilsScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtilsOptions<UClientContext, UInput, UOutput, UError> : {
|
|
385
|
-
[K in keyof T]?: T[K] extends AnyNestedClient ? RouterUtilsScoped<T[K]> : never;
|
|
378
|
+
[K in keyof T]?: (T[K] extends AnyNestedClient ? RouterUtilsScoped<T[K]> : never) | undefined;
|
|
386
379
|
};
|
|
387
|
-
interface RouterUtilsOptions<T extends AnyNestedClient> extends
|
|
380
|
+
interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyBaseOptions {
|
|
388
381
|
/**
|
|
389
382
|
* Base path for all query keys.
|
|
390
383
|
*
|
|
@@ -394,23 +387,23 @@ interface RouterUtilsOptions<T extends AnyNestedClient> extends OperationKeyPref
|
|
|
394
387
|
/**
|
|
395
388
|
* Interceptors that intercept query inside .queryOptions
|
|
396
389
|
*/
|
|
397
|
-
queryInterceptors?: ProcedureUtilsQueryInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
390
|
+
queryInterceptors?: ProcedureUtilsQueryInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
398
391
|
/**
|
|
399
392
|
* Interceptors that intercept query inside .streamedOptions
|
|
400
393
|
*/
|
|
401
|
-
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
394
|
+
streamedInterceptors?: ProcedureUtilsStreamedInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
402
395
|
/**
|
|
403
396
|
* Interceptors that intercept query inside .liveOptions
|
|
404
397
|
*/
|
|
405
|
-
liveInterceptors?: ProcedureUtilsLiveInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
398
|
+
liveInterceptors?: ProcedureUtilsLiveInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
406
399
|
/**
|
|
407
400
|
* Interceptors that intercept query inside .infiniteOptions
|
|
408
401
|
*/
|
|
409
|
-
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
402
|
+
infiniteInterceptors?: ProcedureUtilsInfiniteInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
410
403
|
/**
|
|
411
404
|
* Interceptors that intercept mutation inside .mutationOptions
|
|
412
405
|
*/
|
|
413
|
-
mutationInterceptors?: ProcedureUtilsMutationInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
|
|
406
|
+
mutationInterceptors?: ProcedureUtilsMutationInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
|
|
414
407
|
/**
|
|
415
408
|
* Per-procedure options following the shape of the router.
|
|
416
409
|
* Allows fine-grained configuration of individual procedure utils
|
|
@@ -454,15 +447,20 @@ interface ContractJsonifiedUtilsFactory<TClientContext extends ClientContext> {
|
|
|
454
447
|
}
|
|
455
448
|
interface ContractJsonifiedUtilsFactoryOptions<TClientContext extends ClientContext> extends Omit<RouterUtilsOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>>, 'path'> {
|
|
456
449
|
}
|
|
457
|
-
declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractClientFactory<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
|
|
458
|
-
|
|
459
450
|
/**
|
|
460
|
-
*
|
|
461
|
-
*
|
|
451
|
+
* Like `createContractUtilsFactory`, but for clients whose types are wrapped in `JsonifiedClient`,
|
|
452
|
+
* such as clients using OpenAPI Link.
|
|
453
|
+
*
|
|
454
|
+
* @remarks
|
|
455
|
+
* Takes a client factory created by `createContractJsonifiedClientFactory` from `@orpc/openapi`.
|
|
456
|
+
*
|
|
457
|
+
* **Note**: The contract must define a `path` meta matching its position in the root router contract.
|
|
458
|
+
*
|
|
459
|
+
* @see {@link https://orpc.dev/docs/contract/client-factory#pinia-colada-integration | Contract Client Factory - Pinia Colada Integration}
|
|
462
460
|
*/
|
|
463
|
-
declare function
|
|
461
|
+
declare function createContractJsonifiedUtilsFactory<TClientContext extends ClientContext>(clientFactory: ContractJsonifiedClientFactory<TClientContext>, options: ContractJsonifiedUtilsFactoryOptions<TClientContext>): ContractJsonifiedUtilsFactory<TClientContext>;
|
|
464
462
|
|
|
465
|
-
type PiniaColadaMetaOptions<TClientContext extends ClientContext, TInput, TOutput, TError> = Omit<ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>,
|
|
463
|
+
type PiniaColadaMetaOptions<TClientContext extends ClientContext, TInput, TOutput, TError> = Omit<ProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>, keyof OperationKeyBaseOptions>;
|
|
466
464
|
interface PiniaColadaMetaPlugin<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> extends MetaPlugin<TInputSchema, TOutputSchema, TErrorMap> {
|
|
467
465
|
name: '~pinia-colada';
|
|
468
466
|
}
|
|
@@ -499,5 +497,5 @@ declare class ContractOptionsUtilsPlugin<T extends AnyNestedClient = AnyNestedCl
|
|
|
499
497
|
initProcedureOptions(path: string[], options: ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>): ProcedureUtilsOptions<InferClientContext<T>, any, any, InferClientError<T>>;
|
|
500
498
|
}
|
|
501
499
|
|
|
502
|
-
export {
|
|
503
|
-
export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, PiniaColadaMetaOptions, PiniaColadaMetaPlugin, OperationContext as PiniaColadaOperationContext, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsPlugin, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, UseMutationFnContext, UseQueryFnContext };
|
|
500
|
+
export { ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createORPCVueColadaUtils, createRouterUtils as createPiniaColadaUtils, createRouterUtils, getPiniaColadaMeta, mergeProcedureUtilsOptions, piniaColada };
|
|
501
|
+
export type { ContractJsonifiedUtilsFactory, ContractJsonifiedUtilsFactoryOptions, ContractUtilsFactory, ContractUtilsFactoryOptions, InferLiveQueryOutput, InferStreamedQueryOutput, InfiniteKeyOptions, InfiniteOptionsIn, InfiniteOptionsOut, MutationKeyOptions, MutationOptionsIn, MutationOptionsOut, OperationContext, OperationKey, OperationKeyBaseOptions, OperationKeyOptions, OperationKeyPrefixOptions, OperationType, PiniaColadaMetaOptions, PiniaColadaMetaPlugin, OperationContext as PiniaColadaOperationContext, ProcedureUtilsInfiniteInterceptor, ProcedureUtilsInfiniteInterceptorOptions, ProcedureUtilsLiveInterceptor, ProcedureUtilsLiveInterceptorOptions, ProcedureUtilsModifier, ProcedureUtilsMutationInterceptor, ProcedureUtilsMutationInterceptorOptions, ProcedureUtilsOptions, ProcedureUtilsQueryInterceptor, ProcedureUtilsQueryInterceptorOptions, ProcedureUtilsStreamedInterceptor, ProcedureUtilsStreamedInterceptorOptions, QueryKeyOptions, QueryOptionsIn, QueryOptionsOut, RouterUtils, RouterUtilsOptions, RouterUtilsPlugin, RouterUtilsScoped, SerializableStreamedQueryOptions, StreamedKeyOptions, StreamedOptionsIn, StreamedOptionsOut, UseMutationFnContext, UseQueryFnContext };
|
package/dist/index.mjs
CHANGED
|
@@ -26,19 +26,6 @@ class CompositeRouterUtilsPlugin {
|
|
|
26
26
|
}
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
const serializer = new RPCJsonSerializer();
|
|
30
|
-
function generateOperationKey(path, options = {}) {
|
|
31
|
-
return [
|
|
32
|
-
...options.prefix !== void 0 ? [options.prefix] : [],
|
|
33
|
-
path,
|
|
34
|
-
{
|
|
35
|
-
...options.input !== void 0 ? { input: serializer.serialize(options.input).json } : {},
|
|
36
|
-
...options.type !== void 0 ? { type: options.type } : {},
|
|
37
|
-
...options.fnOptions !== void 0 ? { fnOptions: options.fnOptions } : {}
|
|
38
|
-
}
|
|
39
|
-
];
|
|
40
|
-
}
|
|
41
|
-
|
|
42
29
|
function liveQuery(queryFn) {
|
|
43
30
|
return async (context) => {
|
|
44
31
|
const { entry, signal } = context;
|
|
@@ -60,6 +47,30 @@ function liveQuery(queryFn) {
|
|
|
60
47
|
};
|
|
61
48
|
}
|
|
62
49
|
|
|
50
|
+
const defaultSerializer = new RPCJsonSerializer();
|
|
51
|
+
function generateOperationKey(path, options = {}) {
|
|
52
|
+
return [
|
|
53
|
+
...options.prefix !== void 0 ? [options.prefix] : [],
|
|
54
|
+
path,
|
|
55
|
+
{
|
|
56
|
+
...options.input !== void 0 ? serializeInput(options.serializer ?? defaultSerializer, options.input) : {},
|
|
57
|
+
...options.type !== void 0 ? { type: options.type } : {},
|
|
58
|
+
...options.fnOptions !== void 0 ? { fnOptions: options.fnOptions } : {}
|
|
59
|
+
}
|
|
60
|
+
];
|
|
61
|
+
}
|
|
62
|
+
function serializeInput(serializer, input) {
|
|
63
|
+
const { json, meta } = serializer.serializeJson(input);
|
|
64
|
+
if (!meta?.length) {
|
|
65
|
+
return { input: json };
|
|
66
|
+
}
|
|
67
|
+
const inputMeta = {};
|
|
68
|
+
for (const [type, ...segments] of meta) {
|
|
69
|
+
(inputMeta[stringifyJSON(segments)] ??= []).push(type);
|
|
70
|
+
}
|
|
71
|
+
return { input: json, inputMeta };
|
|
72
|
+
}
|
|
73
|
+
|
|
63
74
|
class SharedUtils {
|
|
64
75
|
constructor(path, options) {
|
|
65
76
|
this.path = path;
|
|
@@ -71,7 +82,7 @@ class SharedUtils {
|
|
|
71
82
|
* @see {@link https://orpc.dev/docs/integrations/pinia-colada#querymutation-key | Pinia Colada Integration - Query/Mutation Key}
|
|
72
83
|
*/
|
|
73
84
|
key(options = {}) {
|
|
74
|
-
return generateOperationKey(this.path, { ...options, prefix: this.options.prefix });
|
|
85
|
+
return generateOperationKey(this.path, { ...options, prefix: this.options.prefix, serializer: this.options.serializer });
|
|
75
86
|
}
|
|
76
87
|
}
|
|
77
88
|
|
|
@@ -141,6 +152,10 @@ function isProcedureUtilsOptions(value) {
|
|
|
141
152
|
if (typeof value[key] !== "string") {
|
|
142
153
|
return false;
|
|
143
154
|
}
|
|
155
|
+
} else if (key === "serializer") {
|
|
156
|
+
if (!isTypescriptObject(value[key]) || typeof value[key].serializeJson !== "function") {
|
|
157
|
+
return false;
|
|
158
|
+
}
|
|
144
159
|
} else if (PROCEDURE_UTILS_INTERCEPTOR_KEYS.includes(key)) {
|
|
145
160
|
if (!Array.isArray(value[key]) || value[key].some((i) => typeof i !== "function")) {
|
|
146
161
|
return false;
|
|
@@ -204,7 +219,7 @@ class ProcedureUtils extends SharedUtils {
|
|
|
204
219
|
} else if (this.options.queryKey) {
|
|
205
220
|
optionsIn = { ...this.options.queryKey, ...optionsIn };
|
|
206
221
|
}
|
|
207
|
-
const key = optionsIn.key ??
|
|
222
|
+
const key = optionsIn.key ?? this.key({ type: "query", input: optionsIn.input });
|
|
208
223
|
return key;
|
|
209
224
|
}
|
|
210
225
|
/**
|
|
@@ -261,7 +276,7 @@ class ProcedureUtils extends SharedUtils {
|
|
|
261
276
|
} else if (this.options.streamedKey) {
|
|
262
277
|
optionsIn = { ...this.options.streamedKey, ...optionsIn };
|
|
263
278
|
}
|
|
264
|
-
const key = optionsIn.key ??
|
|
279
|
+
const key = optionsIn.key ?? this.key({ type: "streamed", input: optionsIn.input, fnOptions: optionsIn.fnOptions });
|
|
265
280
|
return key;
|
|
266
281
|
}
|
|
267
282
|
/**
|
|
@@ -327,7 +342,7 @@ class ProcedureUtils extends SharedUtils {
|
|
|
327
342
|
} else if (this.options.liveKey) {
|
|
328
343
|
optionsIn = { ...this.options.liveKey, ...optionsIn };
|
|
329
344
|
}
|
|
330
|
-
const key = optionsIn.key ??
|
|
345
|
+
const key = optionsIn.key ?? this.key({ type: "live", input: optionsIn.input });
|
|
331
346
|
return key;
|
|
332
347
|
}
|
|
333
348
|
/**
|
|
@@ -389,8 +404,7 @@ class ProcedureUtils extends SharedUtils {
|
|
|
389
404
|
} else if (this.options.infiniteKey) {
|
|
390
405
|
optionsIn = { ...this.options.infiniteKey, ...optionsIn };
|
|
391
406
|
}
|
|
392
|
-
const key = optionsIn.key ??
|
|
393
|
-
prefix: this.options.prefix,
|
|
407
|
+
const key = optionsIn.key ?? this.key({
|
|
394
408
|
type: "infinite",
|
|
395
409
|
input: optionsIn.input(
|
|
396
410
|
typeof optionsIn.initialPageParam === "function" ? optionsIn.initialPageParam() : optionsIn.initialPageParam
|
|
@@ -451,7 +465,7 @@ class ProcedureUtils extends SharedUtils {
|
|
|
451
465
|
} else if (this.options.mutationKey) {
|
|
452
466
|
optionsIn = { ...this.options.mutationKey, ...optionsIn };
|
|
453
467
|
}
|
|
454
|
-
const key = optionsIn.key ?? ((input) =>
|
|
468
|
+
const key = optionsIn.key ?? ((input) => this.key({ type: "mutation", input }));
|
|
455
469
|
return key;
|
|
456
470
|
}
|
|
457
471
|
/**
|
|
@@ -511,6 +525,7 @@ function createRouterUtilsInternal(client, options, plugin) {
|
|
|
511
525
|
plugin.initProcedureOptions(path, mergeProcedureUtilsOptions(
|
|
512
526
|
pick(options, [
|
|
513
527
|
"prefix",
|
|
528
|
+
"serializer",
|
|
514
529
|
"queryInterceptors",
|
|
515
530
|
"streamedInterceptors",
|
|
516
531
|
"liveInterceptors",
|
|
@@ -524,8 +539,11 @@ function createRouterUtilsInternal(client, options, plugin) {
|
|
|
524
539
|
const recursive = new Proxy(utils, {
|
|
525
540
|
get(target, prop) {
|
|
526
541
|
const value = Reflect.get(target, prop);
|
|
542
|
+
if (RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop)) {
|
|
543
|
+
return value ?? Reflect.get(Object.prototype, prop);
|
|
544
|
+
}
|
|
527
545
|
const nextClient = Reflect.get(client, prop);
|
|
528
|
-
if (typeof prop !== "string" ||
|
|
546
|
+
if (typeof prop !== "string" || !isTypescriptObject(nextClient)) {
|
|
529
547
|
return value;
|
|
530
548
|
}
|
|
531
549
|
let result = cache.get(prop);
|
|
@@ -601,4 +619,4 @@ class ContractOptionsUtilsPlugin {
|
|
|
601
619
|
}
|
|
602
620
|
}
|
|
603
621
|
|
|
604
|
-
export {
|
|
622
|
+
export { ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as PINIA_COLADA_OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils as createORPCVueColadaUtils, createRouterUtils as createPiniaColadaUtils, createRouterUtils, getPiniaColadaMeta, mergeProcedureUtilsOptions, piniaColada };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/pinia-colada",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.0.0-beta.
|
|
4
|
+
"version": "2.0.0-beta.46",
|
|
5
5
|
"description": "Pinia Colada integration for oRPC: typesafe queries and mutations for Vue",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"funding": [
|
|
@@ -41,17 +41,17 @@
|
|
|
41
41
|
"vue": ">=3.5.17"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@orpc/client": "2.0.0-beta.
|
|
45
|
-
"@orpc/contract": "2.0.0-beta.
|
|
46
|
-
"@orpc/openapi": "2.0.0-beta.
|
|
47
|
-
"@orpc/shared": "2.0.0-beta.
|
|
44
|
+
"@orpc/client": "2.0.0-beta.46",
|
|
45
|
+
"@orpc/contract": "2.0.0-beta.46",
|
|
46
|
+
"@orpc/openapi": "2.0.0-beta.46",
|
|
47
|
+
"@orpc/shared": "2.0.0-beta.46"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@pinia/colada": "^1.4.8",
|
|
51
51
|
"@vue/test-utils": "^2.5.1",
|
|
52
|
-
"pinia": "^4.0
|
|
53
|
-
"vue": "^3.5.
|
|
54
|
-
"zod": "^4.6.
|
|
52
|
+
"pinia": "^4.1.0",
|
|
53
|
+
"vue": "^3.5.44",
|
|
54
|
+
"zod": "^4.6.7"
|
|
55
55
|
},
|
|
56
56
|
"scripts": {
|
|
57
57
|
"type:check": "tsc -b"
|