@illgrenoble/webx-client 0.9.0 → 1.0.0

package/dist/input/mouse/WebXMouseState.d.ts

@@ -31,28 +31,137 @@ export declare class WebXMouseState {
      * wheel.
      */
     private _down;
+    /**
+     * Whether the shift button is currently pressed.
+     */
     private _shift;
+    /**
+     * Whether the ctrl button is currently pressed.
+     */
     private _ctrl;
+    /**
+     * Whether the alt button is currently pressed.
+     */
     private _alt;
+    /**
+     * Gets the current X position of the mouse pointer.
+     *
+     * @returns The X-coordinate as a number.
+     */
     get x(): number;
+    /**
+     * Sets the current X position of the mouse pointer.
+     *
+     * @param value The new X-coordinate as a number.
+     */
     set x(value: number);
+    /**
+     * Gets the current Y position of the mouse pointer.
+     *
+     * @returns The Y-coordinate as a number.
+     */
     get y(): number;
+    /**
+     * Sets the current Y position of the mouse pointer.
+     *
+     * @param value The new Y-coordinate as a number.
+     */
     set y(value: number);
+    /**
+     * Gets whether the left mouse button is currently pressed.
+     *
+     * @returns True if the left button is pressed, false otherwise.
+     */
     get left(): boolean;
+    /**
+     * Sets whether the left mouse button is currently pressed.
+     *
+     * @param value True to indicate the left button is pressed, false otherwise.
+     */
     set left(value: boolean);
+    /**
+     * Gets whether the middle mouse button is currently pressed.
+     *
+     * @returns True if the middle button is pressed, false otherwise.
+     */
     get middle(): boolean;
+    /**
+     * Sets whether the middle mouse button is currently pressed.
+     *
+     * @param value True to indicate the middle button is pressed, false otherwise.
+     */
     set middle(value: boolean);
+    /**
+     * Gets whether the right mouse button is currently pressed.
+     *
+     * @returns True if the right button is pressed, false otherwise.
+     */
     get right(): boolean;
+    /**
+     * Sets whether the right mouse button is currently pressed.
+     *
+     * @param value True to indicate the right button is pressed, false otherwise.
+     */
     set right(value: boolean);
+    /**
+     * Gets whether the up mouse button (scroll up) is currently pressed.
+     *
+     * @returns True if the up button is pressed, false otherwise.
+     */
     get up(): boolean;
+    /**
+     * Sets whether the up mouse button (scroll up) is currently pressed.
+     *
+     * @param value True to indicate the up button is pressed, false otherwise.
+     */
     set up(value: boolean);
+    /**
+     * Gets whether the down mouse button (scroll down) is currently pressed.
+     *
+     * @returns True if the down button is pressed, false otherwise.
+     */
     get down(): boolean;
+    /**
+     * Sets whether the down mouse button (scroll down) is currently pressed.
+     *
+     * @param value True to indicate the down button is pressed, false otherwise.
+     */
     set down(value: boolean);
+    /**
+     * Gets whether the shift key is currently pressed.
+     *
+     * @returns True if the shift key is pressed, false otherwise.
+     */
     get shift(): boolean;
+    /**
+     * Sets whether the shift key is currently pressed.
+     *
+     * @param value True to indicate the shift key is pressed, false otherwise.
+     */
     set shift(value: boolean);
+    /**
+     * Gets whether the ctrl key is currently pressed.
+     *
+     * @returns True if the ctrl key is pressed, false otherwise.
+     */
     get ctrl(): boolean;
+    /**
+     * Sets whether the ctrl key is currently pressed.
+     *
+     * @param value True to indicate the ctrl key is pressed, false otherwise.
+     */
     set ctrl(value: boolean);
+    /**
+     * Gets whether the alt key is currently pressed.
+     *
+     * @returns True if the alt key is pressed, false otherwise.
+     */
     get alt(): boolean;
+    /**
+     * Sets whether the alt key is currently pressed.
+     *
+     * @param value True to indicate the alt key is pressed, false otherwise.
+     */
     set alt(value: boolean);
     /**
      * Create a new mouse state instance
@@ -68,11 +177,13 @@ export declare class WebXMouseState {
         down: boolean;
     });
     /**
-     * Release all buttons
+     * Releases all mouse buttons by setting their states to false.
      */
     releaseButtons(): void;
     /**
-     * Get a button mask for this mouse state
+     * Generates a bitmask representing the current state of mouse buttons and modifiers.
+     *
+     * @returns A number representing the button mask.
      */
     getButtonMask(): number;
 }

