@orpc/tanstack-query 0.0.0-next.e82d760 → 0.0.0-next.e8416db

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +9 -4
  2. package/dist/index.d.mts +146 -32
  3. package/dist/index.d.ts +146 -32
  4. package/dist/index.mjs +135 -11
  5. 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.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
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>
@@ -30,7 +33,8 @@
30
33
  - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
34
  - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
35
  - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
- - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
36
+ - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
37
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
34
38
  - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
39
  - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
40
  - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -38,11 +42,10 @@
38
42
  - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
43
  - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
44
  - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
- - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
42
45
 
43
46
  ## Documentation
44
47
 
45
- You can find the full documentation [here](https://orpc.unnoq.com).
48
+ You can find the full documentation [here](https://orpc.dev).
46
49
 
47
50
  ## Packages
48
51
 
@@ -50,9 +53,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
50
53
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
51
54
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
55
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
56
+ - [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
53
57
  - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
54
58
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
55
59
  - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
60
+ - [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
56
61
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
57
62
  - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
58
63
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
package/dist/index.d.mts CHANGED
@@ -1,14 +1,40 @@
1
1
  import { ClientContext, Client, NestedClient } from '@orpc/client';
2
- import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
3
- import { SkipToken, QueryKey, QueryObserverOptions, DataTag, QueryFunction, experimental_streamedQuery, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
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
- type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
7
- type OperationType = 'query' | 'streamed' | 'infinite' | 'mutation';
32
+ type experimental_LiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
33
+ type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
8
34
  type OperationKeyOptions<TType extends OperationType, TInput> = {
9
35
  type?: TType;
10
36
  input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
11
- fnOptions?: TType extends 'streamed' ? experimental_StreamedQueryOptions : never;
37
+ fnOptions?: TType extends 'streamed' ? experimental_SerializableStreamedQueryOptions : never;
12
38
  };
13
39
  type OperationKey<TType extends OperationType, TInput> = [path: readonly string[], options: OperationKeyOptions<TType, TInput>];
14
40
  declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
@@ -35,13 +61,13 @@ interface QueryOptionsBase<TOutput, TError> {
35
61
  queryFn: QueryFunction<TOutput>;
36
62
  throwOnError?: (error: TError) => boolean;
37
63
  retryDelay?: (count: number, error: TError) => number;
38
- enabled: boolean;
64
+ enabled?: boolean;
39
65
  }
40
66
  type experimental_StreamedKeyOptions<TInput> = QueryKeyOptions<TInput> & {
41
- queryFnOptions?: experimental_StreamedQueryOptions;
67
+ queryFnOptions?: experimental_SerializableStreamedQueryOptions;
42
68
  };
43
69
  type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & {
44
- queryFnOptions?: experimental_StreamedQueryOptions;
70
+ queryFnOptions?: experimental_SerializableStreamedQueryOptions;
45
71
  };
46
72
  interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
47
73
  }
@@ -58,7 +84,7 @@ interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
58
84
  select?(): InfiniteData<TOutput, TPageParam>;
59
85
  throwOnError?: (error: TError) => boolean;
60
86
  retryDelay?: (count: number, error: TError) => number;
61
- enabled: boolean;
87
+ enabled?: boolean;
62
88
  }
63
89
  type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
64
90
  context?: TClientContext;
@@ -74,7 +100,7 @@ interface GeneralUtils<TInput> {
74
100
  /**
75
101
  * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
76
102
  *
77
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
103
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
78
104
  */
79
105
  key<TType extends OperationType>(options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
80
106
  }
@@ -86,77 +112,165 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
86
112
  /**
87
113
  * Calling corresponding procedure client
88
114
  *
89
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#calling-clients Tanstack Calling Procedure Client Docs}
115
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#calling-clients Tanstack Calling Procedure Client Docs}
90
116
  */
91
117
  call: Client<TClientContext, TInput, TOutput, TError>;
92
118
  /**
93
- * Generate a **full matching** key for [Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#query-options).
119
+ * Generate a **full matching** key for [Query Options](https://orpc.dev/docs/integrations/tanstack-query#query-options).
94
120
  *
95
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
121
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
96
122
  */
97
123
  queryKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, TOutput, TError>;
98
124
  /**
99
125
  * Generate options used for useQuery/useSuspenseQuery/prefetchQuery/...
100
126
  *
101
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
127
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
102
128
  */
103
129
  queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
104
130
  /**
105
- * Generate a **full matching** key for [Streamed Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options).
131
+ * Generate a **full matching** key for [Streamed Query Options](https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options).
106
132
  *
107
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
133
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
108
134
  */
109
135
  experimental_streamedKey(...rest: MaybeOptionalOptions<experimental_StreamedKeyOptions<TInput>>): DataTag<QueryKey, experimental_StreamedQueryOutput<TOutput>, TError>;
110
136
  /**
111
- * Generate [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) options used for useQuery/useSuspenseQuery/prefetchQuery/...
112
- * Built on top of [steamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
137
+ * Configure queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
138
+ * This is built on [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
139
+ * and works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
113
140
  *
114
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
141
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
115
142
  */
116
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>>;
117
144
  /**
118
- * Generate a **full matching** key for [Infinite Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options).
145
+ * Generate a **full matching** key for [Live Query Options](https://orpc.dev/docs/integrations/tanstack-query#live-query-options).
146
+ *
147
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
148
+ */
149
+ experimental_liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, experimental_LiveQueryOutput<TOutput>, TError>;
150
+ /**
151
+ * Configure live queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
152
+ * Unlike `.streamedOptions` which accumulates chunks, live queries replace the entire result with each new chunk received.
153
+ * Works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
119
154
  *
120
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
155
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
156
+ */
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>>;
158
+ /**
159
+ * Generate a **full matching** key for [Infinite Query Options](https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options).
160
+ *
161
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
121
162
  */
122
163
  infiniteKey<UPageParam>(options: Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, UPageParam>, UPageParam>, 'input' | 'initialPageParam' | 'queryKey'>): DataTag<QueryKey, InfiniteData<TOutput, UPageParam>, TError>;
123
164
  /**
124
165
  * Generate options used for useInfiniteQuery/useSuspenseInfiniteQuery/prefetchInfiniteQuery/...
125
166
  *
126
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
167
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
127
168
  */
128
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>>;
129
170
  /**
130
- * Generate a **full matching** key for [Mutation Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#mutation-options).
171
+ * Generate a **full matching** key for [Mutation Options](https://orpc.dev/docs/integrations/tanstack-query#mutation-options).
131
172
  *
132
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
173
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
133
174
  */
134
175
  mutationKey(options?: Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>): DataTag<QueryKey, TOutput, TError>;
135
176
  /**
136
177
  * Generate options used for useMutation/...
137
178
  *
138
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
179
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
139
180
  */
140
181
  mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptions<TInput, TOutput, TError, UMutationContext>>;
141
182
  }
142
- interface CreateProcedureUtilsOptions {
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> {
143
249
  path: readonly string[];
250
+ experimental_defaults?: experimental_ProcedureUtilsDefaults<TClientContext, TInput, TOutput, TError>;
144
251
  }
145
- 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>;
146
253
 
147
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> : {
148
255
  [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
149
256
  } & GeneralUtils<unknown>;
150
- interface CreateRouterUtilsOptions {
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>> {
151
264
  path?: readonly string[];
265
+ experimental_defaults?: experimental_RouterUtilsDefaults<T>;
152
266
  }
153
267
  /**
154
268
  * Create a router utils from a client.
155
269
  *
156
270
  * @info Both client-side and server-side clients are supported.
157
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query Tanstack Query Integration}
271
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query Tanstack Query Integration}
158
272
  */
159
- 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>;
160
274
 
161
- export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
162
- export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, 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,14 +1,40 @@
1
1
  import { ClientContext, Client, NestedClient } from '@orpc/client';
2
- import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
3
- import { SkipToken, QueryKey, QueryObserverOptions, DataTag, QueryFunction, experimental_streamedQuery, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
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
- type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
7
- type OperationType = 'query' | 'streamed' | 'infinite' | 'mutation';
32
+ type experimental_LiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
33
+ type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
8
34
  type OperationKeyOptions<TType extends OperationType, TInput> = {
9
35
  type?: TType;
10
36
  input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
11
- fnOptions?: TType extends 'streamed' ? experimental_StreamedQueryOptions : never;
37
+ fnOptions?: TType extends 'streamed' ? experimental_SerializableStreamedQueryOptions : never;
12
38
  };
13
39
  type OperationKey<TType extends OperationType, TInput> = [path: readonly string[], options: OperationKeyOptions<TType, TInput>];
14
40
  declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
@@ -35,13 +61,13 @@ interface QueryOptionsBase<TOutput, TError> {
35
61
  queryFn: QueryFunction<TOutput>;
36
62
  throwOnError?: (error: TError) => boolean;
37
63
  retryDelay?: (count: number, error: TError) => number;
38
- enabled: boolean;
64
+ enabled?: boolean;
39
65
  }
40
66
  type experimental_StreamedKeyOptions<TInput> = QueryKeyOptions<TInput> & {
41
- queryFnOptions?: experimental_StreamedQueryOptions;
67
+ queryFnOptions?: experimental_SerializableStreamedQueryOptions;
42
68
  };
43
69
  type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & {
44
- queryFnOptions?: experimental_StreamedQueryOptions;
70
+ queryFnOptions?: experimental_SerializableStreamedQueryOptions;
45
71
  };
46
72
  interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
47
73
  }
@@ -58,7 +84,7 @@ interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
58
84
  select?(): InfiniteData<TOutput, TPageParam>;
59
85
  throwOnError?: (error: TError) => boolean;
60
86
  retryDelay?: (count: number, error: TError) => number;
61
- enabled: boolean;
87
+ enabled?: boolean;
62
88
  }
63
89
  type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
64
90
  context?: TClientContext;
@@ -74,7 +100,7 @@ interface GeneralUtils<TInput> {
74
100
  /**
75
101
  * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
76
102
  *
77
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
103
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
78
104
  */
79
105
  key<TType extends OperationType>(options?: OperationKeyOptions<TType, TInput>): OperationKey<TType, TInput>;
80
106
  }
@@ -86,77 +112,165 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
86
112
  /**
87
113
  * Calling corresponding procedure client
88
114
  *
89
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#calling-clients Tanstack Calling Procedure Client Docs}
115
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#calling-clients Tanstack Calling Procedure Client Docs}
90
116
  */
91
117
  call: Client<TClientContext, TInput, TOutput, TError>;
92
118
  /**
93
- * Generate a **full matching** key for [Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#query-options).
119
+ * Generate a **full matching** key for [Query Options](https://orpc.dev/docs/integrations/tanstack-query#query-options).
94
120
  *
95
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
121
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
96
122
  */
97
123
  queryKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, TOutput, TError>;
98
124
  /**
99
125
  * Generate options used for useQuery/useSuspenseQuery/prefetchQuery/...
100
126
  *
101
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
127
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
102
128
  */
103
129
  queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
104
130
  /**
105
- * Generate a **full matching** key for [Streamed Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options).
131
+ * Generate a **full matching** key for [Streamed Query Options](https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options).
106
132
  *
107
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
133
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
108
134
  */
109
135
  experimental_streamedKey(...rest: MaybeOptionalOptions<experimental_StreamedKeyOptions<TInput>>): DataTag<QueryKey, experimental_StreamedQueryOutput<TOutput>, TError>;
110
136
  /**
111
- * Generate [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) options used for useQuery/useSuspenseQuery/prefetchQuery/...
112
- * Built on top of [steamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
137
+ * Configure queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
138
+ * This is built on [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
139
+ * and works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
113
140
  *
114
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
141
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
115
142
  */
116
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>>;
117
144
  /**
118
- * Generate a **full matching** key for [Infinite Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options).
145
+ * Generate a **full matching** key for [Live Query Options](https://orpc.dev/docs/integrations/tanstack-query#live-query-options).
146
+ *
147
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
148
+ */
149
+ experimental_liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, experimental_LiveQueryOutput<TOutput>, TError>;
150
+ /**
151
+ * Configure live queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
152
+ * Unlike `.streamedOptions` which accumulates chunks, live queries replace the entire result with each new chunk received.
153
+ * Works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
119
154
  *
120
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
155
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
156
+ */
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>>;
158
+ /**
159
+ * Generate a **full matching** key for [Infinite Query Options](https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options).
160
+ *
161
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
121
162
  */
122
163
  infiniteKey<UPageParam>(options: Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, UPageParam>, UPageParam>, 'input' | 'initialPageParam' | 'queryKey'>): DataTag<QueryKey, InfiniteData<TOutput, UPageParam>, TError>;
123
164
  /**
124
165
  * Generate options used for useInfiniteQuery/useSuspenseInfiniteQuery/prefetchInfiniteQuery/...
125
166
  *
126
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
167
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
127
168
  */
128
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>>;
129
170
  /**
130
- * Generate a **full matching** key for [Mutation Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#mutation-options).
171
+ * Generate a **full matching** key for [Mutation Options](https://orpc.dev/docs/integrations/tanstack-query#mutation-options).
131
172
  *
132
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
173
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
133
174
  */
134
175
  mutationKey(options?: Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>): DataTag<QueryKey, TOutput, TError>;
135
176
  /**
136
177
  * Generate options used for useMutation/...
137
178
  *
138
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
179
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
139
180
  */
140
181
  mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptions<TInput, TOutput, TError, UMutationContext>>;
141
182
  }
142
- interface CreateProcedureUtilsOptions {
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> {
143
249
  path: readonly string[];
250
+ experimental_defaults?: experimental_ProcedureUtilsDefaults<TClientContext, TInput, TOutput, TError>;
144
251
  }
145
- 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>;
146
253
 
147
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> : {
148
255
  [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
149
256
  } & GeneralUtils<unknown>;
150
- interface CreateRouterUtilsOptions {
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>> {
151
264
  path?: readonly string[];
265
+ experimental_defaults?: experimental_RouterUtilsDefaults<T>;
152
266
  }
153
267
  /**
154
268
  * Create a router utils from a client.
155
269
  *
156
270
  * @info Both client-side and server-side clients are supported.
157
- * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query Tanstack Query Integration}
271
+ * @see {@link https://orpc.dev/docs/integrations/tanstack-query Tanstack Query Integration}
158
272
  */
159
- 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>;
160
274
 
161
- export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
162
- export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, 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 { isAsyncIteratorObject, toArray } from '@orpc/shared';
2
- import { skipToken, experimental_streamedQuery } from '@tanstack/query-core';
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, {
@@ -17,16 +17,94 @@ function createGeneralUtils(path) {
17
17
  };
18
18
  }
19
19
 
20
+ function experimental_liveQuery(queryFn) {
21
+ return async (context) => {
22
+ const stream = await queryFn(context);
23
+ let last;
24
+ for await (const chunk of stream) {
25
+ if (context.signal.aborted) {
26
+ throw context.signal.reason;
27
+ }
28
+ last = { chunk };
29
+ context.client.setQueryData(context.queryKey, chunk);
30
+ }
31
+ if (!last) {
32
+ throw new Error(
33
+ `Live query for ${stringifyJSON(context.queryKey)} did not yield any data. Ensure the query function returns an AsyncIterable with at least one chunk.`
34
+ );
35
+ }
36
+ return last.chunk;
37
+ };
38
+ }
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
+
20
96
  const OPERATION_CONTEXT_SYMBOL = Symbol("ORPC_OPERATION_CONTEXT");
21
97
 
22
98
  function createProcedureUtils(client, options) {
23
99
  const utils = {
24
100
  call: client,
25
101
  queryKey(...[optionsIn = {}]) {
102
+ optionsIn = { ...options.experimental_defaults?.queryKey, ...optionsIn };
26
103
  const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "query", input: optionsIn.input });
27
104
  return queryKey;
28
105
  },
29
106
  queryOptions(...[optionsIn = {}]) {
107
+ optionsIn = { ...options.experimental_defaults?.queryOptions, ...optionsIn };
30
108
  const queryKey = utils.queryKey(optionsIn);
31
109
  return {
32
110
  queryFn: ({ signal }) => {
@@ -44,21 +122,22 @@ function createProcedureUtils(client, options) {
44
122
  }
45
123
  });
46
124
  },
47
- enabled: optionsIn.input !== skipToken,
125
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
48
126
  ...optionsIn,
49
127
  queryKey
50
128
  };
51
129
  },
52
130
  experimental_streamedKey(...[optionsIn = {}]) {
131
+ optionsIn = { ...options.experimental_defaults?.experimental_streamedKey, ...optionsIn };
53
132
  const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "streamed", input: optionsIn.input, fnOptions: optionsIn.queryFnOptions });
54
133
  return queryKey;
55
134
  },
56
135
  experimental_streamedOptions(...[optionsIn = {}]) {
136
+ optionsIn = { ...options.experimental_defaults?.experimental_streamedOptions, ...optionsIn };
57
137
  const queryKey = utils.experimental_streamedKey(optionsIn);
58
138
  return {
59
- enabled: optionsIn.input !== skipToken,
60
- queryFn: experimental_streamedQuery({
61
- queryFn: async ({ signal }) => {
139
+ queryFn: experimental_serializableStreamedQuery(
140
+ async ({ signal }) => {
62
141
  if (optionsIn.input === skipToken) {
63
142
  throw new Error("queryFn should not be called with skipToken used as input");
64
143
  }
@@ -77,13 +156,48 @@ function createProcedureUtils(client, options) {
77
156
  }
78
157
  return output;
79
158
  },
80
- ...optionsIn.queryFnOptions
159
+ optionsIn.queryFnOptions
160
+ ),
161
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
162
+ ...optionsIn,
163
+ queryKey
164
+ };
165
+ },
166
+ experimental_liveKey(...[optionsIn = {}]) {
167
+ optionsIn = { ...options.experimental_defaults?.experimental_liveKey, ...optionsIn };
168
+ const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "live", input: optionsIn.input });
169
+ return queryKey;
170
+ },
171
+ experimental_liveOptions(...[optionsIn = {}]) {
172
+ optionsIn = { ...options.experimental_defaults?.experimental_liveOptions, ...optionsIn };
173
+ const queryKey = utils.experimental_liveKey(optionsIn);
174
+ return {
175
+ queryFn: experimental_liveQuery(async ({ signal }) => {
176
+ if (optionsIn.input === skipToken) {
177
+ throw new Error("queryFn should not be called with skipToken used as input");
178
+ }
179
+ const output = await client(optionsIn.input, {
180
+ signal,
181
+ context: {
182
+ [OPERATION_CONTEXT_SYMBOL]: {
183
+ key: queryKey,
184
+ type: "live"
185
+ },
186
+ ...optionsIn.context
187
+ }
188
+ });
189
+ if (!isAsyncIteratorObject(output)) {
190
+ throw new Error("liveQuery requires an event iterator output");
191
+ }
192
+ return output;
81
193
  }),
194
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
82
195
  ...optionsIn,
83
196
  queryKey
84
197
  };
85
198
  },
86
199
  infiniteKey(optionsIn) {
200
+ optionsIn = { ...options.experimental_defaults?.infiniteKey, ...optionsIn };
87
201
  const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, {
88
202
  type: "infinite",
89
203
  input: optionsIn.input === skipToken ? skipToken : optionsIn.input(optionsIn.initialPageParam)
@@ -91,6 +205,7 @@ function createProcedureUtils(client, options) {
91
205
  return queryKey;
92
206
  },
93
207
  infiniteOptions(optionsIn) {
208
+ optionsIn = { ...options.experimental_defaults?.infiniteOptions, ...optionsIn };
94
209
  const queryKey = utils.infiniteKey(optionsIn);
95
210
  return {
96
211
  queryFn: ({ pageParam, signal }) => {
@@ -108,16 +223,18 @@ function createProcedureUtils(client, options) {
108
223
  }
109
224
  });
110
225
  },
111
- enabled: optionsIn.input !== skipToken,
226
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
112
227
  ...optionsIn,
113
228
  queryKey
114
229
  };
115
230
  },
116
231
  mutationKey(...[optionsIn = {}]) {
232
+ optionsIn = { ...options.experimental_defaults?.mutationKey, ...optionsIn };
117
233
  const mutationKey = optionsIn.mutationKey ?? generateOperationKey(options.path, { type: "mutation" });
118
234
  return mutationKey;
119
235
  },
120
236
  mutationOptions(...[optionsIn = {}]) {
237
+ optionsIn = { ...options.experimental_defaults?.mutationOptions, ...optionsIn };
121
238
  const mutationKey = utils.mutationKey(optionsIn);
122
239
  return {
123
240
  mutationFn: (input) => client(input, {
@@ -140,7 +257,10 @@ function createProcedureUtils(client, options) {
140
257
  function createRouterUtils(client, options = {}) {
141
258
  const path = toArray(options.path);
142
259
  const generalUtils = createGeneralUtils(path);
143
- const procedureUtils = createProcedureUtils(client, { path });
260
+ const procedureUtils = createProcedureUtils(client, {
261
+ path,
262
+ experimental_defaults: options.experimental_defaults
263
+ });
144
264
  const recursive = new Proxy({
145
265
  ...generalUtils,
146
266
  ...procedureUtils
@@ -150,7 +270,11 @@ function createRouterUtils(client, options = {}) {
150
270
  if (typeof prop !== "string") {
151
271
  return value;
152
272
  }
153
- const nextUtils = createRouterUtils(client[prop], { ...options, path: [...path, prop] });
273
+ const nextUtils = createRouterUtils(client[prop], {
274
+ ...options,
275
+ path: [...path, prop],
276
+ experimental_defaults: get(options.experimental_defaults, [prop])
277
+ });
154
278
  if (typeof value !== "function") {
155
279
  return nextUtils;
156
280
  }
@@ -164,4 +288,4 @@ function createRouterUtils(client, options = {}) {
164
288
  return recursive;
165
289
  }
166
290
 
167
- 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.e82d760",
4
+ "version": "0.0.0-next.e8416db",
5
5
  "license": "MIT",
6
- "homepage": "https://orpc.unnoq.com",
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.e82d760"
28
+ "@orpc/client": "0.0.0-next.e8416db"
29
29
  },
30
30
  "dependencies": {
31
- "@orpc/shared": "0.0.0-next.e82d760"
31
+ "@orpc/shared": "0.0.0-next.e8416db"
32
32
  },
33
33
  "devDependencies": {
34
- "@angular/core": "^20.0.5",
35
- "@tanstack/angular-query-experimental": "^5.80.10",
36
- "@tanstack/query-core": "^5.80.10",
37
- "@tanstack/react-query": "^5.80.10",
38
- "@tanstack/solid-query": "^5.80.10",
39
- "@tanstack/svelte-query": "^5.81.3",
40
- "@tanstack/vue-query": "^5.81.3",
41
- "svelte": "^5.34.8",
42
- "vue": "^3.5.17",
43
- "zod": "^3.25.67"
34
+ "@angular/core": "^20.3.12",
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",