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

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 +7 -2
  2. package/dist/index.d.mts +54 -13
  3. package/dist/index.d.ts +54 -13
  4. package/dist/index.mjs +103 -9
  5. package/package.json +13 -13
package/README.md CHANGED
@@ -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,7 +42,6 @@
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
 
@@ -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, DataTag, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } 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;
@@ -108,12 +134,27 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
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.unnoq.com/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
141
  * @see {@link https://orpc.unnoq.com/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>>;
144
+ /**
145
+ * Generate a **full matching** key for [Live Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options).
146
+ *
147
+ * @see {@link https://orpc.unnoq.com/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.unnoq.com/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`.
154
+ *
155
+ * @see {@link https://orpc.unnoq.com/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>>;
117
158
  /**
118
159
  * Generate a **full matching** key for [Infinite Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options).
119
160
  *
@@ -158,5 +199,5 @@ interface CreateRouterUtilsOptions {
158
199
  */
159
200
  declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
160
201
 
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 };
202
+ export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, experimental_serializableStreamedQuery, generateOperationKey };
203
+ export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, experimental_LiveQueryOutput, 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, DataTag, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } 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;
@@ -108,12 +134,27 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
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.unnoq.com/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
141
  * @see {@link https://orpc.unnoq.com/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>>;
144
+ /**
145
+ * Generate a **full matching** key for [Live Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options).
146
+ *
147
+ * @see {@link https://orpc.unnoq.com/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.unnoq.com/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`.
154
+ *
155
+ * @see {@link https://orpc.unnoq.com/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>>;
117
158
  /**
118
159
  * Generate a **full matching** key for [Infinite Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options).
119
160
  *
@@ -158,5 +199,5 @@ interface CreateRouterUtilsOptions {
158
199
  */
159
200
  declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
160
201
 
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 };
202
+ export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, experimental_serializableStreamedQuery, generateOperationKey };
203
+ export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, OperationContext, OperationKey, OperationKeyOptions, OperationType, ProcedureUtils, QueryKeyOptions, QueryOptionsBase, QueryOptionsIn, RouterUtils, OperationContext as TanstackQueryOperationContext, experimental_LiveQueryOutput, 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 } from '@orpc/shared';
2
+ import { skipToken } from '@tanstack/query-core';
3
3
 
4
4
  function generateOperationKey(path, state = {}) {
5
5
  return [path, {
@@ -17,6 +17,69 @@ 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 isRefetch = !!query && query.state.data !== void 0;
44
+ if (isRefetch && refetchMode === "reset") {
45
+ query.setState({
46
+ status: "pending",
47
+ data: void 0,
48
+ error: null,
49
+ fetchStatus: "fetching"
50
+ });
51
+ }
52
+ let result = [];
53
+ const stream = await queryFn(context);
54
+ for await (const chunk of stream) {
55
+ if (context.signal.aborted) {
56
+ throw context.signal.reason;
57
+ }
58
+ if (!isRefetch || refetchMode !== "replace") {
59
+ context.client.setQueryData(
60
+ context.queryKey,
61
+ (prev = []) => {
62
+ return addToEnd(prev, chunk, maxChunks);
63
+ }
64
+ );
65
+ }
66
+ result = addToEnd(result, chunk, maxChunks);
67
+ }
68
+ if (isRefetch && refetchMode === "replace") {
69
+ context.client.setQueryData(context.queryKey, result);
70
+ }
71
+ const currentResult = context.client.getQueryData(context.queryKey);
72
+ if (!Array.isArray(currentResult)) {
73
+ return result;
74
+ }
75
+ return currentResult;
76
+ };
77
+ }
78
+ function addToEnd(items, item, max) {
79
+ const newItems = [...items, item];
80
+ return newItems.length > max ? newItems.slice(newItems.length - max) : newItems;
81
+ }
82
+
20
83
  const OPERATION_CONTEXT_SYMBOL = Symbol("ORPC_OPERATION_CONTEXT");
21
84
 
22
85
  function createProcedureUtils(client, options) {
@@ -44,7 +107,7 @@ function createProcedureUtils(client, options) {
44
107
  }
45
108
  });
