@illgrenoble/webx-client 1.9.2 → 1.9.4

package/dist/src/transport/WebXBinarySerializer.d.ts

@@ -1,31 +0,0 @@
-import { WebXInstruction } from '../instruction';
-import { WebXMessage } from '../message';
-import { WebXMessageBuffer } from '.';
-import { WebXTextureFactory } from '../display';
-/**
- * Serializes and deserializes WebX instructions and messages.
- */
-export declare class WebXBinarySerializer {
-    private readonly _instructionEncoder;
-    private readonly _messageDecoder;
-    /**
-     * Creates a new instance of WebXBinarySerializer.
-     *
-     * @param textureFactory The texture factory used for decoding image data.
-     */
-    constructor(textureFactory: WebXTextureFactory);
-    /**
-     * Serializes a WebXInstruction into a binary ArrayBuffer.
-     *
-     * @param instruction The instruction to serialize.
-     * @returns The serialized ArrayBuffer.
-     */
-    serializeInstruction(instruction: WebXInstruction): ArrayBuffer;
-    /**
-     * Deserializes a binary message buffer into a WebXMessage object.
-     *
-     * @param buffer The binary message buffer to deserialize.
-     * @returns A promise that resolves to the deserialized WebXMessage.
-     */
-    deserializeMessage(buffer: WebXMessageBuffer): Promise<WebXMessage>;
-}

package/dist/src/transport/WebXBinarySerializer.js

@@ -1,63 +0,0 @@
-"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.WebXBinarySerializer = void 0;
-const _1 = require(".");
-/**
- * Serializes and deserializes WebX instructions and messages.
- */
-class WebXBinarySerializer {
-    /**
-     * Creates a new instance of WebXBinarySerializer.
-     *
-     * @param textureFactory The texture factory used for decoding image data.
-     */
-    constructor(textureFactory) {
-        this._instructionEncoder = new _1.WebXInstructionEncoder();
-        this._messageDecoder = new _1.WebXMessageDecoder(textureFactory);
-    }
-    /**
-     * Serializes a WebXInstruction into a binary ArrayBuffer.
-     *
-     * @param instruction The instruction to serialize.
-     * @returns The serialized ArrayBuffer.
-     */
-    serializeInstruction(instruction) {
-        // return instruction.toJsonString();
-        const encoded = this._instructionEncoder.encode(instruction);
-        if (encoded == null) {
-            console.warn('Could not serialize instruction: Unknown type');
-        }
-        return encoded;
-    }
-    /**
-     * Deserializes a binary message buffer into a WebXMessage object.
-     *
-     * @param buffer The binary message buffer to deserialize.
-     * @returns A promise that resolves to the deserialized WebXMessage.
-     */
-    deserializeMessage(buffer) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const message = yield this._messageDecoder.decode(buffer);
-                if (message == null) {
-                    console.error(`Failed to decode message data`);
-                }
-                return message;
-            }
-            catch (error) {
-                console.error(`Caught error decoding message data: ${error.message}`);
-            }
-        });
-    }
-}
-exports.WebXBinarySerializer = WebXBinarySerializer;
-//# sourceMappingURL=WebXBinarySerializer.js.map

package/dist/src/transport/WebXBinarySerializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebXBinarySerializer.js","sourceRoot":"","sources":["../../../src/transport/WebXBinarySerializer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,wBAAkF;AAGlF;;GAEG;AACH,MAAa,oBAAoB;IAK/B;;;;OAIG;IACH,YAAY,cAAkC;QAC5C,IAAI,CAAC,mBAAmB,GAAG,IAAI,yBAAsB,EAAE,CAAC;QACxD,IAAI,CAAC,eAAe,GAAG,IAAI,qBAAkB,CAAC,cAAc,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,WAA4B;QAC/C,qCAAqC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACG,kBAAkB,CAAC,MAAyB;;YAChD,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC1D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;gBACjD,CAAC;gBACD,OAAO,OAAO,CAAC;YAEjB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;KAAA;CAGF;AAlDD,oDAkDC"}

package/dist/src/transport/WebXInstructionBuffer.d.ts

