npm - @tanstack/react-query - Versions diffs - 5.0.0-beta.9 → 5.0.0-rc.0 - Mend

@tanstack/react-query 5.0.0-beta.9 → 5.0.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (113) hide show

package/build/codemods/coverage/clover.xml +2 -2
package/build/codemods/coverage/index.html +1 -1
package/build/legacy/HydrationBoundary.cjs +37 -2
package/build/legacy/HydrationBoundary.cjs.map +1 -1
package/build/legacy/HydrationBoundary.d.cts +3 -1
package/build/legacy/HydrationBoundary.d.ts +3 -1
package/build/legacy/HydrationBoundary.js +37 -2
package/build/legacy/HydrationBoundary.js.map +1 -1
package/build/legacy/index.cjs +3 -0
package/build/legacy/index.cjs.map +1 -1
package/build/legacy/index.d.cts +1 -0
package/build/legacy/index.d.ts +1 -0
package/build/legacy/index.js +2 -0
package/build/legacy/index.js.map +1 -1
package/build/legacy/queryOptions.cjs.map +1 -1
package/build/legacy/queryOptions.d.cts +7 -3
package/build/legacy/queryOptions.d.ts +7 -3
package/build/legacy/queryOptions.js.map +1 -1
package/build/legacy/suspense.cjs +3 -0
package/build/legacy/suspense.cjs.map +1 -1
package/build/legacy/suspense.d.cts +3 -2
package/build/legacy/suspense.d.ts +3 -2
package/build/legacy/suspense.js +2 -0
package/build/legacy/suspense.js.map +1 -1
package/build/legacy/types.cjs.map +1 -1
package/build/legacy/types.d.cts +4 -4
package/build/legacy/types.d.ts +4 -4
package/build/legacy/useQueries.cjs.map +1 -1
package/build/legacy/useQueries.d.cts +4 -4
package/build/legacy/useQueries.d.ts +4 -4
package/build/legacy/useQueries.js.map +1 -1
package/build/legacy/useSuspenseQueries.cjs +47 -0
package/build/legacy/useSuspenseQueries.cjs.map +1 -0
package/build/legacy/useSuspenseQueries.d.cts +66 -0
package/build/legacy/useSuspenseQueries.d.ts +66 -0
package/build/legacy/useSuspenseQueries.js +23 -0
package/build/legacy/useSuspenseQueries.js.map +1 -0
package/build/legacy/useSuspenseQuery.cjs +2 -1
package/build/legacy/useSuspenseQuery.cjs.map +1 -1
package/build/legacy/useSuspenseQuery.js +2 -1
package/build/legacy/useSuspenseQuery.js.map +1 -1
package/build/legacy/utils.cjs.map +1 -1
package/build/legacy/utils.d.cts +1 -1
package/build/legacy/utils.d.ts +1 -1
package/build/legacy/utils.js.map +1 -1
package/build/modern/HydrationBoundary.cjs +37 -2
package/build/modern/HydrationBoundary.cjs.map +1 -1
package/build/modern/HydrationBoundary.d.cts +3 -1
package/build/modern/HydrationBoundary.d.ts +3 -1
package/build/modern/HydrationBoundary.js +37 -2
package/build/modern/HydrationBoundary.js.map +1 -1
package/build/modern/index.cjs +3 -0
package/build/modern/index.cjs.map +1 -1
package/build/modern/index.d.cts +1 -0
package/build/modern/index.d.ts +1 -0
package/build/modern/index.js +2 -0
package/build/modern/index.js.map +1 -1
package/build/modern/queryOptions.cjs.map +1 -1
package/build/modern/queryOptions.d.cts +7 -3
package/build/modern/queryOptions.d.ts +7 -3
package/build/modern/queryOptions.js.map +1 -1
package/build/modern/suspense.cjs +3 -0
package/build/modern/suspense.cjs.map +1 -1
package/build/modern/suspense.d.cts +3 -2
package/build/modern/suspense.d.ts +3 -2
package/build/modern/suspense.js +2 -0
package/build/modern/suspense.js.map +1 -1
package/build/modern/types.cjs.map +1 -1
package/build/modern/types.d.cts +4 -4
package/build/modern/types.d.ts +4 -4
package/build/modern/useQueries.cjs.map +1 -1
package/build/modern/useQueries.d.cts +4 -4
package/build/modern/useQueries.d.ts +4 -4
package/build/modern/useQueries.js.map +1 -1
package/build/modern/useSuspenseQueries.cjs +47 -0
package/build/modern/useSuspenseQueries.cjs.map +1 -0
package/build/modern/useSuspenseQueries.d.cts +66 -0
package/build/modern/useSuspenseQueries.d.ts +66 -0
package/build/modern/useSuspenseQueries.js +23 -0
package/build/modern/useSuspenseQueries.js.map +1 -0
package/build/modern/useSuspenseQuery.cjs +2 -1
package/build/modern/useSuspenseQuery.cjs.map +1 -1
package/build/modern/useSuspenseQuery.js +2 -1
package/build/modern/useSuspenseQuery.js.map +1 -1
package/build/modern/utils.cjs.map +1 -1
package/build/modern/utils.d.cts +1 -1
package/build/modern/utils.d.ts +1 -1
package/build/modern/utils.js.map +1 -1
package/package.json +7 -3
package/src/HydrationBoundary.tsx +78 -8
package/src/__tests__/HydrationBoundary.test.tsx +111 -7
package/src/__tests__/QueryResetErrorBoundary.test.tsx +10 -6
package/src/__tests__/fine-grained-persister.test.tsx +163 -0
package/src/__tests__/queryOptions.types.test.tsx +31 -0
package/src/__tests__/ssr.test.tsx +2 -2
package/src/__tests__/suspense.test.tsx +94 -386
package/src/__tests__/useInfiniteQuery.test.tsx +44 -44
package/src/__tests__/useInfiniteQuery.type.test.tsx +10 -10
package/src/__tests__/useIsFetching.test.tsx +2 -2
package/src/__tests__/useMutation.test.tsx +4 -4
package/src/__tests__/useMutationState.test.tsx +4 -4
package/src/__tests__/useQueries.test.tsx +65 -64
package/src/__tests__/useQuery.test.tsx +142 -141
package/src/__tests__/useQuery.types.test.tsx +34 -0
package/src/__tests__/utils.tsx +0 -7
package/src/index.ts +5 -0
package/src/queryOptions.ts +11 -3
package/src/suspense.ts +12 -0
package/src/types.ts +18 -12
package/src/useQueries.ts +34 -28
package/src/useSuspenseQueries.ts +164 -0
package/src/useSuspenseQuery.ts +2 -1
package/src/utils.ts +1 -1