46
109
  },
47
- enabled: optionsIn.input !== skipToken,
110
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
48
111
  ...optionsIn,
49
112
  queryKey
50
113
  };
@@ -56,9 +119,8 @@ function createProcedureUtils(client, options) {
56
119
  experimental_streamedOptions(...[optionsIn = {}]) {
57
120
  const queryKey = utils.experimental_streamedKey(optionsIn);
58
121
  return {
59
- enabled: optionsIn.input !== skipToken,
60
- queryFn: experimental_streamedQuery({
61
- queryFn: async ({ signal }) => {
122
+ queryFn: experimental_serializableStreamedQuery(
123
+ async ({ signal }) => {
62
124
  if (optionsIn.input === skipToken) {
63
125
  throw new Error("queryFn should not be called with skipToken used as input");
64
126
  }
@@ -77,8 +139,40 @@ function createProcedureUtils(client, options) {
77
139
  }
78
140
  return output;
79
141
  },
80
- ...optionsIn.queryFnOptions
142
+ optionsIn.queryFnOptions
143
+ ),
144
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
145
+ ...optionsIn,
146
+ queryKey
147
+ };
148
+ },
149
+ experimental_liveKey(...[optionsIn = {}]) {
150
+ const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "live", input: optionsIn.input });
151
+ return queryKey;
152
+ },
153
+ experimental_liveOptions(...[optionsIn = {}]) {
154
+ const queryKey = utils.experimental_liveKey(optionsIn);
155
+ return {
156
+ queryFn: experimental_liveQuery(async ({ signal }) => {
157
+ if (optionsIn.input === skipToken) {
158
+ throw new Error("queryFn should not be called with skipToken used as input");
159
+ }
160
+ const output = await client(optionsIn.input, {
161
+ signal,
162
+ context: {
163
+ [OPERATION_CONTEXT_SYMBOL]: {
164
+ key: queryKey,
165
+ type: "live"
166
+ },
167
+ ...optionsIn.context
168
+ }
169
+ });
170
+ if (!isAsyncIteratorObject(output)) {
171
+ throw new Error("liveQuery requires an event iterator output");
172
+ }
173
+ return output;
81
174
  }),
175
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
82
176
  ...optionsIn,
83
177
  queryKey
84
178
  };
@@ -108,7 +202,7 @@ function createProcedureUtils(client, options) {
108
202
  }
109
203
  });
110
204
  },
111
- enabled: optionsIn.input !== skipToken,
205
+ ...optionsIn.input === skipToken ? { enabled: false } : {},
112
206
  ...optionsIn,
113
207
  queryKey
114
208
  };
@@ -164,4 +258,4 @@ function createRouterUtils(client, options = {}) {
164
258
  return recursive;
165
259
  }
166
260
 
167
- export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
261
+ 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,7 +1,7 @@
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.e91d2fd",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -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.e91d2fd"
29
29
  },
30
30
  "dependencies": {
31
- "@orpc/shared": "0.0.0-next.e82d760"
31
+ "@orpc/shared": "0.0.0-next.e91d2fd"
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.6",
35
+ "@tanstack/angular-query-experimental": "^5.90.5",
36
+ "@tanstack/query-core": "^5.90.5",
37
+ "@tanstack/react-query": "^5.90.5",
38
+ "@tanstack/solid-query": "^5.90.6",
39
+ "@tanstack/svelte-query": "^6.0.3",
40
+ "@tanstack/vue-query": "^5.90.5",
41
+ "svelte": "^5.40.2",
42
+ "vue": "^3.5.22",
43
+ "zod": "^4.1.12"
44
44
  },
45
45
  "scripts": {
46
46
  "build": "unbuild",