unreal-toolkit-next 0.0.1

package/README.md

@@ -0,0 +1,18 @@
+# Unreal Toolkit - Next Edition
+A universal runtime library for advanced Unreal Engine web game development. The **Unreal Toolkit** requires
+the **TOOLKIT** namespaces to be globally accessible.
+
+<a href="https://www.npmjs.com/package/unreal-toolkit">Classic Edition (UMD)</a>
+<br/>
+<a href="https://github.com/UnrealJS/UnrealToolkit/tree/master/Runtime">Browser Edition (CDN)</a>
+
+
+## Default Installation (ES6)
+```bash
+npm install unreal-toolkit-next
+```
+
+* Default Toolkit Import Libraries
+```javascript
+import TOOLKIT from 'unreal-toolkit';
+```

package/dist/index.d.ts

@@ -0,0 +1,69 @@
+/** ES6 Module Imports */
+/**
+ * Unreal Toolkit (Static Manager Pattern)
+ * @class UnrealToolkit - All rights reserved (c) 2024 Mackey Kinard
+ */
+export declare class UnrealToolkit {
+    private static _EventBus;
+    /** Unreal Toolkit event message bus
+     * @example
+     * ```typescript
+     * // Handle myevent message
+     * UnrealToolkit.EventBus.OnMessage("myevent", (data:string) => {
+     *    console.log("My Event Data: " + data);
+     * });
+     *
+     * // Post myevent message
+     * UnrealToolkit.EventBus.PostMessage("myevent", "Hello World!");
+     * ```
+    */
+    static get EventBus(): UnrealMessageBus;
+}
+/**
+ * Unreal Toolkit Message Bus (Asynchronous Post Message Communication)
+ * @class UnrealMessageBus - All rights reserved (c) 2024 Mackey Kinard
+ */
+export declare class UnrealMessageBus {
+    constructor();
+    /** Handle event bus message
+     * @param message The message to handle
+     * @param data The data to handle
+     * @returns void
+     */
+    OnMessage(message: string, handler: (data: string) => void): void;
+    /** Post event bus message
+     * @param message The message to post
+     * @param data The data to post
+     * @param target The target to post
+     * @param transfer The transfer to post
+     * @returns void
+     */
+    PostMessage(message: string, data?: string): void;
+    /** Remove event bus message handler
+     * @param message The message to remove
+     * @param handler The handler to remove
+     * @returns void
+     */
+    RemoveHandler(message: string, handler: (data: string) => void): void;
+    /** Clear and reset all event bus message handlers
+     * @returns void
+     */
+    ResetHandlers(): void;
+    /** Dispose the unreal message bus
+     * @returns void
+     */
+    Dispose(): void;
+    /** Handle window message event
+     * @param event The message event to handle
+     * @returns void
+     */
+    private HandleWindowMessage;
+    /** Dispatch internal event bus message
+     * @param message The message to dispatch
+     * @param data The data to dispatch
+     * @returns void
+     */
+    private OnDispatchMessage;
+    private ListenerDictionary;
+}
+export default UnrealToolkit;

package/dist/index.js

