thor-io.vnext 2.0.5-beta.3 → 3.1.0-beta.1

package/.gitattributes

@@ -1,17 +1,17 @@
-# Auto detect text files and perform LF normalization
-* text=auto
-
-# Custom for Visual Studio
-*.cs     diff=csharp
-
-# Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
-*.docx diff=astextplain
-*.DOCX diff=astextplain
-*.dot  diff=astextplain
-*.DOT  diff=astextplain
-*.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

package/build/index.d.ts

@@ -0,0 +1,24 @@
+export { ThorIOServer } from './src/Server/ThorIOServer';
+export { Connection } from './src/Connection/Connection';
+export { ControllerBase } from './src/Controller/ControllerBase';
+export { Subscription } from './src/Controller/Subscription';
+export { BufferUtils } from './src/Utils/BufferUtils';
+export { Plugin } from './src/Server/Plugin';
+export { TextMessage } from './src/Messages/TextMessage';
+export { ErrorMessage } from './src/Messages/ErrorMessage';
+export { PipeMessage } from './src/Messages/PipeMessage';
+export { WebSocketMessage } from './src/Messages/WebSocketMessage';
+export { BufferMessage } from './src/Messages/BufferMessage';
+export { PipeMessageTransport } from './src/Transports/PipeMessageTransport';
+export { WebSocketMessageTransport, } from './src/Transports/WebSocketMessageTransport';
+export { BufferMessageTransport, } from './src/Transports/BufferMessageTransport';
+export { CanSetGet as CanSet } from './src/Decorators/CanSet';
+export { CanInvoke } from './src/Decorators/CanInvoke';
+export { ControllerProperties } from './src/Decorators/ControllerProperties';
+export { BrokerController, } from './src/Controllers/BrokerController/BrokerController';
+export { Signal } from './src/Controllers/BrokerController/Models/Signal';
+export { PeerConnection, } from './src/Controllers/BrokerController/Models/PeerConnection';
+export { ITransport } from './src/Interfaces/ITransport';
+export { ITransportMessage } from './src/Interfaces/ITransportMessage';
+export { StringUtils } from './src/Utils/StringUtils';
+export { ClientInfo } from './src/Connection/ClientInfo';

