unreal-toolkit-next 0.1.11 → 0.1.14

package/README.md

@@ -1,10 +1,10 @@
 # Unreal Toolkit - Next Edition
-A universal runtime library for advanced Unreal Engine web game development. The **Unreal Toolkit** enables interoperability
+A runtime library for advanced Unreal Engine web game development. The **Unreal Toolkit** enables interoperability
 with your hosted Unreal Engine streaming web application.
 
 <a href="https://www.npmjs.com/package/unreal-toolkit">Classic Edition (UMD)</a>
 <br/>
-<a href="https://github.com/MackeyK24/UnrealToolkit/tree/master/Runtime">Browser Edition (CDN)</a>
+<a href="https://github.com/codewrxai/UnrealToolkit/cdn">Browser Edition (CDN)</a>
 
 
 ## Default Installation (ES6)
@@ -16,3 +16,37 @@ npm install unreal-toolkit-next
 ```javascript
 import UnrealToolkit from 'unreal-toolkit';
 ```
+
+* Unreal Toolkit Message Bus Usage
+```typescript
+// Post WM_HELLO message to Unreal Engine
+UnrealToolkit.EventBus.PostWindowMessage("WM_HELLO", ["Hello World!"]);
+
+// Handle WM_MY_EVENT message from Unreal Engine
+UnrealToolkit.EventBus.OnWindowMessage("WM_MY_EVENT", (args:string[]) => {
+   console.log("My Event Args: ", args);
+});
+```
+
+* Unreal Toolkit Content Frame Style
+```css
+iframe {
+   position: absolute;
+   width: 100%;
+   height: 100%;
+   min-height: 100vh;
+   border: none;
+   outline: none;
+   z-index: 0;
+}
+```
+
+* Unreal Toolkit Content Frame Window
+```html
+<iframe
+  src="your.unrealtoolkitproject.com"
+  crossorigin="anonymous"
+  allow="cross-origin-isolated"
+  sandbox="allow-same-origin allow-scripts allow-popups allow-forms allow-pointer-lock">
+</iframe>
+```

package/dist/index.d.ts

@@ -8,13 +8,13 @@ export declare 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 WM_HELLO message to Unreal Engine
+     * UnrealToolkit.EventBus.PostWindowMessage("WM_HELLO", ["Hello World!"]);
      *
