thor-io.vnext 2.0.6 → 3.1.0-beta.2

package/src/Messages/BufferMessage.ts

@@ -1,69 +1,70 @@
-import { TextMessage } from './TextMessage';
-import { ITransportMessage } from '../Interfaces/ITransportMessage';
-/**
- *
- *
- * @export
- * @class BufferMessage
- * @implements {ITransportMessage}
- */
-export class BufferMessage implements ITransportMessage {
-    /**
-     * Creates an instance of BufferMessage.
-     *
-     * @param {Buffer} data
-     * @param {boolean} binary
-     *
-     * @memberOf BufferMessage
-     */
-    constructor(public data: Buffer, public binary: boolean) {
-    }
-    /**
-     *
-     *
-     * @returns {TextMessage}
-     *
-     * @memberOf BufferMessage
-     */
-    toMessage(): TextMessage {
-        const headerLen = 3;
-        const tLen = this.data.readUInt8(0);
-        const cLen = this.data.readUInt8(1);
-        const dLen = this.data.readUInt8(2);
-        let offset = headerLen;
-        const topic = this.data.toString("utf-8", offset, tLen + offset);
-        offset += tLen;
-        const controller = this.data.toString("utf-8", offset, offset + cLen);
-        offset += cLen;
-        const data = this.data.toString("utf-8", offset, offset + dLen);
-        let message = new TextMessage(topic, data, controller);
-        return message;
-    }
-    /**
-     *
-     *
-     * @returns {Buffer}
-     *
-     * @memberOf BufferMessage
-     */
-    toBuffer(): Buffer {
-        let message = JSON.parse(this.data.toString()) as TextMessage;
-        const header = 3;
-        let offset = 0;
-        const tLen = message.T.length;
-        const dLen = message.D.length;
-        const cLen = message.C.length;
-        let bufferSize = header + tLen + dLen + cLen;
-        let buffer = new Buffer(bufferSize);
-        buffer.writeUInt8(tLen, 0);
-        buffer.writeUInt8(cLen, 1);
-        buffer.writeInt8(dLen, 2);
-        offset = header;
-        buffer.write(message.T, offset);
-        offset += tLen;
-        buffer.write(message.C, offset);
-        offset += cLen;
-        buffer.write(message.D, offset);
-        return buffer;
-    }
-}
+import { ITransportMessage } from '../Interfaces/ITransportMessage';
+import { TextMessage } from './TextMessage';
+
+/**
+ *
+ *
+ * @export
+ * @class BufferMessage
+ * @implements {ITransportMessage}
+ */
+export class BufferMessage implements ITransportMessage {
+    /**
+     * Creates an instance of BufferMessage.
+     *
+     * @param {Buffer} data
+     * @param {boolean} isBinary
+     *
+     * @memberOf BufferMessage
+     */
+    constructor(public data: Buffer, public isBinary: boolean) {
+    }
+    /**
+     *
+     *
+     * @returns {TextMessage}
+     *
+     * @memberOf BufferMessage
+     */
+    toMessage(): TextMessage {
+        const headerLen = 3;
+        const tLen = this.data.readUInt8(0);
+        const cLen = this.data.readUInt8(1);
+        const dLen = this.data.readUInt8(2);
+        let offset = headerLen;
+        const topic = this.data.toString("utf-8", offset, tLen + offset);
+        offset += tLen;
+        const controller = this.data.toString("utf-8", offset, offset + cLen);
+        offset += cLen;
+        const data = this.data.toString("utf-8", offset, offset + dLen);
+        let message = new TextMessage(topic, data, controller);
+        return message;
+    }
+    /**
+     *
+     *
+     * @returns {Buffer}
+     *
+     * @memberOf BufferMessage
+     */
+    toBuffer(): Buffer {
+        let message = JSON.parse(this.data.toString()) as TextMessage;
+        const header = 3;
+        let offset = 0;
+        const tLen = message.T.length;
+        const dLen = message.D.length;
+        const cLen = message.C.length;
+        let bufferSize = header + tLen + dLen + cLen;
+        let buffer = new Buffer(bufferSize);
+        buffer.writeUInt8(tLen, 0);
+        buffer.writeUInt8(cLen, 1);
+        buffer.writeInt8(dLen, 2);
+        offset = header;
+        buffer.write(message.T, offset);
+        offset += tLen;
+        buffer.write(message.C, offset);
+        offset += cLen;
+        buffer.write(message.D, offset);
+        return buffer;
+    }
+}

package/src/Messages/ErrorMessage.ts

