@illgrenoble/webx-client 0.9.0 → 1.0.0

package/dist/transport/WebXMessageBuffer.d.ts

@@ -1,21 +1,76 @@
+/**
+ * Represents a buffer for encoding and decoding WebX messages.
+ *
+ * This class provides methods to write and read data in a structured format
+ * for communication with the WebX Engine.
+ */
 export declare class WebXMessageBuffer {
     private _buffer;
+    /**
+     * The length of the message header in bytes.
+     */
     static readonly MESSAGE_HEADER_LENGTH = 48;
-    private readonly _timestampMs;
-    private readonly _messageTypeId;
-    private readonly _messageId;
-    private readonly _bufferLength;
+    /**
+     * The timestamp in milliseconds when the message was created.
+     */
+    readonly timestampMs: Uint8Array;
+    /**
+     * The type ID of the message.
+     */
+    readonly messageTypeId: number;
+    /**
+     * The unique ID of the message.
+     */
+    readonly messageId: number;
+    /**
+     * The total length of the buffer in bytes.
+     */
+    readonly bufferLength: number;
     private _readOffset;
     private _encoder;
-    get timestampMs(): Uint8Array;
-    get messageTypeId(): number;
-    get messageId(): number;
-    get bufferLength(): number;
+    /**
+     * Creates a new instance of WebXMessageBuffer.
+     *
+     * @param _buffer The buffer to read from.
+     */
     constructor(_buffer: ArrayBuffer);
+    /**
+     * Reads a 32-bit signed integer from the buffer.
+     *
+     * @returns The read value.
+     */
     getInt32(): number;
+    /**
+     * Reads a 32-bit unsigned integer from the buffer.
+     *
+     * @returns The read value.
+     */
     getUint32(): number;
+    /**
+     * Reads a 32-bit floating point number from the buffer.
+     *
+     * @returns The read value.
+     */
     getFloat(): number;
+    /**
+     * Reads a Uint8Array from the buffer.
+     *
+     * @param length The length of the array to read.
+     * @returns The read Uint8Array.
+     */
     getUint8Array(length: number): Uint8Array;
+    /**
+     * Reads a string from the buffer.
+     *
+     * @param length The length of the string to read.
+     * @returns The read string.
+     */
     getString(length: number): string;
+    /**
+     * Calculates the next read offset, ensuring alignment.
+     *
+     * @param sizeOfData The size of the data to read.
+     * @returns The next read offset.
+     */
     private _getNextReadOffset;
 }

package/dist/transport/WebXMessageBuffer.js

