@virid/core 0.0.1 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Ailrid
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md CHANGED
@@ -1,259 +1,273 @@
1
- # 🛰️ @virid/core
1
+ # @virid/core
2
2
 
3
+ `@virid/core` is the logical heart of the entire Virid ecosystem. It provides a deterministic message distribution and scheduling mechanism designed to decouple business logic from complex UI frameworks and runtime environments.
3
4
 
5
+ ## 🌟 Core Design Philosophy
4
6
 
5
- > **A Lightweight, Message-Driven Logic Engine inspired by Rust's ECS Architecture and Nestjs.**
7
+ - **Absolute Environment Independence**: This package does not depend on any browser, Node.js specific APIs, or third-party libraries (relying only on `reflect-metadata` for decorator functionality). This ensures the core can run seamlessly in Electron main processes, Worker threads, Web rendering layers, or even pure server environments.
8
+ - **Deterministic Scheduling**: It introduces a "Tick" mechanism similar to game engines, utilizing a double-buffered message pool to ensure the predictability of logic execution order.
6
9
 
7
- [中文说明](README.zh.md)
10
+ ## 🛠️ Core Functional Overview
8
11
 
9
- ## Features
12
+ ### 1. Message-Driven & Dispatcher Mechanism
10
13
 
14
+ In Virid, all state changes must be triggered by sending a `Message` command.
11
15
 
16
+ - **Automatic Scheduling**: By defining specific types of `Message` and corresponding `System` handlers, the engine automatically invokes the registered logic in the next microtask cycle (Tick).
17
+ - **Message Types**:
18
+ - **`SingleMessage`**: Messages of the same type within the same Tick are automatically merged, suitable for state synchronization.
19
+ - **`EventMessage`**: Sequentially appended, ensuring the integrity of action sequences.
20
+ - **`ErrorMessage`**: Sequentially appended; errors are treated as a message type with a default handling System.
21
+ - **`WarnMessage`**: Sequentially appended; warnings are a message type with a default handling System.
22
+ - **`InfoMessage`**: Sequentially appended; information is a message type with a default handling System.
12
23
 
13
- ### 🧩 What is CCS Architecture?
24
+ ### 2. Dependency Injection System (DI)
14
25
 
15
- `virid` is built on the **CCS (Component-Controller-System)** architecture. Based on the traditional ECS (Entity-Component-System) pattern, it introduces a "Controller" layer specifically for Web/UI environments to bridge logic and views seamlessly.
26
+ Virid implements a lightweight, decorator-based DI system, allowing Systems to access data entities with minimal effort.
16
27
 
17
- #### 1. 💾 Component (Data) "The Container of Truth"
28
+ - **Data Entities (Component)**: Classes marked with the `@Component()` decorator are defined as data containers.
29
+ - **Automatic Injection**: Once registered via `app.bindComponent()`, the Dispatcher automatically injects the corresponding instances based on the parameter types of the System function.
18
30
 
19
- - **Definition**: Pure data structures containing zero business logic.
20
- - **Responsibility**: Stores state (e.g., `PlaylistComponent` storing song lists and playback status). In `virid`, Components are managed as **Singletons** within the IoC container.
31
+ TypeScript
21
32
 
22
- #### 2. 🎮 Controller (The Bridge) — "The Anchor of Views"
23
-
24
- - **Definition**: A proxy layer between the UI framework (Vue) and the core logic (Core).
25
- - **Responsibility**:
26
- - **Projection**: Safely maps data from `Components` to Vue using `@Project`.
27
- - **Command**: Captures UI events (like clicks) and transforms them into `Messages` to be dispatched to the engine.
28
- - **Context Awareness**: Perceives UI hierarchy and metadata (like list indices) via `@Env`.
33
+ ```ts
34
+ class IncrementMessage extends SingleMessage {
35
+ constructor(public amount: number) {
36
+ super();
37
+ }
38
+ }
29
39
 
30
- #### 3. ⚙️ System (Logic) — "The Arbiter of Causality"
40
+ @Component()
41
+ class CounterComponent { public count = 0; }
31
42
 
32
- - **Definition**: A collection of stateless static methods and the **only** legitimate place for state transitions.
33
- - **Responsibility**: Listens for `Messages` and modifies `Component` data accordingly. Systems are **deterministic**, ensuring that the same input always yields the same state transition.
43
+ class CounterSystem {
44
+ @System()
45
+ static onIncrement(
46
+ @Message(IncrementMessage) msg: IncrementMessage,
47
+ count: CounterComponent
48
+ ) {
49
+ count.count += msg.amount; // CounterComponent instance is automatically injected
50
+ }
51
+ }
52
+ ```
34
53
 
