@illgrenoble/webx-client 0.10.0 → 1.1.0

package/dist/tunnel/WebXTunnel.js

@@ -13,16 +13,34 @@ exports.WebXTunnel = void 0;
 const instruction_1 = require("../instruction");
 const message_1 = require("../message");
 const transport_1 = require("../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.
+ */
 class WebXTunnel {
     constructor() {
         this._instructionResponses = new Map();
         this._serializer = null;
     }
+    /**
+     * Sends an instruction to the WebX Engine.
+     *
+     * @param command The instruction to send.
+     */
     sendInstruction(command) {
         // console.log(`Sending command: `, command);
         const message = this._serializer.serializeInstruction(command);
         this.send(message);
     }
+    /**
+     * 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, timeout) {
         // console.log(`Sending request: `, command);
         command.synchronous = true;
@@ -40,6 +58,11 @@ class WebXTunnel {
             });
         });
     }
+    /**
+     * Handles incoming messages from the WebX Engine.
+     *
+     * @param data The received data.
+     */
     onMessage(data) {
         return __awaiter(this, void 0, void 0, function* () {
             if (data.byteLength === 0) {
@@ -68,19 +91,35 @@ class WebXTunnel {
             }
         });
     }
-    // eslint-disable-next-line
+    /**
+     * Handles a received message from the WebX Engine.
+     *
+     * @param message The received message.
+     */
     handleMessage(message) {
         throw new Error('Method not implemented.');
     }
-    // eslint-disable-next-line
+    /**
+     * Handles received bytes from the WebX Engine.
+     *
+     * @param data The received data.
+     */
     handleReceivedBytes(data) {
         throw new Error('Method not implemented.');
     }
-    // eslint-disable-next-line
+    /**
+     * Handles sent bytes to the WebX Engine.
+     *
+     * @param data The sent data.
+     */
     handleSentBytes(data) {
         throw new Error('Method not implemented');
     }
-    // eslint-disable-next-line
+    /**
+     * Handles the close event of the connection.
+     *
+     * @param event The close event.
+     */
     handleClose(event) {
         // Clear all pending instruction responses
         this._instructionResponses.forEach((response) => {
@@ -88,9 +127,17 @@ class WebXTunnel {
         });
         this.onClosed();
     }
+    /**
+     * Called when the connection is closed.
+     */
     onClosed() {
         console.log(`Websocket closed`);
     }
+    /**
+     * Handles critical messages such as PING and data acknowledgments.
+     *
+     * @param buffer The message buffer.
+     */
     _handleCriticalMessages(buffer) {
         if (buffer.messageTypeId == message_1.WebXMessageType.PING) {
             // Reply immediately with a pong

package/dist/tunnel/WebXTunnel.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXTunnel.js","sourceRoot":"","sources":["../../src/tunnel/WebXTunnel.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAAqH;AACrH,wCAAwD;AACxD,4CAAuE;AAEvE,MAAsB,UAAU;IAO9B;QAFQ,0BAAqB,GAA8C,IAAI,GAAG,EAAwC,CAAC;QAGzH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAUD,eAAe,CAAC,OAAwB;QACtC,6CAA6C;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAED,WAAW,CAAC,OAAwB,EAAE,OAAgB;QACpD,6CAA6C;QAC7C,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;QAC3B,OAAO,GAAG,OAAO,IAAI,KAAK,CAAC;QAC3B,MAAM,QAAQ,GAAG,IAAI,qCAAuB,CAAc,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5E,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,QAAQ;iBACL,IAAI,CAAC,OAAO,CAAC;iBACb,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;gBACtB,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC9C,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;IAEe,SAAS,CAAC,IAAiB;;YACzC,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;gBAC1C,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,GAAG,6BAAiB,CAAC,qBAAqB,EAAE,CAAC;gBACrE,OAAO,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;gBACxD,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,6BAAiB,CAAC,IAAI,CAAC,CAAC;YAE3C,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YAErC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAE/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAClE,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBAEpB,+BAA+B;gBAC/B,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;oBAC3F,MAAM,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;oBAC9E,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;oBACrD,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAEvC,CAAC;qBAAM,CAAC;oBACN,qBAAqB;oBACrB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;KAAA;IAED,2BAA2B;IAC3B,aAAa,CAAC,OAAoB;QAChC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,2BAA2B;IAC3B,mBAAmB,CAAC,IAAiB;QACnC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,2BAA2B;IAC3B,eAAe,CAAC,IAAiB;QAC/B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,2BAA2B;IAC3B,WAAW,CAAC,KAAiB;QAC3B,0CAA0C;QAC1C,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,QAA8C,EAAE,EAAE;YACpF,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED,QAAQ;QACN,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAClC,CAAC;IAEO,uBAAuB,CAAC,MAAyB;QACvD,IAAI,MAAM,CAAC,aAAa,IAAI,yBAAe,CAAC,IAAI,EAAE,CAAC;YACjD,gCAAgC;YAChC,IAAI,CAAC,eAAe,CAAC,IAAI,iCAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAEpE,CAAC;aAAM,IAAI,MAAM,CAAC,aAAa,IAAI,yBAAe,CAAC,SAAS,IAAI,MAAM,CAAC,aAAa,IAAI,yBAAe,CAAC,KAAK,EAAE,CAAC;YAC9G,kEAAkE;YAClE,IAAI,MAAM,CAAC,YAAY,GAAG,UAAU,CAAC,yBAAyB,EAAE,CAAC;gBAC/D,IAAI,CAAC,eAAe,CAAC,IAAI,oCAAsB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5F,CAAC;QACH,CAAC;IACH,CAAC;;AAjHH,gCAmHC;AAlHyB,oCAAyB,GAAG,KAAK,AAAR,CAAS"}
+{"version":3,"file":"WebXTunnel.js","sourceRoot":"","sources":["../../src/tunnel/WebXTunnel.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAAqH;AACrH,wCAAwD;AACxD,4CAAuE;AAEvE;;;;;GAKG;AACH,MAAsB,UAAU;IAO9B;QAFQ,0BAAqB,GAA8C,IAAI,GAAG,EAAwC,CAAC;QAGzH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IA8BD;;;;OAIG;IACH,eAAe,CAAC,OAAwB;QACtC,6CAA6C;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAwB,EAAE,OAAgB;QACpD,6CAA6C;QAC7C,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;QAC3B,OAAO,GAAG,OAAO,IAAI,KAAK,CAAC;QAC3B,MAAM,QAAQ,GAAG,IAAI,qCAAuB,CAAc,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5E,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,QAAQ;iBACL,IAAI,CAAC,OAAO,CAAC;iBACb,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;gBACtB,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC9C,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACa,SAAS,CAAC,IAAiB;;YACzC,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;gBAC1C,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,GAAG,6BAAiB,CAAC,qBAAqB,EAAE,CAAC;gBACrE,OAAO,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;gBACxD,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,6BAAiB,CAAC,IAAI,CAAC,CAAC;YAE3C,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YAErC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAE/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAClE,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBAEpB,+BAA+B;gBAC/B,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;oBAC3F,MAAM,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;oBAC9E,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;oBACrD,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAEvC,CAAC;qBAAM,CAAC;oBACN,qBAAqB;oBACrB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACH,aAAa,CAAC,OAAoB;QAChC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,IAAiB;QACnC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,IAAiB;QAC/B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,KAAiB;QAC3B,0CAA0C;QAC1C,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,QAA8C,EAAE,EAAE;YACpF,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,MAAyB;QACvD,IAAI,MAAM,CAAC,aAAa,IAAI,yBAAe,CAAC,IAAI,EAAE,CAAC;YACjD,gCAAgC;YAChC,IAAI,CAAC,eAAe,CAAC,IAAI,iCAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAEpE,CAAC;aAAM,IAAI,MAAM,CAAC,aAAa,IAAI,yBAAe,CAAC,SAAS,IAAI,MAAM,CAAC,aAAa,IAAI,yBAAe,CAAC,KAAK,EAAE,CAAC;YAC9G,kEAAkE;YAClE,IAAI,MAAM,CAAC,YAAY,GAAG,UAAU,CAAC,yBAAyB,EAAE,CAAC;gBAC/D,IAAI,CAAC,eAAe,CAAC,IAAI,oCAAsB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5F,CAAC;QACH,CAAC;IACH,CAAC;;AA9KH,gCAgLC;AA/KyB,oCAAyB,GAAG,KAAK,AAAR,CAAS"}

package/dist/tunnel/WebXWebSocketTunnel.d.ts

@@ -1,5 +1,11 @@
 import { WebXTunnel } from './WebXTunnel';
 import { WebXBinarySerializer } from '../transport';
+/**
+ * Represents a WebSocket-based implementation of the WebX communication tunnel.
+ *
+ * This class manages the WebSocket connection to the WebX Engine, handles
+ * sending and receiving data, and processes events related to the connection.
+ */
 export declare class WebXWebSocketTunnel extends WebXTunnel {
     private readonly _url;
     private _socket;
@@ -7,8 +13,28 @@ export declare class WebXWebSocketTunnel extends WebXTunnel {
     private _socketOpen;
     constructor(url: string, options?: any);
     getSocket(): WebSocket;
+    /**
+     * Sends data to the WebX Engine over the WebSocket connection.
+     *
+     * @param data The data to send.
+     */
     send(data: ArrayBuffer): void;
+    /**
+     * Establishes a WebSocket connection to the WebX Engine.
+     *
+     * @param data The connection options.
+     * @param serializer The serializer to use for encoding/decoding messages.
+     * @returns A promise that resolves when the connection is successfully established.
+     */
     connect(data: any, serializer: WebXBinarySerializer): Promise<Event>;
+    /**
+     * Closes the WebSocket connection to the WebX Engine.
+     */
     disconnect(): void;
+    /**
+     * Checks if the WebSocket connection is currently open.
+     *
+     * @returns True if the WebSocket is open, false otherwise.
+     */
     isConnected(): boolean;
 }

package/dist/tunnel/WebXWebSocketTunnel.js

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXWebSocketTunnel = void 0;
 const WebXTunnel_1 = require("./WebXTunnel");
+/**
+ * Represents a WebSocket-based implementation of the WebX communication tunnel.
+ *
+ * This class manages the WebSocket connection to the WebX Engine, handles
+ * sending and receiving data, and processes events related to the connection.
+ */
 class WebXWebSocketTunnel extends WebXTunnel_1.WebXTunnel {
     constructor(url, options = {}) {
         super();
@@ -12,12 +18,24 @@ class WebXWebSocketTunnel extends WebXTunnel_1.WebXTunnel {
     getSocket() {
         return this._socket;
     }
+    /**
+     * Sends data to the WebX Engine over the WebSocket connection.
+     *
+     * @param data The data to send.
+     */
     send(data) {
         if (this._socket != null) {
             this._socket.send(data);
             this.handleSentBytes(data);
         }
     }
+    /**
+     * Establishes a WebSocket connection to the WebX Engine.
+     *
+     * @param data The connection options.
+     * @param serializer The serializer to use for encoding/decoding messages.
+     * @returns A promise that resolves when the connection is successfully established.
+     */
     connect(data, serializer) {
         const options = Object.assign(Object.assign({}, this._connectionOptions), data);
         const parameters = new URLSearchParams(options);
@@ -35,6 +53,9 @@ class WebXWebSocketTunnel extends WebXTunnel_1.WebXTunnel {
             this._socket.onmessage = (aMessage) => this.onMessage(aMessage.data);
         });
     }
+    /**
+     * Closes the WebSocket connection to the WebX Engine.
+     */
     disconnect() {
         if (this._socket) {
             this._socketOpen = false;
@@ -42,6 +63,11 @@ class WebXWebSocketTunnel extends WebXTunnel_1.WebXTunnel {
             this._socket = null;
         }
     }
+    /**
+     * Checks if the WebSocket connection is currently open.
+     *
+     * @returns True if the WebSocket is open, false otherwise.
+     */
     isConnected() {
         return this._socketOpen;
     }

package/dist/tunnel/WebXWebSocketTunnel.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXWebSocketTunnel.js","sourceRoot":"","sources":["../../src/tunnel/WebXWebSocketTunnel.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAG1C,MAAa,mBAAoB,SAAQ,uBAAU;IAMjD,YAAY,GAAW,EAAE,UAAe,EAAE;QACxC,KAAK,EAAE,CAAC;QAHF,gBAAW,GAAG,KAAK,CAAC;QAI1B,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,IAAiB;QACpB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,OAAO,CAAC,IAAS,EAAE,UAAgC;QACjD,MAAM,OAAO,mCAAO,IAAI,CAAC,kBAAkB,GAAK,IAAI,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;QAEzC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE;gBACzB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;gBACxB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,KAAY,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,QAAa,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC;IAED,UAAU;QACR,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;YACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;IACH,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CAGF;AAvDD,kDAuDC"}
+{"version":3,"file":"WebXWebSocketTunnel.js","sourceRoot":"","sources":["../../src/tunnel/WebXWebSocketTunnel.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAG1C;;;;;GAKG;AACH,MAAa,mBAAoB,SAAQ,uBAAU;IAMjD,YAAY,GAAW,EAAE,UAAe,EAAE;QACxC,KAAK,EAAE,CAAC;QAHF,gBAAW,GAAG,KAAK,CAAC;QAI1B,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,IAAiB;QACpB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,IAAS,EAAE,UAAgC;QACjD,MAAM,OAAO,mCAAO,IAAI,CAAC,kBAAkB,GAAK,IAAI,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;QAEzC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE;gBACzB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;gBACxB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,KAAY,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,QAAa,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;YACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF;AAzED,kDAyEC"}

package/dist/utils/ColorGenerator.d.ts

@@ -1,5 +1,24 @@
+/**
+ * Utility class for generating colors.
+ *
+ * This class provides methods to generate random colors or retrieve colors
+ * from a predefined palette based on an index.
+ */
 export declare class ColorGenerator {
     private static _COLOURS;
+    /**
+     * Generates a random color from the predefined palette.
+     *
+     * @returns A random color as a hexadecimal string.
+     */
     static randomColour(): string;
+    /**
+     * Retrieves a color from the predefined palette based on the given index.
+     *
+     * If the index exceeds the palette size, it wraps around using modulo.
+     *
+     * @param index The index of the color to retrieve.
+     * @returns The color as a hexadecimal string.
+     */
     static indexedColour(index: number): string;
 }

package/dist/utils/ColorGenerator.js

@@ -1,11 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ColorGenerator = void 0;
+/**
+ * Utility class for generating colors.
+ *
+ * This class provides methods to generate random colors or retrieve colors
+ * from a predefined palette based on an index.
+ */
 class ColorGenerator {
+    /**
+     * Generates a random color from the predefined palette.
+     *
+     * @returns A random color as a hexadecimal string.
+     */
     static randomColour() {
         const index = Math.floor(Math.random() * ColorGenerator._COLOURS.length);
         return ColorGenerator._COLOURS[index];
     }
+    /**
+     * Retrieves a color from the predefined palette based on the given index.
+     *
+     * If the index exceeds the palette size, it wraps around using modulo.
+     *
+     * @param index The index of the color to retrieve.
+     * @returns The color as a hexadecimal string.
+     */
     static indexedColour(index) {
         index = index % ColorGenerator._COLOURS.length;
         return ColorGenerator._COLOURS[index];

package/dist/utils/ColorGenerator.js.map

@@ -1 +1 @@
-{"version":3,"file":"ColorGenerator.js","sourceRoot":"","sources":["../../src/utils/ColorGenerator.ts"],"names":[],"mappings":";;;AAAA,MAAa,cAAc;IAehB,MAAM,CAAC,YAAY;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzE,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,KAAa;QACvC,KAAK,GAAG,KAAK,GAAG,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/C,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;;AAvBL,wCA0BC;AAxBgB,uBAAQ,GAAG;IACxB,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;CACtD,CAAA"}
+{"version":3,"file":"ColorGenerator.js","sourceRoot":"","sources":["../../src/utils/ColorGenerator.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,MAAa,cAAc;IAezB;;;;OAIG;IACI,MAAM,CAAC,YAAY;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzE,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,KAAa;QACvC,KAAK,GAAG,KAAK,GAAG,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/C,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;;AApCH,wCAqCC;AAnCgB,uBAAQ,GAAG;IACxB,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;IACrD,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;CACtD,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@illgrenoble/webx-client",
   "description": "Client javascript library to display WebX remote desktop in a browser.",
-  "version": "0.10.0",
+  "version": "1.1.0",
   "scripts": {
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",