feat: create migration guide to update to v1.1

[MartianGreed]

Closes #

Introduced changes

Checklist

• Linked relevant issue
• Updated relevant documentation
• Added relevant tests
• Add a dedicated CI job for new examples
• Performed self-review of the code

Summary by CodeRabbit

• New Features

  • Streamlined query operations for easier and more efficient query creation.
  • Improved subscription support that now delivers initial data immediately along with live updates.
  • Simplified SDK initialization to reduce configuration overhead.

• Documentation

  • Updated migration guide outlining the steps for a smooth upgrade to the new system.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the Dojo.js migration from version 1.0 to 1.1 by modifying the query system and subscription APIs. The default query system now uses ToriiQueryBuilder instead of the legacy QueryBuilder, eliminating the need for a schema parameter during SDK initialization. The subscription API has been updated to return a tuple containing the initial entities and the subscription object. Additional documentation on migration patterns and key management (using constructs like includeHashedKeys()) is provided for a smooth transition.

Changes

File(s)	Change Summary
migration/v1-0-v1-1.md	- Removed the schema parameter from the init method. - Replaced QueryBuilder with ToriiQueryBuilder for constructing entity queries. - Updated subscription API to return [initialEntities, sub].

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant SDK
    participant QueryBuilder

    Developer->>SDK: init(...)
    SDK-->>Developer: Returns sdk instance (schema parameter removed)
    Developer->>QueryBuilder: new ToriiQueryBuilder(...)
    QueryBuilder-->>Developer: Query instance created

Loading

sequenceDiagram
    participant Developer
    participant SDK

    Developer->>SDK: subscribeEntityQuery({ query config })
    SDK-->>Developer: Returns [initialEntities, subscription]

Loading

Suggested reviewers

• ponderingdemocritus

Poem

I'm a rabbit in the code field, hopping with delight,
New queries bloom without the schema in sight.
Torii leads the way with a gentle, nimble spin,
Subscriptions now bring data with a cheerful grin.
Coding carrots fuel my leaps, bright and keen—
A whimsical migration, happy and serene! 🥕
Hop on, dear code, let’s keep riding the scene!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b9ef26d and 0f46718.

📒 Files selected for processing (1)

• migration/v1-0-v1-1.md (1 hunks)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.