@tanstack/query-core 4.15.0 → 4.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.15.0",
+  "version": "4.18.0",
   "description": "The framework agnostic core that powers TanStack Query",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/queryClient.ts

@@ -28,6 +28,7 @@ import type {
   ResetOptions,
   ResetQueryFilters,
   SetDataOptions,
+  WithRequired,
 } from './types'
 import type { QueryState } from './query'
 import { QueryCache } from './queryCache'
@@ -118,6 +119,67 @@ export class QueryClient {
     return this.queryCache.find<TQueryFnData>(queryKey, filters)?.state.data
   }
 
+  ensureQueryData<
+    TQueryFnData = unknown,
+    TError = unknown,
+    TData = TQueryFnData,
+    TQueryKey extends QueryKey = QueryKey,
+  >(
+    options: WithRequired<
+      FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+      'queryKey'
+    >,
+  ): Promise<TData>
+  ensureQueryData<
+    TQueryFnData = unknown,
+    TError = unknown,
+    TData = TQueryFnData,
+    TQueryKey extends QueryKey = QueryKey,
+  >(
+    queryKey: TQueryKey,
+    options?: Omit<
+      FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+      'queryKey'
+    >,
+  ): Promise<TData>
+  ensureQueryData<
+    TQueryFnData = unknown,
+    TError = unknown,
+    TData = TQueryFnData,
+    TQueryKey extends QueryKey = QueryKey,
+  >(
+    queryKey: TQueryKey,
+    queryFn: QueryFunction<TQueryFnData, TQueryKey>,
+    options?: Omit<
+      FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+      'queryKey' | 'queryFn'
+    >,
+  ): Promise<TData>
+  ensureQueryData<
+    TQueryFnData,
+    TError,
+    TData = TQueryFnData,
+    TQueryKey extends QueryKey = QueryKey,
+  >(
+    arg1:
+      | TQueryKey
+      | WithRequired<
+          FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+          'queryKey'
+        >,
+    arg2?:
+      | QueryFunction<TQueryFnData, TQueryKey>
+      | FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    arg3?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+  ): Promise<TData> {
+    const parsedOptions = parseQueryArgs(arg1, arg2, arg3)
+    const cachedData = this.getQueryData<TData>(parsedOptions.queryKey!)
+
+    return cachedData
+      ? Promise.resolve(cachedData)
+      : this.fetchQuery(parsedOptions)
+  }
+
   getQueriesData<TQueryFnData = unknown>(
     queryKey: QueryKey,
   ): [QueryKey, TQueryFnData | undefined][]

package/src/tests/queryClient.test.tsx

@@ -470,6 +470,28 @@ describe('queryClient', () => {
     })
   })
 
+  describe('ensureQueryData', () => {
+    test('should return the cached query data if the query is found', async () => {
+      const key = queryKey()
+      const queryFn = () => Promise.resolve('data')
+
+      queryClient.setQueryData([key, 'id'], 'bar')
+
+      await expect(
+        queryClient.ensureQueryData({ queryKey: [key, 'id'], queryFn }),
+      ).resolves.toEqual('bar')
+    })
+
+    test('should call fetchQuery and return its results if the query is not found', async () => {
+      const key = queryKey()
+      const queryFn = () => Promise.resolve('data')
+
+      await expect(
+        queryClient.ensureQueryData({ queryKey: [key], queryFn }),
+      ).resolves.toEqual('data')
+    })
+  })
+
   describe('getQueriesData', () => {
     test('should return the query data for all matched queries', () => {
       const key1 = queryKey()

package/src/types.ts

@@ -250,7 +250,8 @@ export interface QueryObserverOptions<
   _optimisticResults?: 'optimistic' | 'isRestoring'
 }
 
-type WithRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+export type WithRequired<T, K extends keyof T> = Omit<T, K> &
+  Required<Pick<T, K>>
 export type DefaultedQueryObserverOptions<
   TQueryFnData = unknown,
   TError = unknown,