@illgrenoble/webx-client 0.10.0 → 1.1.0

package/dist/transport/WebXInstructionBuffer.d.ts

@@ -1,11 +1,24 @@
 import { WebXInstruction } from '../instruction';
+/**
+ * Represents a buffer for encoding and decoding WebX instructions.
+ *
+ * This class provides methods to write and read data in a structured format
+ * for communication with the WebX Engine.
+ */
 export declare class WebXInstructionBuffer {
     private readonly _buffer;
     private _offset;
+    /**
+     * Creates a new instance of WebXInstructionBuffer.
+     *
+     * @param instruction The WebX instruction.
+     * @param length The length of the buffer in bytes.
+     */
     constructor(instruction: WebXInstruction, length: number);
     private _getNextOffset;
     /**
      * Write a signed 32 bit integer to the buffer
+     * @param value the value to write
      */
     putInt32(value: number): WebXInstructionBuffer;
     /**
@@ -18,6 +31,11 @@ export declare class WebXInstructionBuffer {
      * @param value the value to write
      */
     putUInt32(value: number): WebXInstructionBuffer;
+    /**
+     * Write an array of unsigned 8 bit integers to the buffer
+     * @param array the array to write
+     * @param length the length of the array
+     */
     putUInt8Array(array: Uint8Array, length: number): WebXInstructionBuffer;
     /**
      * Write a string to the buffer
@@ -31,6 +49,7 @@ export declare class WebXInstructionBuffer {
     putBoolean(value: boolean): WebXInstructionBuffer;
     /**
      * Get the array buffer
+     * @returns the array buffer
      */
     buffer(): ArrayBuffer;
 }

package/dist/transport/WebXInstructionBuffer.js

