@illgrenoble/webx-client 0.9.0 → 1.0.0

package/dist/instruction/WebXWindowsInstruction.d.ts

@@ -1,4 +1,13 @@
 import { WebXInstruction } from './WebXInstruction';
+/**
+ * Represents an instruction to request the list of visible windows.
+ *
+ * This instruction is used to fetch information about all currently visible
+ * windows from the WebX Engine.
+ */
 export declare class WebXWindowsInstruction extends WebXInstruction {
+    /**
+     * Constructs a new WebXWindowsInstruction.
+     */
     constructor();
 }

package/dist/instruction/WebXWindowsInstruction.js

@@ -3,7 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXWindowsInstruction = void 0;
 const WebXInstruction_1 = require("./WebXInstruction");
 const WebXInstructionType_1 = require("./WebXInstructionType");
+/**
+ * Represents an instruction to request the list of visible windows.
+ *
+ * This instruction is used to fetch information about all currently visible
+ * windows from the WebX Engine.
+ */
 class WebXWindowsInstruction extends WebXInstruction_1.WebXInstruction {
+    /**
+     * Constructs a new WebXWindowsInstruction.
+     */
     constructor() {
         super(WebXInstructionType_1.WebXInstructionType.WINDOWS);
     }

package/dist/instruction/WebXWindowsInstruction.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXWindowsInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXWindowsInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D,MAAa,sBAAuB,SAAQ,iCAAe;IACzD;QACE,KAAK,CAAC,yCAAmB,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACF;AAJD,wDAIC"}
+{"version":3,"file":"WebXWindowsInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXWindowsInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,iCAAe;IACzD;;OAEG;IACH;QACE,KAAK,CAAC,yCAAmB,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACF;AAPD,wDAOC"}

package/dist/message/WebXCursorImageMessage.d.ts

@@ -1,17 +1,46 @@
 import { WebXMessage } from './WebXMessage';
 import { Texture } from 'three';
+/**
+ * Represents a message containing cursor image data.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the cursor's appearance, including its texture and hotspot coordinates.
+ */
 export declare class WebXCursorImageMessage extends WebXMessage {
-    private _x;
-    private _y;
-    private _xHot;
-    private _yHot;
-    private _cursorId;
-    private _texture;
-    get x(): number;
-    get y(): number;
-    get xHot(): number;
-    get yHot(): number;
-    get cursorId(): number;
-    get texture(): Texture;
-    constructor(_x: number, _y: number, _xHot: number, _yHot: number, _cursorId: number, _texture: Texture, commandId: number);
+    /**
+     * The ID of the cursor associated with this message.
+     */
+    readonly cursorId: number;
+    /**
+     * The x-coordinate of the cursor's hotspot.
+     */
+    readonly xHot: number;
+    /**
+     * The y-coordinate of the cursor's hotspot.
+     */
+    readonly yHot: number;
+    /**
+     * The texture of the cursor.
+     */
+    readonly texture: Texture;
+    /**
+     * The x-coordinate of the cursor's position.
+     */
+    readonly x: number;
+    /**
+     * The y-coordinate of the cursor's position.
+     */
+    readonly y: number;
+    /**
+     * Constructs a new WebXCursorImageMessage.
+     *
+     * @param cursorId The ID of the cursor.
+     * @param xHot The x-coordinate of the cursor's hotspot.
+     * @param yHot The y-coordinate of the cursor's hotspot.
+     * @param texture The texture of the cursor.
+     * @param x The x-coordinate of the cursor's position.
+     * @param y The y-coordinate of the cursor's position.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(x: number, y: number, xHot: number, yHot: number, cursorId: number, texture: Texture, commandId: number);
 }

package/dist/message/WebXCursorImageMessage.js

@@ -3,33 +3,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXCursorImageMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a message containing cursor image data.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the cursor's appearance, including its texture and hotspot coordinates.
+ */
 class WebXCursorImageMessage extends WebXMessage_1.WebXMessage {
-    get x() {
-        return this._x;
-    }
-    get y() {
-        return this._y;
-    }
-    get xHot() {
-        return this._xHot;
-    }
-    get yHot() {
-        return this._yHot;
-    }
-    get cursorId() {
-        return this._cursorId;
-    }
-    get texture() {
-        return this._texture;
-    }
-    constructor(_x, _y, _xHot, _yHot, _cursorId, _texture, commandId) {
+    /**
+     * Constructs a new WebXCursorImageMessage.
+     *
+     * @param cursorId The ID of the cursor.
+     * @param xHot The x-coordinate of the cursor's hotspot.
+     * @param yHot The y-coordinate of the cursor's hotspot.
+     * @param texture The texture of the cursor.
+     * @param x The x-coordinate of the cursor's position.
+     * @param y The y-coordinate of the cursor's position.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(x, y, xHot, yHot, cursorId, texture, commandId) {
         super(WebXMessageType_1.WebXMessageType.CURSOR_IMAGE, commandId);
-        this._x = _x;
-        this._y = _y;
-        this._xHot = _xHot;
-        this._yHot = _yHot;
-        this._cursorId = _cursorId;
-        this._texture = _texture;
+        this.x = x;
+        this.y = y;
+        this.xHot = xHot;
+        this.yHot = yHot;
+        this.cursorId = cursorId;
+        this.texture = texture;
     }
 }
 exports.WebXCursorImageMessage = WebXCursorImageMessage;

package/dist/message/WebXCursorImageMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXCursorImageMessage.js","sourceRoot":"","sources":["../../src/message/WebXCursorImageMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAGpD,MAAa,sBAAuB,SAAQ,yBAAW;IAErD,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,YAAoB,EAAU,EAAU,EAAU,EAAU,KAAa,EAAU,KAAa,EAAU,SAAiB,EAAU,QAAiB,EAAE,SAAiB;QACvK,KAAK,CAAC,iCAAe,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAD7B,OAAE,GAAF,EAAE,CAAQ;QAAU,OAAE,GAAF,EAAE,CAAQ;QAAU,UAAK,GAAL,KAAK,CAAQ;QAAU,UAAK,GAAL,KAAK,CAAQ;QAAU,cAAS,GAAT,SAAS,CAAQ;QAAU,aAAQ,GAAR,QAAQ,CAAS;IAEtJ,CAAC;CACF;AA7BD,wDA6BC"}
+{"version":3,"file":"WebXCursorImageMessage.js","sourceRoot":"","sources":["../../src/message/WebXCursorImageMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAGpD;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,yBAAW;IA+BrD;;;;;;;;;;OAUG;IACH,YAAY,CAAS,EAAE,CAAS,EAAE,IAAY,EAAE,IAAY,EAAE,QAAgB,EAAE,OAAgB,EAAE,SAAiB;QACjH,KAAK,CAAC,iCAAe,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAnDD,wDAmDC"}

package/dist/message/WebXImageMessage.d.ts

@@ -1,15 +1,41 @@
 import { WebXMessage } from './WebXMessage';
 import { Texture } from 'three';
+/**
+ * Represents a message containing image data for a window.
+ *
+ * This message is received from the WebX Engine and contains the color and
+ * alpha textures for a specific window.
+ */
 export declare class WebXImageMessage extends WebXMessage {
-    private readonly _windowId;
-    private readonly _depth;
-    private readonly _colorMap;
-    private readonly _alphaMap;
-    private readonly _size;
-    get windowId(): number;
-    get depth(): number;
-    get colorMap(): Texture;
-    get alphaMap(): Texture;
-    get size(): number;
-    constructor(_windowId: number, _depth: number, _colorMap: Texture, _alphaMap: Texture, commandId: number, _size: number);
+    /**
+     * The ID of the window associated with this image.
+     */
+    readonly windowId: number;
+    /**
+     * The depth of the image (e.g., 24-bit or 32-bit).
+     */
+    readonly depth: number;
+    /**
+     * The color texture of the image.
+     */
+    readonly colorMap: Texture;
+    /**
+     * The alpha texture of the image.
+     */
+    readonly alphaMap: Texture;
+    /**
+     * The size of the image.
+     */
+    readonly size: number;
+    /**
+     * Constructs a new WebXImageMessage.
+     *
+     * @param windowId The ID of the window.
+     * @param depth The depth of the image.
+     * @param colorMap The color texture.
+     * @param alphaMap The alpha texture.
+     * @param commandId The ID of the command associated with this message.
+     * @param size The size of the image.
+     */
+    constructor(windowId: number, depth: number, colorMap: Texture, alphaMap: Texture, commandId: number, size: number);
 }

package/dist/message/WebXImageMessage.js

@@ -3,29 +3,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXImageMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a message containing image data for a window.
+ *
+ * This message is received from the WebX Engine and contains the color and
+ * alpha textures for a specific window.
+ */
 class WebXImageMessage extends WebXMessage_1.WebXMessage {
-    get windowId() {
-        return this._windowId;
-    }
-    get depth() {
-        return this._depth;
-    }
-    get colorMap() {
-        return this._colorMap;
-    }
-    get alphaMap() {
-        return this._alphaMap;
-    }
-    get size() {
-        return this._size;
-    }
-    constructor(_windowId, _depth, _colorMap, _alphaMap, commandId, _size) {
+    /**
+     * Constructs a new WebXImageMessage.
+     *
+     * @param windowId The ID of the window.
+     * @param depth The depth of the image.
+     * @param colorMap The color texture.
+     * @param alphaMap The alpha texture.
+     * @param commandId The ID of the command associated with this message.
+     * @param size The size of the image.
+     */
+    constructor(windowId, depth, colorMap, alphaMap, commandId, size) {
         super(WebXMessageType_1.WebXMessageType.IMAGE, commandId);
-        this._windowId = _windowId;
-        this._depth = _depth;
-        this._colorMap = _colorMap;
-        this._alphaMap = _alphaMap;
-        this._size = _size;
+        this.windowId = windowId;
+        this.depth = depth;
+        this.colorMap = colorMap;
+        this.alphaMap = alphaMap;
+        this.size = size;
     }
 }
 exports.WebXImageMessage = WebXImageMessage;

package/dist/message/WebXImageMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXImageMessage.js","sourceRoot":"","sources":["../../src/message/WebXImageMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAGpD,MAAa,gBAAiB,SAAQ,yBAAW;IAC/C,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,YAA6B,SAAiB,EACjB,MAAc,EACd,SAAkB,EAClB,SAAkB,EACnC,SAAiB,EACA,KAAa;QACxC,KAAK,CAAC,iCAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QANb,cAAS,GAAT,SAAS,CAAQ;QACjB,WAAM,GAAN,MAAM,CAAQ;QACd,cAAS,GAAT,SAAS,CAAS;QAClB,cAAS,GAAT,SAAS,CAAS;QAElB,UAAK,GAAL,KAAK,CAAQ;IAE1C,CAAC;CACF;AA7BD,4CA6BC"}
+{"version":3,"file":"WebXImageMessage.js","sourceRoot":"","sources":["../../src/message/WebXImageMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAGpD;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,yBAAW;IA0B/C;;;;;;;;;OASG;IACH,YAAY,QAAgB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAiB,EAAE,IAAY;QAChH,KAAK,CAAC,iCAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AA5CD,4CA4CC"}

package/dist/message/WebXMessage.d.ts

@@ -1,8 +1,24 @@
 import { WebXMessageType } from './WebXMessageType';
-export declare class WebXMessage {
-    private _messageType;
-    private _commandId;
-    get type(): WebXMessageType;
-    get commandId(): number;
-    constructor(_messageType: WebXMessageType, _commandId?: number);
+/**
+ * Base class for all WebX messages.
+ *
+ * Messages are data structures received from the WebX Engine, containing
+ * information about the state of the remote desktop or responses to instructions.
+ */
+export declare abstract class WebXMessage {
+    /**
+     * The type of the message.
+     */
+    readonly type: WebXMessageType;
+    /**
+     * The ID of the command associated with this message.
+     */
+    readonly commandId: number;
+    /**
+     * Constructs a new WebXMessage.
+     *
+     * @param type The type of the message.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(type: WebXMessageType, commandId?: number);
 }

package/dist/message/WebXMessage.js

@@ -1,16 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXMessage = void 0;
+/**
+ * Base class for all WebX messages.
+ *
+ * Messages are data structures received from the WebX Engine, containing
+ * information about the state of the remote desktop or responses to instructions.
+ */
 class WebXMessage {
-    get type() {
-        return this._messageType;
-    }
-    get commandId() {
-        return this._commandId;
-    }
-    constructor(_messageType, _commandId = 0) {
-        this._messageType = _messageType;
-        this._commandId = _commandId;
+    /**
+     * Constructs a new WebXMessage.
+     *
+     * @param type The type of the message.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(type, commandId = 0) {
+        this.type = type;
+        this.commandId = commandId;
     }
 }
 exports.WebXMessage = WebXMessage;

package/dist/message/WebXMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXMessage.js","sourceRoot":"","sources":["../../src/message/WebXMessage.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;IACtB,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,YAAoB,YAA6B,EAAU,aAAqB,CAAC;QAA7D,iBAAY,GAAZ,YAAY,CAAiB;QAAU,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;CACtF;AAVD,kCAUC"}
+{"version":3,"file":"WebXMessage.js","sourceRoot":"","sources":["../../src/message/WebXMessage.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,MAAsB,WAAW;IAW/B;;;;;OAKG;IACH,YAAY,IAAqB,EAAE,YAAoB,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AArBD,kCAqBC"}

package/dist/message/WebXMessageType.d.ts

@@ -1,12 +1,47 @@
+/**
+ * Enum representing the types of WebX messages.
+ *
+ * These types are used to categorize messages received from the WebX Engine.
+ */
 export declare enum WebXMessageType {
+    /**
+     * Message indicating a connection event (handled by the WebX Relay).
+     */
     CONNECTION = 1,
+    /**
+     * Message containing information about visible windows.
+     */
     WINDOWS = 2,
+    /**
+     * Message containing image data for a window.
+     */
     IMAGE = 3,
+    /**
+     * Message containing screen information.
+     */
     SCREEN = 4,
+    /**
+     * Message containing sub-image data for a window.
+     */
     SUBIMAGES = 5,
+    /**
+     * Message containing mouse state updates.
+     */
     MOUSE = 6,
+    /**
+     * Message containing cursor image data.
+     */
     CURSOR_IMAGE = 7,
+    /**
+     * Ping message for connection health checks.
+     */
     PING = 8,
+    /**
+     * Message indicating a disconnection event (handled by the WebX Relay).
+     */
     DISCONNECT = 9,
+    /**
+     * Message containing quality-related information.
+     */
     QUALITY = 10
 }

package/dist/message/WebXMessageType.js

@@ -1,17 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXMessageType = void 0;
+/**
+ * Enum representing the types of WebX messages.
+ *
+ * These types are used to categorize messages received from the WebX Engine.
+ */
 var WebXMessageType;
 (function (WebXMessageType) {
+    /**
+     * Message indicating a connection event (handled by the WebX Relay).
+     */
     WebXMessageType[WebXMessageType["CONNECTION"] = 1] = "CONNECTION";
+    /**
+     * Message containing information about visible windows.
+     */
     WebXMessageType[WebXMessageType["WINDOWS"] = 2] = "WINDOWS";
+    /**
+     * Message containing image data for a window.
+     */
     WebXMessageType[WebXMessageType["IMAGE"] = 3] = "IMAGE";
+    /**
+     * Message containing screen information.
+     */
     WebXMessageType[WebXMessageType["SCREEN"] = 4] = "SCREEN";
+    /**
+     * Message containing sub-image data for a window.
+     */
     WebXMessageType[WebXMessageType["SUBIMAGES"] = 5] = "SUBIMAGES";
+    /**
+     * Message containing mouse state updates.
+     */
     WebXMessageType[WebXMessageType["MOUSE"] = 6] = "MOUSE";
+    /**
+     * Message containing cursor image data.
+     */
     WebXMessageType[WebXMessageType["CURSOR_IMAGE"] = 7] = "CURSOR_IMAGE";
+    /**
+     * Ping message for connection health checks.
+     */
     WebXMessageType[WebXMessageType["PING"] = 8] = "PING";
+    /**
+     * Message indicating a disconnection event (handled by the WebX Relay).
+     */
     WebXMessageType[WebXMessageType["DISCONNECT"] = 9] = "DISCONNECT";
+    /**
+     * Message containing quality-related information.
+     */
     WebXMessageType[WebXMessageType["QUALITY"] = 10] = "QUALITY";
 })(WebXMessageType || (exports.WebXMessageType = WebXMessageType = {}));
 //# sourceMappingURL=WebXMessageType.js.map

package/dist/message/WebXMessageType.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXMessageType.js","sourceRoot":"","sources":["../../src/message/WebXMessageType.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAWX;AAXD,WAAY,eAAe;IACzB,iEAAc,CAAA;IACd,2DAAW,CAAA;IACX,uDAAS,CAAA;IACT,yDAAU,CAAA;IACV,+DAAa,CAAA;IACb,uDAAS,CAAA;IACT,qEAAgB,CAAA;IAChB,qDAAQ,CAAA;IACR,iEAAc,CAAA;IACd,4DAAY,CAAA;AACd,CAAC,EAXW,eAAe,+BAAf,eAAe,QAW1B"}
+{"version":3,"file":"WebXMessageType.js","sourceRoot":"","sources":["../../src/message/WebXMessageType.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,eAkDX;AAlDD,WAAY,eAAe;IACzB;;OAEG;IACH,iEAAc,CAAA;IAEd;;OAEG;IACH,2DAAW,CAAA;IAEX;;OAEG;IACH,uDAAS,CAAA;IAET;;OAEG;IACH,yDAAU,CAAA;IAEV;;OAEG;IACH,+DAAa,CAAA;IAEb;;OAEG;IACH,uDAAS,CAAA;IAET;;OAEG;IACH,qEAAgB,CAAA;IAEhB;;OAEG;IACH,qDAAQ,CAAA;IAER;;OAEG;IACH,iEAAc,CAAA;IAEd;;OAEG;IACH,4DAAY,CAAA;AACd,CAAC,EAlDW,eAAe,+BAAf,eAAe,QAkD1B"}

package/dist/message/WebXMouseMessage.d.ts

@@ -1,10 +1,30 @@
 import { WebXMessage } from './WebXMessage';
+/**
+ * Represents a message containing mouse state updates.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the mouse position and cursor ID.
+ */
 export declare class WebXMouseMessage extends WebXMessage {
-    private _x;
-    private _y;
-    private _cursorId;
-    get x(): number;
-    get y(): number;
-    get cursorId(): number;
-    constructor(_x: number, _y: number, _cursorId: number, commandId: number);
+    /**
+     * The x-coordinate of the mouse pointer.
+     */
+    readonly x: number;
+    /**
+     * The y-coordinate of the mouse pointer.
+     */
+    readonly y: number;
+    /**
+     * The ID of the cursor associated with the mouse pointer.
+     */
+    readonly cursorId: number;
+    /**
+     * Constructs a new WebXMouseMessage.
+     *
+     * @param x The x-coordinate of the mouse pointer.
+     * @param y The y-coordinate of the mouse pointer.
+     * @param cursorId The ID of the cursor.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(x: number, y: number, cursorId: number, commandId: number);
 }

package/dist/message/WebXMouseMessage.js

@@ -3,21 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXMouseMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a message containing mouse state updates.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the mouse position and cursor ID.
+ */
 class WebXMouseMessage extends WebXMessage_1.WebXMessage {
-    get x() {
-        return this._x;
-    }
-    get y() {
-        return this._y;
-    }
-    get cursorId() {
-        return this._cursorId;
-    }
-    constructor(_x, _y, _cursorId, commandId) {
+    /**
+     * Constructs a new WebXMouseMessage.
+     *
+     * @param x The x-coordinate of the mouse pointer.
+     * @param y The y-coordinate of the mouse pointer.
+     * @param cursorId The ID of the cursor.
+     * @param commandId The ID of the command associated with this message.
+     */
+    constructor(x, y, cursorId, commandId) {
         super(WebXMessageType_1.WebXMessageType.MOUSE, commandId);
-        this._x = _x;
-        this._y = _y;
-        this._cursorId = _cursorId;
+        this.x = x;
+        this.y = y;
+        this.cursorId = cursorId;
     }
 }
 exports.WebXMouseMessage = WebXMouseMessage;

package/dist/message/WebXMouseMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXMouseMessage.js","sourceRoot":"","sources":["../../src/message/WebXMouseMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD,MAAa,gBAAiB,SAAQ,yBAAW;IAC/C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,YAAoB,EAAU,EAAU,EAAU,EAAU,SAAiB,EAAE,SAAiB;QAC9F,KAAK,CAAC,iCAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QADtB,OAAE,GAAF,EAAE,CAAQ;QAAU,OAAE,GAAF,EAAE,CAAQ;QAAU,cAAS,GAAT,SAAS,CAAQ;IAE7E,CAAC;CACF;AAhBD,4CAgBC"}
+{"version":3,"file":"WebXMouseMessage.js","sourceRoot":"","sources":["../../src/message/WebXMouseMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,yBAAW;IAgB/C;;;;;;;OAOG;IACH,YAAY,CAAS,EAAE,CAAS,EAAE,QAAgB,EAAE,SAAiB;QACnE,KAAK,CAAC,iCAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACxC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AA9BD,4CA8BC"}

package/dist/message/WebXPingMessage.d.ts

@@ -1,4 +1,13 @@
 import { WebXMessage } from './WebXMessage';
+/**
+ * Represents a ping message for connection health checks.
+ *
+ * This message is sent by the WebX Engine to ensure the connection is active. The client responds with
+ * an WebXPongInstruction.
+ */
 export declare class WebXPingMessage extends WebXMessage {
+    /**
+     * Constructs a new WebXPingMessage.
+     */
     constructor();
 }

package/dist/message/WebXPingMessage.js

@@ -3,7 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXPingMessage = void 0;
 const WebXMessage_1 = require("./WebXMessage");
 const WebXMessageType_1 = require("./WebXMessageType");
+/**
+ * Represents a ping message for connection health checks.
+ *
+ * This message is sent by the WebX Engine to ensure the connection is active. The client responds with
+ * an WebXPongInstruction.
+ */
 class WebXPingMessage extends WebXMessage_1.WebXMessage {
+    /**
+     * Constructs a new WebXPingMessage.
+     */
     constructor() {
         super(WebXMessageType_1.WebXMessageType.PING);
     }

package/dist/message/WebXPingMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXPingMessage.js","sourceRoot":"","sources":["../../src/message/WebXPingMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD,MAAa,eAAgB,SAAQ,yBAAW;IAC9C;QACE,KAAK,CAAC,iCAAe,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAJD,0CAIC"}
+{"version":3,"file":"WebXPingMessage.js","sourceRoot":"","sources":["../../src/message/WebXPingMessage.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,uDAAoD;AAEpD;;;;;GAKG;AACH,MAAa,eAAgB,SAAQ,yBAAW;IAC9C;;OAEG;IACH;QACE,KAAK,CAAC,iCAAe,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAPD,0CAOC"}

package/dist/message/WebXQualityMessage.d.ts

@@ -1,14 +1,39 @@
 import { WebXMessage } from './WebXMessage';
+/**
+ * Represents a message containing quality-related information.
+ *
+ * This message is received from the WebX Engine and contains details about
+ * the quality settings.
+ */
 export declare class WebXQualityMessage extends WebXMessage {
-    private _index;
-    private _imageFPS;
-    private _rgbQuality;
-    private _alphaQuality;
-    private _maxMbps;
-    get index(): number;
-    get imageFPS(): number;
-    get rgbQuality(): number;
-    get alphaQuality(): number;
-    get maxMbps(): number;
-    constructor(_index: number, _imageFPS: number, _rgbQuality: number, _alphaQuality: number, _maxMbps: number);
+    /**
+     * The quality index.
+     */
+    readonly index: number;
+    /**
+     * The frames per second (FPS) for image rendering.
+     */
+    readonly imageFPS: number;
+    /**
+     * The quality level for RGB data.
+     */
+    readonly rgbQuality: number;
+    /**
+     * The quality level for alpha data.
+     */
+    readonly alphaQuality: number;
+    /**
+     * The maximum bandwidth in Mbps for window image updates.
+     */
+    readonly maxMbps: number;
+    /**
+     * 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: number, imageFPS: number, rgbQuality: number, alphaQuality: number, maxMbps: number);
 }