package/build/modern/useSuspenseQueries.d.cts ADDED Viewed

@@ -0,0 +1,66 @@
+import { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types.cjs';
+import { DefaultError, QueryClient, QueryFunction } from '@tanstack/query-core';
+type MAXIMUM_DEPTH = 20;
+type GetSuspenseOptions<T> = T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+    data: infer TData;
+} ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+} ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends {
+    data: infer TData;
+    error?: infer TError;
+} ? UseSuspenseQueryOptions<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryOptions<TQueryFnData> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
+    select: (data: any) => infer TData;
+} ? UseSuspenseQueryOptions<TQueryFnData, Error, TData, TQueryKey> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
+} ? UseSuspenseQueryOptions<TQueryFnData, Error, TQueryFnData, TQueryKey> : UseSuspenseQueryOptions;
+type GetSuspenseResults<T> = T extends {
+    queryFnData: any;
+    error?: infer TError;
+    data: infer TData;
+} ? UseSuspenseQueryResult<TData, TError> : T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+} ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends {
+    data: infer TData;
+    error?: infer TError;
+} ? UseSuspenseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseSuspenseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryResult<TQueryFnData> : T extends {
+    queryFn?: QueryFunction<unknown, any>;
+    select: (data: any) => infer TData;
+} ? UseSuspenseQueryResult<TData> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, any>;
+} ? UseSuspenseQueryResult<TQueryFnData> : UseSuspenseQueryResult;
+/**
+ * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
+ */
+type SuspenseQueriesOptions<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryOptions> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetSuspenseOptions<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesOptions<[
+    ...Tail
+], [
+    ...Result,
+    GetSuspenseOptions<Head>
+], [
+    ...Depth,
+    1
+]> : Array<unknown> extends T ? T : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>> : Array<UseSuspenseQueryOptions>;
+/**
+ * SuspenseQueriesResults reducer recursively maps type param to results
+ */
+type SuspenseQueriesResults<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetSuspenseResults<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesResults<[
+    ...Tail
+], [
+    ...Result,
+    GetSuspenseResults<Head>
+], [
+    ...Depth,
+    1
+]> : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>> ? Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError>> : Array<UseSuspenseQueryResult>;
+declare function useSuspenseQueries<T extends Array<any>, TCombinedResult = SuspenseQueriesResults<T>>(options: {
+    queries: readonly [...SuspenseQueriesOptions<T>];
+    combine?: (result: SuspenseQueriesResults<T>) => TCombinedResult;
+}, queryClient?: QueryClient): TCombinedResult;
+export { SuspenseQueriesOptions, SuspenseQueriesResults, useSuspenseQueries };

