@trpc/react-query 10.7.0 → 10.8.1

package/src/internals/context.tsx

@@ -1,11 +1,13 @@
 import {
-  CancelOptions,
   FetchInfiniteQueryOptions,
   FetchQueryOptions,
+  QueryClient,
+} from '@tanstack/react-query';
+import {
+  CancelOptions,
   InfiniteData,
   InvalidateOptions,
   InvalidateQueryFilters,
-  QueryClient,
   RefetchOptions,
   RefetchQueryFilters,
   ResetOptions,
@@ -15,16 +17,13 @@ import {
 } from '@tanstack/react-query';
 import {
   TRPCClient,
-  TRPCClientError,
   TRPCRequestOptions,
   inferRouterProxyClient,
 } from '@trpc/client';
-import type {
-  AnyRouter,
-  inferHandlerInput,
-  inferProcedureInput,
-} from '@trpc/server';
-import type { inferTransformedProcedureOutput } from '@trpc/server/shared';
+import { TRPCClientError } from '@trpc/client';
+import type { AnyRouter } from '@trpc/server';
+import { inferHandlerInput, inferProcedureInput } from '@trpc/server';
+import { inferTransformedProcedureOutput } from '@trpc/server/shared';
 import { createContext } from 'react';
 
 export interface TRPCFetchQueryOptions<TInput, TError, TOutput>
@@ -64,6 +63,9 @@ export interface ProxyTRPCContextProps<TRouter extends AnyRouter, TSSRContext> {
   abortOnUnmount?: boolean;
 }
 
+/**
+ * @internal
+ */
 export type DecoratedProxyTRPCContextProps<
   TRouter extends AnyRouter,
   TSSRContext,
@@ -87,6 +89,27 @@ export const contextProps: (keyof ProxyTRPCContextProps<any, any>)[] = [
 ];
 
 /** @internal */
+type TRPCContextResetQueries<TRouter extends AnyRouter> =
+  /**
+   * @link https://react-query.tanstack.com/reference/QueryClient#queryclientresetqueries
+   */
+  (<
+    TPath extends keyof TRouter['_def']['queries'] & string,
+    TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
+  >(
+    pathAndInput?: [TPath, TInput?] | TPath,
+    filters?: ResetQueryFilters,
+    options?: ResetOptions,
+  ) => Promise<void>) &
+    /**
+     * @link https://react-query.tanstack.com/reference/QueryClient#queryclientresetqueries
+     */
+    ((filters?: ResetQueryFilters, options?: ResetOptions) => Promise<void>);
+
+/**
+ * @deprecated
+ * @internal
+ **/
 export interface TRPCContextState<
   TRouter extends AnyRouter,
   TSSRContext = undefined,
@@ -94,7 +117,7 @@ export interface TRPCContextState<
   /**
    * @link https://tanstack.com/query/v4/docs/reference/QueryClient#queryclientfetchquery
    */
-  fetchQuery<
+  fetchQuery: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TProcedure extends TRouter['_def']['queries'][TPath],
     TOutput extends inferTransformedProcedureOutput<TProcedure>,
@@ -102,11 +125,11 @@ export interface TRPCContextState<
   >(
     pathAndInput: [path: TPath, ...args: inferHandlerInput<TProcedure>],
     opts?: TRPCFetchQueryOptions<TInput, TRPCClientError<TRouter>, TOutput>,
-  ): Promise<TOutput>;
+  ) => Promise<TOutput>;
   /**
    * @link https://tanstack.com/query/v4/docs/reference/QueryClient#queryclientfetchinfinitequery
    */
-  fetchInfiniteQuery<
+  fetchInfiniteQuery: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TProcedure extends TRouter['_def']['queries'][TPath],
     TOutput extends inferTransformedProcedureOutput<TProcedure>,
@@ -118,11 +141,11 @@ export interface TRPCContextState<
       TRPCClientError<TRouter>,
       TOutput
     >,
-  ): Promise<InfiniteData<TOutput>>;
+  ) => Promise<InfiniteData<TOutput>>;
   /**
    * @link https://react-query.tanstack.com/guides/prefetching
    */
-  prefetchQuery<
+  prefetchQuery: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TProcedure extends TRouter['_def']['queries'][TPath],
     TOutput extends inferTransformedProcedureOutput<TProcedure>,
@@ -130,12 +153,12 @@ export interface TRPCContextState<
   >(
     pathAndInput: [path: TPath, ...args: inferHandlerInput<TProcedure>],
     opts?: TRPCFetchQueryOptions<TInput, TRPCClientError<TRouter>, TOutput>,
-  ): Promise<void>;
+  ) => Promise<void>;
 
   /**
    * @link https://tanstack.com/query/v4/docs/reference/QueryClient#queryclientprefetchinfinitequery
    */
