@illgrenoble/webx-client 0.10.0 → 1.1.0

package/dist/message/WebXQualityMessage.js

@@ -3,29 +3,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXQualityMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a message containing quality-related information.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the quality settings.
+ */
 class WebXQualityMessage extends WebXMessage_1.WebXMessage {
-    get index() {
-        return this._index;
-    }
-    get imageFPS() {
-        return this._imageFPS;
-    }
-    get rgbQuality() {
-        return this._rgbQuality;
-    }
-    get alphaQuality() {
-        return this._alphaQuality;
-    }
-    get maxMbps() {
-        return this._maxMbps;
-    }
-    constructor(_index, _imageFPS, _rgbQuality, _alphaQuality, _maxMbps) {
+    /**
+     * Constructs a new WebXQualityMessage.
+     *
+     * @param index The quality index.
+     * @param imageFPS The frames per second for image rendering.
+     * @param rgbQuality The quality level for RGB data.
+     * @param alphaQuality The quality level for alpha data.
+     * @param maxMbps The maximum bandwidth in Mbps.
+     */
+    constructor(index, imageFPS, rgbQuality, alphaQuality, maxMbps) {
         super(WebXMessageType_1.WebXMessageType.QUALITY);
-        this._index = _index;
-        this._imageFPS = _imageFPS;
-        this._rgbQuality = _rgbQuality;
-        this._alphaQuality = _alphaQuality;
-        this._maxMbps = _maxMbps;
+        this.index = index;
+        this.imageFPS = imageFPS;
+        this.rgbQuality = rgbQuality;
+        this.alphaQuality = alphaQuality;
+        this.maxMbps = maxMbps;
     }
 }
 exports.WebXQualityMessage = WebXQualityMessage;

package/dist/message/WebXQualityMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXQualityMessage.js","sourceRoot":"","sources":["../../src/message/WebXQualityMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD,MAAa,kBAAmB,SAAQ,yBAAW;IAEjD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,YAAoB,MAAc,EAAU,SAAiB,EAAU,WAAmB,EAAU,aAAqB,EAAU,QAAgB;QACjJ,KAAK,CAAC,iCAAe,CAAC,OAAO,CAAC,CAAC;QADb,WAAM,GAAN,MAAM,CAAQ;QAAU,cAAS,GAAT,SAAS,CAAQ;QAAU,gBAAW,GAAX,WAAW,CAAQ;QAAU,kBAAa,GAAb,aAAa,CAAQ;QAAU,aAAQ,GAAR,QAAQ,CAAQ;IAEnJ,CAAC;CACF;AAzBD,gDAyBC"}
+{"version":3,"file":"WebXQualityMessage.js","sourceRoot":"","sources":["../../src/message/WebXQualityMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD;;;;;GAKG;AACH,MAAa,kBAAmB,SAAQ,yBAAW;IA0BjD;;;;;;;;OAQG;IACH,YAAY,KAAa,EAAE,QAAgB,EAAE,UAAkB,EAAE,YAAoB,EAAE,OAAe;QACpG,KAAK,CAAC,iCAAe,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AA3CD,gDA2CC"}

package/dist/message/WebXScreenMessage.d.ts

@@ -1,11 +1,25 @@
 import { WebXMessage } from './WebXMessage';
+/**
+ * Represents a message containing screen information.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the screen size.
+ */
 export declare class WebXScreenMessage extends WebXMessage {
-    private _screenSize;
-    get screenSize(): {
+    /**
+     * The size of the screen.
+     */
+    readonly screenSize: {
         width: number;
         height: number;
     };
-    constructor(_screenSize: {
+    /**
+     * Constructs a new WebXScreenMessage.
+     *
+     * @param screenSize The size of the screen.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(screenSize: {
         width: number;
         height: number;
     }, commandId: number);

package/dist/message/WebXScreenMessage.js

@@ -3,13 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXScreenMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a message containing screen information.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the screen size.
+ */
 class WebXScreenMessage extends WebXMessage_1.WebXMessage {
-    get screenSize() {
-        return this._screenSize;
-    }
-    constructor(_screenSize, commandId) {
+    /**
+     * Constructs a new WebXScreenMessage.
+     *
+     * @param screenSize The size of the screen.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(screenSize, commandId) {
         super(WebXMessageType_1.WebXMessageType.SCREEN, commandId);
-        this._screenSize = _screenSize;
+        this.screenSize = screenSize;
     }
 }
 exports.WebXScreenMessage = WebXScreenMessage;

package/dist/message/WebXScreenMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXScreenMessage.js","sourceRoot":"","sources":["../../src/message/WebXScreenMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD,MAAa,iBAAkB,SAAQ,yBAAW;IAChD,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,YAAoB,WAA8C,EAAE,SAAiB;QACnF,KAAK,CAAC,iCAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QADvB,gBAAW,GAAX,WAAW,CAAmC;IAElE,CAAC;CACF;AARD,8CAQC"}
+{"version":3,"file":"WebXScreenMessage.js","sourceRoot":"","sources":["../../src/message/WebXScreenMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD;;;;;GAKG;AACH,MAAa,iBAAkB,SAAQ,yBAAW;IAMhD;;;;;OAKG;IACH,YAAY,UAA6C,EAAE,SAAiB;QAC1E,KAAK,CAAC,iCAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAhBD,8CAgBC"}

package/dist/message/WebXSubImagesMessage.d.ts

@@ -1,11 +1,31 @@
 import { WebXMessage } from './WebXMessage';
 import { WebXSubImage } from '../display';
+/**
+ * Represents a message containing sub-image data for a window.
+ *
+ * This message is received from the WebX Engine and contains a list of
+ * sub-images that should be updated.
+ */
 export declare class WebXSubImagesMessage extends WebXMessage {
-    private _windowId;
-    private _subImages;
-    private _size;
-    get windowId(): number;
-    get subImages(): WebXSubImage[];
-    get size(): number;
-    constructor(_windowId: number, _subImages: WebXSubImage[], commandId: number, _size: number);
+    /**
+     * The ID of the window associated with these sub-images.
+     */
+    readonly windowId: number;
+    /**
+     * The list of sub-images.
+     */
+    readonly subImages: Array<WebXSubImage>;
+    /**
+     * The size of the message in bytes.
+     */
+    readonly size: number;
+    /**
+     * Constructs a new WebXSubImagesMessage.
+     *
+     * @param windowId The ID of the window.
+     * @param subImages The list of sub-images.
+     * @param commandId The ID of the command associated with this message.
+     * @param size The size of the message in bytes.
+     */
+    constructor(windowId: number, subImages: Array<WebXSubImage>, commandId: number, size: number);
 }

package/dist/message/WebXSubImagesMessage.js

@@ -3,21 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXSubImagesMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a message containing sub-image data for a window.
+ *
+ * This message is received from the WebX Engine and contains a list of
+ * sub-images that should be updated.
+ */
 class WebXSubImagesMessage extends WebXMessage_1.WebXMessage {
-    get windowId() {
-        return this._windowId;
-    }
-    get subImages() {
-        return this._subImages;
-    }
-    get size() {
-        return this._size;
-    }
-    constructor(_windowId, _subImages, commandId, _size) {
+    /**
+     * Constructs a new WebXSubImagesMessage.
+     *
+     * @param windowId The ID of the window.
+     * @param subImages The list of sub-images.
+     * @param commandId The ID of the command associated with this message.
+     * @param size The size of the message in bytes.
+     */
+    constructor(windowId, subImages, commandId, size) {
         super(WebXMessageType_1.WebXMessageType.SUBIMAGES, commandId);
-        this._windowId = _windowId;
-        this._subImages = _subImages;
-        this._size = _size;
+        this.windowId = windowId;
+        this.subImages = subImages;
+        this.size = size;
     }
 }
 exports.WebXSubImagesMessage = WebXSubImagesMessage;

package/dist/message/WebXSubImagesMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXSubImagesMessage.js","sourceRoot":"","sources":["../../src/message/WebXSubImagesMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAGpD,MAAa,oBAAqB,SAAQ,yBAAW;IACnD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,YAAoB,SAAiB,EACjB,UAA0B,EAClC,SAAiB,EACT,KAAa;QAC/B,KAAK,CAAC,iCAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAJ1B,cAAS,GAAT,SAAS,CAAQ;QACjB,eAAU,GAAV,UAAU,CAAgB;QAE1B,UAAK,GAAL,KAAK,CAAQ;IAEjC,CAAC;CACF;AAnBD,oDAmBC"}
+{"version":3,"file":"WebXSubImagesMessage.js","sourceRoot":"","sources":["../../src/message/WebXSubImagesMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAGpD;;;;;GAKG;AACH,MAAa,oBAAqB,SAAQ,yBAAW;IAgBnD;;;;;;;OAOG;IACH,YAAY,QAAgB,EAAE,SAA8B,EAAE,SAAiB,EAAE,IAAY;QAC3F,KAAK,CAAC,iCAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AA9BD,oDA8BC"}

package/dist/message/WebXWindowsMessage.d.ts

@@ -1,7 +1,21 @@
 import { WebXMessage } from './WebXMessage';
 import { WebXWindowProperties } from '../display';
+/**
+ * Represents a message containing information about visible windows.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * all currently visible windows.
+ */
 export declare class WebXWindowsMessage extends WebXMessage {
-    private _windows;
-    get windows(): Array<WebXWindowProperties>;
-    constructor(_windows: Array<WebXWindowProperties>, commandId: number);
+    /**
+     * The list of visible windows.
+     */
+    readonly windows: Array<WebXWindowProperties>;
+    /**
+     * Constructs a new WebXWindowsMessage.
+     *
+     * @param windows The list of visible windows.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(windows: Array<WebXWindowProperties>, commandId: number);
 }

package/dist/message/WebXWindowsMessage.js

@@ -3,13 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXWindowsMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a message containing information about visible windows.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * all currently visible windows.
+ */
 class WebXWindowsMessage extends WebXMessage_1.WebXMessage {
-    get windows() {
-        return this._windows;
-    }
-    constructor(_windows, commandId) {
+    /**
+     * Constructs a new WebXWindowsMessage.
+     *
+     * @param windows The list of visible windows.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(windows, commandId) {
         super(WebXMessageType_1.WebXMessageType.WINDOWS, commandId);
-        this._windows = _windows;
+        this.windows = windows;
     }
 }
 exports.WebXWindowsMessage = WebXWindowsMessage;

package/dist/message/WebXWindowsMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXWindowsMessage.js","sourceRoot":"","sources":["../../src/message/WebXWindowsMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAE5C,uDAAoD;AAEpD,MAAa,kBAAmB,SAAQ,yBAAW;IACjD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,YAAoB,QAAqC,EAAE,SAAiB;QAC1E,KAAK,CAAC,iCAAe,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QADxB,aAAQ,GAAR,QAAQ,CAA6B;IAEzD,CAAC;CACF;AARD,gDAQC"}
+{"version":3,"file":"WebXWindowsMessage.js","sourceRoot":"","sources":["../../src/message/WebXWindowsMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAGpD;;;;;GAKG;AACH,MAAa,kBAAmB,SAAQ,yBAAW;IAMjD;;;;;OAKG;IACH,YAAY,OAAoC,EAAE,SAAiB;QACjE,KAAK,CAAC,iCAAe,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAhBD,gDAgBC"}

package/dist/tracer/WebXDebugImageMessageHandler.d.ts

@@ -2,17 +2,47 @@ import { WebXDisplay } from "../display";
 import { WebXMessage } from "../message";
 import { WebXMessageHandler } from "./WebXMessageHandler";
 import { WebXHandler } from "./WebXHandler";
+/**
+ * Handles debug image messages for the WebX client.
+ * This class is responsible for rendering debug images in a 3D scene
+ * and managing their lifecycle.
+ */
 export declare class WebXDebugImageMessageHandler extends WebXMessageHandler implements WebXHandler {
     private _display;
+    /**
+     * Geometry used for creating debug image planes.
+     */
     private static _PLANE_GEOMETRY;
     private _scene;
     private _debugLayer;
     private _currentZ;
     private _disposed;
     private _tweenGroup;
+    /**
+     * Constructs a new WebXDebugImageMessageHandler.
+     * @param _display The WebX display instance used for rendering.
+     */
     constructor(_display: WebXDisplay);
+    /**
+     * Creates a mesh for rendering a debug image.
+     * @param x The x-coordinate of the mesh.
+     * @param y The y-coordinate of the mesh.
+     * @param width The width of the mesh.
+     * @param height The height of the mesh.
+     * @param colour The color of the mesh.
+     */
     private _createMesh;
+    /**
+     * Handles an incoming WebX message.
+     * @param message The WebX message to handle.
+     */
     handle(message: WebXMessage): void;
+    /**
+     * Cleans up resources used by this handler.
+     */
     destroy(): void;
+    /**
+     * Animates the debug layer.
+     */
     private _animate;
 }

package/dist/tracer/WebXDebugImageMessageHandler.js

@@ -6,7 +6,16 @@ const tween_js_1 = require("@tweenjs/tween.js");
 const utils_1 = require("../utils");
 const message_1 = require("../message");
 const WebXMessageHandler_1 = require("./WebXMessageHandler");
+/**
+ * Handles debug image messages for the WebX client.
+ * This class is responsible for rendering debug images in a 3D scene
+ * and managing their lifecycle.
+ */
 class WebXDebugImageMessageHandler extends WebXMessageHandler_1.WebXMessageHandler {
+    /**
+     * Constructs a new WebXDebugImageMessageHandler.
+     * @param _display The WebX display instance used for rendering.
+     */
     constructor(_display) {
         super();
         this._display = _display;
@@ -19,6 +28,14 @@ class WebXDebugImageMessageHandler extends WebXMessageHandler_1.WebXMessageHandl
         this._scene.add(this._debugLayer);
         this._animate();
     }
+    /**
+     * Creates a mesh for rendering a debug image.
+     * @param x The x-coordinate of the mesh.
+     * @param y The y-coordinate of the mesh.
+     * @param width The width of the mesh.
+     * @param height The height of the mesh.
+     * @param colour The color of the mesh.
+     */
     _createMesh(x, y, width, height, colour) {
         const material = new three_1.MeshBasicMaterial({ color: colour, opacity: 0.8, transparent: true });
         material.side = three_1.BackSide;
@@ -33,6 +50,10 @@ class WebXDebugImageMessageHandler extends WebXMessageHandler_1.WebXMessageHandl
             .onComplete(() => this._debugLayer.remove(mesh))
             .start();
     }
+    /**
+     * Handles an incoming WebX message.
+     * @param message The WebX message to handle.
+     */
     handle(message) {
         if (message.type === message_1.WebXMessageType.IMAGE) {
             const imageMessage = message;
@@ -48,6 +69,9 @@ class WebXDebugImageMessageHandler extends WebXMessageHandler_1.WebXMessageHandl
             });
         }
     }
+    /**
+     * Cleans up resources used by this handler.
+     */
     destroy() {
         this._disposed = true;
         this._debugLayer.children.forEach((child) => {
@@ -57,6 +81,9 @@ class WebXDebugImageMessageHandler extends WebXMessageHandler_1.WebXMessageHandl
         this._debugLayer.clear();
         this._debugLayer.removeFromParent();
     }
+    /**
+     * Animates the debug layer.
+     */
     _animate() {
         if (!this._disposed) {
             requestAnimationFrame((time) => {
@@ -67,5 +94,8 @@ class WebXDebugImageMessageHandler extends WebXMessageHandler_1.WebXMessageHandl
     }
 }
 exports.WebXDebugImageMessageHandler = WebXDebugImageMessageHandler;
+/**
+ * Geometry used for creating debug image planes.
+ */
 WebXDebugImageMessageHandler._PLANE_GEOMETRY = new three_1.PlaneGeometry(1.0, 1.0, 2, 2);
 //# sourceMappingURL=WebXDebugImageMessageHandler.js.map

package/dist/tracer/WebXDebugImageMessageHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXDebugImageMessageHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXDebugImageMessageHandler.ts"],"names":[],"mappings":";;;AAAA,iCAA0F;AAC1F,gDAAyD;AACzD,oCAA0C;AAE1C,wCAAkG;AAClG,6DAA0D;AAG1D,MAAa,4BAA6B,SAAQ,uCAAkB;IAUlE,YAAoB,QAAqB;QACvC,KAAK,EAAE,CAAC;QADU,aAAQ,GAAR,QAAQ,CAAa;QALjC,gBAAW,GAAa,IAAI,gBAAQ,EAAE,CAAC;QACvC,cAAS,GAAG,CAAC,CAAC;QACd,cAAS,GAAG,KAAK,CAAC;QAClB,gBAAW,GAAG,IAAI,gBAAK,EAAE,CAAC;QAIhC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAEO,WAAW,CAAC,CAAS,EAAE,CAAS,EAAE,KAAa,EAAE,MAAc,EAAE,MAAc;QACrF,MAAM,QAAQ,GAAG,IAAI,yBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3F,QAAQ,CAAC,IAAI,GAAG,gBAAQ,CAAC;QAEzB,MAAM,IAAI,GAAG,IAAI,YAAI,CAAC,4BAA4B,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QAC9E,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE3B,IAAI,gBAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;aAClC,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC;aACzB,MAAM,CAAC,iBAAM,CAAC,SAAS,CAAC,GAAG,CAAC;aAC5B,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aAC/C,KAAK,EAAE,CAAC;IACb,CAAC;IAED,MAAM,CAAC,OAAoB;QAEzB,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAe,CAAC,KAAK,EAAE,CAAC;YAC3C,MAAM,YAAY,GAAG,OAA2B,CAAC;YACjD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC9D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC;YAEtD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,sBAAc,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QAEvG,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAe,CAAC,SAAS,EAAE,CAAC;YACtD,MAAM,eAAe,GAAG,OAA+B,CAAC;YACxD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YAEjE,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAC3C,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,sBAAc,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;YACnJ,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAW,EAAE,EAAE;YAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAA6B,CAAC;YACrD,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC;IACtC,CAAC;IAEO,QAAQ;QACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,qBAAqB,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC7B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;;AA1EH,oEA4EC;AA1EgB,4CAAe,GAAkB,IAAI,qBAAa,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,AAAnD,CAAoD"}
+{"version":3,"file":"WebXDebugImageMessageHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXDebugImageMessageHandler.ts"],"names":[],"mappings":";;;AAAA,iCAA0F;AAC1F,gDAAyD;AACzD,oCAA0C;AAE1C,wCAAkG;AAClG,6DAA0D;AAG1D;;;;GAIG;AACH,MAAa,4BAA6B,SAAQ,uCAAkB;IAalE;;;OAGG;IACH,YAAoB,QAAqB;QACvC,KAAK,EAAE,CAAC;QADU,aAAQ,GAAR,QAAQ,CAAa;QATjC,gBAAW,GAAa,IAAI,gBAAQ,EAAE,CAAC;QACvC,cAAS,GAAG,CAAC,CAAC;QACd,cAAS,GAAG,KAAK,CAAC;QAClB,gBAAW,GAAG,IAAI,gBAAK,EAAE,CAAC;QAQhC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACK,WAAW,CAAC,CAAS,EAAE,CAAS,EAAE,KAAa,EAAE,MAAc,EAAE,MAAc;QACrF,MAAM,QAAQ,GAAG,IAAI,yBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3F,QAAQ,CAAC,IAAI,GAAG,gBAAQ,CAAC;QAEzB,MAAM,IAAI,GAAG,IAAI,YAAI,CAAC,4BAA4B,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QAC9E,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE3B,IAAI,gBAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;aAClC,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC;aACzB,MAAM,CAAC,iBAAM,CAAC,SAAS,CAAC,GAAG,CAAC;aAC5B,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aAC/C,KAAK,EAAE,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAoB;QAEzB,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAe,CAAC,KAAK,EAAE,CAAC;YAC3C,MAAM,YAAY,GAAG,OAA2B,CAAC;YACjD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC9D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC;YAEtD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,sBAAc,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QAEvG,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAe,CAAC,SAAS,EAAE,CAAC;YACtD,MAAM,eAAe,GAAG,OAA+B,CAAC;YACxD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YAEjE,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAC3C,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,sBAAc,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;YACnJ,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAW,EAAE,EAAE;YAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAA6B,CAAC;YACrD,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IACK,QAAQ;QACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,qBAAqB,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC7B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;;AAnGH,oEAqGC;AAnGC;;GAEG;AACY,4CAAe,GAAkB,IAAI,qBAAa,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,AAAnD,CAAoD"}

package/dist/tracer/WebXHandler.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Interface for handling WebX events.
+ *
+ * Implementations of this interface are responsible for processing WebX events
+ * and providing a mechanism to clean up resources when no longer needed.
+ */
 export interface WebXHandler {
+    /**
+     * Cleans up resources associated with the handler.
+     *
+     * This method should be called when the handler is no longer needed.
+     */
     destroy(): void;
 }

package/dist/tracer/WebXInstructionHandler.d.ts

@@ -1,4 +1,21 @@
 import { WebXInstruction } from '../instruction';
+/**
+ * Interface for handling WebX instructions.
+ *
+ * Implementations of this interface are responsible for processing WebX instructions
+ * and providing a mechanism to clean up resources when no longer needed.
+ */
 export declare abstract class WebXInstructionHandler {
+    /**
+     * Processes a WebX instruction.
+     *
+     * @param instruction The WebX instruction to process.
+     */
     abstract handle(instruction: WebXInstruction): void;
+    /**
+     * Cleans up resources associated with the handler.
+     *
+     * This method should be called when the handler is no longer needed.
+     */
+    abstract destroy(): void;
 }

package/dist/tracer/WebXInstructionHandler.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXInstructionHandler = void 0;
+/**
+ * Interface for handling WebX instructions.
+ *
+ * Implementations of this interface are responsible for processing WebX instructions
+ * and providing a mechanism to clean up resources when no longer needed.
+ */
 class WebXInstructionHandler {
 }
 exports.WebXInstructionHandler = WebXInstructionHandler;

package/dist/tracer/WebXInstructionHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXInstructionHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXInstructionHandler.ts"],"names":[],"mappings":";;;AAEA,MAAsB,sBAAsB;CAG3C;AAHD,wDAGC"}
+{"version":3,"file":"WebXInstructionHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXInstructionHandler.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,MAAsB,sBAAsB;CAc3C;AAdD,wDAcC"}

package/dist/tracer/WebXMessageHandler.d.ts

@@ -1,4 +1,21 @@
 import { WebXMessage } from '../message';
+/**
+ * Abstract class for handling WebX messages.
+ *
+ * Implementations of this class are responsible for processing WebX messages
+ * and providing a mechanism to clean up resources when no longer needed.
+ */
 export declare abstract class WebXMessageHandler {
+    /**
+     * Processes a WebX message.
+     *
+     * @param message The WebX message to process.
+     */
     abstract handle(message: WebXMessage): void;
+    /**
+     * Cleans up resources associated with the handler.
+     *
+     * This method should be called when the handler is no longer needed.
+     */
+    abstract destroy(): void;
 }

package/dist/tracer/WebXMessageHandler.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXMessageHandler = void 0;
+/**
+ * Abstract class for handling WebX messages.
+ *
+ * Implementations of this class are responsible for processing WebX messages
+ * and providing a mechanism to clean up resources when no longer needed.
+ */
 class WebXMessageHandler {
 }
 exports.WebXMessageHandler = WebXMessageHandler;

package/dist/tracer/WebXMessageHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXMessageHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXMessageHandler.ts"],"names":[],"mappings":";;;AAEA,MAAsB,kBAAkB;CAIvC;AAJD,gDAIC"}
+{"version":3,"file":"WebXMessageHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXMessageHandler.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,MAAsB,kBAAkB;CAcvC;AAdD,gDAcC"}

package/dist/tracer/WebXStatsHandler.d.ts

@@ -1,7 +1,23 @@
+/**
+ * Interface for handling WebX statistics.
+ *
+ * Implementations of this interface are responsible for processing WebX statistics
+ * and providing a mechanism to clean up resources when no longer needed.
+ */
 export declare abstract class WebXStatsHandler {
+    /**
+     * Processes WebX statistics.
+     *
+     * @param stats The WebX statistics to process.
+     */
     abstract handle(stats: {
         received: number;
         sent: number;
     }): void;
+    /**
+     * Cleans up resources associated with the handler.
+     *
+     * This method should be called when the handler is no longer needed.
+     */
     abstract destroy(): void;
 }

package/dist/tracer/WebXStatsHandler.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXStatsHandler = void 0;
+/**
+ * Interface for handling WebX statistics.
+ *
+ * Implementations of this interface are responsible for processing WebX statistics
+ * and providing a mechanism to clean up resources when no longer needed.
+ */
 class WebXStatsHandler {
 }
 exports.WebXStatsHandler = WebXStatsHandler;

package/dist/tracer/WebXStatsHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXStatsHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXStatsHandler.ts"],"names":[],"mappings":";;;AAAA,MAAsB,gBAAgB;CAGrC;AAHD,4CAGC"}
+{"version":3,"file":"WebXStatsHandler.js","sourceRoot":"","sources":["../../src/tracer/WebXStatsHandler.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,MAAsB,gBAAgB;CAcrC;AAdD,4CAcC"}

package/dist/transport/WebXBinarySerializer.d.ts

@@ -2,10 +2,30 @@ import { WebXInstruction } from '../instruction';
 import { WebXMessage } from '../message';
 import { WebXMessageBuffer } from '.';
 import { WebXTextureFactory } from '../display';
+/**
+ * Serializes and deserializes WebX instructions and messages.
+ */
 export declare class WebXBinarySerializer {
     private readonly _instructionEncoder;
     private readonly _messageDecoder;
+    /**
+     * Creates a new instance of WebXBinarySerializer.
+     *
+     * @param textureFactory The texture factory used for decoding image data.
+     */
     constructor(textureFactory: WebXTextureFactory);
+    /**
+     * Serializes a WebXInstruction into a binary ArrayBuffer.
+     *
+     * @param instruction The instruction to serialize.
+     * @returns The serialized ArrayBuffer.
+     */
     serializeInstruction(instruction: WebXInstruction): ArrayBuffer;
+    /**
+     * Deserializes a binary message buffer into a WebXMessage object.
+     *
+     * @param buffer The binary message buffer to deserialize.
+     * @returns A promise that resolves to the deserialized WebXMessage.
+     */
     deserializeMessage(buffer: WebXMessageBuffer): Promise<WebXMessage>;
 }

package/dist/transport/WebXBinarySerializer.js

@@ -11,11 +11,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXBinarySerializer = void 0;
 const _1 = require(".");
+/**
+ * Serializes and deserializes WebX instructions and messages.
+ */
 class WebXBinarySerializer {
+    /**
+     * Creates a new instance of WebXBinarySerializer.
+     *
+     * @param textureFactory The texture factory used for decoding image data.
+     */
     constructor(textureFactory) {
         this._instructionEncoder = new _1.WebXInstructionEncoder();
         this._messageDecoder = new _1.WebXMessageDecoder(textureFactory);
     }
+    /**
+     * Serializes a WebXInstruction into a binary ArrayBuffer.
+     *
+     * @param instruction The instruction to serialize.
+     * @returns The serialized ArrayBuffer.
+     */
     serializeInstruction(instruction) {
         // return instruction.toJsonString();
         const encoded = this._instructionEncoder.encode(instruction);
@@ -24,6 +38,12 @@ class WebXBinarySerializer {
         }
         return encoded;
     }
+    /**
+     * Deserializes a binary message buffer into a WebXMessage object.
+     *
+     * @param buffer The binary message buffer to deserialize.
+     * @returns A promise that resolves to the deserialized WebXMessage.
+     */
     deserializeMessage(buffer) {
         return __awaiter(this, void 0, void 0, function* () {
             try {

package/dist/transport/WebXBinarySerializer.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXBinarySerializer.js","sourceRoot":"","sources":["../../src/transport/WebXBinarySerializer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,wBAAkF;AAGlF,MAAa,oBAAoB;IAK/B,YAAY,cAAkC;QAC5C,IAAI,CAAC,mBAAmB,GAAG,IAAI,yBAAsB,EAAE,CAAC;QACxD,IAAI,CAAC,eAAe,GAAG,IAAI,qBAAkB,CAAC,cAAc,CAAC,CAAC;IAChE,CAAC;IAED,oBAAoB,CAAC,WAA4B;QAC/C,qCAAqC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEK,kBAAkB,CAAC,MAAyB;;YAChD,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC1D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;gBACjD,CAAC;gBACD,OAAO,OAAO,CAAC;YAEjB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;KAAA;CAGF;AAjCD,oDAiCC"}
+{"version":3,"file":"WebXBinarySerializer.js","sourceRoot":"","sources":["../../src/transport/WebXBinarySerializer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,wBAAkF;AAGlF;;GAEG;AACH,MAAa,oBAAoB;IAK/B;;;;OAIG;IACH,YAAY,cAAkC;QAC5C,IAAI,CAAC,mBAAmB,GAAG,IAAI,yBAAsB,EAAE,CAAC;QACxD,IAAI,CAAC,eAAe,GAAG,IAAI,qBAAkB,CAAC,cAAc,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,WAA4B;QAC/C,qCAAqC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACG,kBAAkB,CAAC,MAAyB;;YAChD,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC1D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;gBACjD,CAAC;gBACD,OAAO,OAAO,CAAC;YAEjB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;KAAA;CAGF;AAlDD,oDAkDC"}