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

package/build/src/Server/Plugin.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plugin = void 0;
+const StringUtils_1 = require("../Utils/StringUtils");
+/**
+ * Represents a plugin with a specific type.
+ * @template T The type of the plugin instance.
+ */
+class Plugin {
+    /**
+     * Creates an instance of Plugin.
+     * @param {T} object The plugin instance.
+     */
+    constructor(object) {
+        this.id = StringUtils_1.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() {
+        return this.instance;
+    }
+}
+exports.Plugin = Plugin;

package/build/src/Server/ThorIOServer.d.ts

@@ -0,0 +1,68 @@
+import * as net from 'net';
+import { ControllerBase } from '../Controller/ControllerBase';
+import { ITransport } from '../Interfaces/ITransport';
+/**
+ * ThorIOServer server class for managing connections and controllers.
+ */
+export declare class ThorIOServer {
+    /**
+     * An array of plugins containing registered controllers.
+     */
+    private controllers;
+    /**
+     * A Map of connections indexed by their ID.
+     */
+    private connections;
+    /**
+     * An array of active net.Server instances representing endpoints.
+     */
+    private endpoints;
+    /**
+     * (Optional) Interceptors for custom logic during communication.
+     */
+    interceptors: any;
+    /**
+     * Creates a new instance of ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     * @returns {ThorIOServer} A new ThorIOServer instance.
+     */
+    static createInstance(controllers: Array<any>): ThorIOServer;
+    /**
+     * Constructor for ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     */
+    constructor(controllers: Array<ControllerBase>);
+    /**
+     * Removes a connection from the server.
+     *
+     * @param {string} id The ID of the connection to remove.
+     * @param {number} reason The reason for removing the connection.
+     */
+    removeConnection(id: string, reason: number): void;
+    /**
+     * Adds a new endpoint to the server using the specified transport type, host, and port.
+     *
+     * @param {new (...args: any[]) => ITransport} typeOfTransport A constructor function for the transport type.
+     * @param {string} host The hostname or IP address to listen on.
+     * @param {number} port The port number to listen on.
+     * @returns {net.Server} The created net.Server instance.
+     */
+    addEndpoint(typeOfTransport: {
+        new (...args: any[]): ITransport;
+    }, host: string, port: number): net.Server;
+    /**
+     * Adds a WebSocket connection to the server.
+     *
+     * @param {any} ws The WebSocket object.
+     * @param {any} req The request object (if applicable).
+     */
+    addWebSocket(ws: any, req: any): void;
+    /**
+     * Adds a new connection to the server's internal state.
+     *
+     * @param {ITransport} transport The transport object representing the connection.
+     */
+    private addConnection;
+}

package/build/src/Server/ThorIOServer.js

@@ -0,0 +1,131 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThorIOServer = void 0;
+const net = __importStar(require("net"));
+const Connection_1 = require("../Connection/Connection");
+const Plugin_1 = require("../Server/Plugin");
+const WebSocketMessageTransport_1 = require("../Transports/WebSocketMessageTransport");
+/**
+ * ThorIOServer server class for managing connections and controllers.
+ */
+class ThorIOServer {
+    /**
+     * Creates a new instance of ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     * @returns {ThorIOServer} A new ThorIOServer instance.
+     */
+    static createInstance(controllers) {
+        return new ThorIOServer(controllers);
+    }
+    /**
+     * Constructor for ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     */
+    constructor(controllers) {
+        this.endpoints = new Array();
+        this.connections = new Map();
+        this.controllers = new Map();
+        controllers.forEach((ctrl) => {
+            if (!Reflect.hasOwnMetadata("alias", ctrl)) {
+                throw "Failed to register one of the specified Controllers, missing ControllerProperties alias attribute";
+            }
+            else {
+                console.log(`Starting registering the '${Reflect.getMetadata("alias", ctrl)}' controller.`);
+            }
+            const plugin = new Plugin_1.Plugin(ctrl);
+            this.controllers.set(Reflect.getMetadata("alias", ctrl), plugin);
+        });
+    }
+    /**
+     * Removes a connection from the server.
+     *
+     * @param {string} id The ID of the connection to remove.
+     * @param {number} reason The reason for removing the connection.
+     */
+    removeConnection(id, reason) {
+        try {
+            this.connections.delete(id);
+        }
+        catch (error) {
+            console.warn(`Failed to delete a connection with id ${id}, reason: ${reason}`);
+        }
+    }
+    /**
+     * Adds a new endpoint to the server using the specified transport type, host, and port.
+     *
+     * @param {new (...args: any[]) => ITransport} typeOfTransport A constructor function for the transport type.
+     * @param {string} host The hostname or IP address to listen on.
+     * @param {number} port The port number to listen on.
+     * @returns {net.Server} The created net.Server instance.
+     */
+    addEndpoint(typeOfTransport, host, port) {
+        const endpoint = net.createServer((socket) => {
+            const transport = new typeOfTransport(socket);
+            this.addConnection(transport);
+        });
+        endpoint.listen(port, host, ((listener) => {
+            // do op
+        }));
+        this.endpoints.push(endpoint);
+        return endpoint;
+    }
+    /**
+     * Adds a WebSocket connection to the server.
+     *
+     * @param {any} ws The WebSocket object.
+     * @param {any} req The request object (if applicable).
+     */
+    addWebSocket(ws, req) {
+        const transport = new WebSocketMessageTransport_1.WebSocketMessageTransport(ws, req);
+        this.addConnection(transport);
+    }
+    /**
+     * Adds a new connection to the server's internal state.
+     *
+     * @param {ITransport} transport The transport object representing the connection.
+     */
+    addConnection(transport) {
+        transport.addEventListener("close", (reason) => {
+            if (transport.onClose)
+                transport.onClose(reason);
+            this.removeConnection(transport.id, reason);
+        });
+        this.connections.set(transport.id, new Connection_1.Connection(transport, this.connections, this.controllers));
+    }
+}
+exports.ThorIOServer = ThorIOServer;

package/build/src/Subscription.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscription = void 0;
+/**
+ * Represents a subscription to a specific topic with an associated controller.
+ *
+ * @export
+ * @class Subscription
+ */
+class Subscription {
+    /**
+     * Creates an instance of Subscription.
+     *
+     * @param {string} topic - The topic of the subscription.
+     * @param {string} controller - The controller associated with the subscription.
+     */
+    constructor(topic, controller) {
+        this.topic = topic;
+        this.controller = controller;
+    }
+}
+exports.Subscription = Subscription;

package/build/src/ThorIO.js

@@ -0,0 +1,142 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThorIO = void 0;
+const net = __importStar(require("net"));
+const Connection_1 = require("./Connection/Connection");
+const Plugin_1 = require("./Plugin");
+const WebSocketMessageTransport_1 = require("./Transports/WebSocketMessageTransport");
+class MockTransport {
+    constructor() {
+        this.readyState = 0;
+        this.id = 'mock-transport-id';
+        this.onMessage = () => { };
+        this.onClose = () => { };
+        this.onOpen = () => { };
+        this.interceptors = new Map();
+    }
+    addEventListener(topic, fn) {
+        throw new Error('Method not implemented.');
+    }
+    ping() {
+        throw new Error('Method not implemented.');
+    }
+    // Implement other methods of ITransport interface as needed
+    send(message) { }
+    close(code, reason) { }
+}
+/**
+ * ThorIO server class for managing connections and controllers.
+ */
+class ThorIO {
+    /**
+      * Constructor for ThorIO.
+      *
+      * @param {Array<ControllerBase>} controllers An array of controllers to register.
+      */
+    constructor(controllers) {
+        this.endpoints = new Array();
+        this.connections = new Map();
+        this.controllers = new Array();
+        controllers.forEach((ctrl) => {
+            if (!Reflect.hasOwnMetadata("alias", ctrl)) {
+                throw "Faild to register on of the specified Controller's";
+            }
+            let plugin = new Plugin_1.Plugin(ctrl);
+            this.controllers.push(plugin);
+        });
+    }
+    /**
+   * Creates a new instance of ThorIO.
+   *
+   * @param {Array<ControllerBase>} controllers An array of controllers to register.
+   * @returns {ThorIO} A new ThorIO instance.
+   */
+    static createInstance(controllers) {
+        return new ThorIO(controllers);
+    }
+    /**
+      * Creates sealed (standalone) instances of controllers marked with the "seald" metadata.
+      */
+    createSealdControllers() {
+        this.controllers.forEach((controller) => {
+            if (Reflect.getMetadata("seald", controller.instance)) {
+                new controller.instance(new Connection_1.Connection(new MockTransport(), this.connections, this.controllers));
+            }
+        });
+    }
+    /**
+  * Removes a connection from the server.
+  *
+  * @param {string} id The ID of the connection to remove.
+  * @param {number} reason The reason for removing the connection.
+  */
+    removeConnection(id, reason) {
+        try {
+            this.connections.delete(id);
+        }
+        catch (error) {
+        }
+    }
+    /**
+  * Adds a new endpoint to the server using the specified transport type, host, and port.
+  *
+  * @param {typeof ITransport} typeOfTransport A constructor function for the transport type.
+  * @param {string} host The hostname or IP address to listen on.
+  * @param {number} port The port number to listen on.
+  * @returns {net.Server} The created net.Server instance.
+  */
+    addEndpoint(typeOfTransport, host, port) {
+        let endpoint = net.createServer((socket) => {
+            let transport = new typeOfTransport(socket);
+            this.addConnection(transport);
+        });
+        endpoint.listen(port, host, ((listener) => {
+            // do op
+        }));
+        this.endpoints.push(endpoint);
+        return endpoint;
+    }
+    /**
+  * Adds a WebSocket connection to the server.
+  *
+  * @param {any} ws The WebSocket object.
+  * @param {any} req The request object (if applicable).
+  */
+    addWebSocket(ws, req) {
+        let transport = new WebSocketMessageTransport_1.WebSocketMessageTransport(ws, req);
+        this.addConnection(transport);
+    }
+    /**
+  * Adds a new connection to the server's internal state.
+  *
+  * @param {ITransport} transport The transport object representing the connection.
+  */
+    addConnection(transport) {
+        transport.addEventListener("close", (reason) => {
+            if (transport.onClose)
+                transport.onClose(reason);
+            this.removeConnection(transport.id, reason);
+        });
+        this.connections.set(transport.id, new Connection_1.Connection(transport, this.connections, this.controllers));
+    }
+}
+exports.ThorIO = ThorIO;

package/build/src/ThorIOServer.d.ts

@@ -0,0 +1,64 @@
+import * as net from 'net';
+import { ControllerBase } from './Controller/ControllerBase';
+import { ITransport } from './Interfaces/ITransport';
+/**
+ * ThorIOServer server class for managing connections and controllers.
+ */
+export declare class ThorIOServer {
+    /**
+     * An array of plugins containing registered controllers.
+     */
+    private controllers;
+    /**
+     * A Map of connections indexed by their ID.
+     */
+    private connections;
+    /**
+     * An array of active net.Server instances representing endpoints.
+     */
+    private endpoints;
+    /**
+     * Creates a new instance of ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     * @returns {ThorIOServer} A new ThorIOServer instance.
+     */
+    static createInstance(controllers: Array<any>): ThorIOServer;
+    /**
+     * Constructor for ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     */
+    constructor(controllers: Array<ControllerBase>);
+    /**
+     * Removes a connection from the server.
+     *
+     * @param {string} id The ID of the connection to remove.
+     * @param {number} reason The reason for removing the connection.
+     */
+    removeConnection(id: string, reason: number): void;
+    /**
+     * Adds a new endpoint to the server using the specified transport type, host, and port.
+     *
+     * @param {new (...args: any[]) => ITransport} typeOfTransport A constructor function for the transport type.
+     * @param {string} host The hostname or IP address to listen on.
+     * @param {number} port The port number to listen on.
+     * @returns {net.Server} The created net.Server instance.
+     */
+    addEndpoint(typeOfTransport: {
+        new (...args: any[]): ITransport;
+    }, host: string, port: number): net.Server;
+    /**
+     * Adds a WebSocket connection to the server.
+     *
+     * @param {any} ws The WebSocket object.
+     * @param {any} req The request object (if applicable).
+     */
+    addWebSocket(ws: any, req: any): void;
+    /**
+     * Adds a new connection to the server's internal state.
+     *
+     * @param {ITransport} transport The transport object representing the connection.
+     */
+    private addConnection;
+}

package/build/src/ThorIOServer.js

@@ -0,0 +1,131 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThorIOServer = void 0;
+const net = __importStar(require("net"));
+const Connection_1 = require("./Connection/Connection");
+const Plugin_1 = require("./Server/Plugin");
+const WebSocketMessageTransport_1 = require("./Transports/WebSocketMessageTransport");
+/**
+ * ThorIOServer server class for managing connections and controllers.
+ */
+class ThorIOServer {
+    /**
+     * Creates a new instance of ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     * @returns {ThorIOServer} A new ThorIOServer instance.
+     */
+    static createInstance(controllers) {
+        return new ThorIOServer(controllers);
+    }
+    /**
+     * Constructor for ThorIOServer.
+     *
+     * @param {Array<ControllerBase>} controllers An array of controllers to register.
+     */
+    constructor(controllers) {
+        this.endpoints = new Array();
+        this.connections = new Map();
+        this.controllers = new Map();
+        controllers.forEach((ctrl) => {
+            if (!Reflect.hasOwnMetadata("alias", ctrl)) {
+                throw "Failed to register one of the specified Controllers, missing ControllerProperties alias attribute";
+            }
+            else {
+                console.log(`Starting registering the '${Reflect.getMetadata("alias", ctrl)}' controller.`);
+            }
+            const plugin = new Plugin_1.Plugin(ctrl);
+            this.controllers.set(Reflect.getMetadata("alias", ctrl), plugin);
+        });
+    }
+    /**
+     * Removes a connection from the server.
+     *
+     * @param {string} id The ID of the connection to remove.
+     * @param {number} reason The reason for removing the connection.
+     */
+    removeConnection(id, reason) {
+        try {
+            this.connections.delete(id);
+        }
+        catch (error) {
+            console.warn(`Failed to delete a connection with id ${id}, reason: ${reason}`);
+        }
+    }
+    /**
+     * Adds a new endpoint to the server using the specified transport type, host, and port.
+     *
+     * @param {new (...args: any[]) => ITransport} typeOfTransport A constructor function for the transport type.
+     * @param {string} host The hostname or IP address to listen on.
+     * @param {number} port The port number to listen on.
+     * @returns {net.Server} The created net.Server instance.
+     */
+    addEndpoint(typeOfTransport, host, port) {
+        const endpoint = net.createServer((socket) => {
+            const transport = new typeOfTransport(socket);
+            this.addConnection(transport);
+        });
+        endpoint.listen(port, host, ((listener) => {
+            // do op
+        }));
+        this.endpoints.push(endpoint);
+        return endpoint;
+    }
+    /**
+     * Adds a WebSocket connection to the server.
+     *
+     * @param {any} ws The WebSocket object.
+     * @param {any} req The request object (if applicable).
+     */
+    addWebSocket(ws, req) {
+        const transport = new WebSocketMessageTransport_1.WebSocketMessageTransport(ws, req);
+        this.addConnection(transport);
+    }
+    /**
+     * Adds a new connection to the server's internal state.
+     *
+     * @param {ITransport} transport The transport object representing the connection.
+     */
+    addConnection(transport) {
+        transport.addEventListener("close", (reason) => {
+            if (transport.onClose)
+                transport.onClose(reason);
+            this.removeConnection(transport.id, reason);
+        });
+        this.connections.set(transport.id, new Connection_1.Connection(transport, this.connections, this.controllers));
+    }
+}
+exports.ThorIOServer = ThorIOServer;

package/build/src/Transports/BufferMessageTransport.d.ts

@@ -0,0 +1,78 @@
+import { IncomingMessage } from 'http';
+import * as net from 'net';
+import { ITransport } from '../Interfaces/ITransport';
+import { ITransportMessage } from '../Interfaces/ITransportMessage';
+/**
+ * A transport implementation for handling buffer-based messages over a socket.
+ *
+ * @export
+ * @class BufferMessageTransport
+ * @implements {ITransport}
+ */
+export declare class BufferMessageTransport implements ITransport {
+    socket: net.Socket;
+    /**
+     * Unique identifier for this transport instance.
+     *
+     * @type {string}
+     */
+    id: string;
+    /**
+     * Event handler for receiving transport messages.
+     *
+     * @type {(message: ITransportMessage) => void}
+     */
+    onMessage: (message: ITransportMessage) => void;
+    /**
+     * The underlying socket used for communication.
+     *
+     * @type {net.Socket}
+     */
+    constructor(socket: net.Socket);
+    /**
+     * The incoming HTTP request associated with the transport (if any).
+     *
+     * @type {IncomingMessage | any}
+     */
+    request: IncomingMessage | any;
+    /**
+     * Event handler for when the transport connection is closed.
+     *
+     * @type {() => void}
+     */
+    onClose: () => void;
+    /**
+     * Event handler for when the transport connection is opened.
+     *
+     * @type {() => void}
+     */
+    onOpen: () => void;
+    /**
+     * The ready state of the transport connection.
+     *
+     * @readonly
+     * @type {number}
+     */
+    get readyState(): number;
+    /**
+     * Sends a string message over the transport.
+     *
+     * @param {string} data - The message to send.
+     */
+    send(data: string): void;
+    /**
+     * Adds an event listener to the underlying socket.
+     *
+     * @param {string} name - The name of the event.
+     * @param {Function} fn - The callback function to invoke when the event occurs.
+     */
+    addEventListener(name: string, fn: any): void;
+    /**
+     * Sends a ping message (no-op for this transport).
+     */
+    ping(): void;
+    /**
+     * Closes the transport connection and destroys the socket.
+     */
+    close(): void;
+}