@@ -1,55 +0,0 @@
-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;
-    /**
-     * Write an unsigned 8 bit integer to the buffer
-     * @param value the value to write
-     */
-    putUInt8(value: number): WebXInstructionBuffer;
-    /**
-     * Write an unsigned 32 bit integer to the buffer
-     * @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
-     * @param value the value to write
-     */
-    putString(value: string): WebXInstructionBuffer;
-    /**
-     * Write a boolean to the buffer
-     * @param value the value to write
-     */
-    putBoolean(value: boolean): WebXInstructionBuffer;
-    /**
-     * Get the array buffer
-     * @returns the array buffer
-     */
-    buffer(): ArrayBuffer;
-}

package/dist/src/transport/WebXInstructionBuffer.js

@@ -1,109 +0,0 @@
-"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
-        const headerSize = 32;
-        this._buffer = new ArrayBuffer(length + headerSize);
-        this._offset = 20;
-        // add the header
-        if (instruction.synchronous) {
-            this.putUInt32(0x80000000 | instruction.type);
-        }
-        else {
-            this.putUInt32(instruction.type);
-        }
-        this.putUInt32(instruction.id);
-        // Padding to make up 32 bytes (maintaining 8 bit alignment)
-        this.putUInt32(0);
-    }
-    _getNextOffset(sizeOfData) {
-        // Ensure alignment
-        const padding = this._offset % sizeOfData > 0 ? sizeOfData - (this._offset % sizeOfData) : 0;
-        const position = this._offset + padding;
-        this._offset += sizeOfData + padding;
-        return position;
-    }
-    /**
-     * Write a signed 32 bit integer to the buffer
-     * @param value the value to write
-     */
-    putInt32(value) {
-        const offset = this._getNextOffset(4);
-        const typedArray = new Int32Array(this._buffer, offset, 1);
-        typedArray[0] = value;
-        return this;
-    }
-    /**
-     * Write an unsigned 8 bit integer to the buffer
-     * @param value the value to write
-     */
-    putUInt8(value) {
-        const offset = this._getNextOffset(1);
-        const typedArray = new Uint8Array(this._buffer, offset, 1);
-        typedArray[0] = value;
-        return this;
-    }
-    /**
-     * Write an unsigned 32 bit integer to the buffer
-     * @param value the value to write
-     */
-    putUInt32(value) {
-        const offset = this._getNextOffset(4);
-        const typedArray = new Uint32Array(this._buffer, offset, 1);
-        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);
-        typedArray.set(array);
-        return this;
-    }
-    /**
-     * Write a string to the buffer
-     * @param value the value to write
-     */
-    putString(value) {
-        for (let i = 0; i < value.length; i++) {
-            this.putUInt8(value.charCodeAt(i));
-        }
-        return this;
-    }
-    /**
-     * Write a boolean to the buffer
-     * @param value the value to write
-     */
-    putBoolean(value) {
-        this.putUInt32(value === true ? 0xff : 0x00);
-        return this;
-    }
-    /**
-     * Get the array buffer
-     * @returns the array buffer
-     */
-    buffer() {
-        return this._buffer;
-    }
-}
-exports.WebXInstructionBuffer = WebXInstructionBuffer;
-//# sourceMappingURL=WebXInstructionBuffer.js.map

package/dist/src/transport/WebXInstructionBuffer.js.map

@@ -1 +0,0 @@
-{"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/src/transport/WebXInstructionEncoder.d.ts

@@ -1,181 +0,0 @@
-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;
-    /**
-     * Create a new clipboard instruction
-     * @param instruction the clipboard instruction to encode
-     * Structure:
-     *   Header: 32 bytes
-     *    sessionId: 16 bytes
-     *    clientId: 4 bytes
-     *    type: 4 bytes
-     *    id: 4 bytes
-     *    padding: 4 bytes
-     *   Content:
-     *     clipboardContentLength: 4 bytes
-     *     clipboardContent: N bytes
-     */
-    private _createClipboardInstruction;
-    /**
-     * Create a new shape instruction
-     * @param instruction the shape 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 _createShapeInstruction;
-}