-  prefetchInfiniteQuery<
+  prefetchInfiniteQuery: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TProcedure extends TRouter['_def']['queries'][TPath],
     TOutput extends inferTransformedProcedureOutput<TProcedure>,
@@ -147,39 +170,24 @@ export interface TRPCContextState<
       TRPCClientError<TRouter>,
       TOutput
     >,
-  ): Promise<void>;
+  ) => Promise<void>;
 
   /**
    * @link https://react-query.tanstack.com/guides/query-invalidation
    */
-  invalidateQueries<
+  invalidateQueries: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
   >(
     pathAndInput?: [TPath, TInput?] | TPath,
     filters?: InvalidateQueryFilters,
     options?: InvalidateOptions,
-  ): Promise<void>;
+  ) => Promise<void>;
 
   /**
    * @link https://react-query.tanstack.com/reference/QueryClient#queryclientresetqueries
    */
-  resetQueries<
-    TPath extends keyof TRouter['_def']['queries'] & string,
-    TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
-  >(
-    pathAndInput?: [TPath, TInput?] | TPath,
-    filters?: ResetQueryFilters,
-    options?: ResetOptions,
-  ): Promise<void>;
-
-  /**
-   * @link https://react-query.tanstack.com/reference/QueryClient#queryclientresetqueries
-   */
-  resetQueries(
-    filters?: ResetQueryFilters,
-    options?: ResetOptions,
-  ): Promise<void>;
+  resetQueries: TRPCContextResetQueries<TRouter>;
 
   /**
    * @link https://react-query.tanstack.com/reference/QueryClient#queryclientrefetchqueries
@@ -203,17 +211,17 @@ export interface TRPCContextState<
   /**
    * @link https://react-query.tanstack.com/guides/query-cancellation
    */
-  cancelQuery<
+  cancelQuery: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
   >(
     pathAndInput: [TPath, TInput?],
     options?: CancelOptions,
-  ): Promise<void>;
+  ) => Promise<void>;
   /**
    * @link https://react-query.tanstack.com/reference/QueryClient#queryclientsetquerydata
    */
-  setQueryData<
+  setQueryData: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
     TOutput extends inferTransformedProcedureOutput<
@@ -223,11 +231,11 @@ export interface TRPCContextState<
     pathAndInput: [TPath, TInput?],
     updater: Updater<TOutput | undefined, TOutput | undefined>,
     options?: SetDataOptions,
-  ): void;
+  ) => void;
   /**
    * @link https://react-query.tanstack.com/reference/QueryClient#queryclientgetquerydata
    */
-  getQueryData<
+  getQueryData: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
     TOutput extends inferTransformedProcedureOutput<
@@ -235,11 +243,11 @@ export interface TRPCContextState<
     >,
   >(
     pathAndInput: [TPath, TInput?],
-  ): TOutput | undefined;
+  ) => TOutput | undefined;
   /**
    * @link https://react-query.tanstack.com/reference/QueryClient#queryclientsetquerydata
    */
-  setInfiniteQueryData<
+  setInfiniteQueryData: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
     TOutput extends inferTransformedProcedureOutput<
@@ -252,11 +260,11 @@ export interface TRPCContextState<
       InfiniteData<TOutput> | undefined
     >,
     options?: SetDataOptions,
-  ): void;
+  ) => void;
   /**
    * @link https://react-query.tanstack.com/reference/QueryClient#queryclientgetquerydata
    */
-  getInfiniteQueryData<
+  getInfiniteQueryData: <
     TPath extends keyof TRouter['_def']['queries'] & string,
     TInput extends inferProcedureInput<TRouter['_def']['queries'][TPath]>,
     TOutput extends inferTransformedProcedureOutput<
@@ -264,7 +272,7 @@ export interface TRPCContextState<
     >,
   >(
     pathAndInput: [TPath, TInput?],
-  ): InfiniteData<TOutput> | undefined;
+  ) => InfiniteData<TOutput> | undefined;
 }
 
 export const TRPCContext = createContext(null as any);

package/src/internals/getClientArgs.ts

@@ -0,0 +1,7 @@
+export function getClientArgs<TPathAndInput extends unknown[], TOptions>(
+  pathAndInput: TPathAndInput,
+  opts: TOptions,
+) {
+  const [path, input] = pathAndInput;
+  return [path, input, (opts as any)?.trpc] as const;
+}

package/src/internals/useHookResult.ts

@@ -0,0 +1,18 @@
+import { useRef } from 'react';
+
+export interface TRPCHookResult {
+  trpc: {
+    path: string;
+  };
+}
+
+/**
+ * Makes a stable reference of the `trpc` prop
+ */
+export function useHookResult(
+  value: TRPCHookResult['trpc'],
+): TRPCHookResult['trpc'] {
+  const ref = useRef(value);
+  ref.current.path = value.path;
+  return ref.current;
+}