@@ -1,55 +1,87 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXMessageBuffer = void 0;
+/**
+ * Represents a buffer for encoding and decoding WebX messages.
+ *
+ * This class provides methods to write and read data in a structured format
+ * for communication with the WebX Engine.
+ */
 class WebXMessageBuffer {
-    get timestampMs() {
-        return this._timestampMs;
-    }
-    get messageTypeId() {
-        return this._messageTypeId;
-    }
-    get messageId() {
-        return this._messageId;
-    }
-    get bufferLength() {
-        return this._bufferLength;
-    }
+    /**
+     * Creates a new instance of WebXMessageBuffer.
+     *
+     * @param _buffer The buffer to read from.
+     */
     constructor(_buffer) {
         this._buffer = _buffer;
         this._readOffset = 24;
         this._encoder = new TextDecoder('utf-8');
         this._readOffset = 24; // Session Id (16) and client index mask (8)
-        this._timestampMs = this.getUint8Array(8);
-        this._messageTypeId = this.getUint32();
-        this._messageId = this.getUint32();
-        this._bufferLength = this.getUint32();
+        this.timestampMs = this.getUint8Array(8);
+        this.messageTypeId = this.getUint32();
+        this.messageId = this.getUint32();
+        this.bufferLength = this.getUint32();
         this._readOffset = WebXMessageBuffer.MESSAGE_HEADER_LENGTH;
     }
+    /**
+     * Reads a 32-bit signed integer from the buffer.
+     *
+     * @returns The read value.
+     */
     getInt32() {
         const offset = this._getNextReadOffset(4);
         const typedArray = new Int32Array(this._buffer, offset, 1);
         return typedArray[0];
     }
+    /**
+     * Reads a 32-bit unsigned integer from the buffer.
+     *
+     * @returns The read value.
+     */
     getUint32() {
         const offset = this._getNextReadOffset(4);
         const typedArray = new Uint32Array(this._buffer, offset, 1);
         return typedArray[0];
     }
+    /**
+     * Reads a 32-bit floating point number from the buffer.
+     *
+     * @returns The read value.
+     */
     getFloat() {
         const offset = this._getNextReadOffset(4);
         const typedArray = new Float32Array(this._buffer, offset, 1);
         return typedArray[0];
     }
+    /**
+     * Reads a Uint8Array from the buffer.
+     *
+     * @param length The length of the array to read.
+     * @returns The read Uint8Array.
+     */
     getUint8Array(length) {
         const typedArray = new Uint8Array(this._buffer, this._readOffset, length);
         this._readOffset += length;
         return typedArray;
     }
+    /**
+     * Reads a string from the buffer.
+     *
+     * @param length The length of the string to read.
+     * @returns The read string.
+     */
     getString(length) {
         const array = new Uint8Array(this._buffer, this._readOffset, length);
         this._readOffset += length;
         return this._encoder.decode(array);
     }
+    /**
+     * Calculates the next read offset, ensuring alignment.
+     *
+     * @param sizeOfData The size of the data to read.
+     * @returns The next read offset.
+     */
     _getNextReadOffset(sizeOfData) {
         // Ensure alignment
         const padding = this._readOffset % sizeOfData > 0 ? sizeOfData - (this._readOffset % sizeOfData) : 0;
@@ -59,5 +91,8 @@ class WebXMessageBuffer {
     }
 }
 exports.WebXMessageBuffer = WebXMessageBuffer;
+/**
+ * The length of the message header in bytes.
+ */
 WebXMessageBuffer.MESSAGE_HEADER_LENGTH = 48;
 //# sourceMappingURL=WebXMessageBuffer.js.map

package/dist/transport/WebXMessageBuffer.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXMessageBuffer.js","sourceRoot":"","sources":["../../src/transport/WebXMessageBuffer.ts"],"names":[],"mappings":";;;AAAA,MAAa,iBAAiB;IAa5B,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,YAAoB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;QApBhC,gBAAW,GAAW,EAAE,CAAC;QAEzB,aAAQ,GAAgB,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QAmBvD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,4CAA4C;QACnE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAC7D,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAE3D,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAEM,SAAS;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAE5D,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAE7D,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAEM,aAAa,CAAC,MAAc;QACjC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC;QAE3B,OAAO,UAAU,CAAC;IACpB,CAAC;IAEM,SAAS,CAAC,MAAc;QAC7B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAEO,kBAAkB,CAAC,UAAkB;QAC3C,mBAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrG,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE5C,IAAI,CAAC,WAAW,IAAI,UAAU,GAAG,OAAO,CAAC;QAEzC,OAAO,QAAQ,CAAC;IAClB,CAAC;;AAnFH,8CAqFC;AAnFwB,uCAAqB,GAAG,EAAE,AAAL,CAAM"}
+{"version":3,"file":"WebXMessageBuffer.js","sourceRoot":"","sources":["../../src/transport/WebXMessageBuffer.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,MAAa,iBAAiB;IA6B5B;;;;OAIG;IACH,YAAoB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;QARhC,gBAAW,GAAW,EAAE,CAAC;QACzB,aAAQ,GAAgB,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QAQvD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,4CAA4C;QACnE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3D,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,SAAS;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5D,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC7D,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,MAAc;QACjC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC;QAC3B,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,MAAc;QAC7B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACK,kBAAkB,CAAC,UAAkB;QAC3C,mBAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrG,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE5C,IAAI,CAAC,WAAW,IAAI,UAAU,GAAG,OAAO,CAAC;QAEzC,OAAO,QAAQ,CAAC;IAClB,CAAC;;AAlHH,8CAmHC;AAlHC;;GAEG;AACoB,uCAAqB,GAAG,EAAE,AAAL,CAAM"}

package/dist/transport/WebXMessageDecoder.d.ts

@@ -1,17 +1,86 @@
 import { WebXMessage } from '../message';
 import { WebXTextureFactory } from '../display';
 import { WebXMessageBuffer } from './WebXMessageBuffer';
+/**
+ * Decodes binary messages received from the WebX Engine into WebXMessage objects.
+ * This class handles various message types and converts them into their respective
+ * WebXMessage implementations.
+ */
 export declare class WebXMessageDecoder {
     private _textureFactory;
+    /**
+     * Creates a new instance of WebXMessageDecoder.
+     *
+     * @param _textureFactory The texture factory used to create textures from image data.
+     */
     constructor(_textureFactory: WebXTextureFactory);
+    /**
+     * Decodes a binary message buffer into a WebXMessage object.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to the decoded WebXMessage.
+     */
     decode(buffer: WebXMessageBuffer): Promise<WebXMessage>;
+    /**
+     * Determines the MIME type of an image based on its type string.
+     *
+     * @param imageType The image type string (e.g., 'jpg', 'png').
+     * @returns The corresponding MIME type.
+     */
     private _determineMimeType;
+    /**
+     * Decodes a buffer into a WebXImageMessage.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXImageMessage.
+     */
     private _createImageMessage;
+    /**
+     * Decodes a buffer into a WebXSubImagesMessage containing multiple sub-images.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXSubImagesMessage.
+     */
     private _createSubImagesMessage;
+    /**
+     * Decodes a buffer into a WebXMouseMessage, which contains mouse position and cursor ID.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXMouseMessage.
+     */
     private _createMouseMessage;
+    /**
+     * Decodes a buffer into a WebXWindowsMessage, which contains information about multiple windows.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXWindowsMessage.
+     */
     private _createWindowsMessage;
+    /**
+     * Decodes a buffer into a WebXCursorImageMessage, which contains cursor image data.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXCursorImageMessage.
+     */
     private _createCursorImageMessage;
+    /**
+     * Decodes a buffer into a WebXScreenMessage, which contains screen dimensions.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXScreenMessage.
+     */
     private _createScreenMessage;
+    /**
+     * Creates a WebXPingMessage, which is used for pinging purposes.
+     *
+     * @returns A promise that resolves to a WebXPingMessage.
+     */
     private _createPingMessage;
+    /**
+     * Decodes a buffer into a WebXQualityMessage, which contains quality metrics.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXQualityMessage.
+     */
     private _createQualityMessage;
 }

package/dist/transport/WebXMessageDecoder.js

@@ -1,12 +1,37 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXMessageDecoder = void 0;
 const message_1 = require("../message");
 const display_1 = require("../display");
+/**
+ * Decodes binary messages received from the WebX Engine into WebXMessage objects.
+ * This class handles various message types and converts them into their respective
+ * WebXMessage implementations.
+ */
 class WebXMessageDecoder {
+    /**
+     * Creates a new instance of WebXMessageDecoder.
+     *
+     * @param _textureFactory The texture factory used to create textures from image data.
+     */
     constructor(_textureFactory) {
         this._textureFactory = _textureFactory;
     }
+    /**
+     * Decodes a binary message buffer into a WebXMessage object.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to the decoded WebXMessage.
+     */
     decode(buffer) {
         const { messageTypeId } = buffer;
         if (messageTypeId === message_1.WebXMessageType.SCREEN) {
@@ -35,6 +60,12 @@ class WebXMessageDecoder {
         }
         console.error(`Failed to decode message with typeId ${messageTypeId}`);
     }
+    /**
+     * Determines the MIME type of an image based on its type string.
+     *
+     * @param imageType The image type string (e.g., 'jpg', 'png').
+     * @returns The corresponding MIME type.
+     */
     _determineMimeType(imageType) {
         if (imageType.substr(0, 3) === 'jpg') {
             return 'image/jpeg';
@@ -44,6 +75,12 @@ class WebXMessageDecoder {
         }
         return 'image/bmp';
     }
+    /**
+     * Decodes a buffer into a WebXImageMessage.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXImageMessage.
+     */
     _createImageMessage(buffer) {
         return new Promise((resolve) => {
             const commandId = buffer.getUint32();
@@ -63,6 +100,12 @@ class WebXMessageDecoder {
             });
         });
     }
+    /**
+     * Decodes a buffer into a WebXSubImagesMessage containing multiple sub-images.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXSubImagesMessage.
+     */
     _createSubImagesMessage(buffer) {
         return new Promise((resolve) => {
             const commandId = buffer.getUint32();
@@ -97,17 +140,29 @@ class WebXMessageDecoder {
             });
         });
     }
+    /**
+     * Decodes a buffer into a WebXMouseMessage, which contains mouse position and cursor ID.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXMouseMessage.
+     */
     _createMouseMessage(buffer) {
-        return new Promise((resolve) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const commandId = buffer.getUint32();
             const x = buffer.getInt32();
             const y = buffer.getInt32();
             const cursorId = buffer.getUint32();
-            resolve(new message_1.WebXMouseMessage(x, y, cursorId, commandId));
+            return new message_1.WebXMouseMessage(x, y, cursorId, commandId);
         });
     }
+    /**
+     * Decodes a buffer into a WebXWindowsMessage, which contains information about multiple windows.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXWindowsMessage.
+     */
     _createWindowsMessage(buffer) {
-        return new Promise((resolve) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const commandId = buffer.getUint32();
             const numberOfWindows = buffer.getUint32();
             const windows = new Array();
@@ -119,11 +174,17 @@ class WebXMessageDecoder {
                 const height = buffer.getInt32();
                 windows.push(new display_1.WebXWindowProperties({ id: windowId, x: x, y: y, width: width, height: height }));
             }
-            resolve(new message_1.WebXWindowsMessage(windows, commandId));
+            return new message_1.WebXWindowsMessage(windows, commandId);
         });
     }
+    /**
+     * Decodes a buffer into a WebXCursorImageMessage, which contains cursor image data.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXCursorImageMessage.
+     */
     _createCursorImageMessage(buffer) {
-        return new Promise((resolve) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const commandId = buffer.getUint32();
             const x = buffer.getInt32();
             const y = buffer.getInt32();
@@ -132,36 +193,53 @@ class WebXMessageDecoder {
             const cursorId = buffer.getUint32();
             const imageDataSize = buffer.getUint32();
             const imageData = buffer.getUint8Array(imageDataSize);
-            this._textureFactory.createTextureFromArray(imageData, 'image/png')
-                .then(texture => {
-                resolve(new message_1.WebXCursorImageMessage(x, y, xHot, yHot, cursorId, texture, commandId));
-            })
-                .catch(() => {
-                console.error('Failed to get texture for cursor image');
-            });
+            try {
+                const texture = yield this._textureFactory.createTextureFromArray(imageData, 'image/png');
+                return new message_1.WebXCursorImageMessage(x, y, xHot, yHot, cursorId, texture, commandId);
+            }
+            catch (error) {
+                console.error(`Failed to get texture for cursor image: ${error}`);
+            }
         });
     }
+    /**
+     * Decodes a buffer into a WebXScreenMessage, which contains screen dimensions.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXScreenMessage.
+     */
     _createScreenMessage(buffer) {
-        return new Promise((resolve) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const commandId = buffer.getUint32();
             const screenWidth = buffer.getInt32();
             const screenHeight = buffer.getInt32();
-            resolve(new message_1.WebXScreenMessage({ width: screenWidth, height: screenHeight }, commandId));
+            return new message_1.WebXScreenMessage({ width: screenWidth, height: screenHeight }, commandId);
         });
     }
