@orpc/tanstack-query 0.0.0-next.02cdb0f → 0.0.0-next.06aad3a

package/README.md

@@ -30,7 +30,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 +39,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 +50,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

@@ -3,8 +3,9 @@ import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
 import { SkipToken, QueryKey, QueryObserverOptions, DataTag, QueryFunction, experimental_streamedQuery, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
 
 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' | 'infinite' | 'mutation';
+type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
 type OperationKeyOptions<TType extends OperationType, TInput> = {
     type?: TType;
     input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
@@ -35,7 +36,7 @@ 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;
@@ -58,7 +59,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;
@@ -108,12 +109,27 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
      */
     experimental_streamedKey(...rest: MaybeOptionalOptions<experimental_StreamedKeyOptions<TInput>>): DataTag<QueryKey, experimental_StreamedQueryOutput<TOutput>, TError>;
     /**
-     * Generate [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) options used for useQuery/useSuspenseQuery/prefetchQuery/...
-     * Built on top of [steamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
+     * Configure queries for [Event Iterator](https://orpc.unnoq.com/docs/event-iterator).
+     * This is built on [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
+     * and works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
      *
      * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
      */
     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>>;
+    /**
+     * Generate a **full matching** key for [Live Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options).
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    experimental_liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, experimental_LiveQueryOutput<TOutput>, TError>;
+    /**
+     * Configure live queries for [Event Iterator](https://orpc.unnoq.com/docs/event-iterator).
+     * Unlike `.streamedOptions` which accumulates chunks, live queries replace the entire result with each new chunk received.
+     * Works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
+     */
+    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>>;
     /**
      * Generate a **full matching** key for [Infinite Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options).
      *
@@ -159,4 +175,4 @@ 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_StreamedKeyOptions, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, experimental_StreamedQueryOutput };
+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 };

package/dist/index.d.ts

@@ -3,8 +3,9 @@ import { SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
 import { SkipToken, QueryKey, QueryObserverOptions, DataTag, QueryFunction, experimental_streamedQuery, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
 
 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' | 'infinite' | 'mutation';
+type OperationType = 'query' | 'streamed' | 'live' | 'infinite' | 'mutation';
 type OperationKeyOptions<TType extends OperationType, TInput> = {
     type?: TType;
     input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
@@ -35,7 +36,7 @@ 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;
@@ -58,7 +59,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;
@@ -108,12 +109,27 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
      */
     experimental_streamedKey(...rest: MaybeOptionalOptions<experimental_StreamedKeyOptions<TInput>>): DataTag<QueryKey, experimental_StreamedQueryOutput<TOutput>, TError>;
     /**
-     * Generate [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) options used for useQuery/useSuspenseQuery/prefetchQuery/...
-     * Built on top of [steamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
+     * Configure queries for [Event Iterator](https://orpc.unnoq.com/docs/event-iterator).
+     * This is built on [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
+     * and works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
      *
      * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
      */
     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>>;
+    /**
+     * Generate a **full matching** key for [Live Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options).
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    experimental_liveKey(...rest: MaybeOptionalOptions<QueryKeyOptions<TInput>>): DataTag<QueryKey, experimental_LiveQueryOutput<TOutput>, TError>;
+    /**
+     * Configure live queries for [Event Iterator](https://orpc.unnoq.com/docs/event-iterator).
+     * Unlike `.streamedOptions` which accumulates chunks, live queries replace the entire result with each new chunk received.
+     * Works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
+     */
+    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>>;
     /**
      * Generate a **full matching** key for [Infinite Query Options](https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options).
      *
@@ -159,4 +175,4 @@ 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_StreamedKeyOptions, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, experimental_StreamedQueryOutput };
+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 };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { isAsyncIteratorObject, toArray } from '@orpc/shared';
+import { stringifyJSON, isAsyncIteratorObject, toArray } from '@orpc/shared';
 import { skipToken, experimental_streamedQuery } from '@tanstack/query-core';
 
 function generateOperationKey(path, state = {}) {
@@ -17,6 +17,26 @@ function createGeneralUtils(path) {
   };
 }
 
+function experimental_liveQuery(queryFn) {
+  return async (context) => {
+    const stream = await queryFn(context);
+    let last;
+    for await (const chunk of stream) {
+      if (context.signal.aborted) {
+        break;
+      }
+      last = { chunk };
+      context.client.setQueryData(context.queryKey, chunk);
+    }
+    if (!last) {
+      throw new Error(
+        `Live query for ${stringifyJSON(context.queryKey)} did not yield any data. Ensure the query function returns an AsyncIterable with at least one chunk.`
+      );
+    }
+    return last.chunk;
+  };
+}
+
 const OPERATION_CONTEXT_SYMBOL = Symbol("ORPC_OPERATION_CONTEXT");
 
 function createProcedureUtils(client, options) {
@@ -44,7 +64,7 @@ function createProcedureUtils(client, options) {
             }
           });
         },
-        enabled: optionsIn.input !== skipToken,
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
         ...optionsIn,
         queryKey
       };
@@ -56,7 +76,6 @@ function createProcedureUtils(client, options) {
     experimental_streamedOptions(...[optionsIn = {}]) {
       const queryKey = utils.experimental_streamedKey(optionsIn);
       return {
-        enabled: optionsIn.input !== skipToken,
         queryFn: experimental_streamedQuery({
           queryFn: async ({ signal }) => {
             if (optionsIn.input === skipToken) {
@@ -79,6 +98,38 @@ function createProcedureUtils(client, options) {
           },
           ...optionsIn.queryFnOptions
         }),
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
+        ...optionsIn,
+        queryKey
+      };
+    },
+    experimental_liveKey(...[optionsIn = {}]) {
+      const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "live", input: optionsIn.input });
+      return queryKey;
+    },
+    experimental_liveOptions(...[optionsIn = {}]) {
+      const queryKey = utils.experimental_liveKey(optionsIn);
+      return {
+        queryFn: experimental_liveQuery(async ({ signal }) => {
+          if (optionsIn.input === skipToken) {
+            throw new Error("queryFn should not be called with skipToken used as input");
+          }
+          const output = await client(optionsIn.input, {
+            signal,
+            context: {
+              [OPERATION_CONTEXT_SYMBOL]: {
+                key: queryKey,
+                type: "live"
+              },
+              ...optionsIn.context
+            }
+          });
+          if (!isAsyncIteratorObject(output)) {
+            throw new Error("liveQuery requires an event iterator output");
+          }
+          return output;
+        }),
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
         ...optionsIn,
         queryKey
       };
@@ -108,7 +159,7 @@ function createProcedureUtils(client, options) {
             }
           });
         },
-        enabled: optionsIn.input !== skipToken,
+        ...optionsIn.input === skipToken ? { enabled: false } : {},
         ...optionsIn,
         queryKey
       };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/tanstack-query",
   "type": "module",
-  "version": "0.0.0-next.02cdb0f",
+  "version": "0.0.0-next.06aad3a",
   "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.02cdb0f"
+    "@orpc/client": "0.0.0-next.06aad3a"
   },
   "dependencies": {
-    "@orpc/shared": "0.0.0-next.02cdb0f"
+    "@orpc/shared": "0.0.0-next.06aad3a"
   },
   "devDependencies": {
-    "@angular/core": "^20.0.4",
-    "@tanstack/angular-query-experimental": "^5.80.10",
-    "@tanstack/query-core": "^5.80.10",
-    "@tanstack/react-query": "^5.80.10",
-    "@tanstack/solid-query": "^5.80.10",
-    "@tanstack/svelte-query": "^5.80.10",
-    "@tanstack/vue-query": "^5.80.10",
-    "svelte": "^5.34.7",
-    "vue": "^3.5.17",
-    "zod": "^3.25.67"
+    "@angular/core": "^20.2.3",
+    "@tanstack/angular-query-experimental": "^5.85.9",
+    "@tanstack/query-core": "^5.85.9",
+    "@tanstack/react-query": "^5.85.9",
+    "@tanstack/solid-query": "^5.85.9",
+    "@tanstack/svelte-query": "^5.85.9",
+    "@tanstack/vue-query": "^5.85.9",
+    "svelte": "^5.38.6",
+    "vue": "^3.5.21",
+    "zod": "^4.1.5"
   },
   "scripts": {
     "build": "unbuild",