@orpc/tanstack-query 2.0.0-beta.3 → 2.0.0-beta.30

package/dist/index.mjs

@@ -1,16 +1,8 @@
-import { getPathMeta } from '@orpc/contract';
-import { sortPlugins, stringifyJSON, resolveMaybeOptionalOptions, intercept, toArray, isAsyncIteratorObject, bindMethods, getOrBind, get, isTypescriptObject } from '@orpc/shared';
+import { resolveBasePathMeta, getRouterContract, ProcedureContract } from '@orpc/contract';
+import { sortPlugins, stringifyJSON, resolveMaybeOptionalOptions, intercept, toArray, isAsyncIteratorObject, isTypescriptObject, bindMethods, get } from '@orpc/shared';
 import { RECURSIVE_CLIENT_UNWRAP_KEYS } from '@orpc/client';
 import { skipToken } from '@tanstack/query-core';
 
-function generateOperationKey(path, state = {}) {
-  return [path, {
-    ...state.input !== void 0 ? { input: state.input } : {},
-    ...state.type !== void 0 ? { type: state.type } : {},
-    ...state.fnOptions !== void 0 ? { fnOptions: state.fnOptions } : {}
-  }];
-}
-
 class CompositeRouterUtilsPlugin {
   constructor(plugins = []) {
     this.plugins = plugins;
@@ -35,6 +27,18 @@ class CompositeRouterUtilsPlugin {
   }
 }
 
+function generateOperationKey(path, options = {}) {
+  return [
+    ...options.prefix !== void 0 ? [options.prefix] : [],
+    path,
+    {
+      ...options.input !== void 0 ? { input: options.input } : {},
+      ...options.type !== void 0 ? { type: options.type } : {},
+      ...options.fnOptions !== void 0 ? { fnOptions: options.fnOptions } : {}
+    }
+  ];
+}
+
 function liveQuery(queryFn) {
   return async (context) => {
     const stream = await queryFn(context);
@@ -53,6 +57,19 @@ function liveQuery(queryFn) {
   };
 }
 
+class SharedUtils {
+  constructor(path, options) {
+    this.path = path;
+    this.options = options;
+  }
+  /**
+   * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
+   */
+  key(options = {}) {
+    return generateOperationKey(this.path, { ...options, prefix: this.options.prefix });
+  }
+}
+
 function serializableStreamedQuery(queryFn, { refetchMode = "reset", maxChunks = Number.POSITIVE_INFINITY } = {}) {
   return async (context) => {
     const query = context.client.getQueryCache().find({ queryKey: context.queryKey, exact: true });
@@ -111,16 +128,84 @@ function limitArraySize(items, maxSize) {
 
 const OPERATION_CONTEXT_SYMBOL = Symbol.for("ORPC_TANSTACK_QUERY_OPERATION_CONTEXT");
 
-class ProcedureUtils {
-  constructor(path, client, options = {}) {
-    this.path = path;
-    this.options = options;
-    this.call = client;
+const PROCEDURE_UTILS_INTERCEPTOR_KEYS = [
+  "queryInterceptors",
+  "streamedInterceptors",
+  "liveInterceptors",
+  "infiniteInterceptors",
+  "mutationInterceptors"
+];
+const PROCEDURE_UTILS_MODIFIER_KEYS = [
+  "queryKey",
+  "queryOptions",
+  "streamedKey",
+  "streamedOptions",
+  "liveKey",
+  "liveOptions",
+  "infiniteKey",
+  "infiniteOptions",
+  "mutationKey",
+  "mutationOptions"
+];
+function isProcedureUtilsOptions(value) {
+  if (!isTypescriptObject(value)) {
+    return false;
+  }
+  for (const key in value) {
+    if (value[key] === void 0) {
+      continue;
+    }
+    if (key === "prefix") {
+      if (typeof value[key] !== "string") {
+        return false;
+      }
+    } else if (PROCEDURE_UTILS_INTERCEPTOR_KEYS.includes(key)) {
+      if (!Array.isArray(value[key]) || value[key].some((i) => typeof i !== "function")) {
+        return false;
+      }
+    } else if (PROCEDURE_UTILS_MODIFIER_KEYS.includes(key)) {
+      if (!isTypescriptObject(value[key])) {
+        return false;
+      }
+    }
+  }
+  return true;
+}
+function mergeProcedureUtilsModifier(base, override) {
+  if (typeof base !== "function" && typeof override !== "function") {
+    return { ...base, ...override };
   }
+  const applyBase = typeof base === "function" ? base : (options) => ({ ...base, ...options });
+  const applyOverride = typeof override === "function" ? override : (options) => ({ ...override, ...options });
+  return (options) => applyOverride(applyBase(options));
+}
+function mergeProcedureUtilsOptions(base, override) {
+  const merged = { ...base, ...override };
+  for (const key of PROCEDURE_UTILS_INTERCEPTOR_KEYS) {
+    const baseValue = base[key];
+    const overrideValue = override[key];
+    if (baseValue && overrideValue) {
+      merged[key] = [...baseValue, ...overrideValue];
+    }
+  }
+  for (const key of PROCEDURE_UTILS_MODIFIER_KEYS) {
+    const baseValue = base[key];
+    const overrideValue = override[key];
+    if (baseValue && overrideValue) {
+      merged[key] = mergeProcedureUtilsModifier(baseValue, overrideValue);
+    }
+  }
+  return merged;
+}
+class ProcedureUtils extends SharedUtils {
   /**
    * Calling corresponding procedure client
    */
   call;
+  constructor(path, client, options = {}) {
+    super(path, options);
+    this.call = client;
+  }
   /**
    * Generate a **full matching** key for [Query Options](https://orpc.dev/docs/integrations/tanstack-query#query-options).
    */
@@ -131,7 +216,7 @@ class ProcedureUtils {
     } else if (this.options.queryKey) {
       optionsIn = { ...this.options.queryKey, ...optionsIn };
     }
-    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { type: "query", input: optionsIn.input });
+    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "query", input: optionsIn.input });
     return queryKey;
   }
   /**
@@ -187,11 +272,11 @@ class ProcedureUtils {
     } else if (this.options.streamedKey) {
       optionsIn = { ...this.options.streamedKey, ...optionsIn };
     }
-    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { type: "streamed", input: optionsIn.input, fnOptions: optionsIn.queryFnOptions });
+    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "streamed", input: optionsIn.input, fnOptions: optionsIn.queryFnOptions });
     return queryKey;
   }
   /**
-   * Configure queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
+   * Configure queries for [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object).
    * This is built on [TanStack Query streamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
    * and works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
    */
@@ -232,7 +317,7 @@ class ProcedureUtils {
               async (queryContext) => {
                 const output = await this.call(input, { signal: queryContext.signal, context });
                 if (!isAsyncIteratorObject(output)) {
-                  throw new Error("streamedQuery requires an event iterator output");
+                  throw new Error("streamedQuery requires an AsyncIteratorObject output");
                 }
                 return output;
               },
@@ -254,11 +339,11 @@ class ProcedureUtils {
     } else if (this.options.liveKey) {
       optionsIn = { ...this.options.liveKey, ...optionsIn };
     }
-    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { type: "live", input: optionsIn.input });
+    const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "live", input: optionsIn.input });
     return queryKey;
   }
   /**
-   * Configure live queries for [Event Iterator](https://orpc.dev/docs/event-iterator).
+   * Configure live queries for [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object).
    * Unlike `.streamedOptions` which accumulates chunks, live queries replace the entire result with each new chunk received.
    * Works with hooks like `useQuery`, `useSuspenseQuery`, or `prefetchQuery`.
    */
@@ -301,7 +386,7 @@ class ProcedureUtils {
                 context
               });
               if (!isAsyncIteratorObject(output)) {
-                throw new Error("liveQuery requires an event iterator output");
+                throw new Error("liveQuery requires an AsyncIteratorObject output");
               }
               return output;
             })(fnContext2);
