fix(types): Add types for QueryFilters which flow down to Query<> and…

… QueryKey/DataTag types (#8332) * Add types for QueryFilters which flow down to Query<> and QueryKey/DataTag types * ci: apply automated fixes * Add a type test * ci: apply automated fixes * Fix linting --------- Co-authored-by: Dominik Dorfmeister <[email protected]> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
TanStack · Nov 27, 2024 · 422c879 · 422c879
1 parent d28de3c
commit 422c879
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 5 deletions.
diff --git a/packages/query-core/src/__tests__/utils.test-d.tsx b/packages/query-core/src/__tests__/utils.test-d.tsx
@@ -0,0 +1,45 @@
+import { describe, expectTypeOf, it } from 'vitest'
+import { QueryClient } from '../queryClient'
+import type { QueryFilters } from '../utils'
+import type { DataTag } from '../types'
+
+describe('QueryFilters', () => {
+  it('should be typed if generics are passed', () => {
+    type TData = { a: number; b: string }
+    type TError = { message: string }
+
+    const a: QueryFilters<TData, TError> = {
+      predicate(query) {
+        expectTypeOf(query.setData({ a: 1, b: '1' })).toEqualTypeOf<TData>()
+        return true
+      },
+      queryKey: ['key'] as DataTag<undefined, TData>,
+    }
+
+    const queryClient = new QueryClient()
+
+    const data = queryClient.getQueryData(a.queryKey!)
+    expectTypeOf(data).toEqualTypeOf<TData | undefined>()
+
+    const error = queryClient.getQueryState(a.queryKey!)?.error
+    expectTypeOf(error).toEqualTypeOf<Error | null | undefined>() // maybe one day this can return TError
+  })
+
+  it('should be loose typed if generics are defaults', () => {
+    const a: QueryFilters = {
+      predicate(query) {
+        expectTypeOf(query.setData({ a: 1, b: '1' })).toEqualTypeOf<unknown>()
+        return true
+      },
+      queryKey: ['key'],
+    }
+
+    const queryClient = new QueryClient()
+
+    const data = queryClient.getQueryData(a.queryKey!)
+    expectTypeOf(data).toEqualTypeOf<unknown>()
+
+    const error = queryClient.getQueryState(a.queryKey!)?.error
+    expectTypeOf(error).toEqualTypeOf<Error | null | undefined>()
+  })
+})
diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts
@@ -534,11 +534,21 @@ export interface RefetchOptions extends ResultOptions {
   cancelRefetch?: boolean
 }
 
-export interface InvalidateQueryFilters extends QueryFilters {
+export interface InvalidateQueryFilters<
+  TQueryFnData = unknown,
+  TError = Error,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> extends QueryFilters<TQueryFnData, TError, TData, TQueryKey> {
   refetchType?: QueryTypeFilter | 'none'
 }
 
-export interface RefetchQueryFilters extends QueryFilters {}
+export interface RefetchQueryFilters<
+  TQueryFnData = unknown,
+  TError = Error,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> extends QueryFilters<TQueryFnData, TError, TData, TQueryKey> {}
 
 export interface InvalidateOptions extends RefetchOptions {}
 export interface ResetOptions extends RefetchOptions {}

diff --git a/packages/query-core/src/utils.ts b/packages/query-core/src/utils.ts
@@ -1,4 +1,5 @@
 import type {
+  DataTag,
   DefaultError,
   Enabled,
   FetchStatus,
@@ -14,7 +15,12 @@ import type { FetchOptions, Query } from './query'
 
 // TYPES
 
-export interface QueryFilters {
+export interface QueryFilters<
+  TQueryFnData = unknown,
+  TError = Error,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> {
   /**
    * Filter to active queries, inactive queries or all queries
    */
@@ -26,11 +32,13 @@ export interface QueryFilters {
   /**
    * Include queries matching this predicate function
    */
-  predicate?: (query: Query) => boolean
+  predicate?: (query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean
   /**
    * Include queries matching this query key
    */
-  queryKey?: QueryKey
+  queryKey?: unknown extends TQueryFnData
+    ? QueryKey
+    : QueryKey & DataTag<unknown, TQueryFnData>
   /**
    * Include or exclude stale queries
    */