Merge pull request #2 from OpenScriptJs/develop

Readme updated and helper function for eventparsing added to list of exports.

Author: levizwannah

README.md

@@ -566,13 +566,13 @@ Listen to global application events dispatched via the Broker. Methods prefixed
 - `eventName`: The specific event name triggered.
 
 ```javascript
-import { EventData } from "modular-openscriptjs";
+import { parsePayload } from "modular-openscriptjs";
 
 export default class UserProfile extends Component {
   // Listen for 'auth:login' event
   async $$auth_login(eventData, eventName) {
     // 1. Parse the payload
-    const data = EventData.parse(eventData);
+    const data = parsePayload(eventData);
 
     console.log("User Logged In:", data.message.get("userId"));
   }
@@ -1069,12 +1069,12 @@ When you listen for an event (e.g., in a Mediator or Component), you receive the
 **Why a string?** It ensures that data remains immutable during transit and can be easily serialized for logging or debugging.
 
 ```javascript
-import { EventData } from "modular-openscriptjs";
+import { parsePayload } from "modular-openscriptjs";
 
 // In a Component or Mediator
-async $$auth_login(eventDataString, eventName) {
+async $$auth_login(eventData, eventName) {
     // 1. Parse the string back into an EventData object
-    const data = EventData.parse(eventDataString);
+    const data = parsePayload(eventData);
 
     // 2. Access the message
     const userId = data.message.get("id"); // 42
@@ -1120,7 +1120,7 @@ A Mediator is just a class that extends `Mediator`. It doesn't have a UI. It jus
 
 ```javascript
 // src/mediators/AuthMediator.js
-import { Mediator, EventData, payload } from "modular-openscriptjs";
+import { Mediator, parsePayload, payload } from "modular-openscriptjs";
 
 export default class AuthMediator extends Mediator {
   // REQUIRED: This tells the framework to scan this class for listeners
@@ -1129,8 +1129,8 @@ export default class AuthMediator extends Mediator {
   }
 
   // Logic: Listen for 'auth' and 'login' events
-  async $$auth_login(eventDataString, eventName) {
-    const data = EventData.parse(eventDataString);
+  async $$auth_login(eventData, eventName) {
+    const data = parsePayload(eventData);
     const credentials = data.message.getAll();
 
     try {

docs/2-components.md

@@ -165,20 +165,20 @@ Methods starting with `$$` are treated as listeners for global events emitted vi
 
 **Signature**: `(eventData, eventName)`
 
-- `eventData`: The JSON stringified payload (needs `EventData.parse()`).
+- `eventData`: The JSON stringified payload (needs `parsePayload()`).
 - `eventName`: The string name of the event that triggered this listener.
 
 - `$$app_started(eventData, event)`: Listens for `app:started`.
 - `$$user_login(eventData, event)`: Listens for `user:login`.
 
 ```javascript
-import { EventData, component } from "modular-openscriptjs";
+import { parsePayload, component } from "modular-openscriptjs";
 
 export default class UserProfile extends Component {
   // Listen to global 'auth:logout' event
   async $$auth_logout(eventData, event) {
     // 1. Parse Data
-    const data = EventData.parse(eventData);
+    const data = parsePayload(eventData);
     console.log(`Received ${event}`);
   }
 }

docs/8-events.md

@@ -85,10 +85,10 @@ async $$auth_login(eventData, event) {
 When an event is received (e.g., in a Mediator), the payload is often a **JSON string**. You must parse it back into an `EventData` object to access the helpers.
 
 ```javascript
-import { EventData } from "modular-openscriptjs";
+import { parsePayload } from "modular-openscriptjs";
 
 // ... in a listener
-const eventData = EventData.parse(payloadString);
+const eventData = parsePayload(payloadString);
 ```
 
 ### EventData Helper Methods

docs/9-mediators.md

@@ -52,7 +52,7 @@ The `$$` prefix is used to define event listeners. OpenScript interprets these p
 If you use an underscore in the method name after `$$`, it acts as an **OR** operator. The method will key off **multiple independent events**.
 
 ```javascript
-import { EventData } from "modular-openscriptjs";
+import { parsePayload } from "modular-openscriptjs";
 
 /*
  * Listens for:
@@ -62,7 +62,7 @@ import { EventData } from "modular-openscriptjs";
  */
 async $$user_login(eventData, event) {
   // Parse the JSON string payload
-  const data = EventData.parse(eventData);
+  const data = parsePayload(eventData);
 
   console.log(`Triggered by '${event}'`);
   console.log("User ID:", data.message.get("id"));
@@ -78,7 +78,7 @@ To listen to namespaced events (e.g., `user:login`, `user:logout`), you should u
 $$auth = {
   // Listens for 'auth:login'
   login: async (eventData, event) => {
-    const data = EventData.parse(eventData);
+    const data = parsePayload(eventData);
     this.handleLogin(data);
   },
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "modular-openscriptjs",
-  "version": "2.0.14",
+  "version": "2.0.15",
   "description": "OpenScriptJs Framework - A lightweight, reactive JavaScript framework for building modern web applications",
   "type": "module",
   "main": "./dist/modular-openscriptjs.umd.js",

src/index.js

@@ -64,6 +64,7 @@ const putContext = (referenceName, qualifiedName) =>
   contextProvider.load(referenceName, qualifiedName);
 const lazyFor = Utils.lazyFor;
 const each = Utils.each;
+const parsePayload = Utils.parsePayload;
 const component = (componentId) => app("repository").findComponent(componentId);
 const eData = (meta = {}, message = {}) => {
   return new EventData().meta(meta).message(message).encode();
@@ -189,6 +190,7 @@ export {
   component,
   eData,
   payload,
+  parsePayload,
   ojsRouterEvents,
   removeNodeModifications,
   removeNode,
@@ -233,6 +235,7 @@ export default {
   component,
   eData,
   payload,
+  parsePayload,
   ojsRouterEvents,
   removeNodeModifications,
   removeNode,

src/utils/Utils.js

@@ -7,24 +7,26 @@ export default class Utils {
     /**
      * Runs a foreach on an array
      * @param {Iterable} array
-     * @param {Function} callback
+     * @param {(v: any, index: Number) => any} callback
      */
-    static each = (array, callback = (v, index) => v) => {
+    static each = (array, callback = null) => {
+        if (!callback) callback = (v) => v;
+
         let output = [];
-        if (Array.isArray(array)) {
-            array.forEach((v, i) => output.push(callback(v, i)));
-        } else {
-            for (let k in array) output.push(callback(array[k], k));
-        }
+
+        for (let k in array) output.push(callback(array[k], k));
+
         return output;
     };
 
     /**
      * Iterates over array elements using setTimeout
      * @param {Iterable} array
-     * @param {Function} callback
+     * @param {(v: any) => any} callback
      */
-    static lazyFor = (array, callback = (v) => v) => {
+    static lazyFor = (array, callback = null) => {
+        if (!callback) callback = (v) => v;
+
         let index = 0;
 
         if (array.length < 1) return;