feat: update for better clause

[ponderingdemocritus]

• Clause

Summary by CodeRabbit

• New Features

  • Enhanced filtering capabilities for entities and events through the introduction of optional parameters.
  • Improved synchronization process by allowing users to specify clauses for more precise data retrieval.

• Bug Fixes

  • Resolved issues related to pagination by switching from cursor-based to offset-based pagination for better performance.

[coderabbitai]

Walkthrough

The pull request introduces a new optional clause parameter to the useQuerySync function and modifies several functions within the packages/state/src/recs/index.ts file. The getSyncEntities, getSyncEvents, getEntities, and getEvents functions are updated to include this parameter, enhancing their filtering capabilities. Additionally, the getEntities function transitions from cursor-based pagination to offset-based pagination, while the getEntitiesQuery function adjusts to construct the clause variable based on entityKeyClause.

Changes

File Path	Change Summary
packages/react/src/useQuerySync.ts	- Added clause parameter to useQuerySync function signature.
packages/state/src/recs/index.ts	- Added clause parameter to getSyncEntities, getSyncEvents, getEntities, and getEvents functions. - Updated pagination in getEntities to use offset instead of cursor. - Modified getEntitiesQuery to construct clause based on entityKeyClause.

Poem

🐇 In the code where clauses roam,
New filters help us find a home.
Entities sync with ease and grace,
Events now dance in their rightful place.
With offsets guiding every quest,
Our queries now are truly blessed! 🌟

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

🧹 Outside diff range and nitpick comments (2)

packages/react/src/useQuerySync.ts (2)

34-35: LGTM: Function signature updated correctly.

The addition of the optional clause parameter enhances the function's flexibility while maintaining backward compatibility.

Consider updating the function's JSDoc to include documentation for the new clause parameter. This will help users understand its purpose and usage.

---

Line range hint 1-68: Summary: Successfully implemented the new clause parameter.

The changes in this file effectively introduce the new optional clause parameter to the useQuerySync function. This enhancement allows for more flexible entity synchronization without breaking existing functionality. The implementation is consistent across the function signature, imports, and internal usage.

To fully leverage this new feature:

1. Consider updating any existing calls to useQuerySync throughout the codebase to utilize the new clause parameter where beneficial.
2. Ensure that the documentation for the useQuerySync function is updated to reflect this new capability, helping developers understand when and how to use the clause parameter effectively.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 70f75f8 and a566a50.

📒 Files selected for processing (1)

• packages/react/src/useQuerySync.ts (2 hunks)

🔇 Additional comments (2)

packages/react/src/useQuerySync.ts (2)

5-5: LGTM: Import statement updated correctly.

The addition of Clause to the imports is consistent with its usage in the updated function signature.

---

42-42: LGTM: setupSync function updated correctly.

The clause parameter is now properly passed to the getSyncEntities function, ensuring it's utilized in the synchronization process.