@@ -321,6 +406,7 @@ class ProcedureUtils {
       optionsIn = { ...this.options.infiniteKey, ...optionsIn };
     }
     const queryKey = optionsIn.queryKey ?? generateOperationKey(this.path, {
+      prefix: this.options.prefix,
       type: "infinite",
       input: optionsIn.input === skipToken ? skipToken : optionsIn.input(optionsIn.initialPageParam)
     });
@@ -377,7 +463,7 @@ class ProcedureUtils {
     } else if (this.options.mutationKey) {
       optionsIn = { ...this.options.mutationKey, ...optionsIn };
     }
-    const mutationKey = optionsIn.mutationKey ?? generateOperationKey(this.path, { type: "mutation" });
+    const mutationKey = optionsIn.mutationKey ?? generateOperationKey(this.path, { prefix: this.options.prefix, type: "mutation" });
     return mutationKey;
   }
   /**
@@ -421,113 +507,107 @@ class ProcedureUtils {
   }
 }
 
-class SharedRouterUtils {
-  constructor(path) {
-    this.path = path;
-  }
-  /**
-   * Generate a **partial matching** key for actions like revalidating queries, checking mutation status, etc.
-   */
-  key(options = {}) {
-    return generateOperationKey(this.path, options);
-  }
-}
 function createRouterUtils(client, options = {}) {
   const plugin = new CompositeRouterUtilsPlugin(options.plugins);
   options = plugin.init(options);
   return createRouterUtilsInternal(client, options, plugin);
 }
