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

[visz11]

🎯 Changes

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

Fixes TanStack#9680

It's worth noting, there may be a case where it makes sense to turn QueryFilters (and MutationFilters into a discriminated union on the exact field, so that we only allow partial query filter types in the case where exact is false (or unspecified), but it's possible there are cases where one would want partial query key matching even in the exact: true case, and I'm not sure the added constraint adds much benefit. If you'd like me to add that, let me know.

✅ Checklist

• I have followed the steps in the Contributing guide.
• I have tested this code locally with pnpm test:pr.

🚀 Release Impact

• This change affects published code, and I have generated a changeset.
• This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

• New Features

  • Improved TypeScript support for filtering queries and mutations by allowing partial key prefixes, enhancing autocomplete and type safety with no runtime changes.

• Tests

  • Added type-level tests to validate partial key usage and ensure invalid keys are rejected by the type system.

• Chores

  • Prepared a patch release entry to publish the fix.

[coderabbitai]

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

193 files out of 300 files are above the max files limit of 100. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch clone-fix/9680-queryfilters-partial-matching

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @visz11, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on improving the developer experience and type safety within the @tanstack/query-core package by introducing support for partial query keys in QueryFilters and MutationFilters. This allows developers to specify query key prefixes for filtering operations, leading to enhanced TypeScript autocomplete and more precise type checking without altering any runtime logic. Additionally, the PR includes significant documentation updates across all supported frameworks to reflect recent API changes and best practices, alongside general maintenance and dependency upgrades to keep the project current.

Highlights

• Enhanced Type Safety for Query and Mutation Filters: Introduced type-level support for partial query keys in QueryFilters and MutationFilters, allowing filtering by tuple prefixes.
• Improved Developer Experience: This change provides better autocomplete and more robust type checking when working with query and mutation filters.
• No Runtime Impact: The enhancement is purely type-based, ensuring no changes to runtime behavior or performance.
• Comprehensive Documentation Updates: Extensive updates across Angular, React, Solid, and Svelte documentation, including new reference pages, corrected links, and improved examples, reflecting API changes and best practices.
• Infrastructure and Dependency Updates: Modernized various configuration files, updated Node.js and package manager versions, and streamlined release processes using Changesets.

Ignored Files

• Ignored by pattern: .github/workflows/** (4)
  • .github/workflows/autofix.yml
  • .github/workflows/labeler.yml
  • .github/workflows/pr.yml
  • .github/workflows/release.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a great improvement to type safety by allowing partial query keys in QueryFilters and MutationFilters. The implementation of TuplePrefix is clever and the added tests confirm the new behavior. The PR also includes a massive amount of documentation updates, dependency bumps, and refactoring across the examples and docs, which is a huge effort. My main feedback is a suggestion to further improve the type safety of filters by using a discriminated union, as you've also hinted at in the PR description.