@orpc/tanstack-query 0.0.0-next.b12bcdb → 0.0.0-next.b2d00a3
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 +5 -2
- package/dist/index.d.mts +130 -32
- package/dist/index.d.ts +130 -32
- package/dist/index.mjs +83 -10
- package/package.json +14 -14
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
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>
|
|
@@ -17,6 +17,9 @@
|
|
|
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/unnoq/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>
|
|
@@ -42,7 +45,7 @@
|
|
|
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
|
|
package/dist/index.d.mts
CHANGED
|
@@ -1,15 +1,40 @@
|
|
|
1
1
|
import { ClientContext, Client, NestedClient } from '@orpc/client';
|
|
2
|
-
import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
-
import {
|
|
2
|
+
import { Promisable, SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
+
import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, InfiniteQueryObserverOptions, MutationObserverOptions, DataTag, InfiniteData } from '@tanstack/query-core';
|
|
4
|
+
|
|
5
|
+
interface experimental_SerializableStreamedQueryOptions {
|
|
6
|
+
/**
|
|
7
|
+
* Determines how data is handled when the query is refetched.
|
|
8
|
+
*
|
|
9
|
+
* - `'reset'`: Clears existing data and sets the query back to a pending state.
|
|
10
|
+
* - `'append'`: Appends new data chunks to the existing data.
|
|
11
|
+
* - `'replace'`: Collects all streamed data and replaces the cache once the stream finishes.
|
|
12
|
+
*
|
|
13
|
+
* @default 'reset'
|
|
14
|
+
*/
|
|
15
|
+
refetchMode?: 'append' | 'reset' | 'replace';
|
|
16
|
+
/**
|
|
17
|
+
* Limits the number of data chunks stored in the query result.
|
|
18
|
+
* Older chunks are removed when the limit is reached.
|
|
19
|
+
*
|
|
20
|
+
* @default Number.POSITIVE_INFINITY (unlimited)
|
|
21
|
+
*/
|
|
22
|
+
maxChunks?: number;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* A variant of `streamedQuery` where:
|
|
26
|
+
* - Options are serializable
|
|
27
|
+
* - The output is predictable
|
|
28
|
+
*/
|
|
29
|
+
declare function experimental_serializableStreamedQuery<TQueryFnData = unknown, TQueryKey extends QueryKey = QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => Promisable<AsyncIterable<TQueryFnData>>, { refetchMode, maxChunks }?: experimental_SerializableStreamedQueryOptions): QueryFunction<Array<TQueryFnData>, TQueryKey>;
|
|
4
30
|
|
|
5
31
|
type experimental_StreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
|
|
6
32
|
type experimental_LiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
|
|
7
|
-
type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
|
|
8
33
|
type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
|
|
9
34
|
type OperationKeyOptions<TType extends OperationType, TInput> = {
|
|
10
35
|
type?: TType;
|
|
11
36
|
input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
|
|
12
|
-
fnOptions?: TType extends 'streamed' ?
|
|
37
|
+
fnOptions?: TType extends 'streamed' ? experimental_SerializableStreamedQueryOptions : never;
|
|
13
38
|
};
|
|
14
39
|
type OperationKey<TType extends OperationType, TInput> = [path: readonly string[], options: OperationKeyOptions<TType, TInput>];
|
|
15
40
|
declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
|
|
@@ -39,10 +64,10 @@ interface QueryOptionsBase<TOutput, TError> {
|
|
|
39
64
|
enabled?: boolean;
|
|
40
65
|
}
|
|
41
66
|
type experimental_StreamedKeyOptions<TInput> = QueryKeyOptions<TInput> & {
|
|
42
|
-
queryFnOptions?:
|
|
67
|
+
queryFnOptions?: experimental_SerializableStreamedQueryOptions;
|
|
43
68
|
};
|
|
44
69
|
type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & {
|
|
45
|
-
queryFnOptions?:
|
|
70
|
+
queryFnOptions?: experimental_SerializableStreamedQueryOptions;
|
|
46
71
|
};
|
|
47
72
|
interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
|
|
48
73
|
}
|
|
@@ -75,7 +100,7 @@ interface GeneralUtils<TInput> {
|
|
|
75
100
|
/**
|
|
76
101
|
* Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
|
|
77
102
|
*
|
|
78
|
-
* @see {@link https://orpc.
|
|
103
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
79
104
|
*/
|
|
80
105
|
key<TType extends OperationType>(options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
|
|
81
106
|
}
|
|
@@ -87,92 +112,165 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
|
|
|
87
112
|
/**
|
|
88
113
|
* Calling corresponding procedure client
|
|
89
114
|
*
|
|
90
|
-
* @see {@link https://orpc.
|
|
115
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#calling-clients Tanstack Calling Procedure Client Docs}
|
|
91
116
|
*/
|
|
92
117
|
call: Client<TClientContext, TInput, TOutput, TError>;
|
|
93
118
|
/**
|
|
94
|
-
* Generate a **full matching** key for [Query Options](https://orpc.
|
|
119
|
+
* Generate a **full matching** key for [Query Options](https://orpc.dev/docs/integrations/tanstack-query#query-options).
|
|
95
120
|
*
|
|
96
|
-
* @see {@link https://orpc.
|
|
121
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
97
122
|
*/
|
|
98
123
|
queryKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, TOutput, TError>;
|
|
99
124
|
/**
|
|
100
125
|
* Generate options used for useQuery/useSuspenseQuery/prefetchQuery/...
|
|
101
126
|
*
|
|
102
|
-
* @see {@link https://orpc.
|
|
127
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
|
|
103
128
|
*/
|
|
104
129
|
queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
|
|
105
130
|
/**
|
|
106
|
-
* Generate a **full matching** key for [Streamed Query Options](https://orpc.
|
|
131
|
+
* Generate a **full matching** key for [Streamed Query Options](https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options).
|
|
107
132
|
*
|
|
108
|
-
* @see {@link https://orpc.
|
|
133
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
109
134
|
*/
|
|
110
135
|
experimental_streamedKey(...rest: MaybeOptionalOptions<experimental_StreamedKeyOptions<TInput>>): DataTag<QueryKey, experimental_StreamedQueryOutput<TOutput>, TError>;
|
|
111
136
|
/**
|
|
112
|
-
* Configure queries for [Event Iterator](https://orpc.
|
|
137
|
+
* Configure queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
|
|
113
138
|
* This is built on [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
|
|
114
139
|
* and works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
|
|
115
140
|
*
|
|
116
|
-
* @see {@link https://orpc.
|
|
141
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
|
|
117
142
|
*/
|
|
118
143
|
experimental_streamedOptions<U, USelectData = experimental_StreamedQueryOutput<TOutput>>(...rest: MaybeOptionalOptions<U & experimental_StreamedOptionsIn<TClientContext, TInput, experimental_StreamedQueryOutput<TOutput>, TError, USelectData>>): NoInfer<U & Omit<experimental_StreamedOptionsBase<experimental_StreamedQueryOutput<TOutput>, TError>, keyof U>>;
|
|
119
144
|
/**
|
|
120
|
-
* Generate a **full matching** key for [Live Query Options](https://orpc.
|
|
145
|
+
* Generate a **full matching** key for [Live Query Options](https://orpc.dev/docs/integrations/tanstack-query#live-query-options).
|
|
121
146
|
*
|
|
122
|
-
* @see {@link https://orpc.
|
|
147
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
123
148
|
*/
|
|
124
149
|
experimental_liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, experimental_LiveQueryOutput<TOutput>, TError>;
|
|
125
150
|
/**
|
|
126
|
-
* Configure live queries for [Event Iterator](https://orpc.
|
|
151
|
+
* Configure live queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
|
|
127
152
|
* Unlike `.streamedOptions` which accumulates chunks, live queries replace the entire result with each new chunk received.
|
|
128
153
|
* Works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
|
|
129
154
|
*
|
|
130
|
-
* @see {@link https://orpc.
|
|
155
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
|
|
131
156
|
*/
|
|
132
157
|
experimental_liveOptions<U, USelectData = experimental_LiveQueryOutput<TOutput>>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, experimental_LiveQueryOutput<TOutput>, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<experimental_LiveQueryOutput<TOutput>, TError>, keyof U>>;
|
|
133
158
|
/**
|
|
134
|
-
* Generate a **full matching** key for [Infinite Query Options](https://orpc.
|
|
159
|
+
* Generate a **full matching** key for [Infinite Query Options](https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options).
|
|
135
160
|
*
|
|
136
|
-
* @see {@link https://orpc.
|
|
161
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
137
162
|
*/
|
|
138
163
|
infiniteKey<UPageParam>(options: Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, UPageParam>, UPageParam>, 'input' | 'initialPageParam' | 'queryKey'>): DataTag<QueryKey, InfiniteData<TOutput, UPageParam>, TError>;
|
|
139
164
|
/**
|
|
140
165
|
* Generate options used for useInfiniteQuery/useSuspenseInfiniteQuery/prefetchInfiniteQuery/...
|
|
141
166
|
*
|
|
142
|
-
* @see {@link https://orpc.
|
|
167
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
|
|
143
168
|
*/
|
|
144
169
|
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>>;
|
|
145
170
|
/**
|
|
146
|
-
* Generate a **full matching** key for [Mutation Options](https://orpc.
|
|
171
|
+
* Generate a **full matching** key for [Mutation Options](https://orpc.dev/docs/integrations/tanstack-query#mutation-options).
|
|
147
172
|
*
|
|
148
|
-
* @see {@link https://orpc.
|
|
173
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
149
174
|
*/
|
|
150
175
|
mutationKey(options?: Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>): DataTag<QueryKey, TOutput, TError>;
|
|
151
176
|
/**
|
|
152
177
|
* Generate options used for useMutation/...
|
|
153
178
|
*
|
|
154
|
-
* @see {@link https://orpc.
|
|
179
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
|
|
155
180
|
*/
|
|
156
181
|
mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptions<TInput, TOutput, TError, UMutationContext>>;
|
|
157
182
|
}
|
|
158
|
-
interface
|
|
183
|
+
interface experimental_ProcedureUtilsDefaults<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
|
184
|
+
/**
|
|
185
|
+
* Default options for queryKey utility
|
|
186
|
+
*
|
|
187
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
188
|
+
*/
|
|
189
|
+
queryKey?: Partial<QueryKeyOptions<TInput>>;
|
|
190
|
+
/**
|
|
191
|
+
* Default options for queryOptions utility
|
|
192
|
+
*
|
|
193
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
|
|
194
|
+
*/
|
|
195
|
+
queryOptions?: Partial<QueryOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
|
|
196
|
+
/**
|
|
197
|
+
* Default options for experimental_streamedKey utility
|
|
198
|
+
*
|
|
199
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
200
|
+
*/
|
|
201
|
+
experimental_streamedKey?: Partial<experimental_StreamedKeyOptions<TInput>>;
|
|
202
|
+
/**
|
|
203
|
+
* Default options for experimental_streamedOptions utility
|
|
204
|
+
*
|
|
205
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
|
|
206
|
+
*/
|
|
207
|
+
experimental_streamedOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_StreamedQueryOutput<TOutput>, TError, unknown>>;
|
|
208
|
+
/**
|
|
209
|
+
* Default options for experimental_liveKey utility
|
|
210
|
+
*
|
|
211
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
212
|
+
*/
|
|
213
|
+
experimental_liveKey?: Partial<QueryKeyOptions<TInput>>;
|
|
214
|
+
/**
|
|
215
|
+
* Default options for experimental_liveOptions utility
|
|
216
|
+
*
|
|
217
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
|
|
218
|
+
*/
|
|
219
|
+
experimental_liveOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_LiveQueryOutput<TOutput>, TError, unknown>>;
|
|
220
|
+
/**
|
|
221
|
+
* Default options for infiniteKey utility
|
|
222
|
+
*
|
|
223
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
224
|
+
*/
|
|
225
|
+
infiniteKey?: Partial<Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, unknown>, unknown>, 'input' | 'initialPageParam' | 'queryKey'>>;
|
|
226
|
+
/**
|
|
227
|
+
* Default options for infiniteOptions utility
|
|
228
|
+
*
|
|
229
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
|
|
230
|
+
*/
|
|
231
|
+
infiniteOptions?: Partial<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, unknown>>;
|
|
232
|
+
/**
|
|
233
|
+
* Default options for mutationKey utility
|
|
234
|
+
*
|
|
235
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
236
|
+
*/
|
|
237
|
+
mutationKey?: Partial<Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>>;
|
|
238
|
+
/**
|
|
239
|
+
* Default options for mutationOptions utility
|
|
240
|
+
*
|
|
241
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
|
|
242
|
+
*/
|
|
243
|
+
mutationOptions?: Partial<MutationOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* @todo remove default generic types on v2
|
|
247
|
+
*/
|
|
248
|
+
interface CreateProcedureUtilsOptions<TClientContext extends ClientContext = ClientContext, TInput = unknown, TOutput = unknown, TError = unknown> {
|
|
159
249
|
path: readonly string[];
|
|
250
|
+
experimental_defaults?: experimental_ProcedureUtilsDefaults<TClientContext, TInput, TOutput, TError>;
|
|
160
251
|
}
|
|
161
|
-
declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
|
|
252
|
+
declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
|
|
162
253
|
|
|
163
254
|
type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
|
|
164
255
|
[K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
|
|
165
256
|
} & GeneralUtils<unknown>;
|
|
166
|
-
|
|
257
|
+
type experimental_RouterUtilsDefaults<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? experimental_ProcedureUtilsDefaults<UClientContext, UInput, UOutput, UError> : {
|
|
258
|
+
[K in keyof T]?: T[K] extends NestedClient<any> ? experimental_RouterUtilsDefaults<T[K]> : never;
|
|
259
|
+
};
|
|
260
|
+
/**
|
|
261
|
+
* @todo remove default generic types on v2
|
|
262
|
+
*/
|
|
263
|
+
interface CreateRouterUtilsOptions<T extends NestedClient<any> = NestedClient<any>> {
|
|
167
264
|
path?: readonly string[];
|
|
265
|
+
experimental_defaults?: experimental_RouterUtilsDefaults<T>;
|
|
168
266
|
}
|
|
169
267
|
/**
|
|
170
268
|
* Create a router utils from a client.
|
|
171
269
|
*
|
|
172
270
|
* @info Both client-side and server-side clients are supported.
|
|
173
|
-
* @see {@link https://orpc.
|
|
271
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query Tanstack Query Integration}
|
|
174
272
|
*/
|
|
175
|
-
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
|
|
273
|
+
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions<T>): RouterUtils<T>;
|
|
176
274
|
|
|
177
|
-
export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
|
|
178
|
-
export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, experimental_LiveQueryOutput, experimental_StreamedKeyOptions, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, experimental_StreamedQueryOutput };
|
|
275
|
+
export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, experimental_serializableStreamedQuery, generateOperationKey };
|
|
276
|
+
export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, experimental_LiveQueryOutput, experimental_ProcedureUtilsDefaults, experimental_RouterUtilsDefaults, experimental_SerializableStreamedQueryOptions, experimental_StreamedKeyOptions, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, experimental_StreamedQueryOutput };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,15 +1,40 @@
|
|
|
1
1
|
import { ClientContext, Client, NestedClient } from '@orpc/client';
|
|
2
|
-
import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
-
import {
|
|
2
|
+
import { Promisable, SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
+
import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, InfiniteQueryObserverOptions, MutationObserverOptions, DataTag, InfiniteData } from '@tanstack/query-core';
|
|
4
|
+
|
|
5
|
+
interface experimental_SerializableStreamedQueryOptions {
|
|
6
|
+
/**
|
|
7
|
+
* Determines how data is handled when the query is refetched.
|
|
8
|
+
*
|
|
9
|
+
* - `'reset'`: Clears existing data and sets the query back to a pending state.
|
|
10
|
+
* - `'append'`: Appends new data chunks to the existing data.
|
|
11
|
+
* - `'replace'`: Collects all streamed data and replaces the cache once the stream finishes.
|
|
12
|
+
*
|
|
13
|
+
* @default 'reset'
|
|
14
|
+
*/
|
|
15
|
+
refetchMode?: 'append' | 'reset' | 'replace';
|
|
16
|
+
/**
|
|
17
|
+
* Limits the number of data chunks stored in the query result.
|
|
18
|
+
* Older chunks are removed when the limit is reached.
|
|
19
|
+
*
|
|
20
|
+
* @default Number.POSITIVE_INFINITY (unlimited)
|
|
21
|
+
*/
|
|
22
|
+
maxChunks?: number;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* A variant of `streamedQuery` where:
|
|
26
|
+
* - Options are serializable
|
|
27
|
+
* - The output is predictable
|
|
28
|
+
*/
|
|
29
|
+
declare function experimental_serializableStreamedQuery<TQueryFnData = unknown, TQueryKey extends QueryKey = QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => Promisable<AsyncIterable<TQueryFnData>>, { refetchMode, maxChunks }?: experimental_SerializableStreamedQueryOptions): QueryFunction<Array<TQueryFnData>, TQueryKey>;
|
|
4
30
|
|
|
5
31
|
type experimental_StreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
|
|
6
32
|
type experimental_LiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
|
|
7
|
-
type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
|
|
8
33
|
type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
|
|
9
34
|
type OperationKeyOptions<TType extends OperationType, TInput> = {
|
|
10
35
|
type?: TType;
|
|
11
36
|
input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
|
|
12
|
-
fnOptions?: TType extends 'streamed' ?
|
|
37
|
+
fnOptions?: TType extends 'streamed' ? experimental_SerializableStreamedQueryOptions : never;
|
|
13
38
|
};
|
|
14
39
|
type OperationKey<TType extends OperationType, TInput> = [path: readonly string[], options: OperationKeyOptions<TType, TInput>];
|
|
15
40
|
declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
|
|
@@ -39,10 +64,10 @@ interface QueryOptionsBase<TOutput, TError> {
|
|
|
39
64
|
enabled?: boolean;
|
|
40
65
|
}
|
|
41
66
|
type experimental_StreamedKeyOptions<TInput> = QueryKeyOptions<TInput> & {
|
|
42
|
-
queryFnOptions?:
|
|
67
|
+
queryFnOptions?: experimental_SerializableStreamedQueryOptions;
|
|
43
68
|
};
|
|
44
69
|
type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & {
|
|
45
|
-
queryFnOptions?:
|
|
70
|
+
queryFnOptions?: experimental_SerializableStreamedQueryOptions;
|
|
46
71
|
};
|
|
47
72
|
interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
|
|
48
73
|
}
|
|
@@ -75,7 +100,7 @@ interface GeneralUtils<TInput> {
|
|
|
75
100
|
/**
|
|
76
101
|
* Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
|
|
77
102
|
*
|
|
78
|
-
* @see {@link https://orpc.
|
|
103
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
79
104
|
*/
|
|
80
105
|
key<TType extends OperationType>(options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
|
|
81
106
|
}
|
|
@@ -87,92 +112,165 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
|
|
|
87
112
|
/**
|
|
88
113
|
* Calling corresponding procedure client
|
|
89
114
|
*
|
|
90
|
-
* @see {@link https://orpc.
|
|
115
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#calling-clients Tanstack Calling Procedure Client Docs}
|
|
91
116
|
*/
|
|
92
117
|
call: Client<TClientContext, TInput, TOutput, TError>;
|
|
93
118
|
/**
|
|
94
|
-
* Generate a **full matching** key for [Query Options](https://orpc.
|
|
119
|
+
* Generate a **full matching** key for [Query Options](https://orpc.dev/docs/integrations/tanstack-query#query-options).
|
|
95
120
|
*
|
|
96
|
-
* @see {@link https://orpc.
|
|
121
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
97
122
|
*/
|
|
98
123
|
queryKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, TOutput, TError>;
|
|
99
124
|
/**
|
|
100
125
|
* Generate options used for useQuery/useSuspenseQuery/prefetchQuery/...
|
|
101
126
|
*
|
|
102
|
-
* @see {@link https://orpc.
|
|
127
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
|
|
103
128
|
*/
|
|
104
129
|
queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
|
|
105
130
|
/**
|
|
106
|
-
* Generate a **full matching** key for [Streamed Query Options](https://orpc.
|
|
131
|
+
* Generate a **full matching** key for [Streamed Query Options](https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options).
|
|
107
132
|
*
|
|
108
|
-
* @see {@link https://orpc.
|
|
133
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
109
134
|
*/
|
|
110
135
|
experimental_streamedKey(...rest: MaybeOptionalOptions<experimental_StreamedKeyOptions<TInput>>): DataTag<QueryKey, experimental_StreamedQueryOutput<TOutput>, TError>;
|
|
111
136
|
/**
|
|
112
|
-
* Configure queries for [Event Iterator](https://orpc.
|
|
137
|
+
* Configure queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
|
|
113
138
|
* This is built on [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
|
|
114
139
|
* and works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
|
|
115
140
|
*
|
|
116
|
-
* @see {@link https://orpc.
|
|
141
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
|
|
117
142
|
*/
|
|
118
143
|
experimental_streamedOptions<U, USelectData = experimental_StreamedQueryOutput<TOutput>>(...rest: MaybeOptionalOptions<U & experimental_StreamedOptionsIn<TClientContext, TInput, experimental_StreamedQueryOutput<TOutput>, TError, USelectData>>): NoInfer<U & Omit<experimental_StreamedOptionsBase<experimental_StreamedQueryOutput<TOutput>, TError>, keyof U>>;
|
|
119
144
|
/**
|
|
120
|
-
* Generate a **full matching** key for [Live Query Options](https://orpc.
|
|
145
|
+
* Generate a **full matching** key for [Live Query Options](https://orpc.dev/docs/integrations/tanstack-query#live-query-options).
|
|
121
146
|
*
|
|
122
|
-
* @see {@link https://orpc.
|
|
147
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
123
148
|
*/
|
|
124
149
|
experimental_liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, experimental_LiveQueryOutput<TOutput>, TError>;
|
|
125
150
|
/**
|
|
126
|
-
* Configure live queries for [Event Iterator](https://orpc.
|
|
151
|
+
* Configure live queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
|
|
127
152
|
* Unlike `.streamedOptions` which accumulates chunks, live queries replace the entire result with each new chunk received.
|
|
128
153
|
* Works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
|
|
129
154
|
*
|
|
130
|
-
* @see {@link https://orpc.
|
|
155
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
|
|
131
156
|
*/
|
|
132
157
|
experimental_liveOptions<U, USelectData = experimental_LiveQueryOutput<TOutput>>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, experimental_LiveQueryOutput<TOutput>, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<experimental_LiveQueryOutput<TOutput>, TError>, keyof U>>;
|
|
133
158
|
/**
|
|
134
|
-
* Generate a **full matching** key for [Infinite Query Options](https://orpc.
|
|
159
|
+
* Generate a **full matching** key for [Infinite Query Options](https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options).
|
|
135
160
|
*
|
|
136
|
-
* @see {@link https://orpc.
|
|
161
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
137
162
|
*/
|
|
138
163
|
infiniteKey<UPageParam>(options: Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, UPageParam>, UPageParam>, 'input' | 'initialPageParam' | 'queryKey'>): DataTag<QueryKey, InfiniteData<TOutput, UPageParam>, TError>;
|
|
139
164
|
/**
|
|
140
165
|
* Generate options used for useInfiniteQuery/useSuspenseInfiniteQuery/prefetchInfiniteQuery/...
|
|
141
166
|
*
|
|
142
|
-
* @see {@link https://orpc.
|
|
167
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
|
|
143
168
|
*/
|
|
144
169
|
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>>;
|
|
145
170
|
/**
|
|
146
|
-
* Generate a **full matching** key for [Mutation Options](https://orpc.
|
|
171
|
+
* Generate a **full matching** key for [Mutation Options](https://orpc.dev/docs/integrations/tanstack-query#mutation-options).
|
|
147
172
|
*
|
|
148
|
-
* @see {@link https://orpc.
|
|
173
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
149
174
|
*/
|
|
150
175
|
mutationKey(options?: Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>): DataTag<QueryKey, TOutput, TError>;
|
|
151
176
|
/**
|
|
152
177
|
* Generate options used for useMutation/...
|
|
153
178
|
*
|
|
154
|
-
* @see {@link https://orpc.
|
|
179
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
|
|
155
180
|
*/
|
|
156
181
|
mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptions<TInput, TOutput, TError, UMutationContext>>;
|
|
157
182
|
}
|
|
158
|
-
interface
|
|
183
|
+
interface experimental_ProcedureUtilsDefaults<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
|
184
|
+
/**
|
|
185
|
+
* Default options for queryKey utility
|
|
186
|
+
*
|
|
187
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
188
|
+
*/
|
|
189
|
+
queryKey?: Partial<QueryKeyOptions<TInput>>;
|
|
190
|
+
/**
|
|
191
|
+
* Default options for queryOptions utility
|
|
192
|
+
*
|
|
193
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
|
|
194
|
+
*/
|
|
195
|
+
queryOptions?: Partial<QueryOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
|
|
196
|
+
/**
|
|
197
|
+
* Default options for experimental_streamedKey utility
|
|
198
|
+
*
|
|
199
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
200
|
+
*/
|
|
201
|
+
experimental_streamedKey?: Partial<experimental_StreamedKeyOptions<TInput>>;
|
|
202
|
+
/**
|
|
203
|
+
* Default options for experimental_streamedOptions utility
|
|
204
|
+
*
|
|
205
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
|
|
206
|
+
*/
|
|
207
|
+
experimental_streamedOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_StreamedQueryOutput<TOutput>, TError, unknown>>;
|
|
208
|
+
/**
|
|
209
|
+
* Default options for experimental_liveKey utility
|
|
210
|
+
*
|
|
211
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
212
|
+
*/
|
|
213
|
+
experimental_liveKey?: Partial<QueryKeyOptions<TInput>>;
|
|
214
|
+
/**
|
|
215
|
+
* Default options for experimental_liveOptions utility
|
|
216
|
+
*
|
|
217
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
|
|
218
|
+
*/
|
|
219
|
+
experimental_liveOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_LiveQueryOutput<TOutput>, TError, unknown>>;
|
|
220
|
+
/**
|
|
221
|
+
* Default options for infiniteKey utility
|
|
222
|
+
*
|
|
223
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
224
|
+
*/
|
|
225
|
+
infiniteKey?: Partial<Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, unknown>, unknown>, 'input' | 'initialPageParam' | 'queryKey'>>;
|
|
226
|
+
/**
|
|
227
|
+
* Default options for infiniteOptions utility
|
|
228
|
+
*
|
|
229
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
|
|
230
|
+
*/
|
|
231
|
+
infiniteOptions?: Partial<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, unknown>>;
|
|
232
|
+
/**
|
|
233
|
+
* Default options for mutationKey utility
|
|
234
|
+
*
|
|
235
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
236
|
+
*/
|
|
237
|
+
mutationKey?: Partial<Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>>;
|
|
238
|
+
/**
|
|
239
|
+
* Default options for mutationOptions utility
|
|
240
|
+
*
|
|
241
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
|
|
242
|
+
*/
|
|
243
|
+
mutationOptions?: Partial<MutationOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* @todo remove default generic types on v2
|
|
247
|
+
*/
|
|
248
|
+
interface CreateProcedureUtilsOptions<TClientContext extends ClientContext = ClientContext, TInput = unknown, TOutput = unknown, TError = unknown> {
|
|
159
249
|
path: readonly string[];
|
|
250
|
+
experimental_defaults?: experimental_ProcedureUtilsDefaults<TClientContext, TInput, TOutput, TError>;
|
|
160
251
|
}
|
|
161
|
-
declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
|
|
252
|
+
declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions<TClientContext, TInput, TOutput, TError>): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
|
|
162
253
|
|
|
163
254
|
type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
|
|
164
255
|
[K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
|
|
165
256
|
} & GeneralUtils<unknown>;
|
|
166
|
-
|
|
257
|
+
type experimental_RouterUtilsDefaults<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? experimental_ProcedureUtilsDefaults<UClientContext, UInput, UOutput, UError> : {
|
|
258
|
+
[K in keyof T]?: T[K] extends NestedClient<any> ? experimental_RouterUtilsDefaults<T[K]> : never;
|
|
259
|
+
};
|
|
260
|
+
/**
|
|
261
|
+
* @todo remove default generic types on v2
|
|
262
|
+
*/
|
|
263
|
+
interface CreateRouterUtilsOptions<T extends NestedClient<any> = NestedClient<any>> {
|
|
167
264
|
path?: readonly string[];
|
|
265
|
+
experimental_defaults?: experimental_RouterUtilsDefaults<T>;
|
|
168
266
|
}
|
|
169
267
|
/**
|
|
170
268
|
* Create a router utils from a client.
|
|
171
269
|
*
|
|
172
270
|
* @info Both client-side and server-side clients are supported.
|
|
173
|
-
* @see {@link https://orpc.
|
|
271
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query Tanstack Query Integration}
|
|
174
272
|
*/
|
|
175
|
-
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
|
|
273
|
+
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions<T>): RouterUtils<T>;
|
|
176
274
|
|
|
177
|
-
export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
|
|
178
|
-
export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, experimental_LiveQueryOutput, experimental_StreamedKeyOptions, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, experimental_StreamedQueryOutput };
|
|
275
|
+
export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, experimental_serializableStreamedQuery, generateOperationKey };
|
|
276
|
+
export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, experimental_LiveQueryOutput, experimental_ProcedureUtilsDefaults, experimental_RouterUtilsDefaults, experimental_SerializableStreamedQueryOptions, experimental_StreamedKeyOptions, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, experimental_StreamedQueryOutput };
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { stringifyJSON, isAsyncIteratorObject, toArray } from '@orpc/shared';
|
|
2
|
-
import { skipToken
|
|
1
|
+
import { stringifyJSON, isAsyncIteratorObject, toArray, get } from '@orpc/shared';
|
|
2
|
+
import { skipToken } from '@tanstack/query-core';
|
|
3
3
|
|
|
4
4
|
function generateOperationKey(path, state = {}) {
|
|
5
5
|
return [path, {
|
|
@@ -23,7 +23,7 @@ function experimental_liveQuery(queryFn) {
|
|
|
23
23
|
let last;
|
|
24
24
|
for await (const chunk of stream) {
|
|
25
25
|
if (context.signal.aborted) {
|
|
26
|
-
|
|
26
|
+
throw context.signal.reason;
|
|
27
27
|
}
|
|
28
28
|
last = { chunk };
|
|
29
29
|
context.client.setQueryData(context.queryKey, chunk);
|
|
@@ -37,16 +37,74 @@ function experimental_liveQuery(queryFn) {
|
|
|
37
37
|
};
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
+
function experimental_serializableStreamedQuery(queryFn, { refetchMode = "reset", maxChunks = Number.POSITIVE_INFINITY } = {}) {
|
|
41
|
+
return async (context) => {
|
|
42
|
+
const query = context.client.getQueryCache().find({ queryKey: context.queryKey, exact: true });
|
|
43
|
+
const hasPreviousData = !!query && query.state.data !== void 0;
|
|
44
|
+
if (hasPreviousData) {
|
|
45
|
+
if (refetchMode === "reset") {
|
|
46
|
+
query.setState({
|
|
47
|
+
status: "pending",
|
|
48
|
+
data: void 0,
|
|
49
|
+
error: null,
|
|
50
|
+
fetchStatus: "fetching"
|
|
51
|
+
});
|
|
52
|
+
} else {
|
|
53
|
+
context.client.setQueryData(
|
|
54
|
+
context.queryKey,
|
|
55
|
+
(prev = []) => limitArraySize(prev, maxChunks)
|
|
56
|
+
);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
let result = [];
|
|
60
|
+
const stream = await queryFn(context);
|
|
61
|
+
const shouldUpdateCacheDuringStream = !hasPreviousData || refetchMode !== "replace";
|
|
62
|
+
context.client.setQueryData(
|
|
63
|
+
context.queryKey,
|
|
64
|
+
(prev = []) => limitArraySize(prev, maxChunks)
|
|
65
|
+
);
|
|
66
|
+
for await (const chunk of stream) {
|
|
67
|
+
if (context.signal.aborted) {
|
|
68
|
+
throw context.signal.reason;
|
|
69
|
+
}
|
|
70
|
+
result.push(chunk);
|
|
71
|
+
result = limitArraySize(result, maxChunks);
|
|
72
|
+
if (shouldUpdateCacheDuringStream) {
|
|
73
|
+
context.client.setQueryData(
|
|
74
|
+
context.queryKey,
|
|
75
|
+
(prev = []) => limitArraySize([...prev, chunk], maxChunks)
|
|
76
|
+
);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
if (!shouldUpdateCacheDuringStream) {
|
|
80
|
+
context.client.setQueryData(context.queryKey, result);
|
|
81
|
+
}
|
|
82
|
+
const cachedData = context.client.getQueryData(context.queryKey);
|
|
83
|
+
if (cachedData) {
|
|
84
|
+
return limitArraySize(cachedData, maxChunks);
|
|
85
|
+
}
|
|
86
|
+
return result;
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
function limitArraySize(items, maxSize) {
|
|
90
|
+
if (items.length <= maxSize) {
|
|
91
|
+
return items;
|
|
92
|
+
}
|
|
93
|
+
return items.slice(items.length - maxSize);
|
|
94
|
+
}
|
|
95
|
+
|
|
40
96
|
const OPERATION_CONTEXT_SYMBOL = Symbol("ORPC_OPERATION_CONTEXT");
|
|
41
97
|
|
|
42
98
|
function createProcedureUtils(client, options) {
|
|
43
99
|
const utils = {
|
|
44
100
|
call: client,
|
|
45
101
|
queryKey(...[optionsIn = {}]) {
|
|
102
|
+
optionsIn = { ...options.experimental_defaults?.queryKey, ...optionsIn };
|
|
46
103
|
const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "query", input: optionsIn.input });
|
|
47
104
|
return queryKey;
|
|
48
105
|
},
|
|
49
106
|
queryOptions(...[optionsIn = {}]) {
|
|
107
|
+
optionsIn = { ...options.experimental_defaults?.queryOptions, ...optionsIn };
|
|
50
108
|
const queryKey = utils.queryKey(optionsIn);
|
|
51
109
|
return {
|
|
52
110
|
queryFn: ({ signal }) => {
|
|
@@ -70,14 +128,16 @@ function createProcedureUtils(client, options) {
|
|
|
70
128
|
};
|
|
71
129
|
},
|
|
72
130
|
experimental_streamedKey(...[optionsIn = {}]) {
|
|
131
|
+
optionsIn = { ...options.experimental_defaults?.experimental_streamedKey, ...optionsIn };
|
|
73
132
|
const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "streamed", input: optionsIn.input, fnOptions: optionsIn.queryFnOptions });
|
|
74
133
|
return queryKey;
|
|
75
134
|
},
|
|
76
135
|
experimental_streamedOptions(...[optionsIn = {}]) {
|
|
136
|
+
optionsIn = { ...options.experimental_defaults?.experimental_streamedOptions, ...optionsIn };
|
|
77
137
|
const queryKey = utils.experimental_streamedKey(optionsIn);
|
|
78
138
|
return {
|
|
79
|
-
queryFn:
|
|
80
|
-
|
|
139
|
+
queryFn: experimental_serializableStreamedQuery(
|
|
140
|
+
async ({ signal }) => {
|
|
81
141
|
if (optionsIn.input === skipToken) {
|
|
82
142
|
throw new Error("queryFn should not be called with skipToken used as input");
|
|
83
143
|
}
|
|
@@ -96,18 +156,20 @@ function createProcedureUtils(client, options) {
|
|
|
96
156
|
}
|
|
97
157
|
return output;
|
|
98
158
|
},
|
|
99
|
-
|
|
100
|
-
|
|
159
|
+
optionsIn.queryFnOptions
|
|
160
|
+
),
|
|
101
161
|
...optionsIn.input === skipToken ? { enabled: false } : {},
|
|
102
162
|
...optionsIn,
|
|
103
163
|
queryKey
|
|
104
164
|
};
|
|
105
165
|
},
|
|
106
166
|
experimental_liveKey(...[optionsIn = {}]) {
|
|
167
|
+
optionsIn = { ...options.experimental_defaults?.experimental_liveKey, ...optionsIn };
|
|
107
168
|
const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "live", input: optionsIn.input });
|
|
108
169
|
return queryKey;
|
|
109
170
|
},
|
|
110
171
|
experimental_liveOptions(...[optionsIn = {}]) {
|
|
172
|
+
optionsIn = { ...options.experimental_defaults?.experimental_liveOptions, ...optionsIn };
|
|
111
173
|
const queryKey = utils.experimental_liveKey(optionsIn);
|
|
112
174
|
return {
|
|
113
175
|
queryFn: experimental_liveQuery(async ({ signal }) => {
|
|
@@ -135,6 +197,7 @@ function createProcedureUtils(client, options) {
|
|
|
135
197
|
};
|
|
136
198
|
},
|
|
137
199
|
infiniteKey(optionsIn) {
|
|
200
|
+
optionsIn = { ...options.experimental_defaults?.infiniteKey, ...optionsIn };
|
|
138
201
|
const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, {
|
|
139
202
|
type: "infinite",
|
|
140
203
|
input: optionsIn.input === skipToken ? skipToken : optionsIn.input(optionsIn.initialPageParam)
|
|
@@ -142,6 +205,7 @@ function createProcedureUtils(client, options) {
|
|
|
142
205
|
return queryKey;
|
|
143
206
|
},
|
|
144
207
|
infiniteOptions(optionsIn) {
|
|
208
|
+
optionsIn = { ...options.experimental_defaults?.infiniteOptions, ...optionsIn };
|
|
145
209
|
const queryKey = utils.infiniteKey(optionsIn);
|
|
146
210
|
return {
|
|
147
211
|
queryFn: ({ pageParam, signal }) => {
|
|
@@ -165,10 +229,12 @@ function createProcedureUtils(client, options) {
|
|
|
165
229
|
};
|
|
166
230
|
},
|
|
167
231
|
mutationKey(...[optionsIn = {}]) {
|
|
232
|
+
optionsIn = { ...options.experimental_defaults?.mutationKey, ...optionsIn };
|
|
168
233
|
const mutationKey = optionsIn.mutationKey ?? generateOperationKey(options.path, { type: "mutation" });
|
|
169
234
|
return mutationKey;
|
|
170
235
|
},
|
|
171
236
|
mutationOptions(...[optionsIn = {}]) {
|
|
237
|
+
optionsIn = { ...options.experimental_defaults?.mutationOptions, ...optionsIn };
|
|
172
238
|
const mutationKey = utils.mutationKey(optionsIn);
|
|
173
239
|
return {
|
|
174
240
|
mutationFn: (input) => client(input, {
|
|
@@ -191,7 +257,10 @@ function createProcedureUtils(client, options) {
|
|
|
191
257
|
function createRouterUtils(client, options = {}) {
|
|
192
258
|
const path = toArray(options.path);
|
|
193
259
|
const generalUtils = createGeneralUtils(path);
|
|
194
|
-
const procedureUtils = createProcedureUtils(client, {
|
|
260
|
+
const procedureUtils = createProcedureUtils(client, {
|
|
261
|
+
path,
|
|
262
|
+
experimental_defaults: options.experimental_defaults
|
|
263
|
+
});
|
|
195
264
|
const recursive = new Proxy({
|
|
196
265
|
...generalUtils,
|
|
197
266
|
...procedureUtils
|
|
@@ -201,7 +270,11 @@ function createRouterUtils(client, options = {}) {
|
|
|
201
270
|
if (typeof prop !== "string") {
|
|
202
271
|
return value;
|
|
203
272
|
}
|
|
204
|
-
const nextUtils = createRouterUtils(client[prop], {
|
|
273
|
+
const nextUtils = createRouterUtils(client[prop], {
|
|
274
|
+
...options,
|
|
275
|
+
path: [...path, prop],
|
|
276
|
+
experimental_defaults: get(options.experimental_defaults, [prop])
|
|
277
|
+
});
|
|
205
278
|
if (typeof value !== "function") {
|
|
206
279
|
return nextUtils;
|
|
207
280
|
}
|
|
@@ -215,4 +288,4 @@ function createRouterUtils(client, options = {}) {
|
|
|
215
288
|
return recursive;
|
|
216
289
|
}
|
|
217
290
|
|
|
218
|
-
export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
|
|
291
|
+
export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, experimental_serializableStreamedQuery, generateOperationKey };
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/tanstack-query",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.b2d00a3",
|
|
5
5
|
"license": "MIT",
|
|
6
|
-
"homepage": "https://orpc.
|
|
6
|
+
"homepage": "https://orpc.dev",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
9
|
"url": "git+https://github.com/unnoq/orpc.git",
|
|
@@ -25,22 +25,22 @@
|
|
|
25
25
|
],
|
|
26
26
|
"peerDependencies": {
|
|
27
27
|
"@tanstack/query-core": ">=5.80.2",
|
|
28
|
-
"@orpc/client": "0.0.0-next.
|
|
28
|
+
"@orpc/client": "0.0.0-next.b2d00a3"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@orpc/shared": "0.0.0-next.
|
|
31
|
+
"@orpc/shared": "0.0.0-next.b2d00a3"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
|
-
"@angular/core": "^
|
|
35
|
-
"@tanstack/angular-query-experimental": "^5.
|
|
36
|
-
"@tanstack/query-core": "^5.
|
|
37
|
-
"@tanstack/react-query": "^5.
|
|
38
|
-
"@tanstack/solid-query": "^5.
|
|
39
|
-
"@tanstack/svelte-query": "^
|
|
40
|
-
"@tanstack/vue-query": "^5.
|
|
41
|
-
"svelte": "^5.
|
|
42
|
-
"vue": "^3.5.
|
|
43
|
-
"zod": "^4.1.
|
|
34
|
+
"@angular/core": "^21.0.3",
|
|
35
|
+
"@tanstack/angular-query-experimental": "^5.90.12",
|
|
36
|
+
"@tanstack/query-core": "^5.90.10",
|
|
37
|
+
"@tanstack/react-query": "^5.90.10",
|
|
38
|
+
"@tanstack/solid-query": "^5.90.13",
|
|
39
|
+
"@tanstack/svelte-query": "^6.0.8",
|
|
40
|
+
"@tanstack/vue-query": "^5.91.2",
|
|
41
|
+
"svelte": "^5.45.3",
|
|
42
|
+
"vue": "^3.5.24",
|
|
43
|
+
"zod": "^4.1.12"
|
|
44
44
|
},
|
|
45
45
|
"scripts": {
|
|
46
46
|
"build": "unbuild",
|