35
- ### 🛠️ Decoupling of Logic Sovereignty
54
+ ### 3. Lifecycle Hooks
36
55
 
37
- ### 1. Total UI Demotion: Framework-Agnostic Core
56
+ The Dispatcher provides comprehensive lifecycle monitoring:
38
57
 
39
- - **Transfer of Sovereignty**: The UI framework is stripped of its authority over state management and business scheduling, relegated to a pure **"State Projection Layer."** All business causality and state machine transitions are executed within the closed loop of `virid Core`.
40
- - **Physical Isolation**: The Core layer has zero dependencies on `DOM/BOM` APIs. Your core logic runs seamlessly in **Node.js servers, Web Workers, or even Command Line Interface (CLI) tools**.
41
- - **Seamless Migration**: Logical assets are no longer tethered to a specific UI library. Switch the adapter layer, and you are ready for **Vue, React, or beyond**.
58
+ - **Execution Hooks**: Supports `onBeforeExecute` and `onAfterExecute` for global auditing or filtering before and after logic execution.
59
+ - **Cycle Hooks**: `onBeforeTick` and `onAfterTick` monitor the start and end of each logic frame.
42
60
 
43
- ### 2. Production-Grade Testability
61
+ ### 4. Industrial-Grade Robustness
44
62
 
45
- - **Farewell to Mocking Hell**: Say goodbye to JSDOM and complex browser simulations. Since the core logic is pure JS/TS, you can boot the Core directly in Node.js and complete unit tests for complex business flows via a **"Send Message -> Assert State"** pattern.
46
- - **Logic Playback**: As all side effects are triggered by messages, business logic becomes a **pure pipeline**, enabling offline refactoring and automated regression of production logic paths.
63
+ - **Deadlock Defense**: The Dispatcher includes an `internalDepth` counter. If a logic chain triggers more than 100 levels of recursion, the system automatically fuses and throws an error to prevent the environment from hanging.
64
+ - **Execution Priority**: Supports defining the order of multiple Systems handling the same message via `@System({ priority: number })`.
47
65
 
48
- ### 3. Powerful Inversion of Control (IoC)
66
+ ------
49
67
 
50
- - **Deep IoC Architecture**: Built on **InversifyJS** for robust Dependency Injection. `Systems`, `Components`, and `Controllers` are auto-assembled via the container.
51
- - **Dynamic Lifecycle**: Supports on-demand loading and auto-injection of logic modules. Whether it’s a global singleton `System` or a `Controller` that dies with a component, the container manages the entire lifecycle.
68
+ ## 🛠️ @virid/core API Reference
52
69
 
53
- ---
70
+ ### 1. Engine Initialization
54
71
 
55
- ## 🏎️ Game-Grade Scheduling Engine
72
+ #### `createVirid()`
56
73
 
57
- - **Deterministic Tick Mechanism**: Introduces a Bevy-inspired message loop where all logical changes advance within discrete "Ticks."
58
- - **Double-Buffered Message Pool**: Physically isolates "processing" and "incoming" messages, effectively eliminating infinite loops and logical jitter.
59
- - **Physically Isolated Message Strategies**:
60
- - **SingleMessage (Signal)**: Automatically merges identical signals, triggering a single batch process within the same Tick.
61
- - **EventMessage (Event)**: Guarantees strict sequential execution, ensuring the atomicity of logical chains.
74
+ - **Function**: Initializes the logical kernel and creates the globally unique `Dispatcher` and container.
62
75
 
