fix(tanstack): incorrect vue-query options typing for vue-query v5

[ymc9]

Fixes #1564

[coderabbitai]

Walkthrough

Walkthrough

The changes enhance the makeQueryOptions function in generator.ts to better handle version-dependent typing using UnwrapRef based on the version of TanStack Query. Additional configuration parameters are introduced in the test file plugin.test.ts to ensure proper typing and functionality alignment with TanStack Query's API, addressing issues related to typing mismatches.

Changes

Files	Change Summary
packages/plugins/tanstack-query/src/generator.ts	Modified makeQueryOptions function to conditionally use UnwrapRef in the return type based on the version.
packages/plugins/tanstack-query/tests/plugin.test.ts	Added parameters to useFindFirstpost_Item and useInfiniteFindManypost_Item calls to include extra config objects.

Sequence Diagram(s)

Skipping this section as the changes are focused on modifications to typing and parameters rather than introducing new features or altering control flow.

Assessment against linked issues

Objective	Addressed	Explanation
Correct typing for the second argument of TanStack hooks (#1564)	✅

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ac2b291 and 74575fd.

Files selected for processing (2)

• packages/plugins/tanstack-query/src/generator.ts (2 hunks)
• packages/plugins/tanstack-query/tests/plugin.test.ts (3 hunks)

Additional comments not posted (8)

packages/plugins/tanstack-query/tests/plugin.test.ts (6)

57-57: Verify correctness of new parameters in useFindFirstpost_Item.

Ensure that the enabled and optimisticUpdate properties are correctly typed and utilized within the useFindFirstpost_Item function.

---

65-65: Verify correctness of new parameters in useInfiniteFindManypost_Item.

Ensure that the enabled and getNextPageParam properties are correctly typed and utilized within the useInfiniteFindManypost_Item function.

---

146-146: Verify correctness of new parameters in useFindFirstpost_Item (Vue).

Ensure that the enabled and optimisticUpdate properties are correctly typed and utilized within the useFindFirstpost_Item function in the Vue application source.

---

153-153: Verify correctness of new parameters in useInfiniteFindManypost_Item (Vue).

Ensure that the enabled and getNextPageParam properties are correctly typed and utilized within the useInfiniteFindManypost_Item function in the Vue application source.

---

220-220: Verify correctness of new parameters in useFindFirstpost_Item (Svelte).

Ensure that the enabled and optimisticUpdate properties are correctly typed and utilized within the useFindFirstpost_Item function in the Svelte application source.

---

228-228: Verify correctness of new parameters in useInfiniteFindManypost_Item (Svelte).

Ensure that the enabled and getNextPageParam properties are correctly typed and utilized within the useInfiniteFindManypost_Item function in the Svelte application source.

packages/plugins/tanstack-query/src/generator.ts (2)

627-627: Import of UnwrapRef looks good.

The UnwrapRef type from 'vue' has been correctly imported.

---

677-679: Conditional incorporation of UnwrapRef looks good.

The makeQueryOptions function has been correctly modified to conditionally incorporate UnwrapRef if the version is 'v4'.

Ensure that this conditional logic works as intended in all scenarios.