package/build/modern/useSuspenseQueries.d.ts ADDED Viewed

@@ -0,0 +1,66 @@
+import { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types.js';
+import { DefaultError, QueryClient, QueryFunction } from '@tanstack/query-core';
+type MAXIMUM_DEPTH = 20;
+type GetSuspenseOptions<T> = T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+    data: infer TData;
+} ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+} ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends {
+    data: infer TData;
+    error?: infer TError;
+} ? UseSuspenseQueryOptions<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryOptions<TQueryFnData> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
+    select: (data: any) => infer TData;
+} ? UseSuspenseQueryOptions<TQueryFnData, Error, TData, TQueryKey> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
+} ? UseSuspenseQueryOptions<TQueryFnData, Error, TQueryFnData, TQueryKey> : UseSuspenseQueryOptions;
+type GetSuspenseResults<T> = T extends {
+    queryFnData: any;
+    error?: infer TError;
+    data: infer TData;
+} ? UseSuspenseQueryResult<TData, TError> : T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+} ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends {
+    data: infer TData;
+    error?: infer TError;
+} ? UseSuspenseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseSuspenseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryResult<TQueryFnData> : T extends {
+    queryFn?: QueryFunction<unknown, any>;
+    select: (data: any) => infer TData;
+} ? UseSuspenseQueryResult<TData> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, any>;
+} ? UseSuspenseQueryResult<TQueryFnData> : UseSuspenseQueryResult;
+/**
+ * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
+ */
+type SuspenseQueriesOptions<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryOptions> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetSuspenseOptions<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesOptions<[
+    ...Tail
+], [
+    ...Result,
+    GetSuspenseOptions<Head>
+], [
+    ...Depth,
+    1
+]> : Array<unknown> extends T ? T : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>> : Array<UseSuspenseQueryOptions>;
+/**
+ * SuspenseQueriesResults reducer recursively maps type param to results
+ */
+type SuspenseQueriesResults<T extends Array<any>, Result extends Array<any> = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...Result, GetSuspenseResults<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesResults<[
+    ...Tail
+], [
+    ...Result,
+    GetSuspenseResults<Head>
+], [
+    ...Depth,
+    1
+]> : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>> ? Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError>> : Array<UseSuspenseQueryResult>;
+declare function useSuspenseQueries<T extends Array<any>, TCombinedResult = SuspenseQueriesResults<T>>(options: {
+    queries: readonly [...SuspenseQueriesOptions<T>];
+    combine?: (result: SuspenseQueriesResults<T>) => TCombinedResult;
+}, queryClient?: QueryClient): TCombinedResult;
+export { SuspenseQueriesOptions, SuspenseQueriesResults, useSuspenseQueries };

package/build/modern/useSuspenseQueries.js ADDED Viewed

@@ -0,0 +1,23 @@
+"use client";
+// src/useSuspenseQueries.ts
+import { useQueries } from "./useQueries.js";
+import { defaultThrowOnError } from "./suspense.js";
+function useSuspenseQueries(options, queryClient) {
+  return useQueries(
+    {
+      ...options,
+      queries: options.queries.map((query) => ({
+        ...query,
+        suspense: true,
+        throwOnError: defaultThrowOnError,
+        enabled: true
+      }))
+    },
+    queryClient
+  );
+}
+export {
+  useSuspenseQueries
+};
+//# sourceMappingURL=useSuspenseQueries.js.map

