fix(query-core): allow partial query keys in QueryFilters

packages/query-core/src/__tests__/utils.test-d.tsx

@@ -1,4 +1,4 @@
-import { describe, expectTypeOf, it } from 'vitest'
+import { assertType, describe, expectTypeOf, it } from 'vitest'
 import { QueryClient } from '../queryClient'
 import type { QueryFilters } from '../utils'
 import type { DataTag, QueryKey } from '../types'
@@ -35,11 +35,36 @@ describe('QueryFilters', () => {
     }
 
     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>()
   })
+
+  it('should allow a partial query key to be passed', () => {
+    const filters: QueryFilters<readonly ['key', { a: number; b: string }]> = {
+      queryKey: ['key'],
+    }
+
+    expectTypeOf(filters.queryKey).toEqualTypeOf<
+      | undefined
+      | readonly []
+      | ['key']
+      | readonly [
+          'key',
+          {
+            a: number
+            b: string
+          },
+        ]
+    >()
+  })
+
+  it('should error on invalid query keys', () => {
+    assertType<QueryFilters<readonly ['key', { a: number; b: string }]>>({
+      // @ts-expect-error cannot pass invalid query key
+      queryKey: ['invalid', { a: 1, b: '1' }],
+    })
+  })
 })

packages/query-core/src/types.ts

@@ -36,6 +36,16 @@ export type Override<TTargetA, TTargetB> = {
 
 export type NoInfer<T> = [T][T extends any ? 0 : never]
 
+export type DropLast<T extends ReadonlyArray<unknown>> = T extends readonly [
+  ...infer R,
+  unknown,
+]
+  ? R
+  : never
+
+export type TuplePrefixes<T extends ReadonlyArray<unknown>> =
+  T extends readonly [] ? readonly [] : TuplePrefixes<DropLast<T>> | T
+
 export interface Register {
   // defaultError: Error
   // queryMeta: Record<string, unknown>

packages/query-core/src/utils.ts

@@ -10,6 +10,7 @@ import type {
   QueryOptions,
   StaleTime,
   StaleTimeFunction,
+  TuplePrefixes,
 } from './types'
 import type { Mutation } from './mutation'
 import type { FetchOptions, Query } from './query'
@@ -32,7 +33,7 @@ export interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
   /**
    * Include queries matching this query key
    */
-  queryKey?: TQueryKey
+  queryKey?: TuplePrefixes<TQueryKey>
   /**
    * Include or exclude stale queries
    */
@@ -62,7 +63,7 @@ export interface MutationFilters<
   /**
    * Include mutations matching this mutation key
    */
-  mutationKey?: MutationKey
+  mutationKey?: TuplePrefixes<MutationKey>
   /**
    * Filter by mutation status
    */