@orpc/tanstack-query 0.0.0-next.bb23f2f → 0.0.0-next.bbe55b7

package/README.md

@@ -17,6 +17,9 @@
   <a href="https://discord.gg/TXEbwRBvQn">
     <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
   </a>
+  <a href="https://deepwiki.com/unnoq/orpc">
+    <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
+  </a>
 </div>
 
 <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
@@ -30,7 +33,8 @@
 - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
 - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
 - **📝 Contract-First Development**: Optionally define your API contract before implementation.
-- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
+- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
 - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
 - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
 - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -38,7 +42,6 @@
 - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
 - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
 - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
-- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 
@@ -50,9 +53,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
 - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
 - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
+- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
 - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
 - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
 - [@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

@@ -1,15 +1,40 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
-import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
-import { SkipToken, QueryKey, QueryObserverOptions, DataTag, QueryFunction, experimental_streamedQuery, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
+import { Promisable, SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
+import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, DataTag, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
+
+interface experimental_SerializableStreamedQueryOptions {
+    /**
+     * Determines how data is handled when the query is refetched.
+     *
+     * - `'reset'`: Clears existing data and sets the query back to a pending state.
+     * - `'append'`: Appends new data chunks to the existing data.
+     * - `'replace'`: Collects all streamed data and replaces the cache once the stream finishes.
+     *
+     * @default 'reset'
+     */
+    refetchMode?: 'append' | 'reset' | 'replace';
+    /**
+     * Limits the number of data chunks stored in the query result.
+     * Older chunks are removed when the limit is reached.
+     *
+     * @default Number.POSITIVE_INFINITY (unlimited)
+     */
+    maxChunks?: number;
+}
+/**
+ * A variant of `streamedQuery` where:
+ * - Options are serializable
+ * - The output is predictable
+ */
+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>;
 
 type experimental_StreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type experimental_LiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
-type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
 type OperationKeyOptions<TType extends OperationType, TInput> = {
     type?: TType;
     input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
-    fnOptions?: TType extends 'streamed' ? experimental_StreamedQueryOptions : never;
+    fnOptions?: TType extends 'streamed' ? experimental_SerializableStreamedQueryOptions : never;
 };
 type OperationKey<TType extends OperationType, TInput> = [path: readonly string[], options: OperationKeyOptions<TType, TInput>];
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
@@ -36,13 +61,13 @@ interface QueryOptionsBase<TOutput, TError> {
     queryFn: QueryFunction<TOutput>;
     throwOnError?: (error: TError) => boolean;
     retryDelay?: (count: number, error: TError) => number;
-    enabled: boolean;
+    enabled?: boolean;
 }
 type experimental_StreamedKeyOptions<TInput> = QueryKeyOptions<TInput> & {
-    queryFnOptions?: experimental_StreamedQueryOptions;
+    queryFnOptions?: experimental_SerializableStreamedQueryOptions;
 };
 type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & {
-    queryFnOptions?: experimental_StreamedQueryOptions;
+    queryFnOptions?: experimental_SerializableStreamedQueryOptions;
 };
 interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
 }
@@ -59,7 +84,7 @@ interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
     select?(): InfiniteData<TOutput, TPageParam>;
     throwOnError?: (error: TError) => boolean;
     retryDelay?: (count: number, error: TError) => number;
-    enabled: boolean;
+    enabled?: boolean;
 }
 type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
     context?: TClientContext;
@@ -174,5 +199,5 @@ interface CreateRouterUtilsOptions {
  */
 declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
 
-export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
-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 };
+export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, experimental_serializableStreamedQuery, generateOperationKey };
+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

