Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add specific control param to query torii types #424

Merged
merged 2 commits into from
Mar 25, 2025

Conversation

MartianGreed
Copy link
Collaborator

@MartianGreed MartianGreed commented Mar 25, 2025

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

    • Expanded query capabilities in our SDK now support type‐specific filtering and historical data retrieval for enhanced data management.
    • Updated sample applications use refined state and theme management approaches for a smoother experience.
  • Chores

    • Comprehensive dependency and patch updates have been applied across the platform, enhancing overall stability and performance.
    • Automated build and release workflows have been streamlined with improved submodule handling.

Copy link

coderabbitai bot commented Mar 25, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces new changeset files that document patch updates for multiple Dojo Engine packages and version bumps. Several GitHub workflow configurations have been updated to automatically initialize submodules, replacing manual submodule update commands. There are also dependency upgrades and ordering adjustments across various package.json files, as well as modifications in example applications and SDK internals—such as new hook usage and enhanced type definitions—to adjust control flow and improve type safety.

Changes

File(s) Change Summary
.changeset/dry-rivers-give.md, .changeset/moody-rats-shake.md New changeset entries documenting patch updates for multiple Dojo Engine packages and a version bump for Dojo (1.3.1).
.github/workflows/ci.yaml, .github/workflows/docs.yaml, .github/workflows/release.yaml Updated checkout steps to include submodules: true and removed explicit git submodule update --init --recursive commands.
.gitmodules Added ignore = dirty for packages/torii-wasm/dojo.c and adjusted indentation for worlds/onchain-dash and worlds/dojo-starter.
examples/example-predeployed-connector/src/starknet-provider.tsx, examples/example-vite-kitchen-sink/package.json, examples/example-vite-kitchen-sink/src/components/theme-switch.tsx, examples/example-vite-react-sql/src/components/playground/direction-count.tsx Added a TypeScript ignore comment, shifted dependencies to catalog references, incorporated a new hook (useEntityId) and replaced context-based access with useDojoSDK().
Packages (non-SDK):
packages/core/package.json, packages/create-burner/package.json, packages/create-dojo/package.json, packages/predeployed-connector/package.json, packages/react/package.json, packages/state/package.json, packages/torii-client/package.json, packages/utils/package.json, worlds/onchain-dash
Upgraded tsup versions, reordered dependencies, and updated subproject commit identifiers.
SDK Files:
packages/sdk/src/__tests__/convertClauseToEntityKeysClause.test.ts, packages/sdk/src/clauseBuilder.ts, packages/sdk/src/convertClauseToEntityKeysClause.ts, packages/sdk/src/convertToMemberValue.ts, packages/sdk/src/experimental/index.ts, packages/sdk/src/index.ts
Enhanced type definitions by adding a new MemberValueParam type, adjusted function signatures to include the new union type, restructured conditional checks to prioritize a "Keys" clause, and modified parameters in entity fetching and subscription methods.
State Recs:
packages/state/src/recs/index.ts
Added an optional historical parameter (defaulting to false) to getEntities and getEntitiesQuery and removed it from syncEvents, altering data retrieval logic.

Sequence Diagram(s)

sequenceDiagram
    participant F as convertClauseToEntityKeysClause()
    participant C as Clause Object
    F->>C: Check for "Keys" property
    alt "Keys" exists
        C-->>F: Return clause cast as EntityKeysClause
    else No "Keys"
        C-->>F: Proceed with initialData logic
        F->>F: Process clause further
    end
Loading

Possibly related PRs

Poem

I’m a nimble rabbit in the codefield,
Hopping through patches with a joyful yield.
Dependencies spring to life with every upgrade,
Workflows now dance as submodules are played.
In this garden of updates, my ears twitch in delight—
A whimsical hop in the Dojo Engine night!
🐰✨


📜 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 7d2a6b7 and ff6eb12.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (27)
  • .changeset/dry-rivers-give.md (1 hunks)
  • .changeset/moody-rats-shake.md (1 hunks)
  • .github/workflows/ci.yaml (1 hunks)
  • .github/workflows/docs.yaml (1 hunks)
  • .github/workflows/release.yaml (1 hunks)
  • .gitmodules (1 hunks)
  • examples/example-predeployed-connector/src/starknet-provider.tsx (1 hunks)
  • examples/example-vite-kitchen-sink/package.json (1 hunks)
  • examples/example-vite-kitchen-sink/src/components/theme-switch.tsx (3 hunks)
  • examples/example-vite-react-sql/src/components/playground/direction-count.tsx (2 hunks)
  • packages/core/package.json (1 hunks)
  • packages/create-burner/package.json (1 hunks)
  • packages/create-dojo/package.json (1 hunks)
  • packages/predeployed-connector/package.json (1 hunks)
  • packages/react/package.json (1 hunks)
  • packages/sdk/src/__tests__/convertClauseToEntityKeysClause.test.ts (2 hunks)
  • packages/sdk/src/clauseBuilder.ts (3 hunks)
  • packages/sdk/src/convertClauseToEntityKeysClause.ts (1 hunks)
  • packages/sdk/src/convertToMemberValue.ts (1 hunks)
  • packages/sdk/src/experimental/index.ts (3 hunks)
  • packages/sdk/src/index.ts (4 hunks)
  • packages/state/package.json (1 hunks)
  • packages/state/src/recs/index.ts (5 hunks)
  • packages/torii-client/package.json (1 hunks)
  • packages/torii-wasm/dojo.c (1 hunks)
  • packages/utils/package.json (1 hunks)
  • worlds/onchain-dash (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@MartianGreed MartianGreed force-pushed the feat/bump-dojo131 branch 6 times, most recently from fc33b04 to 4026fd3 Compare March 25, 2025 11:41
@MartianGreed MartianGreed marked this pull request as ready for review March 25, 2025 13:50
@MartianGreed MartianGreed merged commit bfc08b6 into main Mar 25, 2025
4 of 5 checks passed
@MartianGreed MartianGreed deleted the feat/bump-dojo131 branch March 25, 2025 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant