@trpc/react-query 11.0.0-next.92 → 11.0.0-rc.330

package/src/shared/polymorphism/routerLike.ts

@@ -1,29 +1,43 @@
-import {
+import type {
   AnyMutationProcedure,
-  AnyProcedure,
   AnyQueryProcedure,
-  AnyRootConfig,
+  AnyRootTypes,
   AnyRouter,
-} from '@trpc/server';
-import { MutationLike } from './mutationLike';
-import { QueryLike } from './queryLike';
+  RouterRecord,
+} from '@trpc/server/unstable-core-do-not-import';
+import type { MutationLike } from './mutationLike';
+import type { QueryLike } from './queryLike';
 
 /**
  * Use to describe a route path which matches a given route's interface
  */
 export type RouterLike<TRouter extends AnyRouter> = RouterLikeInner<
-  TRouter['_def']['_config'],
+  TRouter['_def']['_config']['$types'],
   TRouter['_def']['procedures']
 >;
 export type RouterLikeInner<
-  TConfig extends AnyRootConfig,
-  TProcedures extends AnyProcedure,
+  TRoot extends AnyRootTypes,
+  TRecord extends RouterRecord,
 > = {
-  [TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter
-    ? RouterLikeInner<TConfig, TProcedures[TKey]['_def']['record']>
-    : TProcedures[TKey] extends AnyQueryProcedure
-    ? QueryLike<TConfig, TProcedures[TKey]>
-    : TProcedures[TKey] extends AnyMutationProcedure
-    ? MutationLike<TConfig, TProcedures[TKey]>
+  [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value
+    ? $Value extends RouterRecord
+      ? RouterLikeInner<TRoot, $Value>
+      : $Value extends AnyQueryProcedure
+      ? QueryLike<TRoot, $Value>
+      : $Value extends AnyMutationProcedure
+      ? MutationLike<TRoot, $Value>
+      : never
     : never;
 };
+
+// /**
+//  * Use to describe a route path which matches a given route's interface
+//  */
+// export type RouterLike<TRouter extends AnyRouter> = RouterLikeInner<
+//   TRouter['_def']['_config']['$types'],
+//   TRouter['_def']['procedures']
+// >;
+// export type RouterLikeInner<
+//   TRoot extends AnyRootTypes,
+//   TRecord extends RouterRecord,
+// > = DecorateRouterRecord<TRoot, TRecord>;

package/src/shared/polymorphism/utilsLike.ts

@@ -1,8 +1,11 @@
-import { AnyRouter } from '@trpc/server';
-import { DecoratedProcedureUtilsRecord } from '../proxy/utilsProxy';
+import type { AnyRouter } from '@trpc/server/unstable-core-do-not-import';
+import type { DecoratedProcedureUtilsRecord } from '../proxy/utilsProxy';
 
 /**
  * Use to describe a Utils/Context path which matches the given route's interface
  */
 export type UtilsLike<TRouter extends AnyRouter> =
-  DecoratedProcedureUtilsRecord<TRouter>;
+  DecoratedProcedureUtilsRecord<
+    TRouter['_def']['_config']['$types'],
+    TRouter['_def']['record']
+  >;

package/src/shared/proxy/decorationProxy.ts

@@ -1,6 +1,6 @@
-import { AnyRouter } from '@trpc/server';
-import { createRecursiveProxy } from '@trpc/server/shared';
-import { CreateReactQueryHooks } from '../hooks/createHooksInternal';
+import type { AnyRouter } from '@trpc/server/unstable-core-do-not-import';
+import { createRecursiveProxy } from '@trpc/server/unstable-core-do-not-import';
+import type { CreateReactQueryHooks } from '../hooks/createHooksInternal';
 
 /**
  * Create proxy for decorating procedures

package/src/shared/proxy/useQueriesProxy.ts

@@ -1,50 +1,84 @@
-import { QueryOptions } from '@tanstack/react-query';
-import { TRPCClientError, TRPCUntypedClient } from '@trpc/client';
-import {
+import type { QueryOptions } from '@tanstack/react-query';
+import type { TRPCClientError, TRPCUntypedClient } from '@trpc/client';
+import type {
   AnyProcedure,
   AnyQueryProcedure,
-  AnyRootConfig,
+  AnyRootTypes,
   AnyRouter,
-  Filter,
   inferProcedureInput,
-} from '@trpc/server';
-import {
-  createRecursiveProxy,
   inferTransformedProcedureOutput,
-} from '@trpc/server/shared';
+  RouterRecord,
+} from '@trpc/server/unstable-core-do-not-import';
+import { createRecursiveProxy } from '@trpc/server/unstable-core-do-not-import';
 import { getQueryKeyInternal } from '../../internals/getQueryKey';
-import { TrpcQueryOptionsForUseQueries } from '../../internals/useQueries';
-import { TRPCUseQueryBaseOptions } from '../hooks/types';
+import type {
+  TrpcQueryOptionsForUseQueries,
+  TrpcQueryOptionsForUseSuspenseQueries,
+} from '../../internals/useQueries';
+import type { TRPCUseQueryBaseOptions } from '../hooks/types';
 
 type GetQueryOptions<
-  TConfig extends AnyRootConfig,
+  TRoot extends AnyRootTypes,
   TProcedure extends AnyProcedure,
-> = <TData = inferTransformedProcedureOutput<TConfig, TProcedure>>(
+> = <TData = inferTransformedProcedureOutput<TRoot, TProcedure>>(
   input: inferProcedureInput<TProcedure>,
   opts?: TrpcQueryOptionsForUseQueries<
-    inferTransformedProcedureOutput<TConfig, TProcedure>,
+    inferTransformedProcedureOutput<TRoot, TProcedure>,
     TData,
-    TRPCClientError<TConfig>
+    TRPCClientError<TRoot>
   >,
 ) => TrpcQueryOptionsForUseQueries<
-  inferTransformedProcedureOutput<TConfig, TProcedure>,
+  inferTransformedProcedureOutput<TRoot, TProcedure>,
   TData,
-  TRPCClientError<TConfig>
+  TRPCClientError<TRoot>
 >;
 
 /**
  * @internal
  */
-export type UseQueriesProcedureRecord<TRouter extends AnyRouter> = {
-  [TKey in keyof Filter<
-    TRouter['_def']['record'],
-    AnyQueryProcedure | AnyRouter
-  >]: TRouter['_def']['record'][TKey] extends AnyRouter
-    ? UseQueriesProcedureRecord<TRouter['_def']['record'][TKey]>
-    : GetQueryOptions<
-        TRouter['_def']['_config'],
-        TRouter['_def']['record'][TKey]
-      >;
+export type UseQueriesProcedureRecord<
+  TRoot extends AnyRootTypes,
+  TRecord extends RouterRecord,
+> = {
+  [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value
+    ? $Value extends RouterRecord
+      ? UseQueriesProcedureRecord<TRoot, $Value>
+      : $Value extends AnyQueryProcedure
+      ? GetQueryOptions<TRoot, $Value>
+      : never
+    : never;
+};
+
+type GetSuspenseQueryOptions<
+  TRoot extends AnyRootTypes,
+  TProcedure extends AnyQueryProcedure,
+> = <TData = inferTransformedProcedureOutput<TRoot, TProcedure>>(
+  input: inferProcedureInput<TProcedure>,
+  opts?: TrpcQueryOptionsForUseSuspenseQueries<
+    inferTransformedProcedureOutput<TRoot, TProcedure>,
+    TData,
+    TRPCClientError<TRoot>
+  >,
+) => TrpcQueryOptionsForUseSuspenseQueries<
+  inferTransformedProcedureOutput<TRoot, TProcedure>,
+  TData,
+  TRPCClientError<TRoot>
+>;
+
+/**
+ * @internal
+ */
+export type UseSuspenseQueriesProcedureRecord<
+  TRoot extends AnyRootTypes,
+  TRecord extends RouterRecord,
+> = {
+  [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value
+    ? $Value extends RouterRecord
+      ? UseSuspenseQueriesProcedureRecord<TRoot, $Value>
+      : $Value extends AnyQueryProcedure
+      ? GetSuspenseQueryOptions<TRoot, $Value>
+      : never
+    : never;
 };
 
 /**
@@ -71,5 +105,8 @@ export function createUseQueries<TRouter extends AnyRouter>(
     };
 
     return options;
-  }) as UseQueriesProcedureRecord<TRouter>;
+  }) as UseQueriesProcedureRecord<
+    TRouter['_def']['_config']['$types'],
+    TRouter['_def']['record']
+  >;
 }

package/src/shared/proxy/utilsProxy.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   CancelOptions,
   InfiniteData,
   InvalidateOptions,
@@ -10,37 +10,36 @@ import {
   SetDataOptions,
   Updater,
 } from '@tanstack/react-query';
-import { createTRPCClientProxy, TRPCClientError } from '@trpc/client';
-import {
+import type { TRPCClientError } from '@trpc/client';
+import { createTRPCClientProxy } from '@trpc/client';
+import type {
   AnyQueryProcedure,
-  AnyRootConfig,
+  AnyRootTypes,
   AnyRouter,
   DeepPartial,
-  Filter,
   inferProcedureInput,
+  inferTransformedProcedureOutput,
   ProtectedIntersection,
-} from '@trpc/server';
+  RouterRecord,
+} from '@trpc/server/unstable-core-do-not-import';
 import {
   createFlatProxy,
   createRecursiveProxy,
-  inferTransformedProcedureOutput,
-} from '@trpc/server/shared';
-import {
-  contextProps,
+} from '@trpc/server/unstable-core-do-not-import';
+import type {
   DecoratedTRPCContextProps,
   TRPCContextState,
   TRPCFetchInfiniteQueryOptions,
   TRPCFetchQueryOptions,
+  TRPCQueryUtils,
 } from '../../internals/context';
-import {
-  getQueryKeyInternal,
-  QueryKeyKnown,
-  QueryType,
-} from '../../internals/getQueryKey';
-import { ExtractCursorType } from '../hooks/types';
+import { contextProps } from '../../internals/context';
+import type { QueryKeyKnown, QueryType } from '../../internals/getQueryKey';
+import { getQueryKeyInternal } from '../../internals/getQueryKey';
+import type { ExtractCursorType } from '../hooks/types';
 
 type DecorateProcedure<
-  TConfig extends AnyRootConfig,
+  TRoot extends AnyRootTypes,
   TProcedure extends AnyQueryProcedure,
 > = {
   /**
@@ -49,10 +48,10 @@ type DecorateProcedure<
   fetch(
     input: inferProcedureInput<TProcedure>,
     opts?: TRPCFetchQueryOptions<
-      inferTransformedProcedureOutput<TConfig, TProcedure>,
-      TRPCClientError<TConfig>
+      inferTransformedProcedureOutput<TRoot, TProcedure>,
+      TRPCClientError<TRoot>
     >,
-  ): Promise<inferTransformedProcedureOutput<TConfig, TProcedure>>;
+  ): Promise<inferTransformedProcedureOutput<TRoot, TProcedure>>;
 
   /**
    * @link https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientfetchinfinitequery
@@ -61,12 +60,12 @@ type DecorateProcedure<
     input: inferProcedureInput<TProcedure>,
     opts?: TRPCFetchInfiniteQueryOptions<
       inferProcedureInput<TProcedure>,
-      inferTransformedProcedureOutput<TConfig, TProcedure>,
-      TRPCClientError<TConfig>
+      inferTransformedProcedureOutput<TRoot, TProcedure>,
+      TRPCClientError<TRoot>
     >,
   ): Promise<
     InfiniteData<
-      inferTransformedProcedureOutput<TConfig, TProcedure>,
+      inferTransformedProcedureOutput<TRoot, TProcedure>,
       NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null
     >
   >;
@@ -77,8 +76,8 @@ type DecorateProcedure<
   prefetch(
     input: inferProcedureInput<TProcedure>,
     opts?: TRPCFetchQueryOptions<
-      inferTransformedProcedureOutput<TConfig, TProcedure>,
-      TRPCClientError<TConfig>
+      inferTransformedProcedureOutput<TRoot, TProcedure>,
+      TRPCClientError<TRoot>
     >,
   ): Promise<void>;
 
@@ -89,21 +88,21 @@ type DecorateProcedure<
     input: inferProcedureInput<TProcedure>,
     opts?: TRPCFetchInfiniteQueryOptions<
       inferProcedureInput<TProcedure>,
-      inferTransformedProcedureOutput<TConfig, TProcedure>,
-      TRPCClientError<TConfig>
+      inferTransformedProcedureOutput<TRoot, TProcedure>,
+      TRPCClientError<TRoot>
     >,
   ): Promise<void>;
 
   /**
-   * @link https://tanstack.com/query/v5/docs/react/reference/QueryClient#queryclientensurequerydata
+   * @link https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientensurequerydata
    */
   ensureData(
     input: inferProcedureInput<TProcedure>,
     opts?: TRPCFetchQueryOptions<
-      inferTransformedProcedureOutput<TConfig, TProcedure>,
-      TRPCClientError<TConfig>
+      inferTransformedProcedureOutput<TRoot, TProcedure>,
+      TRPCClientError<TRoot>
     >,
-  ): Promise<inferTransformedProcedureOutput<TConfig, TProcedure>>;
+  ): Promise<inferTransformedProcedureOutput<TRoot, TProcedure>>;
 
   /**
    * @link https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientinvalidatequeries
@@ -114,7 +113,7 @@ type DecorateProcedure<
       predicate?: (
         query: Query<
           inferProcedureInput<TProcedure>,
-          TRPCClientError<TConfig>,
+          TRPCClientError<TRoot>,
           inferProcedureInput<TProcedure>,
           QueryKeyKnown<
             inferProcedureInput<TProcedure>,
@@ -162,8 +161,8 @@ type DecorateProcedure<
      */
     input: inferProcedureInput<TProcedure>,
     updater: Updater<
-      inferTransformedProcedureOutput<TConfig, TProcedure> | undefined,
-      inferTransformedProcedureOutput<TConfig, TProcedure> | undefined
+      inferTransformedProcedureOutput<TRoot, TProcedure> | undefined,
+      inferTransformedProcedureOutput<TRoot, TProcedure> | undefined
     >,
     options?: SetDataOptions,
   ): void;
@@ -175,12 +174,12 @@ type DecorateProcedure<
     input: inferProcedureInput<TProcedure>,
     updater: Updater<
       | InfiniteData<
-          inferTransformedProcedureOutput<TConfig, TProcedure>,
+          inferTransformedProcedureOutput<TRoot, TProcedure>,
           NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null
         >
       | undefined,
       | InfiniteData<
-          inferTransformedProcedureOutput<TConfig, TProcedure>,
+          inferTransformedProcedureOutput<TRoot, TProcedure>,
           NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null
         >
       | undefined
@@ -193,7 +192,7 @@ type DecorateProcedure<
    */
   getData(
     input?: inferProcedureInput<TProcedure>,
-  ): inferTransformedProcedureOutput<TConfig, TProcedure> | undefined;
+  ): inferTransformedProcedureOutput<TRoot, TProcedure> | undefined;
 
   /**
    * @link https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientgetquerydata
@@ -202,7 +201,7 @@ type DecorateProcedure<
     input?: inferProcedureInput<TProcedure>,
   ):
     | InfiniteData<
-        inferTransformedProcedureOutput<TConfig, TProcedure>,
+        inferTransformedProcedureOutput<TRoot, TProcedure>,
         NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>> | null
       >
     | undefined;
@@ -216,7 +215,7 @@ type DecorateRouter = {
   /**
    * Invalidate the full router
    * @link https://trpc.io/docs/v10/useContext#query-invalidation
-   * @link https://tanstack.com/query/v5/docs/react/guides/query-invalidation
+   * @link https://tanstack.com/query/v5/docs/framework/react/guides/query-invalidation
    */
   invalidate(
     input?: undefined,
@@ -228,20 +227,19 @@ type DecorateRouter = {
 /**
  * @internal
  */
-export type DecoratedProcedureUtilsRecord<TRouter extends AnyRouter> =
-  DecorateRouter & {
-    [TKey in keyof Filter<
-      TRouter['_def']['record'],
-      AnyQueryProcedure | AnyRouter
-    >]: TRouter['_def']['record'][TKey] extends AnyRouter
-      ? DecoratedProcedureUtilsRecord<TRouter['_def']['record'][TKey]> &
-          DecorateRouter
+export type DecoratedProcedureUtilsRecord<
+  TRoot extends AnyRootTypes,
+  TRecord extends RouterRecord,
+> = DecorateRouter & {
+  [TKey in keyof TRecord]: TRecord[TKey] extends infer $Value
+    ? $Value extends RouterRecord
+      ? DecoratedProcedureUtilsRecord<TRoot, $Value> & DecorateRouter
       : // utils only apply to queries
-        DecorateProcedure<
-          TRouter['_def']['_config'],
-          TRouter['_def']['record'][TKey]
-        >;
-  }; // Add functions that should be available at utils root
+      $Value extends AnyQueryProcedure
+      ? DecorateProcedure<TRoot, $Value>
+      : never
+    : never;
+}; // Add functions that should be available at utils root
 
 type AnyDecoratedProcedure = DecorateProcedure<any, any>;
 
@@ -250,9 +248,18 @@ export type CreateReactUtils<
   TSSRContext,
 > = ProtectedIntersection<
   DecoratedTRPCContextProps<TRouter, TSSRContext>,
-  DecoratedProcedureUtilsRecord<TRouter>
+  DecoratedProcedureUtilsRecord<
+    TRouter['_def']['_config']['$types'],
+    TRouter['_def']['record']
+  >
 >;
 
+export type CreateQueryUtils<TRouter extends AnyRouter> =
+  DecoratedProcedureUtilsRecord<
+    TRouter['_def']['_config']['$types'],
+    TRouter['_def']['record']
+  >;
+
 export const getQueryType = (
   utilName: keyof AnyDecoratedProcedure,
 ): QueryType => {
@@ -278,11 +285,52 @@ export const getQueryType = (
   }
 };
 
+/**
+ * @internal
+ */
+function createRecursiveUtilsProxy<TRouter extends AnyRouter>(
+  context: TRPCQueryUtils<TRouter>,
+  key: string,
+) {
+  return createRecursiveProxy((opts) => {
+    const path = [key, ...opts.path];
+    const utilName = path.pop() as keyof AnyDecoratedProcedure;
+    const args = [...opts.args] as Parameters<
+      AnyDecoratedProcedure[typeof utilName]
+    >;
+    const input = args.shift(); // args can now be spread when input removed
+    const queryType = getQueryType(utilName);
+    const queryKey = getQueryKeyInternal(path, input, queryType);
+
+    const contextMap: Record<keyof AnyDecoratedProcedure, () => unknown> = {
+      fetch: () => context.fetchQuery(queryKey, ...args),
+      fetchInfinite: () => context.fetchInfiniteQuery(queryKey, args[0]),
+      prefetch: () => context.prefetchQuery(queryKey, ...args),
+      prefetchInfinite: () => context.prefetchInfiniteQuery(queryKey, args[0]),
+      ensureData: () => context.ensureQueryData(queryKey, ...args),
+      invalidate: () => context.invalidateQueries(queryKey, ...args),
+      reset: () => context.resetQueries(queryKey, ...args),
+      refetch: () => context.refetchQueries(queryKey, ...args),
+      cancel: () => context.cancelQuery(queryKey, ...args),
+      setData: () => {
+        context.setQueryData(queryKey, args[0], args[1]);
+      },
+      setInfiniteData: () => {
+        context.setInfiniteQueryData(queryKey, args[0], args[1]);
+      },
+      getData: () => context.getQueryData(queryKey),
+      getInfiniteData: () => context.getInfiniteQueryData(queryKey),
+    };
+
+    return contextMap[utilName]();
+  });
+}
+
 /**
  * @internal
  */
 export function createReactQueryUtils<TRouter extends AnyRouter, TSSRContext>(
-  context: TRPCContextState<AnyRouter, unknown>,
+  context: TRPCContextState<AnyRouter, TSSRContext>,
 ) {
   type CreateReactUtilsReturnType = CreateReactUtils<TRouter, TSSRContext>;
 
@@ -295,38 +343,17 @@ export function createReactQueryUtils<TRouter extends AnyRouter, TSSRContext>(
       return context[contextName];
     }
 
-    return createRecursiveProxy((opts) => {
-      const path = [key, ...opts.path];
-      const utilName = path.pop() as keyof AnyDecoratedProcedure;
-      const args = [...opts.args] as Parameters<
-        AnyDecoratedProcedure[typeof utilName]
-      >;
-      const input = args.shift(); // args can now be spread when input removed
-      const queryType = getQueryType(utilName);
-      const queryKey = getQueryKeyInternal(path, input, queryType);
-
-      const contextMap: Record<keyof AnyDecoratedProcedure, () => unknown> = {
-        fetch: () => context.fetchQuery(queryKey, ...args),
-        fetchInfinite: () => context.fetchInfiniteQuery(queryKey, args[0]),
-        prefetch: () => context.prefetchQuery(queryKey, ...args),
-        prefetchInfinite: () =>
-          context.prefetchInfiniteQuery(queryKey, args[0]),
-        ensureData: () => context.ensureQueryData(queryKey, ...args),
-        invalidate: () => context.invalidateQueries(queryKey, ...args),
-        reset: () => context.resetQueries(queryKey, ...args),
-        refetch: () => context.refetchQueries(queryKey, ...args),
-        cancel: () => context.cancelQuery(queryKey, ...args),
-        setData: () => {
-          context.setQueryData(queryKey, args[0], args[1]);
-        },
-        setInfiniteData: () => {
-          context.setInfiniteQueryData(queryKey, args[0], args[1]);
-        },
-        getData: () => context.getQueryData(queryKey),
-        getInfiniteData: () => context.getInfiniteQueryData(queryKey),
-      };
+    return createRecursiveUtilsProxy(context, key);
+  });
+}
 
-      return contextMap[utilName]();
-    });
+/**
+ * @internal
+ */
+export function createQueryUtilsProxy<TRouter extends AnyRouter>(
+  context: TRPCQueryUtils<TRouter>,
+): CreateQueryUtils<TRouter> {
+  return createFlatProxy((key) => {
+    return createRecursiveUtilsProxy(context, key);
   });
 }

package/src/shared/queryClient.ts

@@ -1,4 +1,5 @@
-import { QueryClient, QueryClientConfig } from '@tanstack/react-query';
+import type { QueryClientConfig } from '@tanstack/react-query';
+import { QueryClient } from '@tanstack/react-query';
 
 /**
  * @internal

package/src/shared/types.ts

@@ -1,5 +1,8 @@
-import { QueryClient } from '@tanstack/react-query';
-import { AnyRouter, MaybePromise } from '@trpc/server';
+import type { QueryClient } from '@tanstack/react-query';
+import type {
+  AnyRouter,
+  MaybePromise,
+} from '@trpc/server/unstable-core-do-not-import';
 
 /**
  * @internal