-function createRouterUtilsInternal(client, options = {}, plugin) {
+function createRouterUtilsInternal(client, options, plugin) {
   const path = toArray(options.path);
-  const sharedUtils = bindMethods(new SharedRouterUtils(path));
-  const procedureUtils = typeof client === "function" && (options.scoped === void 0 || isProcedureUtilsOptions(options.scoped)) ? bindMethods(new ProcedureUtils(
+  const utils = typeof client === "function" && (options.scoped === void 0 || isProcedureUtilsOptions(options.scoped)) ? bindMethods(new ProcedureUtils(
     path,
     client,
-    plugin.initProcedureOptions(path, {
-      ...options.scoped,
-      queryInterceptors: [...toArray(options.queryInterceptors), ...toArray(options.scoped?.queryInterceptors)],
-      streamedInterceptors: [...toArray(options.streamedInterceptors), ...toArray(options.scoped?.streamedInterceptors)],
-      liveInterceptors: [...toArray(options.liveInterceptors), ...toArray(options.scoped?.liveInterceptors)],
-      infiniteInterceptors: [...toArray(options.infiniteInterceptors), ...toArray(options.scoped?.infiniteInterceptors)],
-      mutationInterceptors: [...toArray(options.mutationInterceptors), ...toArray(options.scoped?.mutationInterceptors)]
-    })
-  )) : void 0;
-  const recursive = new Proxy({
-    ...sharedUtils,
-    ...procedureUtils
-  }, {
+    plugin.initProcedureOptions(path, mergeProcedureUtilsOptions(
+      {
+        prefix: options.prefix,
+        queryInterceptors: options.queryInterceptors,
+        streamedInterceptors: options.streamedInterceptors,
+        liveInterceptors: options.liveInterceptors,
+        infiniteInterceptors: options.infiniteInterceptors,
+        mutationInterceptors: options.mutationInterceptors
+      },
+      options.scoped ?? {}
+    ))
+  ), { unbound: ["call"] }) : bindMethods(new SharedUtils(path, options));
+  const cache = /* @__PURE__ */ new Map();
+  const recursive = new Proxy(utils, {
     get(target, prop) {
-      const value = getOrBind(target, prop);
-      const nextClient = get(client, [prop]);
+      const value = Reflect.get(target, prop);
+      const nextClient = Reflect.get(client, prop);
       if (typeof prop !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop) || !isTypescriptObject(nextClient)) {
         return value;
       }
-      const nextUtils = createRouterUtilsInternal(nextClient, {
-        ...options,
-        path: [...path, prop],
-        scoped: get(options.scoped, [prop])
-      }, plugin);
-      if (typeof value !== "function") {
-        return nextUtils;
-      }
-      return new Proxy(value, {
-        get(target2, prop2) {
-          if (typeof prop2 !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop2)) {
-            return getOrBind(target2, prop2);
+      let result = cache.get(prop);
+      if (result === void 0) {
+        const nextUtils = createRouterUtilsInternal(nextClient, {
+          ...options,
+          path: [...path, prop],
+          scoped: options.scoped?.[prop]
+        }, plugin);
+        result = typeof value !== "function" ? nextUtils : new Proxy(value, {
+          get(target2, prop2) {
+            if (typeof prop2 !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop2)) {
+              return Reflect.get(target2, prop2);
+            }
+            return Reflect.get(nextUtils, prop2);
           }
-          return getOrBind(nextUtils, prop2);
-        }
-      });
+        });
+        cache.set(prop, result);
+      }
+      return result;
     }
   });
   return recursive;
 }
-function isProcedureUtilsOptions(value) {
-  if (!isTypescriptObject(value)) {
-    return false;
-  }
-  if (value.queryInterceptors !== void 0 && !Array.isArray(value.queryInterceptors)) {
-    return false;
-  }
-  if (value.streamedInterceptors !== void 0 && !Array.isArray(value.streamedInterceptors)) {
-    return false;
-  }
-  if (value.liveInterceptors !== void 0 && !Array.isArray(value.liveInterceptors)) {
-    return false;
-  }
-  if (value.infiniteInterceptors !== void 0 && !Array.isArray(value.infiniteInterceptors)) {
-    return false;
-  }
-  if (value.mutationInterceptors !== void 0 && !Array.isArray(value.mutationInterceptors)) {
-    return false;
-  }
-  return true;
-}
 
-function createContractUtilsFactory(caller, options) {
-  return (procedure) => {
-    const path = getPathMeta(procedure);
-    if (!path) {
+function createContractUtilsFactory(clientFactory, options) {
+  const factory = (contract) => {
+    const client = clientFactory(contract);
+    const path = resolveBasePathMeta(contract);
+    if (path === void 0) {
       throw new TypeError(
         "ContractUtilsFactory: procedure contract must define `meta.path` that matches its path in the root router contract."
       );
     }
-    const scoped = get(options.scoped, path);
-    if (scoped !== void 0 && (scoped === null || typeof scoped !== "object")) {
-      throw new TypeError(
-        `ContractUtilsFactory: "scoped" at path "${path.join(".")}" must be an object or undefined, got "${scoped}".`
-      );
+    return createRouterUtils(client, { ...options, path, scoped: get(options.scoped, path) });
+  };
+  return factory;
+}
+function createContractJsonifiedUtilsFactory(clientFactory, options) {
+  return createContractUtilsFactory(clientFactory, options);
+}
+
+function tanstackQuery(options) {
+  return {
+    name: "~tanstack-query",
+    init(meta) {
+      const current = meta["~tanstack-query"];
+      return {
+        ...meta,
+        "~tanstack-query": current ? mergeProcedureUtilsOptions(current, options) : options
+      };
     }
-    const client = (...rest) => caller(procedure, ...rest);
-    return createRouterUtils(client, {
-      ...options,
-      scoped,
-      path: [...toArray(options.path), ...path]
-    });
   };
 }
-function createContractJsonifiedUtilsFactory(caller, options) {
-  return createContractUtilsFactory(caller, options);
+function getTanstackQueryMeta(procedureOrLazy) {
+  return procedureOrLazy["~orpc"].meta["~tanstack-query"];
+}
+class ContractOptionsUtilsPlugin {
+  constructor(contract) {
+    this.contract = contract;
+  }
+  name = "~contract-options";
+  initProcedureOptions(path, options) {
+    const procedure = getRouterContract(this.contract, path);
+    if (!(procedure instanceof ProcedureContract)) {
+      return options;
+    }
+    const base = getTanstackQueryMeta(procedure);
+    if (!base) {
+      return options;
+    }
+    return mergeProcedureUtilsOptions(base, options);
+  }
 }
 
-export { OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedRouterUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, serializableStreamedQuery };
+export { CompositeRouterUtilsPlugin, ContractOptionsUtilsPlugin, OPERATION_CONTEXT_SYMBOL, ProcedureUtils, SharedUtils, OPERATION_CONTEXT_SYMBOL as TANSTACK_QUERY_OPERATION_CONTEXT_SYMBOL, createContractJsonifiedUtilsFactory, createContractUtilsFactory, createRouterUtils, createRouterUtils as createTanstackQueryUtils, generateOperationKey, getTanstackQueryMeta, isProcedureUtilsOptions, mergeProcedureUtilsOptions, serializableStreamedQuery, tanstackQuery };

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@orpc/tanstack-query",
   "type": "module",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.30",
+  "description": "TanStack Query integration for oRPC: typesafe queries, mutations, streaming, and SSR for React, Vue, Solid, Svelte, and Angular",
   "license": "MIT",
+  "funding": [
+    "https://github.com/sponsors/dinwwwh",
+    "https://opencollective.com/middleapi"
+  ],
   "homepage": "https://orpc.dev",
   "repository": {
     "type": "git",
@@ -11,7 +16,17 @@
   },
   "keywords": [
     "orpc",
-    "tanstack query"
+    "tanstack-query",
+    "react-query",
+    "vue-query",
+    "solid-query",
+    "svelte-query",
+    "angular-query",
+    "query",
+    "mutation",
+    "ssr",
+    "typescript",
+    "typesafe"
   ],
   "sideEffects": false,
   "exports": {
@@ -29,21 +44,21 @@
     "@tanstack/query-core": ">=5.80.2"
   },
   "dependencies": {
-    "@orpc/client": "2.0.0-beta.3",
-    "@orpc/contract": "2.0.0-beta.3",
-    "@orpc/shared": "2.0.0-beta.3",
-    "@orpc/openapi": "2.0.0-beta.3"
+    "@orpc/client": "2.0.0-beta.30",
+    "@orpc/contract": "2.0.0-beta.30",
+    "@orpc/openapi": "2.0.0-beta.30",
+    "@orpc/shared": "2.0.0-beta.30"
   },
   "devDependencies": {
-    "@angular/core": "^22.0.1",
-    "@tanstack/angular-query-experimental": "^5.101.0",
-    "@tanstack/query-core": "^5.101.0",
-    "@tanstack/react-query": "^5.101.0",
-    "@tanstack/solid-query": "^5.101.0",
-    "@tanstack/svelte-query": "^6.1.34",
-    "@tanstack/vue-query": "^5.101.0",
-    "svelte": "^5.56.3",
-    "vue": "^3.5.38",
+    "@angular/core": "^22.1.3",
+    "@tanstack/angular-query-experimental": "^5.101.4",
+    "@tanstack/query-core": "^5.101.4",
+    "@tanstack/react-query": "^5.101.4",
+    "@tanstack/solid-query": "^5.101.4",
+    "@tanstack/svelte-query": "^6.1.38",
+    "@tanstack/vue-query": "^5.101.4",
+    "svelte": "^5.56.7",
+    "vue": "^3.5.41",
     "zod": "^4.4.3"
   },
   "scripts": {