@@ -1,15 +1,40 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
-import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
-import { SkipToken, QueryKey, QueryObserverOptions, DataTag, QueryFunction, experimental_streamedQuery, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
+import { Promisable, SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
+import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, DataTag, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
+
+interface experimental_SerializableStreamedQueryOptions {
+    /**
+     * Determines how data is handled when the query is refetched.
+     *
+     * - `'reset'`: Clears existing data and sets the query back to a pending state.
+     * - `'append'`: Appends new data chunks to the existing data.
+     * - `'replace'`: Collects all streamed data and replaces the cache once the stream finishes.
+     *
+     * @default 'reset'
+     */
+    refetchMode?: 'append' | 'reset' | 'replace';
+    /**
+     * Limits the number of data chunks stored in the query result.
+     * Older chunks are removed when the limit is reached.
+     *
+     * @default Number.POSITIVE_INFINITY (unlimited)
+     */
+    maxChunks?: number;
+}
+/**
+ * A variant of `streamedQuery` where:
+ * - Options are serializable
+ * - The output is predictable
+ */
+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>;
 
 type experimental_StreamedQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type experimental_LiveQueryOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
-type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
 type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
 type OperationKeyOptions<TType extends OperationType, TInput> = {
     type?: TType;
     input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
-    fnOptions?: TType extends 'streamed' ? experimental_StreamedQueryOptions : never;
+    fnOptions?: TType extends 'streamed' ? experimental_SerializableStreamedQueryOptions : never;
 };
 type OperationKey<TType extends OperationType, TInput> = [path: readonly string[], options: OperationKeyOptions<TType, TInput>];
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
@@ -36,13 +61,13 @@ interface QueryOptionsBase<TOutput, TError> {
     queryFn: QueryFunction<TOutput>;
     throwOnError?: (error: TError) => boolean;
     retryDelay?: (count: number, error: TError) => number;
-    enabled: boolean;
+    enabled?: boolean;
 }
 type experimental_StreamedKeyOptions<TInput> = QueryKeyOptions<TInput> & {
-    queryFnOptions?: experimental_StreamedQueryOptions;
+    queryFnOptions?: experimental_SerializableStreamedQueryOptions;
 };
 type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & {
-    queryFnOptions?: experimental_StreamedQueryOptions;
+    queryFnOptions?: experimental_SerializableStreamedQueryOptions;
 };
 interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
 }
@@ -59,7 +84,7 @@ interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
     select?(): InfiniteData<TOutput, TPageParam>;
     throwOnError?: (error: TError) => boolean;
     retryDelay?: (count: number, error: TError) => number;
-    enabled: boolean;
+    enabled?: boolean;
 }
 type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
     context?: TClientContext;
@@ -174,5 +199,5 @@ interface CreateRouterUtilsOptions {
  */
 declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
 
-export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
-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 };
+export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, experimental_serializableStreamedQuery, generateOperationKey };
+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

@@ -1,5 +1,5 @@
 import { stringifyJSON, isAsyncIteratorObject, toArray } from '@orpc/shared';
