@orpc/tanstack-query 1.11.2 → 1.12.0

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
 import { Promisable, SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
-import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, DataTag, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
+import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, InfiniteQueryObserverOptions, MutationObserverOptions, DataTag, InfiniteData } from '@tanstack/query-core';
 
 interface experimental_SerializableStreamedQueryOptions {
     /**
@@ -180,16 +180,89 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
      */
     mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptions<TInput, TOutput, TError, UMutationContext>>;
 }
-interface CreateProcedureUtilsOptions {
+interface experimental_ProcedureUtilsDefaults<TClientContext extends ClientContext, TInput, TOutput, TError> {
+    /**
+     * Default options for queryKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    queryKey?: Partial<QueryKeyOptions<TInput>>;
+    /**
+     * Default options for queryOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
+     */
+    queryOptions?: Partial<QueryOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
+    /**
+     * Default options for experimental_streamedKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    experimental_streamedKey?: Partial<experimental_StreamedKeyOptions<TInput>>;
+    /**
+     * Default options for experimental_streamedOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
+     */
+    experimental_streamedOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_StreamedQueryOutput<TOutput>, TError, unknown>>;
+    /**
+     * Default options for experimental_liveKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    experimental_liveKey?: Partial<QueryKeyOptions<TInput>>;
+    /**
+     * Default options for experimental_liveOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
+     */
+    experimental_liveOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_LiveQueryOutput<TOutput>, TError, unknown>>;
+    /**
+     * Default options for infiniteKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    infiniteKey?: Partial<Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, unknown>, unknown>, 'input' | 'initialPageParam' | 'queryKey'>>;
+    /**
+     * Default options for infiniteOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
+     */
+    infiniteOptions?: Partial<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, unknown>>;
+    /**
+     * Default options for mutationKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    mutationKey?: Partial<Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>>;
+    /**
+     * Default options for mutationOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
+     */
+    mutationOptions?: Partial<MutationOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
+}
+/**
+ * @todo remove default generic types on v2
+ */
+interface CreateProcedureUtilsOptions<TClientContext extends ClientContext = ClientContext, TInput = unknown, TOutput = unknown, TError = unknown> {
     path: readonly string[];
+    experimental_defaults?: experimental_ProcedureUtilsDefaults<TClientContext, TInput, TOutput, TError>;
 }
-declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+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>;
 
 type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
     [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
 } & GeneralUtils<unknown>;
-interface CreateRouterUtilsOptions {
+type experimental_RouterUtilsDefaults<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? experimental_ProcedureUtilsDefaults<UClientContext, UInput, UOutput, UError> : {
+    [K in keyof T]?: T[K] extends NestedClient<any> ? experimental_RouterUtilsDefaults<T[K]> : never;
+};
+/**
+ * @todo remove default generic types on v2
+ */
+interface CreateRouterUtilsOptions<T extends NestedClient<any> = NestedClient<any>> {
     path?: readonly string[];
+    experimental_defaults?: experimental_RouterUtilsDefaults<T>;
 }
 /**
  * Create a router utils from a client.
@@ -197,7 +270,7 @@ interface CreateRouterUtilsOptions {
  * @info Both client-side and server-side clients are supported.
  * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query Tanstack Query Integration}
  */
-declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions<T>): RouterUtils<T>;
 
 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 };
+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

@@ -1,6 +1,6 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
 import { Promisable, SetOptional, PartialDeep, MaybeOptionalOptions } from '@orpc/shared';
-import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, DataTag, InfiniteQueryObserverOptions, InfiniteData, MutationObserverOptions } from '@tanstack/query-core';
+import { QueryKey, QueryFunctionContext, QueryFunction, SkipToken, QueryObserverOptions, InfiniteQueryObserverOptions, MutationObserverOptions, DataTag, InfiniteData } from '@tanstack/query-core';
 
 interface experimental_SerializableStreamedQueryOptions {
     /**
@@ -180,16 +180,89 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
      */
     mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): NoInfer<MutationOptions<TInput, TOutput, TError, UMutationContext>>;
 }