@@ -1,7 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXInstructionBuffer = void 0;
+/**
+ * Represents a buffer for encoding and decoding WebX instructions.
+ *
+ * This class provides methods to write and read data in a structured format
+ * for communication with the WebX Engine.
+ */
 class WebXInstructionBuffer {
+    /**
+     * Creates a new instance of WebXInstructionBuffer.
+     *
+     * @param instruction The WebX instruction.
+     * @param length The length of the buffer in bytes.
+     */
     constructor(instruction, length) {
         // 16 for sessionID place holder (set by the relay), 4 for the clientId (set by the relay) and 8 for the instruction type and id, 4 padding
         // Maintain 8 bit alignment to ensure long values can be written without additional padding
@@ -28,6 +40,7 @@ class WebXInstructionBuffer {
     }
     /**
      * Write a signed 32 bit integer to the buffer
+     * @param value the value to write
      */
     putInt32(value) {
         const offset = this._getNextOffset(4);
@@ -55,6 +68,11 @@ class WebXInstructionBuffer {
         typedArray[0] = value;
         return this;
     }
+    /**
+     * Write an array of unsigned 8 bit integers to the buffer
+     * @param array the array to write
+     * @param length the length of the array
+     */
     putUInt8Array(array, length) {
         const offset = this._getNextOffset(8);
         const typedArray = new Uint8Array(this._buffer, offset, length);
@@ -81,6 +99,7 @@ class WebXInstructionBuffer {
     }
     /**
      * Get the array buffer
+     * @returns the array buffer
      */
     buffer() {
         return this._buffer;

package/dist/transport/WebXInstructionBuffer.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXInstructionBuffer.js","sourceRoot":"","sources":["../../src/transport/WebXInstructionBuffer.ts"],"names":[],"mappings":";;;AAEA,MAAa,qBAAqB;IAKhC,YAAY,WAA4B,EAAE,MAAc;QACtD,2IAA2I;QAC3I,2FAA2F;QAC3F,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,iBAAiB;QACjB,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAE/B,4DAA4D;QAC5D,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAEO,cAAc,CAAC,UAAkB;QACvC,mBAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7F,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAExC,IAAI,CAAC,OAAO,IAAI,UAAU,GAAG,OAAO,CAAC;QAErC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,KAAa;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3D,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,KAAa;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3D,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5D,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,KAAiB,EAAE,MAAc;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAChE,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,KAAa;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,KAAc;QAC9B,IAAI,CAAC,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CAEF;AArGD,sDAqGC"}
+{"version":3,"file":"WebXInstructionBuffer.js","sourceRoot":"","sources":["../../src/transport/WebXInstructionBuffer.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,MAAa,qBAAqB;IAKhC;;;;;OAKG;IACH,YAAY,WAA4B,EAAE,MAAc;QACtD,2IAA2I;QAC3I,2FAA2F;QAC3F,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,iBAAiB;QACjB,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAE/B,4DAA4D;QAC5D,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAEO,cAAc,CAAC,UAAkB;QACvC,mBAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7F,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAExC,IAAI,CAAC,OAAO,IAAI,UAAU,GAAG,OAAO,CAAC;QAErC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,KAAa;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3D,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,KAAa;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3D,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5D,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAiB,EAAE,MAAc;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAChE,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,KAAa;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,KAAc;QAC9B,IAAI,CAAC,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CAEF;AAlHD,sDAkHC"}

package/dist/transport/WebXInstructionEncoder.d.ts

@@ -1,14 +1,152 @@
 import { WebXInstruction } from '../instruction';
+/**
+ * Encodes WebX instructions into a format suitable for transmission.
+ * This class handles various instruction types and ensures they are
+ * serialized correctly.
+ */
 export declare class WebXInstructionEncoder {
+    /**
+     * Convert the given instruction to an array buffer ready to be sent along the wire
+     * @param instruction the instruction to encode
+     * @returns The encoded instruction as an ArrayBuffer.
+     */
     encode(instruction: WebXInstruction): ArrayBuffer;
+    /**
+     * Create a new mouse instruction
+     * @param instruction the mouse instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId:4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    x: 4 bytes
+     *    y: 4 bytes
+     *    buttonMask: 4 bytes
+     */
     private _createMouseInstruction;
+    /**
+     * Create a new cursor image instruction
+     * @param instruction the cursor image instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId:4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    cursorId: 4 bytes
+     */
     private _createCursorImageInstruction;
+    /**
+     * Create a new image instruction
+     * @param instruction the image instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId:4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    windowId: 4 bytes
+     */
     private _createImageInstruction;
+    /**
+     * Create a keyboard instruction
+     * @param instruction the keyboard instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 8 bytes
+     *    key (the keyboard key code): 4 bytes
+     *    pressed: 4 bytes
+     */
     private _createKeyboardInstruction;
+    /**
+     * Create a screen instruction
+     * @param instruction the screen instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     */
     private _createScreenInstruction;
+    /**
+     * Create a windows instruction
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     * @param instruction the windows instruction to encode
+     */
     private _createWindowsInstruction;
+    /**
+     * Create a connect instruction
+     * @param instruction the connect instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     */
     private _createConnectInstruction;
+    /**
+     * Create a new quality instruction
+     * @param instruction the quality instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    qualityIndex: 4 bytes
+     */
     private _createQualityInstruction;
+    /**
+     * Create a new pong instruction
+     * @param instruction the pong instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 8 bytes
+     *     timestampMs: 8 bytes
+     */
     private _createPongInstruction;
+    /**
+     * Create a new data ack instruction
+     * @param instruction the data ack instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 8 bytes
+     *     timestampMs: 8 bytes
+     *     dataLength: 4 bytes
+     */
     private _createDataAckInstruction;
 }

package/dist/transport/WebXInstructionEncoder.js

@@ -3,9 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXInstructionEncoder = void 0;
 const instruction_1 = require("../instruction");
 const _1 = require(".");
+/**
+ * Encodes WebX instructions into a format suitable for transmission.
+ * This class handles various instruction types and ensures they are
+ * serialized correctly.
+ */
 class WebXInstructionEncoder {
-    // Convert the given instruction to an array buffer ready to be sent along the wire
-    // @param instruction the instruction to encode
+    /**
+     * Convert the given instruction to an array buffer ready to be sent along the wire
+     * @param instruction the instruction to encode
+     * @returns The encoded instruction as an ArrayBuffer.
+     */
     encode(instruction) {
         if (instruction.type === instruction_1.WebXInstructionType.MOUSE) {
             return this._createMouseInstruction(instruction);
@@ -39,19 +47,21 @@ class WebXInstructionEncoder {
         }
         return null;
     }
-    // Create a new mouse instruction
-    // @param instruction the mouse instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId:4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    //   Content: 4 bytes
-    //    x: 4 bytes
-    //    y: 4 bytes
-    //    buttonMask: 4 bytes
+    /**
+     * Create a new mouse instruction
+     * @param instruction the mouse instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId:4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    x: 4 bytes
+     *    y: 4 bytes
+     *    buttonMask: 4 bytes
+     */
     _createMouseInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 12);
         return encoder
@@ -61,17 +71,19 @@ class WebXInstructionEncoder {
             .putUInt32(instruction.buttonMask)
             .buffer();
     }
-    // Create a new cursor image instruction
-    // @param instruction the cursor image instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId:4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    //   Content: 4 bytes
-    //    cursorId: 4 bytes
+    /**
+     * Create a new cursor image instruction
+     * @param instruction the cursor image instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId:4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    cursorId: 4 bytes
+     */
     _createCursorImageInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 4);
         return encoder
@@ -79,17 +91,19 @@ class WebXInstructionEncoder {
             .putInt32(instruction.cursorId)
             .buffer();
     }
-    // Create a new image instruction
-    // @param instruction the image instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId:4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    //   Content: 4 bytes
-    //    windowId: 4 bytes
+    /**
+     * Create a new image instruction
+     * @param instruction the image instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId:4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    windowId: 4 bytes
+     */
     _createImageInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 4);
         return encoder
@@ -97,18 +111,20 @@ class WebXInstructionEncoder {
             .putUInt32(instruction.windowId)
             .buffer();
     }
-    // Create a keyboard instruction
-    // @param instruction the keyboard instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId: 4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    //   Content: 8 bytes
-    //    key (the keyboard key code): 4 bytes
-    //    pressed: 4 bytes
+    /**
+     * Create a keyboard instruction
+     * @param instruction the keyboard instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 8 bytes
+     *    key (the keyboard key code): 4 bytes
+     *    pressed: 4 bytes
+     */
     _createKeyboardInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 8);
         return encoder
@@ -117,56 +133,64 @@ class WebXInstructionEncoder {
             .putBoolean(instruction.pressed)
             .buffer();
     }
-    // Create a screen instruction
-    // @param instruction the screen instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId: 4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
+    /**
+     * Create a screen instruction
+     * @param instruction the screen instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     */
     _createScreenInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 0);
         return encoder.buffer();
     }
-    // Create a windows instruction
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId: 4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    // @param instruction the windows instruction to encode
+    /**
+     * Create a windows instruction
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     * @param instruction the windows instruction to encode
+     */
     _createWindowsInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 0);
         return encoder.buffer();
     }