-import { skipToken, experimental_streamedQuery } from '@tanstack/query-core';
+import { skipToken } from '@tanstack/query-core';
 
 function generateOperationKey(path, state = {}) {
   return [path, {
@@ -23,7 +23,7 @@ function experimental_liveQuery(queryFn) {
     let last;
     for await (const chunk of stream) {
       if (context.signal.aborted) {
-        break;
+        throw context.signal.reason;
       }
       last = { chunk };
       context.client.setQueryData(context.queryKey, chunk);
@@ -37,6 +37,62 @@ function experimental_liveQuery(queryFn) {
   };
 }
 
+function experimental_serializableStreamedQuery(queryFn, { refetchMode = "reset", maxChunks = Number.POSITIVE_INFINITY } = {}) {
+  return async (context) => {
+    const query = context.client.getQueryCache().find({ queryKey: context.queryKey, exact: true });
+    const hasPreviousData = !!query && query.state.data !== void 0;
+    if (hasPreviousData) {
+      if (refetchMode === "reset") {
+        query.setState({
+          status: "pending",
+          data: void 0,
+          error: null,
+          fetchStatus: "fetching"
+        });
+      } else {
+        context.client.setQueryData(
+          context.queryKey,
+          (prev = []) => limitArraySize(prev, maxChunks)
+        );
+      }
+    }
+    let result = [];
+    const stream = await queryFn(context);
+    const shouldUpdateCacheDuringStream = !hasPreviousData || refetchMode !== "replace";
+    context.client.setQueryData(
+      context.queryKey,
+      (prev = []) => limitArraySize(prev, maxChunks)
+    );
+    for await (const chunk of stream) {
+      if (context.signal.aborted) {
+        throw context.signal.reason;
+      }
+      result.push(chunk);
+      result = limitArraySize(result, maxChunks);
+      if (shouldUpdateCacheDuringStream) {
+        context.client.setQueryData(
+          context.queryKey,
+          (prev = []) => limitArraySize([...prev, chunk], maxChunks)
+        );
+      }
+    }
+    if (!shouldUpdateCacheDuringStream) {
+      context.client.setQueryData(context.queryKey, result);
+    }
+    const cachedData = context.client.getQueryData(context.queryKey);
+    if (cachedData) {
+      return limitArraySize(cachedData, maxChunks);
+    }
+    return result;
+  };
+}
+function limitArraySize(items, maxSize) {
+  if (items.length <= maxSize) {
+    return items;
+  }
+  return items.slice(items.length - maxSize);
+}
+
 const OPERATION_CONTEXT_SYMBOL = Symbol("ORPC_OPERATION_CONTEXT");
 
 function createProcedureUtils(client, options) {
@@ -64,7 +120,7 @@ function createProcedureUtils(client, options) {
             }
           });
         },
-        enabled: optionsIn.input !== skipToken,
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
         ...optionsIn,
         queryKey
       };
@@ -76,9 +132,8 @@ function createProcedureUtils(client, options) {
     experimental_streamedOptions(...[optionsIn = {}]) {
       const queryKey = utils.experimental_streamedKey(optionsIn);
       return {
-        enabled: optionsIn.input !== skipToken,
-        queryFn: experimental_streamedQuery({
-          queryFn: async ({ signal }) => {
+        queryFn: experimental_serializableStreamedQuery(
+          async ({ signal }) => {
             if (optionsIn.input === skipToken) {
               throw new Error("queryFn should not be called with skipToken used as input");
             }
@@ -97,8 +152,9 @@ function createProcedureUtils(client, options) {
             }
             return output;
           },
-          ...optionsIn.queryFnOptions
-        }),
+          optionsIn.queryFnOptions
+        ),
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
         ...optionsIn,
         queryKey
       };
@@ -110,7 +166,6 @@ function createProcedureUtils(client, options) {
     experimental_liveOptions(...[optionsIn = {}]) {
       const queryKey = utils.experimental_liveKey(optionsIn);
       return {
-        enabled: optionsIn.input !== skipToken,
         queryFn: experimental_liveQuery(async ({ signal }) => {
           if (optionsIn.input === skipToken) {
             throw new Error("queryFn should not be called with skipToken used as input");
@@ -130,6 +185,7 @@ function createProcedureUtils(client, options) {
           }
           return output;
         }),
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
         ...optionsIn,
         queryKey
       };
@@ -159,7 +215,7 @@ function createProcedureUtils(client, options) {
             }
           });
         },
-        enabled: optionsIn.input !== skipToken,
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
         ...optionsIn,
         queryKey
       };
@@ -215,4 +271,4 @@ function createRouterUtils(client, options = {}) {
   return recursive;
 }
 
-export { OPERATION_CONTEXT_SYMBOL, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createGeneralUtils, createProcedureUtils, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey };
+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

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/tanstack-query",
   "type": "module",
-  "version": "0.0.0-next.bb23f2f",
+  "version": "0.0.0-next.bbe55b7",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -25,22 +25,22 @@
   ],
   "peerDependencies": {
     "@tanstack/query-core": ">=5.80.2",
-    "@orpc/client": "0.0.0-next.bb23f2f"
+    "@orpc/client": "0.0.0-next.bbe55b7"
   },
   "dependencies": {
-    "@orpc/shared": "0.0.0-next.bb23f2f"
+    "@orpc/shared": "0.0.0-next.bbe55b7"
   },
   "devDependencies": {
-    "@angular/core": "^20.0.6",
-    "@tanstack/angular-query-experimental": "^5.81.5",
-    "@tanstack/query-core": "^5.81.5",
-    "@tanstack/react-query": "^5.81.5",
-    "@tanstack/solid-query": "^5.81.5",
-    "@tanstack/svelte-query": "^5.81.5",
-    "@tanstack/vue-query": "^5.81.5",
-    "svelte": "^5.35.4",
-    "vue": "^3.5.17",
-    "zod": "^3.25.76"
+    "@angular/core": "^20.3.10",
+    "@tanstack/angular-query-experimental": "^5.90.9",
+    "@tanstack/query-core": "^5.90.7",
+    "@tanstack/react-query": "^5.90.7",
+    "@tanstack/solid-query": "^5.90.10",
+    "@tanstack/svelte-query": "^6.0.5",
+    "@tanstack/vue-query": "^5.90.7",
+    "svelte": "^5.43.5",
+    "vue": "^3.5.24",
+    "zod": "^4.1.12"
   },
   "scripts": {
     "build": "unbuild",