@tanstack/react-query 4.42.1 → 4.43.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query",
-  "version": "4.42.1",
+  "version": "4.43.0",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in React",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "@types/jscodeshift": "^0.11.3",
     "@types/react": "^19.1.9",
     "@types/react-dom": "^19.1.7",
-    "@types/use-sync-external-store": "^0.0.3",
+    "@types/use-sync-external-store": "^1.5.0",
     "react": "^19.1.1",
     "react-17": "npm:react@^17.0.2",
     "react-18": "npm:react@^18.2.0",
@@ -52,8 +52,8 @@
     "react-error-boundary": "^3.1.4"
   },
   "dependencies": {
-    "use-sync-external-store": "^1.2.0",
-    "@tanstack/query-core": "4.41.1"
+    "use-sync-external-store": "^1.6.0",
+    "@tanstack/query-core": "4.43.0"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",

package/src/__tests__/usePrefetchInfiniteQuery.types.test.tsx

@@ -0,0 +1,45 @@
+import { expectTypeOf } from 'expect-type'
+import { usePrefetchInfiniteQuery } from '../usePrefetchInfiniteQuery'
+import { doNotExecute } from './utils'
+
+describe('usePrefetchInfiniteQuery', () => {
+  it('should return nothing', () => {
+    doNotExecute(() => {
+      const result = usePrefetchInfiniteQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        getNextPageParam: () => 1,
+      })
+
+      expectTypeOf(result).toEqualTypeOf<void>()
+    })
+  })
+
+  it('should not allow refetchInterval, enabled or throwOnError options', () => {
+    doNotExecute(() => {
+      usePrefetchInfiniteQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        getNextPageParam: () => 1,
+        // @ts-expect-error TS2353
+        refetchInterval: 1000,
+      })
+
+      usePrefetchInfiniteQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        getNextPageParam: () => 1,
+        // @ts-expect-error TS2353
+        enabled: true,
+      })
+
+      usePrefetchInfiniteQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        getNextPageParam: () => 1,
+        // @ts-expect-error TS2353
+        throwOnError: true,
+      })
+    })
+  })
+})

package/src/__tests__/usePrefetchQuery.types.test.tsx

@@ -0,0 +1,56 @@
+import { expectTypeOf } from 'expect-type'
+import { usePrefetchQuery } from '..'
+import { doNotExecute } from './utils'
+
+describe('usePrefetchQuery', () => {
+  it('should return nothing', () => {
+    doNotExecute(() => {
+      const result = usePrefetchQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+      })
+
+      expectTypeOf(result).toEqualTypeOf<void>()
+    })
+  })
+
+  it('should not allow refetchInterval, enabled or throwOnError options', () => {
+    doNotExecute(() => {
+      usePrefetchQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        // @ts-expect-error TS2345
+        refetchInterval: 1000,
+      })
+
+      usePrefetchQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        // @ts-expect-error TS2345
+        enabled: true,
+      })
+
+      usePrefetchQuery({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        // @ts-expect-error TS2345
+        throwOnError: true,
+      })
+    })
+  })
+
+  it('should not allow skipToken in queryFn', () => {
+    doNotExecute(() => {
+      usePrefetchQuery({
+        queryKey: ['key'],
+        // @ts-expect-error
+        queryFn: skipToken,
+      })
+      usePrefetchQuery({
+        queryKey: ['key'],
+        // @ts-expect-error
+        queryFn: Math.random() > 0.5 ? skipToken : () => Promise.resolve(5),
+      })
+    })
+  })
+})

package/src/index.ts

@@ -46,3 +46,5 @@ export { useIsMutating } from './useIsMutating'
 export { useMutation } from './useMutation'
 export { useInfiniteQuery } from './useInfiniteQuery'
 export { useIsRestoring, IsRestoringProvider } from './isRestoring'
+export { usePrefetchQuery } from './usePrefetchQuery'
+export { usePrefetchInfiniteQuery } from './usePrefetchInfiniteQuery'

package/src/usePrefetchInfiniteQuery.ts

@@ -0,0 +1,23 @@
+import { useQueryClient } from './QueryClientProvider'
+import type {
+  FetchInfiniteQueryOptions,
+  QueryKey,
+  WithRequired,
+} from '@tanstack/query-core'
+
+export function usePrefetchInfiniteQuery<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  options: WithRequired<
+    FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    'queryKey'
+  >,
+) {
+  const client = useQueryClient()
+  if (!client.getQueryState(options.queryKey)) {
+    client.prefetchInfiniteQuery(options)
+  }
+}

package/src/usePrefetchQuery.ts

@@ -0,0 +1,23 @@
+import { useQueryClient } from './QueryClientProvider'
+import type {
+  FetchQueryOptions,
+  QueryKey,
+  WithRequired,
+} from '@tanstack/query-core'
+
+export function usePrefetchQuery<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  options: WithRequired<
+    FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    'queryKey'
+  >,
+) {
+  const client = useQueryClient()
+  if (!client.getQueryState(options.queryKey)) {
+    client.prefetchQuery(options)
+  }
+}