63
- ---
76
+ ------
64
77
 
65
- ## 🛡️ State Security & Access Control
78
+ ### 2. Instructions & Messages
66
79
 
67
- - **Read-Only Data Shield**: Controllers receive read-only proxies by default, strictly prohibiting illegal tampering with `Component` states outside of a `System`.
68
- - **Atomic Modification Protocol**: Data changes are forced through specific `AtomicModifyMessage` protocols, ensuring every state transition is traceable and auditable.
80
+ #### `SingleMessage`
69
81
 
70
- ---
82
+ - **Feature**: State synchronization message.
83
+ - **Logic**: Multiple messages of the same type in one Tick are merged; the System typically receives only the latest one.
84
+ - **Example**:
71
85
 
72
- ## 🧬 Declarative Meta-Programming
86
+ ```ts
87
+ import { SingleMessage } from "@virid/core";
88
+ class MyMessage extends SingleMessage {}
89
+ //Send messages anywhere
90
+ MyMessage.send(); // Parameters correspond to the constructor
91
+ ```
73
92
 
74
- - **Decorator-Driven**: Use `@System`, `@Message`, `@Inherit`, and `@Project` to declaratively describe complex dependency networks and reactive logic flows.
75
- - **Automated Data Routing**: Dispatching a message immediately triggers the response; parameters are injected automatically, eliminating the need to write tedious boilerplate for listeners and dispatchers.
93
+ #### `EventMessage`
76
94
 
77
- ## 📖 Quick Start
95
+ - **Feature**: Action command message.
96
+ - **Logic**: Sequential, no merging. Every `EventMessage` triggers a System execution strictly.
97
+ - **Example**: Same as `EventMessage`
78
98
 
79
- ⚠️ Important: You MUST import reflect-metadata at the very first line of your entry file (e.g., main.ts), otherwise decorators will not function correctly.
99
+ ------
80
100
 
81
- Build a strictly protected state machine in a pure JS environment in just three steps.
101
+ ### 3. Data & Logic Definitions (Decorators)
82
102
 
83
- ### 1. Define Components & Messages
103
+ #### `@Component()`
84
104
 
85
- **Components** are pure data structures; **Messages** are the sole driving contracts.
105
+ - **Function**: Marks a class as a **Data Entity**.
106
+ - **Usage**: Used with `bindComponent` to enable dependency injection in Systems.
107
+ - **Example**:
86
108
 
87
109
  ```ts
88
- import {
89
- createvirid,
90
- Component,
91
- System,
92
- Message,
93
- SingleMessage,
94
- AtomicModifyMessage,
95
- } from "@virid/core";
96
-
97
- // Initialize the core engine
98
- const app = createVirid();
99
-
100
- // Define Data Entity (Component)
101
110
  @Component()
102
111
  class CounterComponent {
103
112
  public count = 0;
104
113
  }
105
- // Register component
106
- app.bindComponent(CounterComponent);
107
-
108
- // Define operation instructions (Message)
109
- class IncrementMessage extends SingleMessage {
110
- constructor(public amount: number) {
111
- super();
112
- }
113
- }
114
114
  ```
115
115
 
116
- ### 2. Implement Systems
116
+ #### `@System(params?)`
117
117
 
118
- **Systems** are stateless static methods. They retrieve components via Dependency Injection (DI) to handle business logic. You don't need to manually instantiate or invoke them—virid will automatically discover and execute them through static analysis.
118
+ - **Function**: Registers a static method as a logic handler with automatic dependency assembly.
119
+ - **Parameters**:
120
+ - `priority`: Higher values execute earlier in a Tick.
121
+ - `messageClass`: The message type that triggers this System (cannot coexist with `@Message`).
122
+ - **Note**: Returning a Message (or array) from a System implements automatic logic chaining.
123
+ - **Examples**:
119
124
 