package/build/modern/useSuspenseQueries.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["'use client'\nimport { useQueries } from './useQueries'\nimport { defaultThrowOnError } from './suspense'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\nimport type {\n DefaultError,\n QueryClient,\n QueryFunction,\n} from '@tanstack/query-core'\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetSuspenseOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryOptions<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryOptions<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select: (data: any) => infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, Error, TData, TQueryKey>\n : T extends { queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> }\n ? UseSuspenseQueryOptions<TQueryFnData, Error, TQueryFnData, TQueryKey>\n : // Fallback\n UseSuspenseQueryOptions\n\ntype GetSuspenseResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? UseSuspenseQueryResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? UseSuspenseQueryResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<unknown, any>\n select: (data: any) => infer TData\n }\n ? UseSuspenseQueryResult<TData>\n : T extends { queryFn?: QueryFunction<infer TQueryFnData, any> }\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Fallback\n UseSuspenseQueryResult\n\n/**\n * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type SuspenseQueriesOptions<\n T extends Array<any>,\n Result extends Array<any> = [],\n Depth extends ReadonlyArray<number> = [],\n> = Depth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryOptions>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...Result, GetSuspenseOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesOptions<\n [...Tail],\n [...Result, GetSuspenseOptions<Head>],\n [...Depth, 1]\n >\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseSuspenseQueryOptions>\n\n/**\n * SuspenseQueriesResults reducer recursively maps type param to results\n */\nexport type SuspenseQueriesResults<\n T extends Array<any>,\n Result extends Array<any> = [],\n Depth extends ReadonlyArray<number> = [],\n> = Depth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...Result, GetSuspenseResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesResults<\n [...Tail],\n [...Result, GetSuspenseResults<Head>],\n [...Depth, 1]\n >\n : T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any\n >\n >\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<\n UseSuspenseQueryResult<\n unknown extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n >\n : // Fallback\n Array<UseSuspenseQueryResult>\n\nexport function useSuspenseQueries<\n T extends Array<any>,\n TCombinedResult = SuspenseQueriesResults<T>,\n>(\n options: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n combine?: (result: SuspenseQueriesResults<T>) => TCombinedResult\n },\n queryClient?: QueryClient,\n): TCombinedResult {\n return useQueries(\n {\n ...options,\n queries: options.queries.map((query) => ({\n ...query,\n suspense: true,\n throwOnError: defaultThrowOnError,\n enabled: true,\n })),\n } as any,\n queryClient,\n )\n}\n"],"mappings":";;;AACA,SAAS,kBAAkB;AAC3B,SAAS,2BAA2B;AA2I7B,SAAS,mBAId,SAIA,aACiB;AACjB,SAAO;AAAA,IACL;AAAA,MACE,GAAG;AAAA,MACH,SAAS,QAAQ,QAAQ,IAAI,CAAC,WAAW;AAAA,QACvC,GAAG;AAAA,QACH,UAAU;AAAA,QACV,cAAc;AAAA,QACd,SAAS;AAAA,MACX,EAAE;AAAA,IACJ;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/build/modern/useSuspenseQuery.cjs CHANGED Viewed