-interface CreateProcedureUtilsOptions {
+interface experimental_ProcedureUtilsDefaults<TClientContext extends ClientContext, TInput, TOutput, TError> {
+    /**
+     * Default options for queryKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    queryKey?: Partial<QueryKeyOptions<TInput>>;
+    /**
+     * Default options for queryOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-options Tanstack Query Options Utility Docs}
+     */
+    queryOptions?: Partial<QueryOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
+    /**
+     * Default options for experimental_streamedKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    experimental_streamedKey?: Partial<experimental_StreamedKeyOptions<TInput>>;
+    /**
+     * Default options for experimental_streamedOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#streamed-query-options Tanstack Streamed Query Options Utility Docs}
+     */
+    experimental_streamedOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_StreamedQueryOutput<TOutput>, TError, unknown>>;
+    /**
+     * Default options for experimental_liveKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    experimental_liveKey?: Partial<QueryKeyOptions<TInput>>;
+    /**
+     * Default options for experimental_liveOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#live-query-options Tanstack Live Query Options Utility Docs}
+     */
+    experimental_liveOptions?: Partial<experimental_StreamedOptionsIn<TClientContext, TInput, experimental_LiveQueryOutput<TOutput>, TError, unknown>>;
+    /**
+     * Default options for infiniteKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    infiniteKey?: Partial<Pick<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, InfiniteData<TOutput, unknown>, unknown>, 'input' | 'initialPageParam' | 'queryKey'>>;
+    /**
+     * Default options for infiniteOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#infinite-query-options Tanstack Infinite Query Options Utility Docs}
+     */
+    infiniteOptions?: Partial<InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, unknown, unknown>>;
+    /**
+     * Default options for mutationKey utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#query-mutation-key Tanstack Query/Mutation Key Docs}
+     */
+    mutationKey?: Partial<Pick<MutationOptionsIn<TClientContext, TInput, TOutput, TError, any>, 'mutationKey'>>;
+    /**
+     * Default options for mutationOptions utility
+     *
+     * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query#mutation-options Tanstack Mutation Options Docs}
+     */
+    mutationOptions?: Partial<MutationOptionsIn<TClientContext, TInput, TOutput, TError, unknown>>;
+}
+/**
+ * @todo remove default generic types on v2
+ */
+interface CreateProcedureUtilsOptions<TClientContext extends ClientContext = ClientContext, TInput = unknown, TOutput = unknown, TError = unknown> {
     path: readonly string[];
+    experimental_defaults?: experimental_ProcedureUtilsDefaults<TClientContext, TInput, TOutput, TError>;
 }
-declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+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>;
 
 type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
     [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
 } & GeneralUtils<unknown>;
-interface CreateRouterUtilsOptions {
+type experimental_RouterUtilsDefaults<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? experimental_ProcedureUtilsDefaults<UClientContext, UInput, UOutput, UError> : {
+    [K in keyof T]?: T[K] extends NestedClient<any> ? experimental_RouterUtilsDefaults<T[K]> : never;
+};
+/**
+ * @todo remove default generic types on v2
+ */
+interface CreateRouterUtilsOptions<T extends NestedClient<any> = NestedClient<any>> {
     path?: readonly string[];
+    experimental_defaults?: experimental_RouterUtilsDefaults<T>;
 }
 /**
  * Create a router utils from a client.
@@ -197,7 +270,7 @@ interface CreateRouterUtilsOptions {
  * @info Both client-side and server-side clients are supported.
  * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query Tanstack Query Integration}
  */
-declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions<T>): RouterUtils<T>;
 
 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 };
+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