package/dist/input/mouse/WebXMouseState.js

@@ -2,63 +2,163 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXMouseState = void 0;
 class WebXMouseState {
+    /**
+     * Gets the current X position of the mouse pointer.
+     *
+     * @returns The X-coordinate as a number.
+     */
     get x() {
         return this._x;
     }
+    /**
+     * Sets the current X position of the mouse pointer.
+     *
+     * @param value The new X-coordinate as a number.
+     */
     set x(value) {
         this._x = value;
     }
+    /**
+     * Gets the current Y position of the mouse pointer.
+     *
+     * @returns The Y-coordinate as a number.
+     */
     get y() {
         return this._y;
     }
+    /**
+     * Sets the current Y position of the mouse pointer.
+     *
+     * @param value The new Y-coordinate as a number.
+     */
     set y(value) {
         this._y = value;
     }
+    /**
+     * Gets whether the left mouse button is currently pressed.
+     *
+     * @returns True if the left button is pressed, false otherwise.
+     */
     get left() {
         return this._left;
     }
+    /**
+     * Sets whether the left mouse button is currently pressed.
+     *
+     * @param value True to indicate the left button is pressed, false otherwise.
+     */
     set left(value) {
         this._left = value;
     }
+    /**
+     * Gets whether the middle mouse button is currently pressed.
+     *
+     * @returns True if the middle button is pressed, false otherwise.
+     */
     get middle() {
         return this._middle;
     }
+    /**
+     * Sets whether the middle mouse button is currently pressed.
+     *
+     * @param value True to indicate the middle button is pressed, false otherwise.
+     */
     set middle(value) {
         this._middle = value;
     }
+    /**
+     * Gets whether the right mouse button is currently pressed.
+     *
+     * @returns True if the right button is pressed, false otherwise.
+     */
     get right() {
         return this._right;
     }
+    /**
+     * Sets whether the right mouse button is currently pressed.
+     *
+     * @param value True to indicate the right button is pressed, false otherwise.
+     */
     set right(value) {
         this._right = value;
     }
+    /**
+     * Gets whether the up mouse button (scroll up) is currently pressed.
+     *
+     * @returns True if the up button is pressed, false otherwise.
+     */
     get up() {
         return this._up;
     }
+    /**
+     * Sets whether the up mouse button (scroll up) is currently pressed.
+     *
+     * @param value True to indicate the up button is pressed, false otherwise.
+     */
     set up(value) {
         this._up = value;
     }
+    /**
+     * Gets whether the down mouse button (scroll down) is currently pressed.
+     *
+     * @returns True if the down button is pressed, false otherwise.
+     */
     get down() {
         return this._down;
     }
+    /**
+     * Sets whether the down mouse button (scroll down) is currently pressed.
+     *
+     * @param value True to indicate the down button is pressed, false otherwise.
+     */
     set down(value) {
         this._down = value;
     }
+    /**
+     * Gets whether the shift key is currently pressed.
+     *
+     * @returns True if the shift key is pressed, false otherwise.
+     */
     get shift() {
         return this._shift;
     }
+    /**
+     * Sets whether the shift key is currently pressed.
+     *
+     * @param value True to indicate the shift key is pressed, false otherwise.
+     */
     set shift(value) {
         this._shift = value;
     }
+    /**
+     * Gets whether the ctrl key is currently pressed.
+     *
+     * @returns True if the ctrl key is pressed, false otherwise.
+     */
     get ctrl() {
         return this._ctrl;
     }
+    /**
+     * Sets whether the ctrl key is currently pressed.
+     *
+     * @param value True to indicate the ctrl key is pressed, false otherwise.
+     */
     set ctrl(value) {
         this._ctrl = value;
     }
+    /**
+     * Gets whether the alt key is currently pressed.
+     *
+     * @returns True if the alt key is pressed, false otherwise.
+     */
     get alt() {
         return this._alt;
     }
+    /**
+     * Sets whether the alt key is currently pressed.
+     *
+     * @param value True to indicate the alt key is pressed, false otherwise.
+     */
     set alt(value) {
         this._alt = value;
     }
@@ -77,7 +177,7 @@ class WebXMouseState {
         this._down = down;
     }
     /**
-     * Release all buttons
+     * Releases all mouse buttons by setting their states to false.
      */
     releaseButtons() {
         this._left = false;
@@ -85,7 +185,9 @@ class WebXMouseState {
         this._right = false;
     }
     /**
-     * Get a button mask for this mouse state
+     * Generates a bitmask representing the current state of mouse buttons and modifiers.
+     *
+     * @returns A number representing the button mask.
      */
     getButtonMask() {
         let mask = 0;

package/dist/input/mouse/WebXMouseState.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXMouseState.js","sourceRoot":"","sources":["../../../src/input/mouse/WebXMouseState.ts"],"names":[],"mappings":";;;AAAA,MAAa,cAAc;IA8CzB,IAAW,CAAC;QACV,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;IAClB,CAAC;IAED,IAAW,CAAC;QACV,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;IAClB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,IAAI,CAAC,KAAc;QAC5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAW,MAAM,CAAC,KAAc;QAC9B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAc;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAW,EAAE,CAAC,KAAc;QAC1B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC;IACnB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,IAAI,CAAC,KAAc;QAC5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAc;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,IAAI,CAAC,KAAc;QAC5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAW,GAAG,CAAC,KAAc;QAC3B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,YAAY,KAA2G;QACrH,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACtD,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;CAEF;AAtKD,wCAsKC"}
+{"version":3,"file":"WebXMouseState.js","sourceRoot":"","sources":["../../../src/input/mouse/WebXMouseState.ts"],"names":[],"mappings":";;;AAAA,MAAa,cAAc;IAuDzB;;;;OAIG;IACH,IAAW,CAAC;QACV,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC;QACV,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI,CAAC,KAAc;QAC5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAW,MAAM,CAAC,KAAc;QAC9B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK,CAAC,KAAc;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAW,EAAE,CAAC,KAAc;QAC1B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI,CAAC,KAAc;QAC5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK,CAAC,KAAc;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI,CAAC,KAAc;QAC5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,IAAW,GAAG,CAAC,KAAc;QAC3B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,YAAY,KAA2G;QACrH,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACtD,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,aAAa;QAClB,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;CAEF;AArRD,wCAqRC"}

package/dist/instruction/WebXConnectInstruction.d.ts

@@ -1,4 +1,19 @@
 import { WebXInstruction } from './WebXInstruction';
+/**
+ * Represents an instruction to establish a connection with the WebX Engine.
+ *
+ * This instruction is used to initiate the connection process and send any
+ * necessary connection parameters.
+ */
 export declare class WebXConnectInstruction extends WebXInstruction {
-    constructor();
+    /**
+     * The connection parameters to be sent with the instruction.
+     */
+    readonly parameters: any;
+    /**
+     * Constructs a new WebXConnectInstruction.
+     *
+     * @param parameters The connection parameters.
+     */
+    constructor(parameters: any);
 }

package/dist/instruction/WebXConnectInstruction.js

@@ -3,9 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXConnectInstruction = void 0;
 const WebXInstruction_1 = require("./WebXInstruction");
 const WebXInstructionType_1 = require("./WebXInstructionType");
+/**
+ * Represents an instruction to establish a connection with the WebX Engine.
+ *
+ * This instruction is used to initiate the connection process and send any
+ * necessary connection parameters.
+ */
 class WebXConnectInstruction extends WebXInstruction_1.WebXInstruction {
-    constructor() {
+    /**
+     * Constructs a new WebXConnectInstruction.
+     *
+     * @param parameters The connection parameters.
+     */
+    constructor(parameters) {
         super(WebXInstructionType_1.WebXInstructionType.CONNECT);
+        this.parameters = parameters;
     }
 }
 exports.WebXConnectInstruction = WebXConnectInstruction;

package/dist/instruction/WebXConnectInstruction.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXConnectInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXConnectInstruction.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":"WebXConnectInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXConnectInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,iCAAe;IAMzD;;;;OAIG;IACH,YAAY,UAAe;QACzB,KAAK,CAAC,yCAAmB,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAfD,wDAeC"}

package/dist/instruction/WebXCursorImageInstruction.d.ts

@@ -1,6 +1,18 @@
 import { WebXInstruction } from './WebXInstruction';
+/**
+ * Represents an instruction to request a cursor image.
+ *
+ * This instruction is used to fetch the cursor image data from the WebX Engine.
+ */
 export declare class WebXCursorImageInstruction extends WebXInstruction {
-    private _cursorId;
-    get cursorId(): number;
-    constructor(_cursorId?: number);
+    /**
+     * The ID of the cursor for which the image is requested.
+     */
+    readonly cursorId: number;
+    /**
+     * Constructs a new WebXCursorImageInstruction.
+     *
+     * @param cursorId The ID of the cursor.
+     */
+    constructor(cursorId: number);
 }

package/dist/instruction/WebXCursorImageInstruction.js

@@ -3,13 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXCursorImageInstruction = void 0;
 const WebXInstruction_1 = require("./WebXInstruction");
 const WebXInstructionType_1 = require("./WebXInstructionType");
+/**
+ * Represents an instruction to request a cursor image.
+ *
+ * This instruction is used to fetch the cursor image data from the WebX Engine.
+ */
 class WebXCursorImageInstruction extends WebXInstruction_1.WebXInstruction {
-    get cursorId() {
-        return this._cursorId;
-    }
-    constructor(_cursorId = 0) {
+    /**
+     * Constructs a new WebXCursorImageInstruction.
+     *
+     * @param cursorId The ID of the cursor.
+     */
+    constructor(cursorId) {
         super(WebXInstructionType_1.WebXInstructionType.CURSOR_IMAGE);
-        this._cursorId = _cursorId;
+        this.cursorId = cursorId;
     }
 }
 exports.WebXCursorImageInstruction = WebXCursorImageInstruction;

package/dist/instruction/WebXCursorImageInstruction.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXCursorImageInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXCursorImageInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D,MAAa,0BAA2B,SAAQ,iCAAe;IAE7D,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,YAAoB,YAAoB,CAAC;QACvC,KAAK,CAAC,yCAAmB,CAAC,YAAY,CAAC,CAAC;QADtB,cAAS,GAAT,SAAS,CAAY;IAEzC,CAAC;CACF;AATD,gEASC"}
+{"version":3,"file":"WebXCursorImageInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXCursorImageInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D;;;;GAIG;AACH,MAAa,0BAA2B,SAAQ,iCAAe;IAM7D;;;;OAIG;IACH,YAAY,QAAgB;QAC1B,KAAK,CAAC,yCAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAfD,gEAeC"}

package/dist/instruction/WebXDataAckInstruction.d.ts

@@ -1,8 +1,25 @@
 import { WebXInstruction } from './WebXInstruction';
+/**
+ * Represents an instruction to acknowledge received data.
+ *
+ * This instruction is used to notify the WebX Engine that a specific amount
+ * of data has been successfully received.
+ */
 export declare class WebXDataAckInstruction extends WebXInstruction {
-    private readonly _timestampMs;
-    private readonly _dataLength;
-    get timestampMs(): Uint8Array;
-    get dataLength(): number;
-    constructor(_timestampMs: Uint8Array, _dataLength: number);
+    /**
+     * The timestamp in milliseconds: timestamp originates from the message containing the sent the data (ie timestamp of
+     * the WebX Engine).
+     */
+    readonly timestampMs: Uint8Array;
+    /**
+     * The length of the data.
+     */
+    readonly dataLength: number;
+    /**
+     * Constructs a new WebXDataAckInstruction.
+     *
+     * @param timestampMs The timestamp in milliseconds.
+     * @param dataLength The length of the data.
+     */
+    constructor(timestampMs: Uint8Array, dataLength: number);
 }

package/dist/instruction/WebXDataAckInstruction.js

@@ -3,17 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXDataAckInstruction = void 0;
 const WebXInstruction_1 = require("./WebXInstruction");
 const WebXInstructionType_1 = require("./WebXInstructionType");
+/**
+ * Represents an instruction to acknowledge received data.
+ *
+ * This instruction is used to notify the WebX Engine that a specific amount
+ * of data has been successfully received.
+ */
 class WebXDataAckInstruction extends WebXInstruction_1.WebXInstruction {
-    get timestampMs() {
-        return this._timestampMs;
-    }
-    get dataLength() {
-        return this._dataLength;
-    }
-    constructor(_timestampMs, _dataLength) {
+    /**
+     * Constructs a new WebXDataAckInstruction.
+     *
+     * @param timestampMs The timestamp in milliseconds.
+     * @param dataLength The length of the data.
+     */
+    constructor(timestampMs, dataLength) {
         super(WebXInstructionType_1.WebXInstructionType.DATA_ACK);
-        this._timestampMs = _timestampMs;
-        this._dataLength = _dataLength;
+        this.timestampMs = timestampMs;
+        this.dataLength = dataLength;
     }
 }
 exports.WebXDataAckInstruction = WebXDataAckInstruction;

package/dist/instruction/WebXDataAckInstruction.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXDataAckInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXDataAckInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D,MAAa,sBAAuB,SAAQ,iCAAe;IAEzD,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,YAA6B,YAAwB,EAAmB,WAAmB;QACzF,KAAK,CAAC,yCAAmB,CAAC,QAAQ,CAAC,CAAC;QADT,iBAAY,GAAZ,YAAY,CAAY;QAAmB,gBAAW,GAAX,WAAW,CAAQ;IAE3F,CAAC;CACF;AAbD,wDAaC"}
+{"version":3,"file":"WebXDataAckInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXDataAckInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,iCAAe;IAYzD;;;;;OAKG;IACH,YAAY,WAAuB,EAAE,UAAkB;QACrD,KAAK,CAAC,yCAAmB,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAvBD,wDAuBC"}

package/dist/instruction/WebXImageInstruction.d.ts

@@ -1,7 +1,18 @@
 import { WebXInstruction } from './WebXInstruction';
+/**
+ * Represents an instruction to request an image for a specific window.
+ *
+ * This instruction is used to fetch the image data for a window from the WebX Engine.
+ */
 export declare class WebXImageInstruction extends WebXInstruction {
-    private _windowId;
-    get windowId(): number;
-    set windowId(windowId: number);
+    /**
+     * The ID of the window for which the image is requested.
+     */
+    readonly windowId: number;
+    /**
+     * Constructs a new WebXImageInstruction.
+     *
+     * @param windowId The ID of the window.
+     */
     constructor(windowId: number);
 }

package/dist/instruction/WebXImageInstruction.js

@@ -3,16 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXImageInstruction = void 0;
 const WebXInstruction_1 = require("./WebXInstruction");
 const WebXInstructionType_1 = require("./WebXInstructionType");
+/**
+ * Represents an instruction to request an image for a specific window.
+ *
+ * This instruction is used to fetch the image data for a window from the WebX Engine.
+ */
 class WebXImageInstruction extends WebXInstruction_1.WebXInstruction {
-    get windowId() {
-        return this._windowId;
-    }
-    set windowId(windowId) {
-        this._windowId = windowId;
-    }
+    /**
+     * Constructs a new WebXImageInstruction.
+     *
+     * @param windowId The ID of the window.
+     */
     constructor(windowId) {
         super(WebXInstructionType_1.WebXInstructionType.IMAGE);
-        this._windowId = windowId;
+        this.windowId = windowId;
     }
 }
 exports.WebXImageInstruction = WebXImageInstruction;

package/dist/instruction/WebXImageInstruction.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXImageInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXImageInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D,MAAa,oBAAqB,SAAQ,iCAAe;IAGvD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,QAAQ,CAAC,QAAgB;QAClC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,YAAY,QAAgB;QAC1B,KAAK,CAAC,yCAAmB,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;CACF;AAfD,oDAeC"}
+{"version":3,"file":"WebXImageInstruction.js","sourceRoot":"","sources":["../../src/instruction/WebXImageInstruction.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,+DAA4D;AAE5D;;;;GAIG;AACH,MAAa,oBAAqB,SAAQ,iCAAe;IAMvD;;;;OAIG;IACH,YAAY,QAAgB;QAC1B,KAAK,CAAC,yCAAmB,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAfD,oDAeC"}

package/dist/instruction/WebXInstruction.d.ts

@@ -1,13 +1,29 @@
 import { WebXInstructionType } from './WebXInstructionType';
-export declare class WebXInstruction {
-    private _type;
+/**
+ * Base class for all WebX instructions.
+ *
+ * Instructions are either commands sent to the WebX Engine to perform specific actions or responses to messages from the engine.
+ * Commands include connecting the engine, requesting window layout, handling input, requesting window image data.
+ * Responses include acknowledging received data or ping messages.
+ */
+export declare abstract class WebXInstruction {
     private static _INSTRUCTION_COUNTER;
-    private readonly _id;
-    private _synchronous;
-    get id(): number;
-    get type(): WebXInstructionType;
-    get synchronous(): boolean;
-    set synchronous(value: boolean);
-    constructor(_type: WebXInstructionType);
-    toJsonString(): string;
+    /**
+     * The unique ID of the instruction.
+     */
+    readonly id: number;
+    /**
+     * Indicates whether the instruction is synchronous or asynchronous.
+     */
+    synchronous: boolean;
+    /**
+     * The type of the instruction.
+     */
+    readonly type: WebXInstructionType;
+    /**
+     * Constructs a new WebXInstruction.
+     *
+     * @param type The type of the instruction.
+     */
+    constructor(type: WebXInstructionType);
 }