`matchQuery` types don't support partial keys

[JosNun]

Describe the bug

If I type my query key as per the docs (https://tanstack.com/query/latest/docs/framework/react/typescript#typing-query-and-mutation-keys), matchQuery expects a full query key instead of a partial query key (even if the exact option of the QueryFilters is false.

Your minimal, reproducible example

https://stackblitz.com/edit/vitejs-vite-49gqkj84?file=src%2Fmain.tsx,src%2FApp.tsx

Steps to reproduce

1. Type the query keys as per the docs (https://tanstack.com/query/latest/docs/framework/react/typescript#typing-query-and-mutation-keys)
2. Try to use a partial key with matchQuery

Expected behavior

If exact isn't true (I believe this is the default), I would expect that I would be able to use a partial query key for the QueryFilter passed to matchQuery instead of having to pass a complete key.

How often does this bug happen?

Every time

Screenshots or Videos

No response

Platform

N/A

Tanstack Query adapter

react-query

TanStack Query version

5.90.2

TypeScript version

5.4.5

Additional context

No response

[TkDodo]

hm, I see the issue but the example is somewhat non-realistic. Even a union of all possible types isn’t really what we have in the docs, where the shown pattern would be equivalent to:

type QueryKeys = ['entity', ...Array<string>];

in that case, calling matchQuery would work.

the only solution I could see for your use-case would be to have complicated type gymnastics in all the places where we allow query filters, and I don’t think that’s feasible to tackle from our end, sorry.

[JosNun]

Gotcha! Correct me if I'm wrong, but could you use something like below to support partial keys in the QueryFilters (QueryFilters.queryKey would be Prefixes<TQueryKey>)?

type DropLast<T extends readonly unknown[]> = T extends readonly [
  ...infer R,
  unknown
]
  ? R
  : never;

type Prefixes<T extends readonly unknown[]> = T extends readonly []
  ? readonly []
  : Prefixes<DropLast<T>> | T;

type QueryKeys = ['turtle', 'item', string] | ['fish', 'item', string];
type PartialQueryKey = Prefixes<QueryKey>;
//     ^? readonly [] | ["turtle"] | ["fish"] | ["turtle", "item"] | ["fish", "item"] | ["turtle", "item", string] | ["fish", "item", string]

I 100% get that this is a bit of an edge-case, and the vast majority of users won't run into it, so no worries if it's something you opt not to do.

Thanks for your continued effort in maintaining a great lib that a bunch of people use and appreciate 👏

[TkDodo]

looks nice. if you want to give this ago, please do 🙏