@@ -1,4 +1,4 @@
-import { stringifyJSON, isAsyncIteratorObject, toArray } from '@orpc/shared';
+import { stringifyJSON, isAsyncIteratorObject, toArray, get } from '@orpc/shared';
 import { skipToken } from '@tanstack/query-core';
 
 function generateOperationKey(path, state = {}) {
@@ -99,10 +99,12 @@ function createProcedureUtils(client, options) {
   const utils = {
     call: client,
     queryKey(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.queryKey, ...optionsIn };
       const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "query", input: optionsIn.input });
       return queryKey;
     },
     queryOptions(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.queryOptions, ...optionsIn };
       const queryKey = utils.queryKey(optionsIn);
       return {
         queryFn: ({ signal }) => {
@@ -126,10 +128,12 @@ function createProcedureUtils(client, options) {
       };
     },
     experimental_streamedKey(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.experimental_streamedKey, ...optionsIn };
       const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "streamed", input: optionsIn.input, fnOptions: optionsIn.queryFnOptions });
       return queryKey;
     },
     experimental_streamedOptions(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.experimental_streamedOptions, ...optionsIn };
       const queryKey = utils.experimental_streamedKey(optionsIn);
       return {
         queryFn: experimental_serializableStreamedQuery(
@@ -160,10 +164,12 @@ function createProcedureUtils(client, options) {
       };
     },
     experimental_liveKey(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.experimental_liveKey, ...optionsIn };
       const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, { type: "live", input: optionsIn.input });
       return queryKey;
     },
     experimental_liveOptions(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.experimental_liveOptions, ...optionsIn };
       const queryKey = utils.experimental_liveKey(optionsIn);
       return {
         queryFn: experimental_liveQuery(async ({ signal }) => {
@@ -191,6 +197,7 @@ function createProcedureUtils(client, options) {
       };
     },
     infiniteKey(optionsIn) {
+      optionsIn = { ...options.experimental_defaults?.infiniteKey, ...optionsIn };
       const queryKey = optionsIn.queryKey ?? generateOperationKey(options.path, {
         type: "infinite",
         input: optionsIn.input === skipToken ? skipToken : optionsIn.input(optionsIn.initialPageParam)
@@ -198,6 +205,7 @@ function createProcedureUtils(client, options) {
       return queryKey;
     },
     infiniteOptions(optionsIn) {
+      optionsIn = { ...options.experimental_defaults?.infiniteOptions, ...optionsIn };
       const queryKey = utils.infiniteKey(optionsIn);
       return {
         queryFn: ({ pageParam, signal }) => {
@@ -221,10 +229,12 @@ function createProcedureUtils(client, options) {
       };
     },
     mutationKey(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.mutationKey, ...optionsIn };
       const mutationKey = optionsIn.mutationKey ?? generateOperationKey(options.path, { type: "mutation" });
       return mutationKey;
     },
     mutationOptions(...[optionsIn = {}]) {
+      optionsIn = { ...options.experimental_defaults?.mutationOptions, ...optionsIn };
       const mutationKey = utils.mutationKey(optionsIn);
       return {
         mutationFn: (input) => client(input, {
@@ -247,7 +257,10 @@ function createProcedureUtils(client, options) {
 function createRouterUtils(client, options = {}) {
   const path = toArray(options.path);
   const generalUtils = createGeneralUtils(path);
-  const procedureUtils = createProcedureUtils(client, { path });
+  const procedureUtils = createProcedureUtils(client, {
+    path,
+    experimental_defaults: options.experimental_defaults
+  });
   const recursive = new Proxy({
     ...generalUtils,
     ...procedureUtils
@@ -257,7 +270,11 @@ function createRouterUtils(client, options = {}) {
       if (typeof prop !== "string") {
         return value;
       }
-      const nextUtils = createRouterUtils(client[prop], { ...options, path: [...path, prop] });
+      const nextUtils = createRouterUtils(client[prop], {
+        ...options,
+        path: [...path, prop],
+        experimental_defaults: get(options.experimental_defaults, [prop])
+      });
       if (typeof value !== "function") {
         return nextUtils;
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/tanstack-query",
   "type": "module",
-  "version": "1.11.2",
+  "version": "1.12.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -25,20 +25,20 @@
   ],
   "peerDependencies": {
     "@tanstack/query-core": ">=5.80.2",
-    "@orpc/client": "1.11.2"
+    "@orpc/client": "1.12.0"
   },
   "dependencies": {
-    "@orpc/shared": "1.11.2"
+    "@orpc/shared": "1.12.0"
   },
   "devDependencies": {
-    "@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",
+    "@angular/core": "^20.3.12",
+    "@tanstack/angular-query-experimental": "^5.90.12",
+    "@tanstack/query-core": "^5.90.10",
+    "@tanstack/react-query": "^5.90.10",
+    "@tanstack/solid-query": "^5.90.13",
+    "@tanstack/svelte-query": "^6.0.8",
+    "@tanstack/vue-query": "^5.91.2",
+    "svelte": "^5.43.14",
     "vue": "^3.5.24",
     "zod": "^4.1.12"
   },