fix({react,preact}-query): default 'TData' of infinite query options to 'InfiniteData'

.changeset/gentle-moons-shave.md

@@ -0,0 +1,6 @@
+---
+'@tanstack/react-query': patch
+'@tanstack/preact-query': patch
+---
+
+Default `TData` of `UseInfiniteQueryOptions` and `UseSuspenseInfiniteQueryOptions` to `InfiniteData<TQueryFnData>` so it matches the hook generics.

packages/preact-query/src/__tests__/useInfiniteQuery.test-d.tsx

@@ -3,6 +3,7 @@ import type { InfiniteData } from '@tanstack/query-core'
 import { queryKey } from '@tanstack/query-test-utils'
 import { describe, expectTypeOf, it } from 'vitest'
 
+import type { UseInfiniteQueryOptions } from '../types'
 import { useInfiniteQuery } from '../useInfiniteQuery'
 
 describe('pageParam', () => {
@@ -142,3 +143,19 @@ describe('error booleans', () => {
     expectTypeOf(isRefetchError).toEqualTypeOf<boolean>()
   })
 })
+
+describe('UseInfiniteQueryOptions', () => {
+  it('should default TData to InfiniteData<TQueryFnData>', () => {
+    const options: UseInfiniteQueryOptions<number, Error> = {
+      queryKey: queryKey(),
+      queryFn: () => 5,
+      initialPageParam: 1,
+      getNextPageParam: () => undefined,
+    }
+    const infiniteQuery = useInfiniteQuery(options)
+
+    expectTypeOf(infiniteQuery.data).toEqualTypeOf<
+      InfiniteData<number, unknown> | undefined
+    >()
+  })
+})

packages/preact-query/src/__tests__/useSuspenseInfiniteQuery.test-d.tsx

@@ -3,6 +3,7 @@ import type { InfiniteData } from '@tanstack/query-core'
 import { queryKey } from '@tanstack/query-test-utils'
 import { assertType, describe, expectTypeOf, it } from 'vitest'
 
+import type { UseSuspenseInfiniteQueryOptions } from '../types'
 import { useSuspenseInfiniteQuery } from '../useSuspenseInfiniteQuery'
 
 describe('useSuspenseInfiniteQuery', () => {
@@ -82,6 +83,18 @@ describe('useSuspenseInfiniteQuery', () => {
     )
   })
 
+  it('should default TData of UseSuspenseInfiniteQueryOptions to InfiniteData<TQueryFnData>', () => {
+    const options: UseSuspenseInfiniteQueryOptions<number, Error> = {
+      queryKey: queryKey(),
+      queryFn: () => Promise.resolve(5),
+      initialPageParam: 1,
+      getNextPageParam: () => 1,
+    }
+    const { data } = useSuspenseInfiniteQuery(options)
+
+    expectTypeOf(data).toEqualTypeOf<InfiniteData<number, unknown>>()
+  })
+
   it('should not return isPlaceholderData', () => {
     const query = useSuspenseInfiniteQuery({
       queryKey: queryKey(),

packages/preact-query/src/types.ts

@@ -5,6 +5,7 @@ import type {
   DefinedQueryObserverResult,
   DistributiveOmit,
   FetchQueryOptions,
+  InfiniteData,
   InfiniteQueryObserverOptions,
   InfiniteQueryObserverResult,
   MutateFunction,
@@ -102,7 +103,7 @@ export type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<
 export interface UseInfiniteQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
-  TData = TQueryFnData,
+  TData = InfiniteData<TQueryFnData>,
   TQueryKey extends QueryKey = QueryKey,
   TPageParam = unknown,
 > extends OmitKeyof<
@@ -127,7 +128,7 @@ export type AnyUseSuspenseInfiniteQueryOptions =
 export interface UseSuspenseInfiniteQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
-  TData = TQueryFnData,
+  TData = InfiniteData<TQueryFnData>,
   TQueryKey extends QueryKey = QueryKey,
   TPageParam = unknown,
 > extends OmitKeyof<

packages/react-query/src/__tests__/useInfiniteQuery.test-d.tsx

@@ -3,6 +3,7 @@ import { QueryClient } from '@tanstack/query-core'
 import { queryKey } from '@tanstack/query-test-utils'
 import { useInfiniteQuery } from '../useInfiniteQuery'
 import type { InfiniteData } from '@tanstack/query-core'
+import type { UseInfiniteQueryOptions } from '../types'
 
 describe('pageParam', () => {
   it('initialPageParam should define type of param passed to queryFunctionContext', () => {
@@ -141,3 +142,19 @@ describe('error booleans', () => {
     expectTypeOf(isRefetchError).toEqualTypeOf<boolean>()
   })
 })
+
+describe('UseInfiniteQueryOptions', () => {
+  it('should default TData to InfiniteData<TQueryFnData>', () => {
+    const options: UseInfiniteQueryOptions<number, Error> = {
+      queryKey: queryKey(),
+      queryFn: () => 5,
+      initialPageParam: 1,
+      getNextPageParam: () => undefined,
+    }
+    const infiniteQuery = useInfiniteQuery(options)
+
+    expectTypeOf(infiniteQuery.data).toEqualTypeOf<
+      InfiniteData<number, unknown> | undefined
+    >()
+  })
+})

packages/react-query/src/__tests__/useSuspenseInfiniteQuery.test-d.tsx

@@ -3,6 +3,7 @@ import { skipToken } from '@tanstack/query-core'
 import { queryKey } from '@tanstack/query-test-utils'
 import { useSuspenseInfiniteQuery } from '../useSuspenseInfiniteQuery'
 import type { InfiniteData } from '@tanstack/query-core'
+import type { UseSuspenseInfiniteQueryOptions } from '../types'
 
 describe('useSuspenseInfiniteQuery', () => {
   it('should always have data defined', () => {
@@ -81,6 +82,18 @@ describe('useSuspenseInfiniteQuery', () => {
     )
   })
 
+  it('should default TData of UseSuspenseInfiniteQueryOptions to InfiniteData<TQueryFnData>', () => {
+    const options: UseSuspenseInfiniteQueryOptions<number, Error> = {
+      queryKey: queryKey(),
+      queryFn: () => Promise.resolve(5),
+      initialPageParam: 1,
+      getNextPageParam: () => 1,
+    }
+    const { data } = useSuspenseInfiniteQuery(options)
+
+    expectTypeOf(data).toEqualTypeOf<InfiniteData<number, unknown>>()
+  })
+
   it('should not return isPlaceholderData', () => {
     const query = useSuspenseInfiniteQuery({
       queryKey: queryKey(),

packages/react-query/src/types.ts

@@ -6,6 +6,7 @@ import type {
   DefinedQueryObserverResult,
   DistributiveOmit,
   FetchQueryOptions,
+  InfiniteData,
   InfiniteQueryObserverOptions,
   InfiniteQueryObserverResult,
   MutateFunction,
@@ -103,7 +104,7 @@ export type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<
 export interface UseInfiniteQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
-  TData = TQueryFnData,
+  TData = InfiniteData<TQueryFnData>,
   TQueryKey extends QueryKey = QueryKey,
   TPageParam = unknown,
 > extends OmitKeyof<
@@ -128,7 +129,7 @@ export type AnyUseSuspenseInfiniteQueryOptions =
 export interface UseSuspenseInfiniteQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
-  TData = TQueryFnData,
+  TData = InfiniteData<TQueryFnData>,
   TQueryKey extends QueryKey = QueryKey,
   TPageParam = unknown,
 > extends OmitKeyof<