refactor: state plugin

[hexqi]

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• [x] The commit message follows our Commit Message Guidelines
• [ ] Tests for the changes have been added (for bug fixes / features)
• [ ] Docs have been added / updated (for bug fixes / features)
• [ ] Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

• [ ] Bugfix
• [ ] Feature
• [ ] Code style update (formatting, local variables)
• [x] Refactoring (no functional changes, no api changes)
• [ ] Build related changes
• [ ] CI related changes
• [ ] Documentation content changes
• [ ] Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• [ ] Yes
• [x] No

Other information

Summary by CodeRabbit

• New Features

  • Introduced a new state management plugin with pageState and globalState capabilities.
  • Added Vue components for creating remote APIs, managing data sources, and handling internationalization within the editor.
  • Integrated state management layout with tab and panel interactions.

• Enhancements

  • Improved form validation and editor interactions for state management.
  • Enhanced HTTP request handling for updating and requesting global states.

• Bug Fixes

  • Fixed issues related to state variable creation and validation.

• Documentation

  • Updated documentation URLs and metadata for new state management features.

[coderabbitai[bot]]

Walkthrough

The recent changes introduce a new state management plugin engine.plugins.newstate to the designer-demo and design-core packages. This plugin includes functionalities for managing both page-specific and global states. Several new Vue components and utility functions have been added to support this state management, along with necessary configurations in Vite and metadata definitions.

Changes

File Path	Change Summary
designer-demo/registry.js	Added new plugin engine.plugins.newstate for state management with pageState and globalState metas.
packages/design-core/registry.js	Added State plugin to the list of plugins and restructured settings object.
packages/design-core/vite.config.js	Added alias for @opentiny/tiny-engine-plugin-state.
packages/plugins/state/index.js	Introduced new plugin with AppState component and metadata.
packages/plugins/state/src/app-state/index.js	Exported AppState component and metadata.
packages/plugins/state/src/app-state/meta.js	Defined metadata for global application state.
packages/plugins/state/src/app-state/useState.js	Introduced a default export of an arrow function.
packages/plugins/state/src/common/components/CreateRemoteAPI.vue	Added Vue component for creating remote API configurations.
packages/plugins/state/src/common/components/CreateRemoteFunction.vue	Added Vue component for creating remote functions.
packages/plugins/state/src/common/components/DataSourceList.vue	Added Vue component for displaying and managing data sources.
packages/plugins/state/src/common/components/DataSourceRightPanel.vue	Added Vue component for managing data sources with a right panel interface.
packages/plugins/state/src/common/components/EditorI18nTool.vue	Added Vue component for managing internationalization (i18n) features.
packages/plugins/state/src/common/js/common.js	Introduced validateMonacoEditorData function for validating Monaco editor instances.
packages/plugins/state/src/common/js/constants.js	Defined constants STATE and OPTION_TYPE for state management.
packages/plugins/state/src/common/js/http.js	Updated updateGlobalState and requestGlobalState functions.
packages/plugins/state/src/layout/Layout.vue	Added Vue component for managing state with tabs and panels.
packages/plugins/state/src/layout/index.js	Exported Layout component with metadata.
packages/plugins/state/src/layout/meta.js	Defined layout metadata for the new state management engine plugin.
packages/plugins/state/src/page-state/CreateVariable.vue	Added Vue component for creating variables with customizable initial values and accessors.
packages/plugins/state/src/page-state/PageState.vue	Added Vue component for managing state variables with various functionalities.
packages/plugins/state/src/page-state/index.js	Exported PageState component with metadata.
packages/plugins/state/src/page-state/meta.js	Defined metadata for page state related to the new plugin.
packages/plugins/state/src/page-state/useState.js	Introduced a default export of an arrow function.
packages/plugins/state/vite.config.js	Configured Vite for the plugin-state project.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant UI
    participant StatePlugin
    participant Server

    User->>UI: Interact with State Components
    UI->>StatePlugin: Request State Update
    StatePlugin->>Server: Send Update Request
    Server-->>StatePlugin: Respond with Updated State
    StatePlugin-->>UI: Update UI with New State
    UI-->>User: Display Updated State

Poem

In the realm of code so bright,
A new state plugin takes its flight,
With pages and globals it does play,
Managing states in a seamless way.
Vue components join the dance,
Enhancing the app with every chance.
Hooray for the code, so fresh and new,
A rabbit's joy, in every view! 🐇✨

---

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>.
  • 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 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.