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

* fix(query-core): allow partial query keys in `QueryFilters` and `MutationFilters`

Add a type to match tuple prefixes to match partial query keys in `QueryFilters` and `MutationFilters`

Fixes #9680

* test(query-core): add tests for partial QueryKey matching for `QueryFilters`

add tests to verify that the new partial QueryKey matching for `QueryFilters` does match partial query keys, and also doesn't allow invalid query keys.

* fix(query-core): move tuple prefix helper types to utils.ts

prevent tuple helper types from getting exported, and showing up in the public api

* Add changeset

* ci: apply automated fixes

---------

Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: 3 people

.changeset/wise-numbers-double.md

@@ -0,0 +1,5 @@
+---
+'@tanstack/query-core': patch
+---
+
+fix: 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/utils.ts

@@ -16,6 +16,17 @@ import type { FetchOptions, Query } from './query'
 
 // TYPES
 
+type DropLast<T extends ReadonlyArray<unknown>> = T extends readonly [
+  ...infer R,
+  unknown,
+]
+  ? R
+  : never
+
+type TuplePrefixes<T extends ReadonlyArray<unknown>> = T extends readonly []
+  ? readonly []
+  : TuplePrefixes<DropLast<T>> | T
+
 export interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
   /**
    * Filter to active queries, inactive queries or all queries
@@ -32,7 +43,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 +73,7 @@ export interface MutationFilters<
   /**
    * Include mutations matching this mutation key
    */
-  mutationKey?: MutationKey
+  mutationKey?: TuplePrefixes<MutationKey>
   /**
    * Filter by mutation status
    */