package/build/index.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientInfo = exports.StringUtils = exports.PeerConnection = exports.Signal = exports.BrokerController = exports.ControllerProperties = exports.CanInvoke = exports.CanSet = exports.BufferMessageTransport = exports.WebSocketMessageTransport = exports.PipeMessageTransport = exports.BufferMessage = exports.WebSocketMessage = exports.PipeMessage = exports.ErrorMessage = exports.TextMessage = exports.Plugin = exports.BufferUtils = exports.Subscription = exports.ControllerBase = exports.Connection = exports.ThorIOServer = void 0;
+var ThorIOServer_1 = require("./src/Server/ThorIOServer");
+Object.defineProperty(exports, "ThorIOServer", { enumerable: true, get: function () { return ThorIOServer_1.ThorIOServer; } });
+var Connection_1 = require("./src/Connection/Connection");
+Object.defineProperty(exports, "Connection", { enumerable: true, get: function () { return Connection_1.Connection; } });
+var ControllerBase_1 = require("./src/Controller/ControllerBase");
+Object.defineProperty(exports, "ControllerBase", { enumerable: true, get: function () { return ControllerBase_1.ControllerBase; } });
+var Subscription_1 = require("./src/Controller/Subscription");
+Object.defineProperty(exports, "Subscription", { enumerable: true, get: function () { return Subscription_1.Subscription; } });
+var BufferUtils_1 = require("./src/Utils/BufferUtils");
+Object.defineProperty(exports, "BufferUtils", { enumerable: true, get: function () { return BufferUtils_1.BufferUtils; } });
+var Plugin_1 = require("./src/Server/Plugin");
+Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return Plugin_1.Plugin; } });
+var TextMessage_1 = require("./src/Messages/TextMessage");
+Object.defineProperty(exports, "TextMessage", { enumerable: true, get: function () { return TextMessage_1.TextMessage; } });
+var ErrorMessage_1 = require("./src/Messages/ErrorMessage");
+Object.defineProperty(exports, "ErrorMessage", { enumerable: true, get: function () { return ErrorMessage_1.ErrorMessage; } });
+var PipeMessage_1 = require("./src/Messages/PipeMessage");
+Object.defineProperty(exports, "PipeMessage", { enumerable: true, get: function () { return PipeMessage_1.PipeMessage; } });
+var WebSocketMessage_1 = require("./src/Messages/WebSocketMessage");
+Object.defineProperty(exports, "WebSocketMessage", { enumerable: true, get: function () { return WebSocketMessage_1.WebSocketMessage; } });
+var BufferMessage_1 = require("./src/Messages/BufferMessage");
+Object.defineProperty(exports, "BufferMessage", { enumerable: true, get: function () { return BufferMessage_1.BufferMessage; } });
+var PipeMessageTransport_1 = require("./src/Transports/PipeMessageTransport");
+Object.defineProperty(exports, "PipeMessageTransport", { enumerable: true, get: function () { return PipeMessageTransport_1.PipeMessageTransport; } });
+var WebSocketMessageTransport_1 = require("./src/Transports/WebSocketMessageTransport");
+Object.defineProperty(exports, "WebSocketMessageTransport", { enumerable: true, get: function () { return WebSocketMessageTransport_1.WebSocketMessageTransport; } });
+var BufferMessageTransport_1 = require("./src/Transports/BufferMessageTransport");
+Object.defineProperty(exports, "BufferMessageTransport", { enumerable: true, get: function () { return BufferMessageTransport_1.BufferMessageTransport; } });
+var CanSet_1 = require("./src/Decorators/CanSet");
+Object.defineProperty(exports, "CanSet", { enumerable: true, get: function () { return CanSet_1.CanSetGet; } });
+var CanInvoke_1 = require("./src/Decorators/CanInvoke");
+Object.defineProperty(exports, "CanInvoke", { enumerable: true, get: function () { return CanInvoke_1.CanInvoke; } });
+var ControllerProperties_1 = require("./src/Decorators/ControllerProperties");
+Object.defineProperty(exports, "ControllerProperties", { enumerable: true, get: function () { return ControllerProperties_1.ControllerProperties; } });
+var BrokerController_1 = require("./src/Controllers/BrokerController/BrokerController");
+Object.defineProperty(exports, "BrokerController", { enumerable: true, get: function () { return BrokerController_1.BrokerController; } });
+var Signal_1 = require("./src/Controllers/BrokerController/Models/Signal");
+Object.defineProperty(exports, "Signal", { enumerable: true, get: function () { return Signal_1.Signal; } });
+var PeerConnection_1 = require("./src/Controllers/BrokerController/Models/PeerConnection");
+Object.defineProperty(exports, "PeerConnection", { enumerable: true, get: function () { return PeerConnection_1.PeerConnection; } });
+var StringUtils_1 = require("./src/Utils/StringUtils");
+Object.defineProperty(exports, "StringUtils", { enumerable: true, get: function () { return StringUtils_1.StringUtils; } });
+var ClientInfo_1 = require("./src/Connection/ClientInfo");
+Object.defineProperty(exports, "ClientInfo", { enumerable: true, get: function () { return ClientInfo_1.ClientInfo; } });

package/build/src/Connection/ClientInfo.d.ts

@@ -0,0 +1,27 @@
+export declare class ClientInfo {
+    /**
+     * The client identifier.
+     *
+     * @type {string}
+     */
+    CI: string;
+    /**
+     * The controller identifier.
+     *
+     * @type {string}
+     */
+    C: string;
+    /**
+     * The timestamp when the instance was created.
+     *
+     * @type {Date}
+     */
+    TS: Date;
+    /**
+     * Creates an instance of ClientInfo.
+     *
+     * @param {string} ci - The client identifier.
+     * @param {string} controller - The controller identifier.
+     */
+    constructor(ci: string, controller: string);
+}