120
125
  ```ts
121
- //Define System
126
+ import {
127
+ System,
128
+ Message,
129
+ } from "@virid/core";
130
+
122
131
  class CounterSystem {
123
- @System()
132
+ // Priority can be set for the system
133
+ @System({ priority: 0})
124
134
  static onIncrement(
125
135
  @Message(IncrementMessage) message: IncrementMessage,
126
136
  count: CounterComponent,
127
137
  ) {
128
- console.log("---------------------System----------------------");
129
- console.log("message :>> ", message);
130
138
  count.count += message.amount;
131
139
  }
140
+ //You don't need to use @ Message if you already used messageClass
141
+ @System({messageClass:IncrementMessage})
142
+ static onIncrement(
143
+ count: CounterComponent,
144
+ ) {
145
+ count.count += 1;
146
+ }
147
+ @System()
148
+ static onProcess(msg: SomeMessage) {
149
+ // Directly return the message to achieve logical chain triggering, without the need to //manually call the Message Writer
150
+ // You can also return a message array to trigger continuously
151
+ return new NextStepMessage();
152
+ }
132
153
  }
154
+ //Send messages directly through. send
155
+ IncrementMessage.send(5);
133
156
  ```
134
157
 
135
- ### 3. Headless Execution
158
+ #### `@Message(Class, single?)`
136
159
 
137
- No browser required. Drive your business logic directly in **Node.js** or any testing framework.
138
-
139
- ```ts
140
- // Business logic automatically completes scheduling in the next microtask
141
- queueMicrotask(() => {
142
- IncrementMessage.send(1);
143
- IncrementMessage.send(5);
144
- queueMicrotask(() => {
145
- AtomicModifyMessage.send(
146
- CounterComponent,
147
- (comp) => {
148
- console.log("----------------AtomicModifyMessage------------------");
149
- console.log("CounterComponent :>> ", comp);
150
- },
151
- "Check CounterComponent",
152
- );
153
- });
154
- });
155
- ```
160
+ - **Function**: Parameter decorator defining the message type for the System.
161
+ - **Batch Mode**: Set `single: false` to receive an array of all messages of that type in the current Tick (ideal for high-performance batch processing).
162
+ - **Example**: Same as `System`
156
163
 
157
- ## 🛠️ Advanced Engineering Practices
164
+ #### @Observer(callback)
158
165
 
159
- ### Lifecycle Interception (Middleware & AOP Hooks)
166
+ - **Function** : Attribute level change monitoring, used to handle side effects that are not instruction driven
167
+ - **Logic** : When the attribute marked in 'Component' changes, the engine will automatically trigger the specified callback function.
168
+ - **Example** :
160
169
 
161
- virid provides deep access to the message pipeline, allowing you to easily extend the system with features like **Undo/Redo, State Synchronization, or Automated Logging**.
162
-
163
- - **Middleware**: Pre-process messages before they enter the `EventHub`.
164
-
165
- TypeScript
166
-
167
- ```
168
- app.useMiddleware((message, next) => {
169
- console.log(`[Log]: Intercepted message ${message.constructor.name}`);
170
- next(); // Continue the pipeline
171
- });
172
- ```
173
-
174
- - **AOP Hooks**: Perform aspect-oriented processing before or after specific message execution.
175
- - `onBeforeExecute`: Triggered before System logic runs (e.g., for permission checks).
176
- - `onAfterExecute`: Triggered after logic execution (e.g., for data persistence).
177
-
178
- TypeScript
170
+ ```ts
171
+ @Component()
172
+ class PlayerComponent {
173
+ //Automatically send a synchronization message or execute a callback when progress changes
174
+ @Observer((old, val) => new SyncLyricMessage(val))
175
+ public progress = 0;
176
+ }
177
+ ```
179
178
 