-    // Create a connect instruction
-    // @param instruction the connect instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId: 4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
+    /**
+     * Create a connect instruction
+     * @param instruction the connect instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     */
     _createConnectInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 0);
         return encoder.buffer();
     }
-    // Create a new quality instruction
-    // @param instruction the quality instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId: 4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    //   Content: 4 bytes
-    //    qualityIndex: 4 bytes
+    /**
+     * Create a new quality instruction
+     * @param instruction the quality instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 4 bytes
+     *    qualityIndex: 4 bytes
+     */
     _createQualityInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 4);
         return encoder
@@ -174,17 +198,19 @@ class WebXInstructionEncoder {
             .putUInt32(instruction.qualityIndex)
             .buffer();
     }
-    // Create a new pong instruction
-    // @param instruction the pong instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId: 4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    //   Content: 8 bytes
-    //     timestampMs: 8 bytes
+    /**
+     * Create a new pong instruction
+     * @param instruction the pong instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 8 bytes
+     *     timestampMs: 8 bytes
+     */
     _createPongInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 8);
         return encoder
@@ -192,18 +218,20 @@ class WebXInstructionEncoder {
             .putUInt8Array(instruction.timestampMs, 8)
             .buffer();
     }
-    // Create a new data ack instruction
-    // @param instruction the data ack instruction to encode
-    // Structure:
-    //   Header: 32 bytes
-    //    sessionId: 16 bytes
-    //    clientId: 4 bytes
-    //    type: 4 bytes
-    //    id: 4 bytes
-    //    padding: 4 bytes
-    //   Content: 8 bytes
-    //     timestampMs: 8 bytes
-    //     dataLength: 4 bytes
+    /**
+     * Create a new data ack instruction
+     * @param instruction the data ack instruction to encode
+     * Structure:
+     *   Header: 32 bytes
+     *    sessionId: 16 bytes
+     *    clientId: 4 bytes
+     *    type: 4 bytes
+     *    id: 4 bytes
+     *    padding: 4 bytes
+     *   Content: 8 bytes
+     *     timestampMs: 8 bytes
+     *     dataLength: 4 bytes
+     */
     _createDataAckInstruction(instruction) {
         const encoder = new _1.WebXInstructionBuffer(instruction, 12);
         return encoder

package/dist/transport/WebXInstructionEncoder.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXInstructionEncoder.js","sourceRoot":"","sources":["../../src/transport/WebXInstructionEncoder.ts"],"names":[],"mappings":";;;AAAA,gDAawB;AACxB,wBAA0C;AAE1C,MAAa,sBAAsB;IAEjC,mFAAmF;IACnF,+CAA+C;IACxC,MAAM,CAAC,WAA4B;QACxC,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAmC,CAAC,CAAC;QAE3E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,QAAQ,EAAE,CAAC;YAC7D,OAAO,IAAI,CAAC,0BAA0B,CAAC,WAAsC,CAAC,CAAC;QAEjF,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,YAAY,EAAE,CAAC;YACjE,OAAO,IAAI,CAAC,6BAA6B,CAAC,WAAyC,CAAC,CAAC;QAEvF,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,KAAK,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAmC,CAAC,CAAC;QAE3E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,OAAO,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAE/E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,MAAM,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,wBAAwB,CAAC,WAAoC,CAAC,CAAC;QAE7E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,OAAO,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAE/E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,OAAO,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAE/E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,IAAI,EAAE,CAAC;YACzD,OAAO,IAAI,CAAC,sBAAsB,CAAC,WAAkC,CAAC,CAAC;QAEzE,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,QAAQ,EAAE,CAAC;YAC7D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iCAAiC;IACjC,qDAAqD;IACrD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,sBAAsB;IACtB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,gBAAgB;IAChB,gBAAgB;IAChB,yBAAyB;IACjB,uBAAuB,CAAC,WAAiC;QAC/D,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC3D,OAAO,OAAO;YACZ,qBAAqB;aACpB,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;aACvB,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;aACvB,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC;aACjC,MAAM,EAAE,CAAC;IACd,CAAC;IAED,wCAAwC;IACxC,4DAA4D;IAC5D,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,sBAAsB;IACtB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,uBAAuB;IACf,6BAA6B,CAAC,WAAuC;QAC3E,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC;aAC9B,MAAM,EAAE,CAAC;IACd,CAAC;IAED,iCAAiC;IACjC,qDAAqD;IACrD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,sBAAsB;IACtB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,uBAAuB;IACf,uBAAuB,CAAC,WAAiC;QAC/D,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC;aAC/B,MAAM,EAAE,CAAC;IACd,CAAC;IAED,gCAAgC;IAChC,wDAAwD;IACxD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,uBAAuB;IACvB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,0CAA0C;IAC1C,sBAAsB;IACd,0BAA0B,CAAC,WAAoC;QACrE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC;aAC1B,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC;aAC/B,MAAM,EAAE,CAAC;IACd,CAAC;IAED,8BAA8B;IAC9B,sDAAsD;IACtD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,uBAAuB;IACvB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACd,wBAAwB,CAAC,WAAkC;QACjE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;IAED,+BAA+B;IAC/B,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,uBAAuB;IACvB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,uDAAuD;IAC/C,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;IAED,+BAA+B;IAC/B,uDAAuD;IACvD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,uBAAuB;IACvB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACd,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;IAGD,mCAAmC;IACnC,uDAAuD;IACvD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,uBAAuB;IACvB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,2BAA2B;IACnB,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;aACnC,MAAM,EAAE,CAAC;IACd,CAAC;IAED,gCAAgC;IAChC,oDAAoD;IACpD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,uBAAuB;IACvB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,2BAA2B;IACnB,sBAAsB,CAAC,WAAgC;QAC7D,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,aAAa,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;aACzC,MAAM,EAAE,CAAC;IACd,CAAC;IAED,oCAAoC;IACpC,wDAAwD;IACxD,aAAa;IACb,qBAAqB;IACrB,yBAAyB;IACzB,uBAAuB;IACvB,mBAAmB;IACnB,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,2BAA2B;IAC3B,0BAA0B;IAClB,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC3D,OAAO,OAAO;YACZ,qBAAqB;aACpB,aAAa,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;aACzC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC;aACjC,MAAM,EAAE,CAAC;IACd,CAAC;CAEF;AA9ND,wDA8NC"}
+{"version":3,"file":"WebXInstructionEncoder.js","sourceRoot":"","sources":["../../src/transport/WebXInstructionEncoder.ts"],"names":[],"mappings":";;;AAAA,gDAawB;AACxB,wBAA0C;AAE1C;;;;GAIG;AACH,MAAa,sBAAsB;IAEjC;;;;OAIG;IACI,MAAM,CAAC,WAA4B;QACxC,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAmC,CAAC,CAAC;QAE3E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,QAAQ,EAAE,CAAC;YAC7D,OAAO,IAAI,CAAC,0BAA0B,CAAC,WAAsC,CAAC,CAAC;QAEjF,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,YAAY,EAAE,CAAC;YACjE,OAAO,IAAI,CAAC,6BAA6B,CAAC,WAAyC,CAAC,CAAC;QAEvF,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,KAAK,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAmC,CAAC,CAAC;QAE3E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,OAAO,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAE/E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,MAAM,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,wBAAwB,CAAC,WAAoC,CAAC,CAAC;QAE7E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,OAAO,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAE/E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,OAAO,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAE/E,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,IAAI,EAAE,CAAC;YACzD,OAAO,IAAI,CAAC,sBAAsB,CAAC,WAAkC,CAAC,CAAC;QAEzE,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,iCAAmB,CAAC,QAAQ,EAAE,CAAC;YAC7D,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAqC,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACK,uBAAuB,CAAC,WAAiC;QAC/D,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC3D,OAAO,OAAO;YACZ,qBAAqB;aACpB,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;aACvB,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;aACvB,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC;aACjC,MAAM,EAAE,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,6BAA6B,CAAC,WAAuC;QAC3E,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC;aAC9B,MAAM,EAAE,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,uBAAuB,CAAC,WAAiC;QAC/D,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC;aAC/B,MAAM,EAAE,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,0BAA0B,CAAC,WAAoC;QACrE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC;aAC1B,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC;aAC/B,MAAM,EAAE,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACK,wBAAwB,CAAC,WAAkC;QACjE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACK,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACK,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;IAGD;;;;;;;;;;;;OAYG;IACK,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;aACnC,MAAM,EAAE,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,sBAAsB,CAAC,WAAgC;QAC7D,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO;YACZ,qBAAqB;aACpB,aAAa,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;aACzC,MAAM,EAAE,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,yBAAyB,CAAC,WAAmC;QACnE,MAAM,OAAO,GAAG,IAAI,wBAAqB,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC3D,OAAO,OAAO;YACZ,qBAAqB;aACpB,aAAa,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;aACzC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC;aACjC,MAAM,EAAE,CAAC;IACd,CAAC;CAEF;AArPD,wDAqPC"}