package/{src/Client → build/src/Connection}/ClientInfo.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientInfo = void 0;
 class ClientInfo {
+    /**
+     * Creates an instance of ClientInfo.
+     *
+     * @param {string} ci - The client identifier.
+     * @param {string} controller - The controller identifier.
+     */
     constructor(ci, controller) {
         this.CI = ci;
         this.C = controller;

package/build/src/Connection/Connection.d.ts

@@ -0,0 +1,117 @@
+import { ControllerBase } from '../Controller/ControllerBase';
+import { ITransport } from '../Interfaces/ITransport';
+import { Plugin } from '../Server/Plugin';
+import { ClientInfo } from './ClientInfo';
+export declare class Connection {
+    transport: ITransport;
+    connections: Map<string, Connection>;
+    private controllers;
+    /**
+     * An array to store errors.
+     * @public
+     * @type {Array<any>}
+     */
+    errors: Array<any>;
+    /**
+     * The ping pong interval.
+     * @public
+     * @type {number}
+     */
+    pingPongInterval: number;
+    /**
+     * A map to store the controller instances.
+     * @public
+     * @type {Map<string, ControllerBase>}
+     */
+    controllerInstances: Map<string, ControllerBase>;
+    /**
+     * Client information.
+     * @public
+     * @type {ClientInfo | undefined}
+     */
+    clientInfo: ClientInfo | undefined;
+    /**
+     * Tries to invoke a method or set/get a property on the controller.
+     * @private
+     * @param {ControllerBase} controller The controller instance.
+     * @param {string} methodOrProperty The method or property name.
+     * @param {string} data The data to be passed to the method or property.
+     * @param {Buffer} [buffer] An optional buffer.
+     */
+    private tryInvokeMethod;
+    /**
+     * Getter for the connection ID.
+     * @public
+     * @returns {string} The connection ID.
+     */
+    get id(): string;
+    /**
+     * Constructor for the Connection class.
+     * @param {ITransport} transport The transport instance.
+     * @param {Map<string, Connection>} connections A map of connections.
+     * @param {Map<string, Plugin<ControllerBase>>} controllers A map of controllers.
+     * @constructor
+     */
+    constructor(transport: ITransport, connections: Map<string, Connection>, controllers: Map<string, Plugin<ControllerBase>>);
+    /**
+     * Sets up the transport event listeners.
+     * @private
+     * @param {ITransport} transport The transport instance.
+     */
+    private setupTransport;
+    /**
+     * Adds an error to the errors array.
+     * @private
+     * @param {any} error The error to be added.
+     */
+    private addError;
+    /**
+     * Checks if a controller with the given alias exists.
+     * @public
+     * @param {string} alias The controller alias.
+     * @returns {boolean} True if the controller exists, false otherwise.
+     */
+    hasController(alias: string): boolean;
+    /**
+     * Removes a controller from the controllerInstances.
+     * @public
+     * @param {string} alias The alias of the controller to be removed.
+     * @returns {boolean} True if the controller was removed successfully, false otherwise.
+     */
+    tryRemoveControllerInstance(alias: string): boolean;
+    /**
+     * Gets a controller instance from the controllerInstances map.
+     * @public
+     * @param {string} alias The alias of the controller to be retrieved.
+     * @returns {ControllerBase | undefined} The controller instance if found, otherwise undefined.
+     */
+    tryGetController(alias: string): ControllerBase | undefined;
+    /**
+     * Adds a controller instance to the controllerInstances map.
+     * @private
+     * @param {ControllerBase} controller The controller instance to be added.
+     * @returns {ControllerBase} The added controller instance.
+     */
+    private addControllerInstance;
+    /**
+     * Finds and resolves a controller by alias.
+     * @public
+     * @param {string} alias The alias of the controller to be resolved.
+     * @returns {ControllerBase} The resolved controller instance.
+     * @throws {Error} If the controller cannot be resolved.
+     */
+    tryResolveController(alias: string): ControllerBase;
+    /**
+     * Locates a controller by alias. If registered, returns it; otherwise, creates an instance.
+     * @public
+     * @param {string} alias The alias of the controller to be located.
+     * @returns {ControllerBase | undefined} The located controller instance, or undefined if not found.
+     */
+    tryCreateControllerInstance(alias: string): ControllerBase | undefined;
+    /**
+     * Initializes a newly created controller instance.
+     * @private
+     * @param {ControllerBase} controllerInstance The controller instance to initialize.
+     */
+    private initializeControllerInstance;
+}

package/build/src/Connection/Connection.js

@@ -0,0 +1,202 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connection = void 0;
+const TextMessage_1 = require("../Messages/TextMessage");
+const ClientInfo_1 = require("./ClientInfo");
+class Connection {
+    /**
+     * Tries to invoke a method or set/get a property on the controller.
+     * @private
+     * @param {ControllerBase} controller The controller instance.
+     * @param {string} methodOrProperty The method or property name.
+     * @param {string} data The data to be passed to the method or property.
+     * @param {Buffer} [buffer] An optional buffer.
+     */
+    tryInvokeMethod(controller, methodOrProperty, data, buffer) {
+        if (controller.canInvokeMethod(methodOrProperty)) {
+            controller.invokeMethod(methodOrProperty, data, buffer);
+        }
+        else if (controller.canSetProperty(methodOrProperty)) {
+            controller.setProperty(methodOrProperty, JSON.parse(data));
+        }
+        else if (controller.canGetProperty(methodOrProperty)) {
+            const { resultId } = JSON.parse(data);
+            controller.getProperty(methodOrProperty, resultId);
+        }
+    }
+    /**
+     * Getter for the connection ID.
+     * @public
+     * @returns {string} The connection ID.
+     */
+    get id() {
+        return this.transport.id;
+    }
+    /**
+     * Constructor for the Connection class.
+     * @param {ITransport} transport The transport instance.
+     * @param {Map<string, Connection>} connections A map of connections.
+     * @param {Map<string, Plugin<ControllerBase>>} controllers A map of controllers.
+     * @constructor
+     */
+    constructor(transport, connections, controllers) {
+        this.transport = transport;
+        this.connections = connections;
+        this.controllers = controllers;
+        /**
+         * An array to store errors.
+         * @public
+         * @type {Array<any>}
+         */
+        this.errors = [];
+        /**
+         * The ping pong interval.
+         * @public
+         * @type {number}
+         */
+        this.pingPongInterval = 60;
+        /**
+         * A map to store the controller instances.
+         * @public
+         * @type {Map<string, ControllerBase>}
+         */
+        this.controllerInstances = new Map();
+        try {
+            this.setupTransport(transport);
+        }
+        catch (error) {
+            console.log('Error in Connection constructor', error);
+        }
+    }
+    /**
+     * Sets up the transport event listeners.
+     * @private
+     * @param {ITransport} transport The transport instance.
+     */
+    setupTransport(transport) {
+        if (transport) {
+            this.transport.onMessage = (event) => {
+                try {
+                    const message = event.isBinary ? TextMessage_1.TextMessage.fromArrayBuffer(event.data) : event.toMessage();
+                    const controller = this.tryCreateControllerInstance(message.C);
+                    if (controller) {
+                        this.tryInvokeMethod(controller, message.T, message.D, message.B);
+                    }
+                }
+                catch (error) {
+                    this.addError(error);
+                }
+            };
+        }
+    }
+    /**
+     * Adds an error to the errors array.
+     * @private
+     * @param {any} error The error to be added.
+     */
+    addError(error) {
+        this.errors.push(error);
+    }
+    /**
+     * Checks if a controller with the given alias exists.
+     * @public
+     * @param {string} alias The controller alias.
+     * @returns {boolean} True if the controller exists, false otherwise.
+     */
+    hasController(alias) {
+        return this.controllerInstances.has(alias);
+    }
+    /**
+     * Removes a controller from the controllerInstances.
+     * @public
+     * @param {string} alias The alias of the controller to be removed.
+     * @returns {boolean} True if the controller was removed successfully, false otherwise.
+     */
+    tryRemoveControllerInstance(alias) {
+        return this.controllerInstances.delete(alias);
+    }
+    /**
+     * Gets a controller instance from the controllerInstances map.
+     * @public
+     * @param {string} alias The alias of the controller to be retrieved.
+     * @returns {ControllerBase | undefined} The controller instance if found, otherwise undefined.
+     */
+    tryGetController(alias) {
+        try {
+            const match = this.controllerInstances.get(alias);
+            if (!match)
+                throw new Error(`Cannot locate the requested controller ${alias}`);
+            return match;
+        }
+        catch (error) {
+            this.addError(error);
+            return undefined;
+        }
+    }
+    /**
+     * Adds a controller instance to the controllerInstances map.
+     * @private
+     * @param {ControllerBase} controller The controller instance to be added.
+     * @returns {ControllerBase} The added controller instance.
+     */
+    addControllerInstance(controller) {
+        if (!controller.alias)
+            throw `Cannot add Controller instance`;
+        this.controllerInstances.set(controller.alias, controller);
+        return controller;
+    }
+    /**
+     * Finds and resolves a controller by alias.
+     * @public
+     * @param {string} alias The alias of the controller to be resolved.
+     * @returns {ControllerBase} The resolved controller instance.
+     * @throws {Error} If the controller cannot be resolved.
+     */
+    tryResolveController(alias) {
+        const plugin = this.controllers.get(alias);
+        if (!plugin) {
+            throw new Error(`Cannot resolve ${alias}, controller unknown.`);
+        }
+        return plugin.getInstance();
+    }
+    /**
+     * Locates a controller by alias. If registered, returns it; otherwise, creates an instance.
+     * @public
+     * @param {string} alias The alias of the controller to be located.
+     * @returns {ControllerBase | undefined} The located controller instance, or undefined if not found.
+     */
+    tryCreateControllerInstance(alias) {
+        try {
+            let instancedController = this.tryGetController(alias);
+            if (instancedController) {
+                return instancedController;
+            }
+            else {
+                const resolvedController = this.tryResolveController(alias);
+                const controllerInstance = new resolvedController(this);
+                this.addControllerInstance(controllerInstance);
+                this.initializeControllerInstance(controllerInstance);
+                return controllerInstance;
+            }
+        }
+        catch (error) {
+            this.transport.close(1011, `Cannot locate the specified controller, it may be sealed or the alias is unknown '${alias}'. Connection closed.`);
+            return undefined;
+        }
+    }
+    /**
+     * Initializes a newly created controller instance.
+     * @private
+     * @param {ControllerBase} controllerInstance The controller instance to initialize.
+     */
+    initializeControllerInstance(controllerInstance) {
+        controllerInstance.invoke(new ClientInfo_1.ClientInfo(this.id, controllerInstance.alias), '___open', controllerInstance.alias);
+        if (controllerInstance.onopen)
+            controllerInstance.onopen();
+        this.transport.onClose = (e) => {
+            if (controllerInstance.onclose)
+                controllerInstance.onclose();
+        };
+    }
+}
+exports.Connection = Connection;

package/build/src/Connection/IClientInfo.d.ts

@@ -0,0 +1,20 @@
+export interface IClientInfo {
+    /**
+     * The client identifier.
+     *
+     * @type {string}
+     */
+    CI: string;
+    /**
+     * The controller identifier.
+     *
+     * @type {string}
+     */
+    C: string;
+    /**
+     * The timestamp when the instance was created.
+     *
+     * @type {Date}
+     */
+    TS: Date;
+}

package/build/src/Controller/ControllerBase.d.ts

@@ -0,0 +1,134 @@
+import { URLSearchParams } from 'url';
+import { Connection } from '../Connection/Connection';
+import { Subscription } from './Subscription';
+export interface ControllerBase {
+    subscriptions: Array<Subscription>;
+    connection: Connection;
+    disbaleHeartbeat(): void;
+    canInvokeMethod(method: string): boolean;
+    canSetProperty(property: string): boolean;
+    canGetProperty(property: string): boolean;
+    getProperty(propertyName: string, topic: string): any;
+    setProperty(propertyName: string, propertyValue: any): void;
+    invokeError(ex: any): void;
+    invokeMethod(method: string, data: any, buffer?: Buffer): void;
+    findOn<T>(alias: string, predicate: (item: any) => boolean): ControllerBase[] | undefined;
+    getConnections(alias?: string): Connection[];
+    onopen(): void;
+    onclose(): void;
+    find<T, U>(array: T[], predicate: (item: any) => boolean, selector?: (item: T) => U): U[];
+    invokeToOthers(data: any, topic: string, controller?: string, buffer?: Buffer): void;
+    invokeToAll(data: any, topic: string, controller?: string, buffer?: Buffer): void;
+    invokeTo<T>(predicate: (item: T) => boolean, data: any, topic: string, controller?: string, buffer?: Buffer): void;
+    invoke(data: any, topic: string, controller?: string, buffer?: Buffer): ControllerBase;
+    publish(data: any, topic: string, controller?: string): ControllerBase;
+    publishToAll(data: any, topic: string, controller?: string): void;
+    hasSubscription(topic: string): boolean;
+    addSubscription(topic: string): Subscription;
+    removeSubscription(topic: string): void;
+    getSubscription(topic: string): Subscription | undefined;
+    instance(connection: Connection): ControllerBase;
+    new (connection: Connection): ControllerBase;
+}
+/**
+ * ControllerBase
+ *
+ * Base class for all controllers.
+ */
+export declare class ControllerBase implements ControllerBase {
+    /**
+     * Gets the name of the controller.
+     * @returns {string} The alias of the controller.
+     */
+    getName(): string;
+    /**
+     * The alias of the controller.
+     * @type {string}
+     */
+    alias: string;
+    /**
+     * An array of subscriptions for the controller.
+     * @type {Array<Subscription>}
+     */
+    subscriptions: Array<Subscription>;
+    /**
+     * The connection associated with the controller.
+     * @type {Connection}
+     */
+    connection: Connection;
+    /**
+     * Timestamp of the last pong received.
+     * @type {Date | undefined}
+     */
+    private lastPong;
+    /**
+     * Timestamp of the last ping sent.
+     * @type {Date | undefined}
+     */
+    private lastPing;
+    /**
+     * Interval for sending heartbeats.
+     * @type {number}
+     */
+    private heartbeatInterval;
+    /**
+     * NodeJS.Timeout object for the heartbeat interval.
+     * @type {NodeJS.Timeout | undefined}
+     */
+    private interval;
+    /**
+     * Creates a new instance of ControllerBase.
+     *
+     * @param {Connection} connection The connection associated with the controller.
+     */
+    constructor(connection: Connection);
+    /**
+     * Enables the heartbeat mechanism.
+     */
+    private enableHeartbeat;
+    /**
+     * Connects the controller.
+     *
+     * **Note:** This method is marked as @CanInvoke(true), but its purpose is unclear.
+     * Consider reviewing and potentially removing this method.
+     */
+    ___connect(): void;
+    /**
+     * Closes the connection associated with the controller.
+     */
+    ___close(): void;
+    /**
+     * Subscribes the controller to a specific topic.
+     *
+     * @param {Subscription} subscription The subscription object.
+     * @param {string} topic The topic to subscribe to.
+     * @param {string} controller The controller alias.
+     * @returns {Subscription} The created or existing subscription.
+     */
+    ___subscribe(subscription: Subscription, topic: string, controller: string): Subscription;
+    /**
+     * Unsubscribes the controller from a specific topic.
+     *
+     * @param {Subscription} subscription The subscription to unsubscribe.
+     * @returns {boolean} True if the subscription was successfully unsubscribed, false otherwise.
+     */
+    ___unsubscribe(subscription: Subscription): boolean;
+    /**
+     * Gets the query parameters from the request.
+     *
+     * @returns {URLSearchParams} The URLSearchParams object containing the query parameters.
+     */
+    get queryParameters(): URLSearchParams;
+    /**
+     * Gets the headers from the request.
+     *
+     * @returns {Map<string, string>} A Map containing the request headers.
+     */
+    get headers(): Map<string, string>;
+    /**
+     * Gets the underlying request object.
+     *
+     * @returns {any} The request object.
+     */
+    get request(): any;
+}