@@ -26,13 +26,14 @@ __export(useSuspenseQuery_exports, {
 module.exports = __toCommonJS(useSuspenseQuery_exports);
 var import_query_core = require("@tanstack/query-core");
 var import_useBaseQuery = require("./useBaseQuery.cjs");
+var import_suspense = require("./suspense.cjs");
 function useSuspenseQuery(options, queryClient) {
   return (0, import_useBaseQuery.useBaseQuery)(
     {
       ...options,
       enabled: true,
       suspense: true,
-      throwOnError: true
+      throwOnError: import_suspense.defaultThrowOnError
     },
     import_query_core.QueryObserver,
     queryClient

package/build/modern/useSuspenseQuery.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\nimport type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core'\n\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> {\n return useBaseQuery(\n {\n ...options,\n enabled: true,\n suspense: true,\n throwOnError: ~~true~~,\n },\n QueryObserver,\n queryClient,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,wBAA8B;AAC9B,0BAA6B;~~AAItB~~,SAAS,iBAMd,SACA,aACuC;AACvC,aAAO;AAAA,IACL;AAAA,MACE,GAAG;AAAA,MACH,SAAS;AAAA,MACT,UAAU;AAAA,MACV,cAAc;AAAA,IAChB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
1	+ {"version":3,"sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport { defaultThrowOnError } from './suspense'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\nimport type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core'\n\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> {\n return useBaseQuery(\n {\n ...options,\n enabled: true,\n suspense: true,\n throwOnError: defaultThrowOnError,\n },\n QueryObserver,\n queryClient,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,wBAA8B;AAC9B,0BAA6B;AAC7B,sBAAoC;AAI7B,SAAS,iBAMd,SACA,aACuC;AACvC,aAAO;AAAA,IACL;AAAA,MACE,GAAG;AAAA,MACH,SAAS;AAAA,MACT,UAAU;AAAA,MACV,cAAc;AAAA,IAChB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/build/modern/useSuspenseQuery.js CHANGED Viewed

@@ -3,13 +3,14 @@
 // src/useSuspenseQuery.ts
 import { QueryObserver } from "@tanstack/query-core";
 import { useBaseQuery } from "./useBaseQuery.js";
+import { defaultThrowOnError } from "./suspense.js";
 function useSuspenseQuery(options, queryClient) {
   return useBaseQuery(
     {
       ...options,
       enabled: true,
       suspense: true,
-      throwOnError: true
+      throwOnError: defaultThrowOnError
     },
     QueryObserver,
     queryClient

package/build/modern/useSuspenseQuery.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\nimport type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core'\n\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> {\n return useBaseQuery(\n {\n ...options,\n enabled: true,\n suspense: true,\n throwOnError: ~~true~~,\n },\n QueryObserver,\n queryClient,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"mappings":";;;AACA,SAAS,qBAAqB;AAC9B,SAAS,oBAAoB;~~AAItB~~,SAAS,iBAMd,SACA,aACuC;AACvC,SAAO;AAAA,IACL;AAAA,MACE,GAAG;AAAA,MACH,SAAS;AAAA,MACT,UAAU;AAAA,MACV,cAAc;AAAA,IAChB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
1	+ {"version":3,"sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport { defaultThrowOnError } from './suspense'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\nimport type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core'\n\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseSuspenseQueryResult<TData, TError> {\n return useBaseQuery(\n {\n ...options,\n enabled: true,\n suspense: true,\n throwOnError: defaultThrowOnError,\n },\n QueryObserver,\n queryClient,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"mappings":";;;AACA,SAAS,qBAAqB;AAC9B,SAAS,oBAAoB;AAC7B,SAAS,2BAA2B;AAI7B,SAAS,iBAMd,SACA,aACuC;AACvC,SAAO;AAAA,IACL;AAAA,MACE,GAAG;AAAA,MACH,SAAS;AAAA,MACT,UAAU;AAAA,MACV,cAAc;AAAA,IAChB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/build/modern/utils.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function shouldThrowError<T extends (...args: any[]) => boolean>(\n throwError: boolean \| T \| undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwError function to override throwing behavior on a per-error basis\n if (typeof throwError === 'function') {\n return throwError(...params)\n }\n\n return !!throwError\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,SAAS,iBACd,YACA,QACS;AAET,MAAI,OAAO,eAAe,YAAY;AACpC,WAAO,WAAW,GAAG,MAAM;AAAA,EAC7B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}
1	+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function shouldThrowError<T extends (...args: Array<any>) => boolean>(\n throwError: boolean \| T \| undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwError function to override throwing behavior on a per-error basis\n if (typeof throwError === 'function') {\n return throwError(...params)\n }\n\n return !!throwError\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,SAAS,iBACd,YACA,QACS;AAET,MAAI,OAAO,eAAe,YAAY;AACpC,WAAO,WAAW,GAAG,MAAM;AAAA,EAC7B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}

package/build/modern/utils.d.cts CHANGED Viewed

@@ -1,3 +1,3 @@
-declare function shouldThrowError<T extends (...args: any[]) => boolean>(throwError: boolean | T | undefined, params: Parameters<T>): boolean;
+declare function shouldThrowError<T extends (...args: Array<any>) => boolean>(throwError: boolean | T | undefined, params: Parameters<T>): boolean;
 export { shouldThrowError };

package/build/modern/utils.d.ts CHANGED Viewed

@@ -1,3 +1,3 @@
-declare function shouldThrowError<T extends (...args: any[]) => boolean>(throwError: boolean | T | undefined, params: Parameters<T>): boolean;
+declare function shouldThrowError<T extends (...args: Array<any>) => boolean>(throwError: boolean | T | undefined, params: Parameters<T>): boolean;
 export { shouldThrowError };

package/build/modern/utils.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function shouldThrowError<T extends (...args: any[]) => boolean>(\n throwError: boolean \| T \| undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwError function to override throwing behavior on a per-error basis\n if (typeof throwError === 'function') {\n return throwError(...params)\n }\n\n return !!throwError\n}\n"],"mappings":";AAAO,SAAS,iBACd,YACA,QACS;AAET,MAAI,OAAO,eAAe,YAAY;AACpC,WAAO,WAAW,GAAG,MAAM;AAAA,EAC7B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}
1	+ {"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function shouldThrowError<T extends (...args: Array<any>) => boolean>(\n throwError: boolean \| T \| undefined,\n params: Parameters<T>,\n): boolean {\n // Allow throwError function to override throwing behavior on a per-error basis\n if (typeof throwError === 'function') {\n return throwError(...params)\n }\n\n return !!throwError\n}\n"],"mappings":";AAAO,SAAS,iBACd,YACA,QACS;AAET,MAAI,OAAO,eAAe,YAAY;AACpC,WAAO,WAAW,GAAG,MAAM;AAAA,EAC7B;AAEA,SAAO,CAAC,CAAC;AACX;","names":[]}

package/package.json CHANGED Viewed

@@ -1,10 +1,14 @@
 {
   "name": "@tanstack/react-query",
-  "version": "5.0.0-beta.9",
+  "version": "5.0.0-rc.0",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in React",
   "author": "tannerlinsley",
   "license": "MIT",
-  "repository": "tanstack/query",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/query.git",
+    "directory": "packages/react-query"
+  },
   "homepage": "https://tanstack.com/query",
   "funding": {
     "type": "github",
@@ -38,7 +42,7 @@
   ],
   "dependencies": {
     "client-only": "0.0.1",
-    "@tanstack/query-core": "5.0.0-beta.9"
+    "@tanstack/query-core": "5.0.0-rc.0"
   },
   "devDependencies": {
     "@types/react": "^18.2.4",

package/src/HydrationBoundary.tsx CHANGED Viewed

@@ -3,11 +3,17 @@ import * as React from 'react'
 import { hydrate } from '@tanstack/query-core'
 import { useQueryClient } from './QueryClientProvider'
-import type { HydrateOptions, QueryClient } from '@tanstack/query-core'
+import type {
+  DehydratedState,
+  HydrateOptions,
+  QueryClient,
+} from '@tanstack/query-core'
 export interface HydrationBoundaryProps {
   state?: unknown
-  options?: HydrateOptions
+  options?: Omit<HydrateOptions, 'defaultOptions'> & {
+    defaultOptions?: Omit<HydrateOptions['defaultOptions'], 'mutations'>
+  }
   children?: React.ReactNode
   queryClient?: QueryClient
 }
@@ -19,19 +25,83 @@ export const HydrationBoundary = ({
   queryClient,
 }: HydrationBoundaryProps) => {
   const client = useQueryClient(queryClient)
+  const [hydrationQueue, setHydrationQueue] = React.useState<
+    DehydratedState['queries'] | undefined
+  >()
   const optionsRef = React.useRef(options)
   optionsRef.current = options
-  // Running hydrate again with the same queries is safe,
-  // it wont overwrite or initialize existing queries,
-  // relying on useMemo here is only a performance optimization.
-  // hydrate can and should be run *during* render here for SSR to work properly
+  // This useMemo is for performance reasons only, everything inside it _must_
+  // be safe to run in every render and code here should be read as "in render".
+  //
+  // This code needs to happen during the render phase, because after initial
+  // SSR, hydration needs to happen _before_ children render. Also, if hydrating
+  // during a transition, we want to hydrate as much as is safe in render so
+  // we can prerender as much as possible.
+  //
+  // For any queries that already exist in the cache, we want to hold back on
+  // hydrating until _after_ the render phase. The reason for this is that during
+  // transitions, we don't want the existing queries and observers to update to
+  // the new data on the current page, only _after_ the transition is committed.
+  // If the transition is aborted, we will have hydrated any _new_ queries, but
+  // we throw away the fresh data for any existing ones to avoid unexpectedly
+  // updating the UI.
   React.useMemo(() => {
     if (state) {
-      hydrate(client, state, optionsRef.current)
+      if (typeof state !== 'object') {
+        return
+      }
+      const queryCache = client.getQueryCache()
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      const queries = (state as DehydratedState).queries || []
+      const newQueries: DehydratedState['queries'] = []
+      const existingQueries: DehydratedState['queries'] = []
+      for (const dehydratedQuery of queries) {
+        const existingQuery = queryCache.get(dehydratedQuery.queryHash)
+        if (!existingQuery) {
+          newQueries.push(dehydratedQuery)
+        } else {
+          const hydrationIsNewer =
+            dehydratedQuery.state.dataUpdatedAt >
+            existingQuery.state.dataUpdatedAt
+          const queryAlreadyQueued = hydrationQueue?.find(
+            (query) => query.queryHash === dehydratedQuery.queryHash,
+          )
+          if (
+            hydrationIsNewer &&
+            (!queryAlreadyQueued ||
+              dehydratedQuery.state.dataUpdatedAt >
+                queryAlreadyQueued.state.dataUpdatedAt)
+          ) {
+            existingQueries.push(dehydratedQuery)
+          }
+        }
+      }
+      if (newQueries.length > 0) {
+        // It's actually fine to call this with queries/state that already exists
+        // in the cache, or is older. hydrate() is idempotent for queries.
+        hydrate(client, { queries: newQueries }, optionsRef.current)
+      }
+      if (existingQueries.length > 0) {
+        setHydrationQueue((prev) =>
+          prev ? [...prev, ...existingQueries] : existingQueries,
+        )
+      }
+    }
+  }, [client, hydrationQueue, state])
+  React.useEffect(() => {
+    if (hydrationQueue) {
+      hydrate(client, { queries: hydrationQueue }, optionsRef.current)
+      setHydrationQueue(undefined)
     }
-  }, [client, state])
+  }, [client, hydrationQueue])
   return children as React.ReactElement
 }

package/src/__tests__/HydrationBoundary.test.tsx CHANGED Viewed

@@ -137,8 +137,8 @@ describe('React hydration', () => {
         queryFn: () => dataQuery(['should change']),
       })
       await intermediateClient.prefetchQuery({
-        queryKey: ['added string'],
-        queryFn: () => dataQuery(['added string']),
+        queryKey: ['added'],
+        queryFn: () => dataQuery(['added']),
       })
       const dehydrated = dehydrate(intermediateClient)
       intermediateClient.clear()
@@ -147,17 +147,121 @@ describe('React hydration', () => {
         <QueryClientProvider client={queryClient}>
           <HydrationBoundary state={dehydrated}>
             <Page queryKey={['string']} />
-            <Page queryKey={['added string']} />
+            <Page queryKey={['added']} />
           </HydrationBoundary>
         </QueryClientProvider>,
       )
-      // Existing query data should be overwritten if older,
-      // so this should have changed
+      // Existing observer should not have updated at this point,
+      // as that would indicate a side effect in the render phase
+      rendered.getByText('string')
+      // New query data should be available immediately
+      rendered.getByText('added')
       await sleep(10)
+      // After effects phase has had time to run, the observer should have updated
+      expect(rendered.queryByText('string')).toBeNull()
       rendered.getByText('should change')
-      // New query data should be available immediately
-      rendered.getByText('added string')
+      queryClient.clear()
+    })
+    // When we hydrate in transitions that are later aborted, it could be
+    // confusing to both developers and users if we suddenly updated existing
+    // state on the screen (why did this update when it was not stale, nothing
+    // remounted, I didn't change tabs etc?).
+    // Any queries that does not exist in the cache yet can still be hydrated
+    // since they don't have any observers on the current page that would update.
+    test('should hydrate new but not existing queries if transition is aborted', async () => {
+      const initialDehydratedState = JSON.parse(stringifiedState)
+      const queryCache = new QueryCache()
+      const queryClient = createQueryClient({ queryCache })
+      function Page({ queryKey }: { queryKey: [string] }) {
+        const { data } = useQuery({
+          queryKey,
+          queryFn: () => dataQuery(queryKey),
+        })
+        return (
+          <div>
+            <h1>{data}</h1>
+          </div>
+        )
+      }
+      const rendered = render(
+        <QueryClientProvider client={queryClient}>
+          <HydrationBoundary state={initialDehydratedState}>
+            <Page queryKey={['string']} />
+          </HydrationBoundary>
+        </QueryClientProvider>,
+      )
+      await rendered.findByText('string')
+      const intermediateCache = new QueryCache()
+      const intermediateClient = createQueryClient({
+        queryCache: intermediateCache,
+      })
+      await intermediateClient.prefetchQuery({
+        queryKey: ['string'],
+        queryFn: () => dataQuery(['should not change']),
+      })
+      await intermediateClient.prefetchQuery({
+        queryKey: ['added'],
+        queryFn: () => dataQuery(['added']),
+      })
+      const newDehydratedState = dehydrate(intermediateClient)
+      intermediateClient.clear()
+      function Thrower() {
+        throw new Promise(() => {
+          // Never resolve
+        })
+        // @ts-ignore
+        return null
+      }
+      React.startTransition(() => {
+        rendered.rerender(
+          <React.Suspense fallback="loading">
+            <QueryClientProvider client={queryClient}>
+              <HydrationBoundary state={newDehydratedState}>
+                <Page queryKey={['string']} />
+                <Page queryKey={['added']} />
+                <Thrower />
+              </HydrationBoundary>
+            </QueryClientProvider>
+          </React.Suspense>,
+        )
+        rendered.getByText('loading')
+      })
+      React.startTransition(() => {
+        rendered.rerender(
+          <QueryClientProvider client={queryClient}>
+            <HydrationBoundary state={initialDehydratedState}>
+              <Page queryKey={['string']} />
+              <Page queryKey={['added']} />
+            </HydrationBoundary>
+          </QueryClientProvider>,
+        )
+        // This query existed before the transition so it should stay the same
+        rendered.getByText('string')
+        expect(rendered.queryByText('should not change')).toBeNull()
+        // New query data should be available immediately because it was
+        // hydrated in the previous transition, even though the new dehydrated
+        // state did not contain it
+        rendered.getByText('added')
+      })
+      await sleep(10)
+      // It should stay the same even after effects have had a chance to run
+      rendered.getByText('string')
+      expect(rendered.queryByText('should not change')).toBeNull()
       queryClient.clear()
     })

package/src/__tests__/QueryResetErrorBoundary.test.tsx CHANGED Viewed

@@ -3,7 +3,14 @@ import { ErrorBoundary } from 'react-error-boundary'
 import * as React from 'react'
 import { vi } from 'vitest'
-import { QueryCache, QueryErrorResetBoundary, useQueries, useQuery } from '..'
+import {
+  QueryCache,
+  QueryErrorResetBoundary,
+  useQueries,
+  useQuery,
+  useSuspenseQueries,
+  useSuspenseQuery,
+} from '..'
 import { createQueryClient, queryKey, renderWithClient, sleep } from './utils'
 // TODO: This should be removed with the types for react-error-boundary get updated.
@@ -522,7 +529,7 @@ describe('QueryErrorResetBoundary', () => {
       let renders = 0
       function Page() {
-        const { data } = useQuery({
+        const { data } = useSuspenseQuery({
           queryKey: key,
           queryFn: async () => {
             fetchCount++
@@ -534,7 +541,6 @@ describe('QueryErrorResetBoundary', () => {
             }
           },
           retry: false,
-          suspense: true,
         })
         renders++
         return <div>{data}</div>
@@ -735,7 +741,7 @@ describe('QueryErrorResetBoundary', () => {
       let succeed = false
       function Page() {
-        const [{ data }] = useQueries({
+        const [{ data }] = useSuspenseQueries({
           queries: [
             {
               queryKey: key,
@@ -748,9 +754,7 @@ describe('QueryErrorResetBoundary', () => {
                 }
               },
               retry: false,
-              throwOnError: true,
               retryOnMount: true,
-              suspense: true,
             },
           ],
         })