@@ -0,0 +1,131 @@
+/** ES6 Module Imports */
+/**
+ * Unreal Toolkit (Static Manager Pattern)
+ * @class UnrealToolkit - All rights reserved (c) 2024 Mackey Kinard
+ */
+export class UnrealToolkit {
+    /** Unreal Toolkit event message bus
+     * @example
+     * ```typescript
+     * // Handle myevent message
+     * UnrealToolkit.EventBus.OnMessage("myevent", (data:string) => {
+     *    console.log("My Event Data: " + data);
+     * });
+     *
+     * // Post myevent message
+     * UnrealToolkit.EventBus.PostMessage("myevent", "Hello World!");
+     * ```
+    */
+    static get EventBus() {
+        if (UnrealToolkit._EventBus == null)
+            UnrealToolkit._EventBus = new UnrealMessageBus();
+        return UnrealToolkit._EventBus;
+    }
+}
+UnrealToolkit._EventBus = null;
+/**
+ * Unreal Toolkit Message Bus (Asynchronous Post Message Communication)
+ * @class UnrealMessageBus - All rights reserved (c) 2024 Mackey Kinard
+ */
+export class UnrealMessageBus {
+    constructor() {
+        this.ListenerDictionary = {};
+        if (window && window.top) {
+            this.HandleWindowMessage = this.HandleWindowMessage.bind(this);
+            window.top.addEventListener("message", this.HandleWindowMessage);
+        }
+        else {
+            console.warn("UnrealMessageBus: No Top Window Available");
+        }
+    }
+    /** Handle event bus message
+     * @param message The message to handle
+     * @param data The data to handle
+     * @returns void
+     */
+    OnMessage(message, handler) {
+        let listeners;
+        if (this.ListenerDictionary[message] == null) {
+            listeners = [];
+            this.ListenerDictionary[message] = listeners;
+        }
+        else {
+            listeners = this.ListenerDictionary[message];
+        }
+        const index = listeners.findIndex((e) => { return handler == e; });
+        if (index < 0)
+            listeners.push(handler);
+    }
+    /** Post event bus message
+     * @param message The message to post
+     * @param data The data to post
+     * @param target The target to post
+     * @param transfer The transfer to post
+     * @returns void
+     */
+    PostMessage(message, data) {
+        if (window && window.top)
+            window.top.postMessage({ source: "unrealmessagebus", message: message, data: data });
+        else
+            console.warn("UnrealMessageBus: No Top Window Available");
+    }
+    /** Remove event bus message handler
+     * @param message The message to remove
+     * @param handler The handler to remove
+     * @returns void
+     */
+    RemoveHandler(message, handler) {
+        const listeners = this.ListenerDictionary[message];
+        if (listeners == null)
+            return;
+        const index = listeners.findIndex((e) => { return handler == e; });
+        if (index >= 0)
+            listeners.splice(index, 1);
+    }
+    /** Clear and reset all event bus message handlers
+     * @returns void
+     */
+    ResetHandlers() {
+        this.ListenerDictionary = {};
+    }
+    /** Dispose the unreal message bus
+     * @returns void
+     */
+    Dispose() {
+        this.ResetHandlers();
+        if (window && window.top)
+            window.top.removeEventListener("message", this.HandleWindowMessage);
+    }
+    /** Handle window message event
+     * @param event The message event to handle
+     * @returns void
+     */
+    HandleWindowMessage(event) {
+        if (event != null && event.data != null && event.data.message != null && event.data.source != null && event.data.source == "unrealmessagebus") {
+            this.OnDispatchMessage(event.data.message, (event.data.data != null) ? event.data.data : null);
+        }
+    }
+    /** Dispatch internal event bus message
+     * @param message The message to dispatch
+     * @param data The data to dispatch
+     * @returns void
+     */
+    OnDispatchMessage(message, data = null) {
+        const listeners = this.ListenerDictionary[message];
+        if (listeners == null)
+            return;
+        listeners.forEach((listener) => { try {
+            if (listener)
+                listener(data);
+        }
+        catch (e) {
+            console.warn(e);
+        } });
+    }
+}
+/** Unreal Toolkit Runtime Module */
+if (typeof window !== 'undefined') {
+    window.UnrealToolkit = UnrealToolkit;
+}
+console.log("Unreal Toolkit Runtime - Version 0.0.1");
+export default UnrealToolkit;

package/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "unreal-toolkit-next",
+    "version": "0.0.1",
+    "description": "Unreal Toolkit Runtime Library (ES6)",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "clean": "rimraf dist",
+        "build": "npm run build-all",
+        "build-ts": "tsc",
+        "build-old": "webpack --mode production",
+        "build-all": "npm run clean && npm run build-ts"
+    },
+    "keywords": [
+        "unrealjs",
+        "unreal-toolkit",
+        "game-development",
+        "wasm",
+        "webgl",
+        "webgpu"
+    ],
+    "files": [
+        "README.md",
+        "package.json",
+        "dist/**/*"
+    ],
+    "devDependencies": {
+        "rimraf": "^6.0.1",
+        "terser": "^5.31.6",
+        "ts-loader": "^9.5.1",
+        "typescript": "^5.5.4",
+        "webpack": "^5.93.0",
+        "webpack-cli": "^5.1.4"
+    }
+}