dojoengine / dojo.js

Official JavaScript packages for Dojo.
https://dojoengine.github.io/dojo.js/
MIT License
28 stars 47 forks source link

feat: sdk v2 #266

Closed ponderingdemocritus closed 1 month ago

ponderingdemocritus commented 2 months ago

WIP

still todo:

Attempts to implement a typed query lang ontop of torii client. Very experimental. Discussion needed.

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes introduce several enhancements to the Dojo Engine SDK, focusing on improved management of game-related entities and real-time updates. Key updates include the introduction of a new enumeration for movement directions, a React component for connecting to a Dojo Engine database, and the establishment of TypeScript interfaces for structured data handling. These modifications enhance the SDK's capabilities for real-time data management and entity subscriptions, creating a more robust framework for game state management.

Changes

Files Change Summary
clients/react/react-app/src/App.tsx Introduced DirectionEnum for movement actions, improving code clarity and maintainability.
clients/react/react-app/src/dojo/createSystemCalls.ts Simplified direction handling in createSystemCalls, enhancing clarity.
clients/react/react-app/src/dojo/DojoContext.tsx Minor reorganization of import statements for clarity.
clients/react/react-app/src/main.tsx Reordered import statements for better readability.
clients/react/react-sdk/src/App.tsx New component for managing game entities and real-time updates.
clients/react/react-sdk/src/bindings.ts Introduced TypeScript interfaces and enums for managing game-related data.
clients/vue/vue-app/dojoConfig.ts New configuration file for setting up Dojo resources.
examples/example-nodejs-bot/dojoConfig.ts Updated import path for the manifest JSON file.
examples/example-vite-react-app-recs/dojoConfig.ts Updated import path for the manifest JSON file.
examples/example-vite-react-sdk/dojoConfig.ts Updated import path for the manifest JSON file.
examples/example-vite-react-threejs-recs/dojoConfig.ts New configuration file for Dojo setup.
examples/example-vue-app-recs/dojoConfig.ts New configuration file for Dojo setup.
package.json Updated dependencies related to TypeScript documentation generation.

Possibly related PRs

Poem

🐇 In the meadow of code, we leap and bound,
With new tools and features, joy can be found.
Real-time updates dance in the light,
Game states evolving, oh what a sight!
Let's hop with delight, for changes are here,
In our coding adventure, we have nothing to fear! 🌼


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.