180
- ```
181
- app.onBeforeExecute(IncrementMessage, (message, context) => {
182
- console.log("---------------- onBeforeExecute ------------------");
183
- console.log("Message Details:", message);
184
- console.log("Target System:", context.targetClass.name);
185
- console.log("Method Context:", context.methodName);
186
- });
187
- ```
179
+ #### `@Safe()`
188
180
 
189
- ---
181
+ - **Function**: Method access marking. In Virid, The UI layer is restricted from directly modifying logic data. `@Safe()` explicitly authorizes the view layer to call specific "read-only" or "safe-calculation" methods.
182
+ - **Example** :
190
183
 
191
- ### ⚡ Atomic Modification: The "Snapshot" Privilege
184
+ ```ts
185
+ @Component()
186
+ class PlayerComponent {
187
+ // 如果不加Safe,virid将会禁止在任何vue的controller中调用该方法
188
+ @Safe()
189
+ public someMethod(){}
190
+ }
191
+ ```
192
192
 
193
- To balance **strict constraints** with **development efficiency**, virid allows direct state mutations via `AtomicModifyMessage` without the need to write a full `System`.
193
+ ------
194
194
 
195
- - **Semantic Mutations**: Every atomic modification requires a mandatory `label`, transforming "arbitrary" assignments into auditable, meaningful actions.
196
- - **Consistency Guarantee**: Atomic modifications still follow the **Tick Scheduling** mechanism, ensuring that data changes are synchronized with System logic.
195
+ ### 4. Dispatcher & Hooks
197
196
 
198
- ---
197
+ - **Double-Buffered Flip**: Each execution locks current messages; new messages generated during execution enter the next cycle.
198
+ - **Hooks Example**:
199
199
 
200
- ### 🚨 Everything is a Message: Robust Error Monitoring
200
+ ```ts
201
+ const app = createVirid();
202
+ app.onBeforeExecute(MyMessage, (msg, context) => {
203
+ // Global performance tracking or permission validation
204
+ });
205
+ app.onAfterTick((context) => {
206
+ console.log("----------------onAfterTick------------------");
207
+ });
208
+ ```
201
209
 
202
- virid treats exceptions as first-class citizens of the system:
210
+ ------
203
211
 
204
- - **Automatic Encapsulation**: Any synchronous or asynchronous exception within a `System` or `Hook` is automatically captured by the `Dispatcher` and encapsulated into an `ErrorMessage`.
205
- - **Defensive Programming**: You can define a dedicated `ErrorSystem` to handle these messages globally (e.g., reporting to Sentry or triggering UI alerts). This ensures the core engine remains resilient and never crashes due to a single component failure.
212
+ ### 4. Dispatcher & Hooks
206
213
 
207
- ---
214
+ #### **Dispatcher**
208
215
 
209
- ---
216
+ The core scheduling engine of Virid operates on the following logic:
210
217
 
211
- ## 🚀 Conclusion: Why virid?
218
+ - **Double-Buffered Flip**: The scheduler runs based on logical **Ticks**. A Tick starts at the beginning of a microtask and continues until no new messages are generated internally. During each execution, the scheduler locks the current pending messages; any new messages generated during this process are automatically moved to the next cycle.
219
+ - **Recursion Melt-down (Deadlock Defense)**: If the recursive execution depth (`internalDepth`) exceeds 100, the engine immediately halts and throws an error. This protects the main thread from being frozen by logical "black holes" or infinite loops.
212
220
 
213
- virid is not just another state management library; it is an endeavor to introduce **Deterministic Industrial Standards** to Web development.
221
+ #### **Life-Cycle Hooks**
214
222
 
215
- As your project scales from dozens to thousands of components, and your business logic evolves from simple CRUD into intricate cross-component choreographies, the virid architecture ensures that your codebase remains:
223
+ - **onBeforeTick / onAfterTick**: Monitor the "pulse" of logical frames.
224
+ - **onBeforeExecute / onAfterExecute**: Audit the entire execution process for specific message types.
225
+ - **Example:**
216
226
 
