@tanstack/query-core 5.17.10 → 5.17.15

package/src/tests/queryObserver.test.tsx

@@ -894,4 +894,42 @@ describe('queryObserver', () => {
 
     unsubscribe()
   })
+
+  test('should be inferred as a correct result type', async () => {
+    const key = queryKey()
+    const data = { value: 'data' }
+    const observer = new QueryObserver(queryClient, {
+      queryKey: key,
+      queryFn: () => Promise.resolve(data),
+    })
+
+    const result = observer.getCurrentResult()
+
+    result.isPending &&
+      expectTypeOf<undefined>(result.data) &&
+      expectTypeOf<null>(result.error) &&
+      expectTypeOf<boolean>(result.isLoading) &&
+      expectTypeOf<'pending'>(result.status)
+
+    result.isLoading &&
+      expectTypeOf<undefined>(result.data) &&
+      expectTypeOf<null>(result.error) &&
+      expectTypeOf<true>(result.isPending) &&
+      expectTypeOf<'pending'>(result.status)
+
+    result.isLoadingError &&
+      expectTypeOf<undefined>(result.data) &&
+      expectTypeOf<Error>(result.error) &&
+      expectTypeOf<'error'>(result.status)
+
+    result.isRefetchError &&
+      expectTypeOf<{ value: string }>(result.data) &&
+      expectTypeOf<Error>(result.error) &&
+      expectTypeOf<'error'>(result.status)
+
+    result.isSuccess &&
+      expectTypeOf<{ value: string }>(result.data) &&
+      expectTypeOf<null>(result.error) &&
+      expectTypeOf<'success'>(result.status)
+  })
 })

package/src/tests/utils.test.tsx

@@ -332,6 +332,24 @@ describe('core/utils', () => {
       const result = replaceEqualDeep(obj1, obj2)
       expect(result).toStrictEqual(obj2)
     })
+
+    it('should be able to share values that contain undefined', () => {
+      const current = [
+        {
+          data: undefined,
+          foo: true,
+        },
+      ]
+
+      const next = replaceEqualDeep(current, [
+        {
+          data: undefined,
+          foo: true,
+        },
+      ])
+
+      expect(current).toBe(next)
+    })
   })
 
   describe('matchMutation', () => {

package/src/types.ts

@@ -488,6 +488,20 @@ export interface QueryObserverBaseResult<
   fetchStatus: FetchStatus
 }
 
+export interface QueryObserverPendingResult<
+  TData = unknown,
+  TError = DefaultError,
+> extends QueryObserverBaseResult<TData, TError> {
+  data: undefined
+  error: null
+  isError: false
+  isPending: true
+  isLoadingError: false
+  isRefetchError: false
+  isSuccess: false
+  status: 'pending'
+}
+
 export interface QueryObserverLoadingResult<
   TData = unknown,
   TError = DefaultError,
@@ -496,6 +510,7 @@ export interface QueryObserverLoadingResult<
   error: null
   isError: false
   isPending: true
+  isLoading: true
   isLoadingError: false
   isRefetchError: false
   isSuccess: false
@@ -510,6 +525,7 @@ export interface QueryObserverLoadingErrorResult<
   error: TError
   isError: true
   isPending: false
+  isLoading: false
   isLoadingError: true
   isRefetchError: false
   isSuccess: false
@@ -524,6 +540,7 @@ export interface QueryObserverRefetchErrorResult<
   error: TError
   isError: true
   isPending: false
+  isLoading: false
   isLoadingError: false
   isRefetchError: true
   isSuccess: false
@@ -538,6 +555,7 @@ export interface QueryObserverSuccessResult<
   error: null
   isError: false
   isPending: false
+  isLoading: false
   isLoadingError: false
   isRefetchError: false
   isSuccess: true
@@ -555,6 +573,7 @@ export type QueryObserverResult<TData = unknown, TError = DefaultError> =
   | DefinedQueryObserverResult<TData, TError>
   | QueryObserverLoadingErrorResult<TData, TError>
   | QueryObserverLoadingResult<TData, TError>
+  | QueryObserverPendingResult<TData, TError>
 
 export interface InfiniteQueryObserverBaseResult<
   TData = unknown,
@@ -572,6 +591,20 @@ export interface InfiniteQueryObserverBaseResult<
   isFetchingPreviousPage: boolean
 }
 
+export interface InfiniteQueryObserverPendingResult<
+  TData = unknown,
+  TError = DefaultError,
+> extends InfiniteQueryObserverBaseResult<TData, TError> {
+  data: undefined
+  error: null
+  isError: false
+  isPending: true
+  isLoadingError: false
+  isRefetchError: false
+  isSuccess: false
+  status: 'pending'
+}
+
 export interface InfiniteQueryObserverLoadingResult<
   TData = unknown,
   TError = DefaultError,
@@ -580,6 +613,7 @@ export interface InfiniteQueryObserverLoadingResult<
   error: null
   isError: false
   isPending: true
+  isLoading: true
   isLoadingError: false
   isRefetchError: false
   isSuccess: false
@@ -594,6 +628,7 @@ export interface InfiniteQueryObserverLoadingErrorResult<
   error: TError
   isError: true
   isPending: false
+  isLoading: false
   isLoadingError: true
   isRefetchError: false
   isSuccess: false
@@ -608,6 +643,7 @@ export interface InfiniteQueryObserverRefetchErrorResult<
   error: TError
   isError: true
   isPending: false
+  isLoading: false
   isLoadingError: false
   isRefetchError: true
   isSuccess: false
@@ -622,6 +658,7 @@ export interface InfiniteQueryObserverSuccessResult<
   error: null
   isError: false
   isPending: false
+  isLoading: false
   isLoadingError: false
   isRefetchError: false
   isSuccess: true
@@ -639,9 +676,10 @@ export type InfiniteQueryObserverResult<
   TData = unknown,
   TError = DefaultError,
 > =
+  | DefinedInfiniteQueryObserverResult<TData, TError>
   | InfiniteQueryObserverLoadingErrorResult<TData, TError>
   | InfiniteQueryObserverLoadingResult<TData, TError>
-  | DefinedInfiniteQueryObserverResult<TData, TError>
+  | InfiniteQueryObserverPendingResult<TData, TError>
 
 export type MutationKey = ReadonlyArray<unknown>
 

package/src/utils.ts

@@ -224,7 +224,8 @@ export function replaceEqualDeep(a: any, b: any): any {
   const array = isPlainArray(a) && isPlainArray(b)
 
   if (array || (isPlainObject(a) && isPlainObject(b))) {
-    const aSize = array ? a.length : Object.keys(a).length
+    const aItems = array ? a : Object.keys(a)
+    const aSize = aItems.length
     const bItems = array ? b : Object.keys(b)
     const bSize = bItems.length
     const copy: any = array ? [] : {}
@@ -233,9 +234,19 @@ export function replaceEqualDeep(a: any, b: any): any {
 
     for (let i = 0; i < bSize; i++) {
       const key = array ? i : bItems[i]
-      copy[key] = replaceEqualDeep(a[key], b[key])
-      if (copy[key] === a[key] && a[key] !== undefined) {
+      if (
+        !array &&
+        a[key] === undefined &&
+        b[key] === undefined &&
+        aItems.includes(key)
+      ) {
+        copy[key] = undefined
         equalItems++
+      } else {
+        copy[key] = replaceEqualDeep(a[key], b[key])
+        if (copy[key] === a[key] && a[key] !== undefined) {
+          equalItems++
+        }
       }
     }