@tanstack/react-query 4.39.0 → 4.39.2

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

@@ -1,5 +1,7 @@
+import { expectTypeOf } from 'expect-type'
 import { useQuery } from '../useQuery'
 import { doNotExecute } from './utils'
+import type { DefinedUseQueryResult, UseQueryResult } from '../types'
 
 export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <
   T,
@@ -9,6 +11,39 @@ export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <
 
 export type Expect<T extends true> = T
 
+describe('onSuccess', () => {
+  it('should be typed correctly', () => {
+    doNotExecute(() => {
+      expectTypeOf(
+        useQuery({
+          queryKey: ['posts'],
+          queryFn: async () => ({ id: 1 }),
+          onSuccess: (data) =>
+            expectTypeOf(data).toEqualTypeOf<{ id: number }>(),
+        }),
+      ).toEqualTypeOf<UseQueryResult<{ id: number }, unknown>>()
+      expectTypeOf(
+        useQuery({
+          queryKey: ['posts'],
+          queryFn: async () => ({ id: 1 }),
+          initialData: { id: 1 },
+          onSuccess: (data) =>
+            expectTypeOf(data).toEqualTypeOf<{ id: number }>(),
+        }),
+      ).toEqualTypeOf<DefinedUseQueryResult<{ id: number }, unknown>>()
+      expectTypeOf(
+        useQuery({
+          queryKey: ['posts'],
+          queryFn: async () => ({ id: 1 }),
+          initialData: { id: 1 },
+          select: (data) => data.id,
+          onSuccess: (data) => expectTypeOf(data).toEqualTypeOf<number>(),
+        }),
+      ).toEqualTypeOf<DefinedUseQueryResult<number, unknown>>()
+    })
+  })
+})
+
 describe('initialData', () => {
   describe('Config object overload', () => {
     it('TData should always be defined when initialData is provided as an object', () => {

package/src/queryOptions.ts

@@ -22,7 +22,7 @@ type ProhibitedQueryOptionsKeyInV5 = keyof Pick<
   'useErrorBoundary' | 'suspense' | 'getNextPageParam' | 'getPreviousPageParam'
 >
 
-export type UndefinedInitialDataOptions<
+type UndefinedInitialDataOptions<
   TQueryFnData = unknown,
   TError = unknown,
   TData = TQueryFnData,
@@ -34,7 +34,7 @@ export type UndefinedInitialDataOptions<
     | NonUndefinedGuard<TQueryFnData>
 }
 
-export type DefinedInitialDataOptions<
+type DefinedInitialDataOptions<
   TQueryFnData = unknown,
   TError = unknown,
   TData = TQueryFnData,

package/src/useQuery.ts

@@ -1,10 +1,6 @@
 'use client'
 import { QueryObserver, parseQueryArgs } from '@tanstack/query-core'
 import { useBaseQuery } from './useBaseQuery'
-import type {
-  DefinedInitialDataOptions,
-  UndefinedInitialDataOptions,
-} from './queryOptions'
 import type {
   InitialDataFunction,
   NonUndefinedGuard,
@@ -19,14 +15,6 @@ import type {
 } from './types'
 
 // HOOK
-export function useQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
-): DefinedUseQueryResult<TData, TError>
 export function useQuery<
   TQueryFnData = unknown,
   TError = unknown,
@@ -42,14 +30,6 @@ export function useQuery<
       | (() => NonUndefinedGuard<TQueryFnData>)
   },
 ): DefinedUseQueryResult<TData, TError>
-export function useQuery<
-  TQueryFnData = unknown,
-  TError = unknown,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
-): UseQueryResult<TData, TError>
 export function useQuery<
   TQueryFnData = unknown,
   TError = unknown,

package/src/useSuspenseQuery.ts

@@ -2,15 +2,12 @@ import { QueryObserver } from '@tanstack/query-core'
 import { useBaseQuery } from './useBaseQuery'
 import type {
   DefinedQueryObserverResult,
+  DistributiveOmit,
   OmitKeyof,
   QueryKey,
 } from '@tanstack/query-core'
 import type { UseQueryOptions } from './types'
 
-type DistributiveOmit<TObject, TKey extends keyof TObject> = TObject extends any
-  ? Omit<TObject, TKey>
-  : never
-
 export type UseSuspenseQueryResult<
   TData = unknown,
   TError = unknown,