217
- - **Traceable**: Every logical transition has a clear trail via messages.
218
- - **Predictable**: Every state modification follows strict, predefined protocols.
219
- - **Decoupled**: Every business flow can be tested and validated entirely independent of the UI.
227
+ ```ts
228
+ const app = createVirid();
220
229
 
221
- ### 🛰️ Data Flow Architecture
230
+ app.onBeforeExecute(MyMessage, (msg, context) => {
231
+ // Implement global performance tracking or permission validation here
232
+ // This hook only triggers for MyMessage and its subclasses
233
+ });
222
234
 
223
- ```mermaid
224
- graph TD
225
- %% 定义外部触发
226
- User([External/Logic Call]) -->|Message.send| Writer[MessageWriter]
235
+ app.onAfterTick((context) => {
236
+ console.log("----------------onAfterTick------------------");
237
+ });
238
+ ```
227
239
 
228
- %% 核心引擎内部
229
- subgraph Engine [Virid Core Engine]
230
- direction TB
231
- Writer -->|Middleware Pipeline| Hub[EventHub: Staging]
240
+ ### 5. System Communication (IO)
232
241
 
233
- subgraph Dispatcher [Deterministic Dispatcher]
234
- Hub -->|Tick / Buffer Flip| Active[EventHub: Active Pool]
235
- Active -->|Sort by Priority| TaskQueue[Task Queue]
242
+ #### **MessageWriter**
236
243
 
237
- subgraph Executor [Execution Context]
238
- TaskQueue -->|Identify| Sys[System Static Method]
239
- Container[(Inversify Container)] -.->|Inject Component| Sys
240
- Sys -->|Execute| Logic{Business Logic}
241
- end
242
- end
244
+ - **Function**: A global static utility for system-wide communication.
245
+ - **API**:
246
+ - **`MessageWriter.write(MessageClass, ...args)`**: The underlying entry point for dispatching messages. It instantiates the message class with the provided arguments and sends it to the Dispatcher.
247
+ - **`MessageWriter.error(Error, context?)`**: Throws a system-level error, which automatically triggers an `ErrorMessage`.
248
+ - **`MessageWriter.warn(context)`**: Logs a warning, which automatically triggers a `WarnMessage`.
249
+ - **`MessageWriter.info(context)`**: Logs an informational message, which automatically triggers an `InfoMessage`.
243
250
 
244
- Logic -->|Update| Data[(Raw Component Data)]
251
+ ------
245
252
 
246
- %% 异常与反馈流
247
- Logic -- "New Message" --> Writer
248
- Logic -- "Error" --> ErrorHandler[Error Message System]
249
- end
253
+ ### 🔬 Advanced: Atomic Operations
250
254
 
251
- %% 状态输出
252
- Data -->|Optional Projection| Output([External State Observation])
255
+ #### **AtomicModifyMessage**
253
256
 
254
- %% 样式
255
- style Engine fill:#fff,stroke:#333,stroke-width:2px
256
- style Dispatcher fill:#f5f5f5,stroke:#666,dashed
257
- style Container fill:#e1f5fe,stroke:#01579b
257
+ - **Function**: Provides a "plug-and-play" solution for temporary logic modifications.
258
+ - **Scenario**: When you need to perform a one-time observation or tweak a `Component` without the overhead of defining a dedicated `System`, you can use this message to execute a closure logic in the next logical frame (Tick).
259
+ - **Example**:
258
260
 
261
+ ```ts
262
+ AtomicModifyMessage.send(
263
+ CounterComponent,
264
+ (comp) => {
265
+ // Perform one-time inspection or modification on the component instance
266
+ console.log("----------------AtomicModifyMessage------------------");
267
+ console.log("Current Component State:", comp);
268
+ },
269
+ "Check CounterComponent" // Optional: label for debugging/tracing
270
+ );
259
271
  ```
272
+
273
+ ------