-     * // Post myevent message
-     * UnrealToolkit.EventBus.PostMessage("myevent", "Hello World!");
+     * // Handle WM_MY_EVENT message from Unreal Engine
+     * UnrealToolkit.EventBus.OnWindowMessage("WM_MY_EVENT", (args:string[]) => {
+     *    console.log("My Event Args: ", args);
+     * });
      * ```
     */
     static get EventBus(): UnrealMessageBus;
@@ -24,28 +24,28 @@ export declare class UnrealToolkit {
  * @class UnrealMessageBus - All rights reserved (c) 2024 Mackey Kinard
  */
 export declare class UnrealMessageBus {
-    RequiredOrigin: string;
+    static AllowedOrigin: string;
+    static TargetOrigin: string;
+    static ContentFrames: NodeListOf<HTMLIFrameElement>;
     constructor();
-    /** Handle event bus message
-     * @param message The message to handle
-     * @param data The data to handle
+    /** Post event bus message
+     * @param name The message to post
+     * @param args The args to post
      * @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
+    PostWindowMessage(name: string, args?: string[]): void;
+    /** Handle event bus message
+     * @param name The name to handle
+     * @param args The args to handle
      * @returns void
      */
-    PostMessage(message: string, data?: string, targetOrigin?: string): void;
+    OnWindowMessage(name: string, handler: (args: string[]) => void): 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;
+    RemoveHandler(message: string, handler: (args: string[]) => void): void;
     /** Clear and reset all event bus message handlers
      * @returns void
      */
@@ -54,14 +54,18 @@ export declare class UnrealMessageBus {
      * @returns void
      */
     Dispose(): void;
+    /** Resets the content frame list
+     * @returns void
+     */
+    ResetContentFrames(): 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
+     * @param name The name to dispatch
+     * @param args The args to dispatch
      * @returns void
      */
     private OnDispatchMessage;

package/dist/index.js

@@ -7,13 +7,13 @@ 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 WM_HELLO message to Unreal Engine
+     * UnrealToolkit.EventBus.PostWindowMessage("WM_HELLO", ["Hello World!"]);
      *
-     * // Post myevent message
-     * UnrealToolkit.EventBus.PostMessage("myevent", "Hello World!");
+     * // Handle WM_MY_EVENT message from Unreal Engine
+     * UnrealToolkit.EventBus.OnWindowMessage("WM_MY_EVENT", (args:string[]) => {
+     *    console.log("My Event Args: ", args);
+     * });
      * ```
     */
     static get EventBus() {
@@ -29,47 +29,57 @@ UnrealToolkit._EventBus = null;
  */
 export class UnrealMessageBus {
     constructor() {
-        this.RequiredOrigin = "*";
         this.ListenerDictionary = {};
-        if (window && window.top) {
-            this.HandleWindowMessage = this.HandleWindowMessage.bind(this);
-            window.top.addEventListener("message", this.HandleWindowMessage);
+        this.HandleWindowMessage = this.HandleWindowMessage.bind(this);
+        window.addEventListener("message", this.HandleWindowMessage);
+    }
+    /** Post event bus message
+     * @param name The message to post
+     * @param args The args to post
+     * @returns void
+     */
+    PostWindowMessage(name, args) {
+        try {
+            if (UnrealMessageBus.ContentFrames == null) {
+                UnrealMessageBus.ContentFrames = document.querySelectorAll("iframe");
+            }
+            if (UnrealMessageBus.ContentFrames != null) {
+                UnrealMessageBus.ContentFrames.forEach((frame) => {
+                    var _a;
+                    try {
+                        (_a = frame.contentWindow) === null || _a === void 0 ? void 0 : _a.postMessage({ source: "unrealtoolkit", message: name, args: args }, UnrealMessageBus.TargetOrigin);
+                    }
+                    catch (e) {
+                        console.warn(e);
+                    }
+                });
+            }
+            else {
+                console.warn("UnrealMessageBus: No Content Frames Found!");
+            }
         }
-        else {
-            console.warn("UnrealMessageBus: No Top Window Available");
+        catch (e) {
+            console.warn(e);
         }
     }
     /** Handle event bus message
-     * @param message The message to handle
-     * @param data The data to handle
+     * @param name The name to handle
+     * @param args The args to handle
      * @returns void
      */
-    OnMessage(message, handler) {
+    OnWindowMessage(name, handler) {
         let listeners;
-        if (this.ListenerDictionary[message] == null) {
+        if (this.ListenerDictionary[name] == null) {
             listeners = [];
-            this.ListenerDictionary[message] = listeners;
+            this.ListenerDictionary[name] = listeners;
         }
         else {
-            listeners = this.ListenerDictionary[message];
+            listeners = this.ListenerDictionary[name];
         }
         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, targetOrigin = "*") {
-        if (window && window.top)
-            window.top.postMessage({ source: "unrealmessagebus", message: message, data: data }, targetOrigin);
-        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
@@ -94,41 +104,86 @@ export class UnrealMessageBus {
      */
     Dispose() {
         this.ResetHandlers();
-        if (window && window.top)
-            window.top.removeEventListener("message", this.HandleWindowMessage);
+        window.removeEventListener("message", this.HandleWindowMessage);
+    }
+    /** Resets the content frame list
+     * @returns void
+     */
+    ResetContentFrames() {
+        UnrealMessageBus.ContentFrames = null;
     }
     /** Handle window message event
      * @param event The message event to handle
      * @returns void
      */
     HandleWindowMessage(event) {
-        if (event == null || event.data == null)
+        if (event == null || event.origin == null || event.data == null)
             return;
-        const originMatchRequired = (this.RequiredOrigin != null && this.RequiredOrigin !== "" && this.RequiredOrigin !== "*");
-        if (originMatchRequired === true && event.origin !== this.RequiredOrigin)
+        if (UnrealMessageBus.AllowedOrigin != null && UnrealMessageBus.AllowedOrigin !== "" && UnrealMessageBus.AllowedOrigin !== "*" && event.origin !== UnrealMessageBus.AllowedOrigin) {
+            console.warn("UnrealMessageBus: Invalid Origin: " + event.origin);
             return;
-        if (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);
+        }
+        var postMessage = null;
+        var postArguments = null;
+        if (event.data.type != null) {
+            if (event.data.type === "progress" && event.data.value != null) {
+                postMessage = "WM_PROGRESS";
+                postArguments = [event.data.value.toString()];
+            }
+            else if (event.data.type === "LoadComplete") {
+                postMessage = "WM_LOAD_COMPLETE";
+                postArguments = null;
+            }
+            else if (event.data.type === "focus") {
+                postMessage = "WM_FOCUS";
+                postArguments = null;
+            }
+            else if (event.data.type === "blur") {
+                postMessage = "WM_BLUR";
+                postArguments = null;
+            }
+            else if (event.data.type === "pointer-lock-active") {
+                postMessage = "WM_POINTER_LOCK_ACTIVE";
+                postArguments = null;
+            }
+            else if (event.data.type === "pointer-lock-inactive") {
+                postMessage = "WM_POINTER_LOCK_INACTIVE";
+                postArguments = null;
+            }
+        }
+        else if (event.data.source != null && event.data.source === "unrealtoolkit" && event.data.message != null) {
+            postMessage = event.data.message;
+            postArguments = (event.data.args != null) ? event.data.args : null;
+        }
+        try {
+            if (postMessage != null)
+                this.OnDispatchMessage(postMessage, postArguments);
+        }
+        catch (e) {
+            console.warn(e);
         }
     }
     /** Dispatch internal event bus message
-     * @param message The message to dispatch
-     * @param data The data to dispatch
+     * @param name The name to dispatch
+     * @param args The args to dispatch
      * @returns void
      */
-    OnDispatchMessage(message, data = null) {
-        const listeners = this.ListenerDictionary[message];
+    OnDispatchMessage(name, args = null) {
+        const listeners = this.ListenerDictionary[name];
         if (listeners == null)
             return;
         listeners.forEach((listener) => { try {
             if (listener)
-                listener(data);
+                listener(args);
         }
         catch (e) {
             console.warn(e);
         } });
     }
 }
+UnrealMessageBus.AllowedOrigin = "*";
+UnrealMessageBus.TargetOrigin = "*";
+UnrealMessageBus.ContentFrames = null;
 /** Unreal Toolkit Runtime Module */
 console.log("Unreal Toolkit Runtime - Version 0.1.8");
 export default UnrealToolkit;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "unreal-toolkit-next",
-    "version": "0.1.11",
+    "version": "0.1.14",
     "description": "Unreal Toolkit Runtime Library (ES6)",
     "module": "dist/index.js",
     "types": "dist/index.d.ts",