unreal-toolkit 0.1.11 → 0.1.14

package/README.md

@@ -1,10 +1,10 @@
 # Unreal Toolkit - Classic 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-next">Next Edition (ES6)</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 (UMD)
@@ -16,3 +16,37 @@ npm install unreal-toolkit
 ```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/unreal.toolkit.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/unreal.toolkit.js

@@ -1 +1 @@
-!function(e,n){"object"==typeof exports&&"object"==typeof module?module.exports=n():"function"==typeof define&&define.amd?define([],n):"object"==typeof exports?exports.UnrealToolkit=n():e.UnrealToolkit=n()}(this,(()=>(()=>{"use strict";var e={d:(n,t)=>{for(var i in t)e.o(t,i)&&!e.o(n,i)&&Object.defineProperty(n,i,{enumerable:!0,get:t[i]})},o:(e,n)=>Object.prototype.hasOwnProperty.call(e,n)},n={};e.d(n,{default:()=>o});var t=function(){function e(){}return Object.defineProperty(e,"EventBus",{get:function(){return null==e._EventBus&&(e._EventBus=new i),e._EventBus},enumerable:!1,configurable:!0}),e._EventBus=null,e}(),i=function(){function e(){this.RequiredOrigin="*",this.ListenerDictionary={},window&&window.top?(this.HandleWindowMessage=this.HandleWindowMessage.bind(this),window.top.addEventListener("message",this.HandleWindowMessage)):console.warn("UnrealMessageBus: No Top Window Available")}return e.prototype.OnMessage=function(e,n){var t;null==this.ListenerDictionary[e]?(t=[],this.ListenerDictionary[e]=t):t=this.ListenerDictionary[e],t.findIndex((function(e){return n==e}))<0&&t.push(n)},e.prototype.PostMessage=function(e,n,t){void 0===t&&(t="*"),window&&window.top?window.top.postMessage({source:"unrealmessagebus",message:e,data:n},t):console.warn("UnrealMessageBus: No Top Window Available")},e.prototype.RemoveHandler=function(e,n){var t=this.ListenerDictionary[e];if(null!=t){var i=t.findIndex((function(e){return n==e}));i>=0&&t.splice(i,1)}},e.prototype.ResetHandlers=function(){this.ListenerDictionary={}},e.prototype.Dispose=function(){this.ResetHandlers(),window&&window.top&&window.top.removeEventListener("message",this.HandleWindowMessage)},e.prototype.HandleWindowMessage=function(e){null!=e&&null!=e.data&&(!0==(null!=this.RequiredOrigin&&""!==this.RequiredOrigin&&"*"!==this.RequiredOrigin)&&e.origin!==this.RequiredOrigin||null!=e.data.message&&null!=e.data.source&&"unrealmessagebus"==e.data.source&&this.OnDispatchMessage(e.data.message,null!=e.data.data?e.data.data:null))},e.prototype.OnDispatchMessage=function(e,n){void 0===n&&(n=null);var t=this.ListenerDictionary[e];null!=t&&t.forEach((function(e){try{e&&e(n)}catch(e){console.warn(e)}}))},e}();console.log("Unreal Toolkit Runtime - Version 0.1.8");const o=t;return n.default})()));
+!function(e,n){"object"==typeof exports&&"object"==typeof module?module.exports=n():"function"==typeof define&&define.amd?define([],n):"object"==typeof exports?exports.UnrealToolkit=n():e.UnrealToolkit=n()}(this,(()=>(()=>{"use strict";var e={d:(n,t)=>{for(var o in t)e.o(t,o)&&!e.o(n,o)&&Object.defineProperty(n,o,{enumerable:!0,get:t[o]})},o:(e,n)=>Object.prototype.hasOwnProperty.call(e,n)},n={};e.d(n,{default:()=>i});var t=function(){function e(){}return Object.defineProperty(e,"EventBus",{get:function(){return null==e._EventBus&&(e._EventBus=new o),e._EventBus},enumerable:!1,configurable:!0}),e._EventBus=null,e}(),o=function(){function e(){this.ListenerDictionary={},this.HandleWindowMessage=this.HandleWindowMessage.bind(this),window.addEventListener("message",this.HandleWindowMessage)}return e.prototype.PostWindowMessage=function(n,t){try{null==e.ContentFrames&&(e.ContentFrames=document.querySelectorAll("iframe")),null!=e.ContentFrames?e.ContentFrames.forEach((function(o){var i;try{null===(i=o.contentWindow)||void 0===i||i.postMessage({source:"unrealtoolkit",message:n,args:t},e.TargetOrigin)}catch(e){console.warn(e)}})):console.warn("UnrealMessageBus: No Content Frames Found!")}catch(e){console.warn(e)}},e.prototype.OnWindowMessage=function(e,n){var t;null==this.ListenerDictionary[e]?(t=[],this.ListenerDictionary[e]=t):t=this.ListenerDictionary[e],t.findIndex((function(e){return n==e}))<0&&t.push(n)},e.prototype.RemoveHandler=function(e,n){var t=this.ListenerDictionary[e];if(null!=t){var o=t.findIndex((function(e){return n==e}));o>=0&&t.splice(o,1)}},e.prototype.ResetHandlers=function(){this.ListenerDictionary={}},e.prototype.Dispose=function(){this.ResetHandlers(),window.removeEventListener("message",this.HandleWindowMessage)},e.prototype.ResetContentFrames=function(){e.ContentFrames=null},e.prototype.HandleWindowMessage=function(n){if(null!=n&&null!=n.origin&&null!=n.data)if(null==e.AllowedOrigin||""===e.AllowedOrigin||"*"===e.AllowedOrigin||n.origin===e.AllowedOrigin){var t=null,o=null;null!=n.data.type?"progress"===n.data.type&&null!=n.data.value?(t="WM_PROGRESS",o=[n.data.value.toString()]):"LoadComplete"===n.data.type?(t="WM_LOAD_COMPLETE",o=null):"focus"===n.data.type?(t="WM_FOCUS",o=null):"blur"===n.data.type?(t="WM_BLUR",o=null):"pointer-lock-active"===n.data.type?(t="WM_POINTER_LOCK_ACTIVE",o=null):"pointer-lock-inactive"===n.data.type&&(t="WM_POINTER_LOCK_INACTIVE",o=null):null!=n.data.source&&"unrealtoolkit"===n.data.source&&null!=n.data.message&&(t=n.data.message,o=null!=n.data.args?n.data.args:null);try{null!=t&&this.OnDispatchMessage(t,o)}catch(e){console.warn(e)}}else console.warn("UnrealMessageBus: Invalid Origin: "+n.origin)},e.prototype.OnDispatchMessage=function(e,n){void 0===n&&(n=null);var t=this.ListenerDictionary[e];null!=t&&t.forEach((function(e){try{e&&e(n)}catch(e){console.warn(e)}}))},e.AllowedOrigin="*",e.TargetOrigin="*",e.ContentFrames=null,e}();console.log("Unreal Toolkit Runtime - Version 0.1.8");const i=t;return n.default})()));

package/package.json

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