@@ -1,6 +1,34 @@
-export class ErrorMessage {
-    message: string;
-    constructor(message: string) {
-        this.message = message;
-    }
-}
+/**
+ * Represents an error message with a timestamp.
+ * 
+ * @export
+ * @class ErrorMessage
+ */
+export class ErrorMessage {
+    /**
+     * The error message content.
+     * 
+     * @type {string}
+     * @memberof ErrorMessage
+     */
+    public message: string;
+
+    /**
+     * The timestamp when the error message was created.
+     * 
+     * @type {Date}
+     * @memberof ErrorMessage
+     */
+    public timestamp: Date;
+
+    /**
+     * Creates an instance of the ErrorMessage class.
+     * 
+     * @param {string} message The error message content.
+     * @memberof ErrorMessage
+     */
+    constructor(message: string) {
+        this.message = message;
+        this.timestamp = new Date();
+    }
+}

package/src/Messages/PipeMessage.ts

@@ -1,62 +1,56 @@
-import { TextMessage } from './TextMessage';
-import { ITransportMessage } from '../Interfaces/ITransportMessage';
-/**
- *
- *
- * @export
- * @class PipeMessage
- * @implements {ITransportMessage}
- */
-export class PipeMessage implements ITransportMessage {
-    /**
-     *
-     *
-     * @private
-     * @type {TextMessage}
-     * @memberOf PipeMessage
-     */
-    private message: TextMessage;
-    /**
-     *
-     *
-     * @private
-     * @type {Array<string>}
-     * @memberOf PipeMessage
-     */
-    private arr: Array<string>;
-    /**
-     * Creates an instance of PipeMessage.
-     *
-     * @param {*} data
-     * @param {boolean} binary
-     *
-     * @memberOf PipeMessage
-     */
-    constructor(public data: any, public binary: boolean) {
-        this.message = JSON.parse(this.data) as TextMessage;
-        this.arr = new Array<string>();
-        this.arr.push(this.message.C);
-        this.arr.push(this.message.T);
-        this.arr.push(this.message.D);
-    }
-    /**
-     *
-     *
-     * @returns
-     *
-     * @memberOf PipeMessage
-     */
-    toBuffer() {
-        return new Buffer(this.arr.join("|"));
-    }
-    /**
-     *
-     *
-     * @returns {TextMessage}
-     *
-     * @memberOf PipeMessage
-     */
-    public toMessage(): TextMessage {
-        return this.message;
-    }
-}
+import { ITransportMessage } from '../Interfaces/ITransportMessage';
+import { TextMessage } from './TextMessage';
+
+/**
+ * Represents a message transported via pipes, encapsulating a `TextMessage`.
+ *
+ * @export
+ * @class PipeMessage
+ * @implements {ITransportMessage}
+ */
+export class PipeMessage implements ITransportMessage {
+    /**
+     * The encapsulated `TextMessage` instance.
+     *
+     * @private
+     * @type {TextMessage}
+     */
+    private message: TextMessage;
+
+    /**
+     * Array representation of the message components for serialization.
+     *
+     * @private
+     * @type {Array<string>}
+     */
+    private arr: Array<string>;
+
+    /**
+     * Creates an instance of `PipeMessage`.
+     *
+     * @param {*} data - The raw data representing the message.
+     * @param {boolean} isBinary - Indicates if the data is in binary format.
+     */
+    constructor(public data: any, public isBinary: boolean) {
+        this.message = JSON.parse(data) as TextMessage;
+        this.arr = [this.message.C, this.message.T, this.message.D];
+    }
+
+    /**
+     * Serializes the `PipeMessage` to a `Buffer`.
+     *
+     * @returns {Buffer} A buffer containing the serialized message data.
+     */
+    toBuffer(): Buffer {
+        return Buffer.from(this.arr.join("|"), 'utf-8');
+    }
+
+    /**
+     * Converts the `PipeMessage` back to a `TextMessage` instance.
+     *
+     * @returns {TextMessage} The encapsulated `TextMessage`.
+     */
+    public toMessage(): TextMessage {
+        return this.message;
+    }
+}

package/src/Messages/TextMessage.ts

