@virid/core 0.0.0-stage → 0.5.0

package/LICENSE

@@ -0,0 +1,190 @@
+   Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Ailrid
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,287 @@
-# Temporary Holding Version
+# @virid/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@virid/core` serves as the logical heartbeat of the entire Virid ecosystem. It provides a deterministic message distribution and scheduling mechanism, designed to completely decouple business logic from complex UI frameworks and runtime environments.
+
+⚠️ **Warning:** This framework heavily incorporates design philosophies from **Rust**, **Bevy**, and **NestJS**. It has a steep learning curve and requires the configuration of `reflect-metadata` with experimental metadata support enabled.
+
+### 🌟 Core Design Philosophy
+
+- **Absolute Environment Independence:** This package does not rely on any browser-specific APIs, Node.js internals, or third-party libraries (with the sole exception of `reflect-metadata` for decorator functionality). This ensures the kernel can run seamlessly within Electron main processes, Worker threads, Web rendering layers, or even pure server-side environments.
+- **Deterministic Scheduling:** By introducing a game-engine-inspired **Tick mechanism**, the framework utilizes double-buffered message pools to ensure the execution order of logic remains strictly predictable.
+- **Strong Typing & Ownership:** All systems are built with robust type safety, enforcing the use of modern TypeScript types and classes as unique identifiers. It features a runtime "modification shield" to intercept any illegal write operations. Move beyond a reliance on hot-reloading; as the saying goes: *If it compiles, it works.*
+
+## 🛠️ Core Functional Overview
+
+### 1. Message-Driven & Dispatcher Mechanism
+
+In `Virid`, all state changes must be triggered by sending a `Message` command.
+
+- **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`).
+- **Message Types**:
+  - **`SingleMessage`**: Messages of the same type within the same Tick are automatically merged, suitable for state synchronization.
+  - **`EventMessage`**: Sequentially appended, ensuring the integrity of action sequences.
+  - **`ErrorMessage`**: Sequentially appended; errors are treated as a message type with a default handling System.
+  - **`WarnMessage`**: Sequentially appended; warnings are a message type with a default handling System.
+  - **`InfoMessage`**: Sequentially appended; information is a message type with a default handling System.
+
+### 2. Dependency Injection System (DI)
+
+`Virid` implements a lightweight, decorator-based DI system, allowing Systems to access data entities with minimal effort.
+
+- **Data Entities (Component)**: Classes marked with the `@Component()` decorator are defined as data containers.
+- **Automatic Injection**: Once registered via `app.bindComponent()`, the Dispatcher automatically injects the corresponding instances based on the parameter types of the System function.
+
+```ts
+class IncrementMessage extends SingleMessage {
+  constructor(public amount: number) {
+    super();
+  }
+}
+
+@Component()
+class CounterComponent { public count = 0; }
+
+class CounterSystem {
+  @System()
+  static onIncrement(
+    @Message(IncrementMessage) msg: IncrementMessage,
+    count: CounterComponent
+  ) {
+    count.count += msg.amount; // CounterComponent instance is automatically injected
+  }
+}
+```
+
+### 3. Lifecycle Hooks
+
+The Dispatcher provides comprehensive lifecycle monitoring:
+
+- **Execution Hooks**: Supports `onBeforeExecute` and `onAfterExecute` for global auditing or filtering before and after logic execution.
+- **Cycle Hooks**: `onBeforeTick` and `onAfterTick` monitor the start and end of each logic frame.
+
+### 4. Industrial-Grade Robustness
+
+- **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.
+- **Execution Priority**: Supports defining the order of multiple Systems handling the same message via `@System({ priority: number })`.
+
+------
+
+## 🛠️ @virid/core API Reference
+
+### 1. Engine Initialization
+
+#### `createVirid()`
+
+- **Function**: Initializes the logical kernel and creates the globally unique `Dispatcher` and container.
+
+------
+
+### 2. Instructions & Messages
+
+#### `SingleMessage`
+
+- **Feature**: State synchronization message.
+- **Logic**: Multiple messages of the same type in one Tick are merged; the System typically receives only the latest one.
+- **Example**:
+
+```ts
+import { SingleMessage } from "@virid/core";
+class MyMessage extends SingleMessage {}
+//Send messages anywhere
+MyMessage.send(); // Parameters correspond to the constructor
+```
+
+#### `EventMessage`
+
+- **Feature**: Action command message.
+- **Logic**: Sequential, no merging. Every `EventMessage` triggers a System execution strictly.
+- **Example**: Same as `EventMessage`
+
+## 3. Data & Logic Definitions (Decorators)
+
+### `@Controller()`
+
+- **Function:** Marks a class as a UI Controller. Instances of this class are tied to the lifecycle of Vue components—created when the component is mounted and destroyed when it is unmounted. For details, see `@virid/vue`.
+
+- **Design:** Used in conjunction with `bindController`. Once registered, instances can be retrieved in `@virid/vue` using the `useController` hook.
+
+- **Example:**
+
+```ts
+@Controller()
+class PageController {}
+
+// Registration is required before use
+app.bind(PageController);
+```
+
+------
+
+### `@Component()`
+
+- **Function:** Marks a class as a Data Entity. This class acts as a global singleton and persists throughout the application lifecycle.
+
+- **Design:** Used with `bindComponent`. Once registered, it can be declared as a parameter type in a `@System` to enable automatic Dependency Injection (DI).
+
+- **Example:**
+
+```ts
+@Component()
+class CounterComponent {
+public count = 0;
+}
+
+// Registration is required before use
+app.bind(CounterComponent); 
+```
+
+------
+
+### `@System(params?)`
+
+- **Function:** Registers a static method as a business logic processor. It implements **"Automatic Dependency Wiring."** By simply specifying the `Component` type in the parameters, the engine automatically injects the corresponding instance during execution.
+
+- **Parameters:**
+
+  - `priority`: Execution priority. Higher values execute earlier within the same **Tick**.
+  - `messageClass`: The specific message type that triggers this System. (Cannot be used simultaneously with the `@Message` decorator on parameters).
+
+- **Example:**
+
+
+```ts
+import { System, Message } from "@virid/core";
+
+class CounterSystem {
+// Setting priority; CounterComponent is automatically injected
+@System({ priority: 0 })
+static onIncrement(
+  @Message(IncrementMessage) message: IncrementMessage,
+  count: CounterComponent,
+) {
+  count.count += message.amount;
+}
+
+// Alternative: Define messageClass in the System decorator
+@System({ messageClass: IncrementMessage })
+static onQuickAdd(count: CounterComponent) {
+  count.count += 1;
+}
+
+@System()
+static onProcess(msg: SomeMessage) {
+  // Return a message (or an array of messages) to trigger a logic chain
+  // This removes the need to manually call a MessageWriter
+  return new NextStepMessage(); 
+}
+}
+
+// Triggering logic via the .send() method
+IncrementMessage.send(5);
+```
+
+------
+
+### `@Message(Class, single?)`
+
+- **Function:** A parameter-level decorator that explicitly defines which message type the System is listening to.
+- **Batch Mode:** If `single: false` is set, the System receives an **array** of all messages of that type sent within the current Tick. This is ideal for high-performance batch processing (e.g., physics calculations or log aggregation).
+- **Example:** See the `@System` section above.
+
+------
+
+### `@Observer(callback)`
+
+- **Function:** A property-level decorator for change detection, used to handle "non-command-driven" side effects.
+
+- **Logic:** When a decorated property in a `Component` changes, the engine automatically triggers the specified callback function.
+
+- **Example:**
+
+
+```ts
+@Component()
+class PlayerComponent {
+// Automatically send a sync message or execute a callback when 'progress' changes
+@Observer((old, val) => new SyncLyricMessage(val))
+public progress = 0;
+}
+```
+
+------
+
+### `@Safe()`
+
+- **Function:** A method access modifier. In Virid, external environments (UI layers) are strictly prohibited from directly modifying logic-layer data; all modifications and method calls are intercepted by default. However, "read-only" or "safe calculation" methods can be explicitly authorized via `@Safe()`, allowing the view layer to call them directly.
+
+- **Design:** Primarily serves external projection layers like `@virid/vue`. See **Deep Shield** in the `@virid/vue` documentation for more details.
+
+- **Example:**
+
+
+```ts
+@Component()
+class PlayerComponent {
+// Without @Safe, Virid will block calls to this method from any Vue Controller
+@Safe()
+public someMethod() {}
+}
+```
+
+### 4. Dispatcher & Hooks
+
+- **Double-Buffered Flip**: Each execution locks current messages; new messages generated during execution enter the next cycle.
+- **Hooks Example**:
+
+```ts
+const app = createVirid();
+app.onBeforeExecute(MyMessage, (msg, context) => {
+  // Global performance tracking or permission validation
+});
+app.onAfterTick((context) => {
+  console.log("----------------onAfterTick------------------");
+});
+```
+
+------
+
+### 4. Dispatcher & Hooks
+
+#### **Dispatcher**
+
+The core scheduling engine of Virid operates on the following logic:
+
+- **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.
+- **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.
+
+#### **Life-Cycle Hooks**
+
+- **onBeforeTick / onAfterTick**: Monitor the "pulse" of logical frames.
+- **onBeforeExecute / onAfterExecute**: Audit the entire execution process for specific message types.
+- **Example:**
+
+```ts
+const app = createVirid();
+
+app.onBeforeExecute(MyMessage, (msg, context) => {
+  // Implement global performance tracking or permission validation here
+  // This hook only triggers for MyMessage and its subclasses
+});
+
+app.onAfterTick((context) => {
+  console.log("----------------onAfterTick------------------");
+});
+```
+
+### 5. System Communication (IO)
+
+#### **MessageWriter**
+
+- **Function**: A global static utility for system-wide communication.
+- **API**:
+  - **`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.
+  - **`MessageWriter.error(Error, context?)`**: Throws a system-level error, which automatically triggers an `ErrorMessage`.
+  - **`MessageWriter.warn(context)`**: Logs a warning, which automatically triggers a `WarnMessage`.
+  - **`MessageWriter.info(context)`**: Logs an informational message, which automatically triggers an `InfoMessage`.
+
+------