+    /**
+     * Creates a WebXPingMessage, which is used for pinging purposes.
+     *
+     * @returns A promise that resolves to a WebXPingMessage.
+     */
     _createPingMessage() {
-        return new Promise((resolve) => {
-            resolve(new message_1.WebXPingMessage());
+        return __awaiter(this, void 0, void 0, function* () {
+            return new message_1.WebXPingMessage();
         });
     }
+    /**
+     * Decodes a buffer into a WebXQualityMessage, which contains quality metrics.
+     *
+     * @param buffer The binary message buffer to decode.
+     * @returns A promise that resolves to a WebXQualityMessage.
+     */
     _createQualityMessage(buffer) {
-        return new Promise((resolve) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const index = buffer.getUint32();
             const imageFPS = buffer.getFloat();
             const rgbQuality = buffer.getFloat();
             const alphaQuality = buffer.getFloat();
             const maxMbps = buffer.getFloat();
-            resolve(new message_1.WebXQualityMessage(index, imageFPS, rgbQuality, alphaQuality, maxMbps));
+            return new message_1.WebXQualityMessage(index, imageFPS, rgbQuality, alphaQuality, maxMbps);
         });
     }
 }

package/dist/transport/WebXMessageDecoder.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXMessageDecoder.js","sourceRoot":"","sources":["../../src/transport/WebXMessageDecoder.ts"],"names":[],"mappings":";;;AAAA,wCAUoB;AACpB,wCAAoF;AAGpF,MAAa,kBAAkB;IAE7B,YAAoB,eAAmC;QAAnC,oBAAe,GAAf,eAAe,CAAoB;IACvD,CAAC;IAED,MAAM,CAAC,MAAyB;QAC9B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QAEjC,IAAI,aAAa,KAAK,yBAAe,CAAC,MAAM,EAAE,CAAC;YAC7C,OAAO,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE3C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,OAAO,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE5C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAE1C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,SAAS,EAAE,CAAC;YACvD,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAE9C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAE1C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,YAAY,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAEhD,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,IAAI,EAAE,CAAC;YAClD,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAEnC,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,OAAO,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,wCAAwC,aAAa,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,kBAAkB,CAAC,SAAiB;QAC1C,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACrC,OAAO,YAAY,CAAC;QACtB,CAAC;aAAM,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YAC5C,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,mBAAmB,CAAC,MAAyB;QACnD,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,EAAE;YAC/C,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACpD,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAClE,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAElE,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACzF,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAEzF,OAAO,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;iBAC5C,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE;gBAC7B,OAAO,CAAC,IAAI,0BAAgB,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YACrG,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,MAAyB;QACvD,OAAO,IAAI,OAAO,CAAuB,CAAC,OAAO,EAAE,EAAE;YACnD,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,aAAa,GAAG,IAAI,KAAK,EAAyB,CAAC;YACzD,MAAM,iBAAiB,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACjC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBACpD,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACzC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACzC,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;gBAClE,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;gBAElE,MAAM,YAAY,GAAG,IAAI,OAAO,CAAe,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;oBAC3E,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oBACzF,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oBAEzF,OAAO,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;yBAC5C,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE;wBAC7B,YAAY,CAAC,IAAI,sBAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;oBACrF,CAAC,CAAC;yBACD,KAAK,CAAC,WAAW,CAAC,CAAC;gBACxB,CAAC,CAAC,CAAC;gBACH,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACnC,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,aAA6B,EAAE,EAAE;gBAChE,OAAO,CAAC,IAAI,8BAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;QAEL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,MAAyB;QACnD,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,EAAE;YAC/C,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,OAAO,CAAC,IAAI,0BAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,MAAyB;QACrD,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;YACjD,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,eAAe,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YACnD,MAAM,OAAO,GAAgC,IAAI,KAAK,EAAwB,CAAC;YAC/E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAEjC,OAAO,CAAC,IAAI,CAAC,IAAI,8BAAoB,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YACrG,CAAC;YACD,OAAO,CAAC,IAAI,4BAAkB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,yBAAyB,CAAC,MAAyB;QACzD,OAAO,IAAI,OAAO,CAAyB,CAAC,OAAO,EAAE,EAAE;YACrD,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAElE,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC;iBAChE,IAAI,CAAC,OAAO,CAAC,EAAE;gBACd,OAAO,CAAC,IAAI,gCAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;YACtF,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,oBAAoB,CAAC,MAAyB;QACpD,OAAO,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,EAAE;YAChD,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC9C,MAAM,YAAY,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/C,OAAO,CAAC,IAAI,2BAAiB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,kBAAkB;QACxB,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,EAAE;YAC9C,OAAO,CAAC,IAAI,yBAAe,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,MAAyB;QACrD,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;YACjD,MAAM,KAAK,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,QAAQ,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,MAAM,UAAU,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7C,MAAM,YAAY,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC1C,OAAO,CAAC,IAAI,4BAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC;IACL,CAAC;CAEF;AArLD,gDAqLC"}
+{"version":3,"file":"WebXMessageDecoder.js","sourceRoot":"","sources":["../../src/transport/WebXMessageDecoder.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAUoB;AACpB,wCAAoF;AAGpF;;;;GAIG;AACH,MAAa,kBAAkB;IAC7B;;;;OAIG;IACH,YAAoB,eAAmC;QAAnC,oBAAe,GAAf,eAAe,CAAoB;IAAG,CAAC;IAE3D;;;;;OAKG;IACH,MAAM,CAAC,MAAyB;QAC9B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QAEjC,IAAI,aAAa,KAAK,yBAAe,CAAC,MAAM,EAAE,CAAC;YAC7C,OAAO,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE3C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,OAAO,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE5C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAE1C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,SAAS,EAAE,CAAC;YACvD,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAE9C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAE1C,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,YAAY,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAEhD,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,IAAI,EAAE,CAAC;YAClD,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAEnC,CAAC;aAAM,IAAI,aAAa,KAAK,yBAAe,CAAC,OAAO,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,wCAAwC,aAAa,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACK,kBAAkB,CAAC,SAAiB;QAC1C,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACrC,OAAO,YAAY,CAAC;QACtB,CAAC;aAAM,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YAC5C,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CAAC,MAAyB;QACnD,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,EAAE;YAC/C,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACpD,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAClE,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAElE,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACzF,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAEzF,OAAO,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;iBAC5C,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE;gBAC7B,OAAO,CAAC,IAAI,0BAAgB,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YACrG,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,uBAAuB,CAAC,MAAyB;QACvD,OAAO,IAAI,OAAO,CAAuB,CAAC,OAAO,EAAE,EAAE;YACnD,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,aAAa,GAAG,IAAI,KAAK,EAAyB,CAAC;YACzD,MAAM,iBAAiB,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACjC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBACpD,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACzC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACzC,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;gBAClE,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;gBAElE,MAAM,YAAY,GAAG,IAAI,OAAO,CAAe,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;oBAC3E,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oBACzF,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oBAEzF,OAAO,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;yBAC5C,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE;wBAC7B,YAAY,CAAC,IAAI,sBAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;oBACrF,CAAC,CAAC;yBACD,KAAK,CAAC,WAAW,CAAC,CAAC;gBACxB,CAAC,CAAC,CAAC;gBACH,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACnC,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,aAA6B,EAAE,EAAE;gBAChE,OAAO,CAAC,IAAI,8BAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;QAEL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACW,mBAAmB,CAAC,MAAyB;;YACzD,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,OAAO,IAAI,0BAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QACzD,CAAC;KAAA;IAED;;;;;OAKG;IACW,qBAAqB,CAAC,MAAyB;;YAC3D,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,eAAe,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YACnD,MAAM,OAAO,GAAgC,IAAI,KAAK,EAAwB,CAAC;YAC/E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAEjC,OAAO,CAAC,IAAI,CAAC,IAAI,8BAAoB,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YACrG,CAAC;YACD,OAAO,IAAI,4BAAkB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACpD,CAAC;KAAA;IAED;;;;;OAKG;IACW,yBAAyB,CAAC,MAAyB;;YAC/D,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,SAAS,GAAe,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAElE,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;gBAC1F,OAAO,IAAI,gCAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;YAEpF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,2CAA2C,KAAK,EAAE,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACW,oBAAoB,CAAC,MAAyB;;YAC1D,MAAM,SAAS,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC9C,MAAM,YAAY,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/C,OAAO,IAAI,2BAAiB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,SAAS,CAAC,CAAC;QACxF,CAAC;KAAA;IAED;;;;OAIG;IACW,kBAAkB;;YAC9B,OAAO,IAAI,yBAAe,EAAE,CAAC;QAC/B,CAAC;KAAA;IAED;;;;;OAKG;IACW,qBAAqB,CAAC,MAAyB;;YAC3D,MAAM,KAAK,GAAW,MAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,QAAQ,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,MAAM,UAAU,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7C,MAAM,YAAY,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC1C,OAAO,IAAI,4BAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACpF,CAAC;KAAA;CAEF;AAvOD,gDAuOC"}

package/dist/tunnel/WebXTunnel.d.ts

@@ -1,22 +1,93 @@
 import { WebXInstruction } from '../instruction';
 import { WebXMessage } from '../message';
 import { WebXBinarySerializer } from '../transport';
+/**
+ * Represents a communication tunnel between the WebX client and the WebX Engine.
+ *
+ * This class handles sending and receiving data, managing the connection state,
+ * and processing responses from the WebX Engine.
+ */
 export declare abstract class WebXTunnel {
     private static readonly MIN_BUFFER_LENGTH_FOR_ACK;
     protected _serializer: WebXBinarySerializer;
     private _instructionResponses;
     protected constructor();
+    /**
+     * Establishes a connection to the WebX Engine.
+     *
+     * @param data The data required to establish the connection.
+     * @param serializer The serializer to use for encoding/decoding messages.
+     * @returns A promise that resolves when the connection is successfully established.
+     */
     abstract connect(data: any, serializer: WebXBinarySerializer): Promise<Event>;
+    /**
+     * Closes the connection to the WebX Engine.
+     */
     abstract disconnect(): void;
+    /**
+     * Sends data to the WebX Engine.
+     *
+     * @param data The data to send.
+     */
     abstract send(data: ArrayBuffer): void;
+    /**
+     * Checks if the tunnel is currently connected.
+     *
+     * @returns True if the tunnel is connected, false otherwise.
+     */
     abstract isConnected(): boolean;
+    /**
+     * Sends an instruction to the WebX Engine.
+     *
+     * @param command The instruction to send.
+     */
     sendInstruction(command: WebXInstruction): void;
+    /**
+     * Sends a request to the WebX Engine and waits for a response.
+     *
+     * @param command The request to send.
+     * @param timeout The timeout in milliseconds to wait for a response.
+     * @returns A promise that resolves with the response from the WebX Engine.
+     */
     sendRequest(command: WebXInstruction, timeout?: number): Promise<WebXMessage>;
+    /**
+     * Handles incoming messages from the WebX Engine.
+     *
+     * @param data The received data.
+     */
     protected onMessage(data: ArrayBuffer): Promise<void>;
+    /**
+     * Handles a received message from the WebX Engine.
+     *
+     * @param message The received message.
+     */
     handleMessage(message: WebXMessage): void;
+    /**
+     * Handles received bytes from the WebX Engine.
+     *
+     * @param data The received data.
+     */
     handleReceivedBytes(data: ArrayBuffer): void;
+    /**
+     * Handles sent bytes to the WebX Engine.
+     *
+     * @param data The sent data.
+     */
     handleSentBytes(data: ArrayBuffer): void;
+    /**
+     * Handles the close event of the connection.
+     *
+     * @param event The close event.
+     */
     handleClose(event: CloseEvent): void;
+    /**
+     * Called when the connection is closed.
+     */
     onClosed(): void;
+    /**
+     * Handles critical messages such as PING and data acknowledgments.
+     *
+     * @param buffer The message buffer.
+     */
     private _handleCriticalMessages;
 }