@@ -1,93 +1,139 @@
-import { BufferUtils } from '../Utils/BufferUtils';
-import { Utils } from 'thor-io.client-vnext';
-/**
- *
- *
- * @export
- * @class Message
- */
-export class TextMessage {
-    B: Buffer;
-    T: string;
-    D: any;
-    C: string;
-    isBinary: Boolean;
-    I:string;
-    F: boolean
-    get JSON(): any {
-        return {
-            T: this.T,
-            D: JSON.stringify(this.D),
-            C: this.C,
-            I: this.I,
-            F: this.F
-        };
-    }
-    ;
-    /**
-     * Creates an instance of Message.
-     *
-     * @param {string} topic
-     * @param {string} data
-     * @param {string} controller
-     * @param {Buffer} [arrayBuffer]
-     *
-     * @memberOf Message
-     */
-    constructor(topic: string, data: any, controller: string, arrayBuffer?: Buffer,uuid?:string,isFinal?:boolean) {
-        this.D = data;
-        this.T = topic;
-        this.C = controller;
-        this.B = arrayBuffer;
-        this.I = uuid || Utils.newGuid();
-        this.F = true;
-        if (arrayBuffer)
-            this.isBinary = true;
-    }
-    /**
-     *
-     *
-     * @returns
-     *
-     * @memberOf Message
-     */
-    toString() {
-        return JSON.stringify(this.JSON);
-    }
-    /**
-     *
-     *
-     * @static
-     * @param {Buffer} buffer
-     * @returns {TextMessage}
-     *
-     * @memberOf Message
-     */
-    static fromArrayBuffer(buffer: Buffer): TextMessage {
-        let headerLen = 8;
-        let header = buffer.slice(0, 8);
-        let payloadLength = BufferUtils.arrayToLong(header);
-        let message = buffer.slice(headerLen, payloadLength + headerLen);
-        let blobOffset = headerLen + payloadLength;
-        let blob = buffer.slice(blobOffset, buffer.byteLength);
-        let data = JSON.parse(message.toString()) as TextMessage
-        return new TextMessage(data.T, data.D, data.C, blob,data.I,data.F);
-    }
-    /**
-     *
-     *
-     * @returns {Buffer}
-     *
-     * @memberOf Message
-     */
-    toArrayBuffer(): Buffer {
-        let messagePayload = this.toString();
-        let payloadLength = messagePayload.length;
-        let header = new Buffer(BufferUtils.longToArray(payloadLength));
-        let message = new Buffer(payloadLength);
-        message.write(messagePayload, 0, payloadLength, "utf-8");
-        var blob = new Buffer(this.B);
-        var buffer = Buffer.concat([header, message, blob]);
-        return buffer;
-    }
-}
+import { BufferUtils } from '../Utils/BufferUtils';
+import { StringUtils } from '../Utils/StringUtils';
+
+/**
+ * Represents a text message with optional binary data.
+ *
+ * @export
+ * @class TextMessage
+ */
+export class TextMessage {
+    /**
+     * Binary data associated with the message (if any).
+     *
+     * @type {Buffer | undefined}
+     */
+    B: Buffer | undefined;
+
+    /**
+     * Topic of the message.
+     *
+     * @type {string}
+     */
+    T: string;
+
+    /**
+     * Data payload of the message.
+     *
+     * @type {any}
+     */
+    D: any;
+
+    /**
+     * Controller of the message.
+     *
+     * @type {string}
+     */
+    C: string;
+
+    /**
+     * Indicates whether the message contains binary data.
+     *
+     * @type {boolean}
+     */
+    isBinary: boolean = false;
+
+    /**
+     * Unique identifier for the message.
+     *
+     * @type {string}
+     */
+    I: string;
+
+    /**
+     * Indicates if this is the final message in a sequence.
+     *
+     * @type {boolean}
+     */
+    F: boolean;
+
+    /**
+     * Gets the JSON representation of the message.
+     *
+     * @readonly
+     * @type {any}
+     */
+    get JSON(): any {
+        return {
+            T: this.T,
+            D: JSON.stringify(this.D),
+            C: this.C,
+            I: this.I,
+            F: this.F,
+        };
+    }
+
+    /**
+     * Creates an instance of `TextMessage`.
+     *
+     * @param {string} topic - Topic of the message.
+     * @param {any} data - Data payload of the message.
+     * @param {string} controller - Controller of the message.
+     * @param {Buffer} [arrayBuffer] - Optional binary data.
+     * @param {string} [uuid] - Optional unique identifier.
+     * @param {boolean} [isFinal] - Indicates if this is the final message in a sequence.
+     */
+    constructor(topic: string, data: any, controller: string, arrayBuffer?: Buffer, uuid?: string, isFinal?: boolean) {
+        this.D = data;
+        this.T = topic;
+        this.C = controller;
+        this.B = arrayBuffer;
+        this.I = uuid || StringUtils.newGuid();
+        this.F = isFinal ?? true; // Default to true if not provided
+
+        if (arrayBuffer) {
+            this.isBinary = true;
+        }
+    }
+
+    /**
+     * Returns a string representation of the message.
+     *
+     * @returns {string} The JSON string representation of the message.
+     */
+    toString(): string {
+        return JSON.stringify(this.JSON);
+    }
+
+    /**
+     * Creates a `TextMessage` instance from a `Buffer`.
+     *
+     * @static
+     * @param {Buffer} buffer - The buffer containing the message data.
+     * @returns {TextMessage} The parsed `TextMessage` instance.
+     */
+    static fromArrayBuffer(buffer: Buffer): TextMessage {
+        const headerLen = 8;
+        const header = buffer.slice(0, headerLen);
+        const payloadLength = BufferUtils.arrayToLong(header);
+        const message = buffer.slice(headerLen, payloadLength + headerLen);
+        const blobOffset = headerLen + payloadLength;
+        const blob = buffer.slice(blobOffset, buffer.byteLength);
+        const data = JSON.parse(message.toString()) as TextMessage;
+        return new TextMessage(data.T, data.D, data.C, blob, data.I, data.F);
+    }
+
+    /**
+     * Converts the `TextMessage` to a `Buffer`.
+     *
+     * @returns {Buffer} The buffer representation of the message.
+     */
+    toArrayBuffer(): Buffer {
+        const messagePayload = this.toString();
+        const payloadLength = messagePayload.length;
+        const header = Buffer.from(BufferUtils.longToArray(payloadLength));
+        const message = Buffer.from(messagePayload, 'utf-8');
+        const blob = this.B ? Buffer.from(this.B) : Buffer.alloc(0); 
+        return Buffer.concat([header, message, blob]);
+    }
+}

package/src/Messages/WebSocketMessage.ts

@@ -1,41 +1,39 @@
-import { TextMessage } from './TextMessage';
-import { ITransportMessage } from '../Interfaces/ITransportMessage';
-/**
- *
- *
- * @export
- * @class WebSocketMessage
- * @implements {ITransportMessage}
- */
-export class WebSocketMessage implements ITransportMessage {
-    /**
-     * Creates an instance of WebSocketMessage.
-     *
-     * @param {string} data
-     * @param {any} binary
-     *
-     * @memberOf WebSocketMessage
-     */
-    constructor(public data: string, public binary) {
-    }
-    /**
-     *
-     *
-     * @returns {Buffer}
-     *
-     * @memberOf WebSocketMessage
-     */
-    toBuffer(): Buffer {
-        throw "not yet implemented";
-    }
-    /**
-     *
-     *
-     * @returns {TextMessage}
-     *
-     * @memberOf WebSocketMessage
-     */
-    toMessage(): TextMessage {
-        return JSON.parse(this.data) as TextMessage;
-    }
-}
+import { ITransportMessage } from '../Interfaces/ITransportMessage';
+import { TextMessage } from './TextMessage';
+
+/**
+ * Represents a WebSocket message, encapsulating data and its type (binary or text).
+ *
+ * @export
+ * @class WebSocketMessage
+ * @implements {ITransportMessage}
+ */
+export class WebSocketMessage implements ITransportMessage {
+    /**
+     * Creates an instance of `WebSocketMessage`.
+     *
+     * @param {string} data - The raw message data as a string.
+     * @param {boolean} isBinary - Indicates whether the message is binary.
+     */
+    constructor(public data: string, public isBinary: boolean) {}
+
+    /**
+     * Converts the message to a `Buffer` object.
+     * **Note:** This method is not yet implemented.
+     *
+     * @throws {Error} Throws an error indicating that the method is not implemented.
+     * @returns {Buffer}
+     */
+    toBuffer(): Buffer {
+        throw new Error("toBuffer is not yet implemented");
+    }
+
+    /**
+     * Parses the raw string data and converts it into a `TextMessage` instance.
+     *
+     * @returns {TextMessage} The parsed `TextMessage` object.
+     */
+    toMessage(): TextMessage {
+        return JSON.parse(this.data) as TextMessage;
+    }
+}

package/src/Server/Plugin.ts

@@ -0,0 +1,56 @@
+import { StringUtils } from '../Utils/StringUtils';
+
+/**
+ * Describes the structure of a plugin descriptor.
+ */
+export interface PluginDescriptor {
+  name: string;
+  methods: string[];
+  properties: string[];
+}
+
+/**
+ * Represents a plugin with a specific type.
+ * @template T The type of the plugin instance.
+ */
+export class Plugin<T extends Object> {
+  /**
+   * The alias of the plugin.
+   */
+  public alias: string;
+
+  /**
+   * The instance of the plugin.
+   * @private
+   */
+  private instance: T;
+
+  /**
+   * The unique identifier of the plugin.
+   */
+  id: string;
+
+  /**
+   * Creates an instance of Plugin.
+   * @param {T} object The plugin instance.
+   */
+  constructor(object: T) {
+    this.id = StringUtils.newGuid();
+    this.alias = Reflect.getMetadata("alias", object);
+    this.instance = object;
+    const metaData = Reflect.getMetadataKeys(object);
+    metaData.forEach(metaDataKey => {
+      console.info(`Controller settings  ${metaDataKey} = `, Reflect.getOwnMetadata(metaDataKey, object));
+    });
+    console.info(`Created the plugin with an id of ${this.id}`);
+  }
+
+  /**
+   * Gets the instance of the plugin.
+   * @returns {T} The plugin instance.
+   */
+  getInstance(): T {
+    return this.instance;
+  }
+}
+