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

package/build/src/Transports/BufferMessageTransport.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BufferMessageTransport = void 0;
+const BufferMessage_1 = require("../Messages/BufferMessage");
+const StringUtils_1 = require("../Utils/StringUtils");
+/**
+ * A transport implementation for handling buffer-based messages over a socket.
+ *
+ * @export
+ * @class BufferMessageTransport
+ * @implements {ITransport}
+ */
+class BufferMessageTransport {
+    /**
+     * The underlying socket used for communication.
+     *
+     * @type {net.Socket}
+     */
+    constructor(socket) {
+        this.socket = socket;
+        /**
+         * Event handler for receiving transport messages.
+         *
+         * @type {(message: ITransportMessage) => void}
+         */
+        this.onMessage = (message) => { };
+        /**
+         * Event handler for when the transport connection is closed.
+         *
+         * @type {() => void}
+         */
+        this.onClose = () => { };
+        /**
+         * Event handler for when the transport connection is opened.
+         *
+         * @type {() => void}
+         */
+        this.onOpen = () => { };
+        this.id = StringUtils_1.StringUtils.newGuid();
+        this.socket.addListener("data", (buffer) => {
+            const bm = new BufferMessage_1.BufferMessage(buffer, false);
+            this.onMessage(bm);
+        });
+    }
+    /**
+     * The ready state of the transport connection.
+     *
+     * @readonly
+     * @type {number}
+     */
+    get readyState() {
+        return 1; // Open
+    }
+    /**
+     * Sends a string message over the transport.
+     *
+     * @param {string} data - The message to send.
+     */
+    send(data) {
+        const bm = new BufferMessage_1.BufferMessage(Buffer.from(data), false);
+        this.socket.write(bm.toBuffer());
+    }
+    /**
+     * 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, fn) {
+        this.socket.addListener(name, fn);
+    }
+    /**
+     * Sends a ping message (no-op for this transport).
+     */
+    ping() {
+        return;
+    }
+    /**
+     * Closes the transport connection and destroys the socket.
+     */
+    close() {
+        this.socket.destroy();
+    }
+}
+exports.BufferMessageTransport = BufferMessageTransport;

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

@@ -0,0 +1,79 @@
+import * as net from 'net';
+import { ITransport } from '../Interfaces/ITransport';
+/**
+ * A transport implementation for handling pipe-based messages over a socket.
+ *
+ * @export
+ * @class PipeMessageTransport
+ * @implements {ITransport}
+ */
+export declare class PipeMessageTransport implements ITransport {
+    socket: net.Socket;
+    /**
+     * Unique identifier for this transport instance.
+     *
+     * @type {string}
+     */
+    id: string;
+    /**
+     * Event handler for receiving transport messages.
+     *
+     * @type {(message: any) => void}
+     */
+    onMessage: (message: any) => void;
+    /**
+     * Sends data over the transport.
+     *
+     * @param {any} data - The data to send.
+     */
+    send(data: any): void;
+    /**
+     * Closes the transport connection and destroys the socket.
+     *
+     * @param {number} reason - The reason code for closing the connection.
+     * @param {any} message - An optional message describing the closure.
+     */
+    close(reason: number, message: any): 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;
+    /**
+     * The ready state of the transport connection.
+     *
+     * @readonly
+     * @type {number}
+     */
+    get readyState(): number;
+    /**
+     * Sends a ping message (no-op for this transport).
+     */
+    ping(): void;
+    /**
+     * Creates an instance of PipeMessageTransport.
+     *
+     * @param {net.Socket} socket - The underlying socket used for communication.
+     */
+    constructor(socket: net.Socket);
+    /**
+     * The incoming request associated with the transport (if any).
+     *
+     * @type {any}
+     */
+    request: 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;
+}

package/build/src/Transports/PipeMessageTransport.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PipeMessageTransport = void 0;
+const PipeMessage_1 = require("../Messages/PipeMessage");
+const TextMessage_1 = require("../Messages/TextMessage");
+const StringUtils_1 = require("../Utils/StringUtils");
+/**
+ * A transport implementation for handling pipe-based messages over a socket.
+ *
+ * @export
+ * @class PipeMessageTransport
+ * @implements {ITransport}
+ */
+class PipeMessageTransport {
+    /**
+     * Sends data over the transport.
+     *
+     * @param {any} data - The data to send.
+     */
+    send(data) {
+        const message = new PipeMessage_1.PipeMessage(data, false);
+        this.socket.write(message.toBuffer());
+    }
+    /**
+     * Closes the transport connection and destroys the socket.
+     *
+     * @param {number} reason - The reason code for closing the connection.
+     * @param {any} message - An optional message describing the closure.
+     */
+    close(reason, message) {
+        this.socket.destroy();
+    }
+    /**
+     * 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, fn) {
+        this.socket.addListener(name, fn);
+    }
+    /**
+     * The ready state of the transport connection.
+     *
+     * @readonly
+     * @type {number}
+     */
+    get readyState() {
+        return 1; // Open
+    }
+    /**
+     * Sends a ping message (no-op for this transport).
+     */
+    ping() {
+        return;
+    }
+    /**
+     * Creates an instance of PipeMessageTransport.
+     *
+     * @param {net.Socket} socket - The underlying socket used for communication.
+     */
+    constructor(socket) {
+        this.socket = socket;
+        /**
+         * Event handler for receiving transport messages.
+         *
+         * @type {(message: any) => void}
+         */
+        this.onMessage = () => { };
+        /**
+         * Event handler for when the transport connection is closed.
+         *
+         * @type {() => void}
+         */
+        this.onClose = () => { };
+        /**
+         * Event handler for when the transport connection is opened.
+         *
+         * @type {() => void}
+         */
+        this.onOpen = () => { };
+        this.id = StringUtils_1.StringUtils.newGuid();
+        socket.addListener("data", (buffer) => {
+            const args = buffer.toString().split("|");
+            const message = new TextMessage_1.TextMessage(args[1], args[2], args[0]);
+            this.onMessage(new PipeMessage_1.PipeMessage(message.toString(), false));
+        });
+    }
+}
+exports.PipeMessageTransport = PipeMessageTransport;

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

@@ -0,0 +1,87 @@
+import { IncomingMessage } from 'http';
+import { ITransport } from '../Interfaces/ITransport';
+import { ITransportMessage } from '../Interfaces/ITransportMessage';
+/**
+ * A transport class for handling WebSocket communication and converting messages
+ * to/from the `WebSocketMessage` format.
+ *
+ * @export
+ * @class WebSocketMessageTransport
+ * @implements {ITransport}
+ */
+export declare class WebSocketMessageTransport implements ITransport {
+    /**
+     * The HTTP request associated with the WebSocket connection.
+     *
+     * @type {IncomingMessage | Request}
+     */
+    request: IncomingMessage | Request;
+    /**
+     * The WebSocket instance used for communication.
+     *
+     * @type {WebSocket}
+     */
+    socket: WebSocket;
+    /**
+     * Callback for handling incoming messages. Defaults to creating a `WebSocketMessage`.
+     *
+     * @type {(message: ITransportMessage) => void}
+     */
+    onMessage: (message: ITransportMessage) => void;
+    /**
+     * Sends data through the WebSocket connection.
+     *
+     * @param {any} data - The data to be sent.
+     */
+    send(data: any): void;
+    /**
+     * Closes the WebSocket connection.
+     *
+     * @param {number} reason - The reason code for closing the connection.
+     * @param {string} message - Optional message providing details about the closure.
+     */
+    close(reason: number, message: string): void;
+    /**
+     * Adds an event listener to the WebSocket instance.
+     *
+     * @param {string} name - The event name.
+     * @param {Function} fn - The callback function to execute when the event occurs.
+     */
+    addEventListener(name: string, fn: any): void;
+    /**
+     * Creates an instance of `WebSocketMessageTransport`.
+     *
+     * @param {WebSocket} socket - The WebSocket object to use for communication.
+     * @param {IncomingMessage} req - The initial HTTP request associated with the connection.
+     */
+    constructor(socket: WebSocket, req: IncomingMessage);
+    /**
+     * Unique identifier for this transport instance.
+     *
+     * @type {string}
+     */
+    id: string;
+    /**
+     * Callback for handling the WebSocket `close` event.
+     *
+     * @type {(ev: CloseEvent) => void}
+     */
+    onClose: (ev: CloseEvent) => void;
+    /**
+     * Callback for handling the WebSocket `open` event.
+     *
+     * @type {(ev: Event) => void}
+     */
+    onOpen: (ev: Event) => void;
+    /**
+     * The current ready state of the WebSocket connection.
+     *
+     * @readonly
+     * @type {number}
+     */
+    get readyState(): number;
+    /**
+     * Sends a ping message to maintain the connection or test latency.
+     */
+    ping(): void;
+}

package/build/src/Transports/WebSocketMessageTransport.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketMessageTransport = void 0;
+const WebSocketMessage_1 = require("../Messages/WebSocketMessage");
+const StringUtils_1 = require("../Utils/StringUtils");
+/**
+ * A transport class for handling WebSocket communication and converting messages
+ * to/from the `WebSocketMessage` format.
+ *
+ * @export
+ * @class WebSocketMessageTransport
+ * @implements {ITransport}
+ */
+class WebSocketMessageTransport {
+    /**
+     * Sends data through the WebSocket connection.
+     *
+     * @param {any} data - The data to be sent.
+     */
+    send(data) {
+        this.socket.send(data);
+    }
+    /**
+     * Closes the WebSocket connection.
+     *
+     * @param {number} reason - The reason code for closing the connection.
+     * @param {string} message - Optional message providing details about the closure.
+     */
+    close(reason, message) {
+        this.socket.close(reason, message);
+    }
+    /**
+     * Adds an event listener to the WebSocket instance.
+     *
+     * @param {string} name - The event name.
+     * @param {Function} fn - The callback function to execute when the event occurs.
+     */
+    addEventListener(name, fn) {
+        this.socket.addEventListener(name, fn);
+    }
+    /**
+     * Creates an instance of `WebSocketMessageTransport`.
+     *
+     * @param {WebSocket} socket - The WebSocket object to use for communication.
+     * @param {IncomingMessage} req - The initial HTTP request associated with the connection.
+     */
+    constructor(socket, req) {
+        /**
+         * Callback for handling incoming messages. Defaults to creating a `WebSocketMessage`.
+         *
+         * @type {(message: ITransportMessage) => void}
+         */
+        this.onMessage = (message) => {
+            // Default implementation
+        };
+        /**
+         * Callback for handling the WebSocket `close` event.
+         *
+         * @type {(ev: CloseEvent) => void}
+         */
+        this.onClose = (ev) => { };
+        /**
+         * Callback for handling the WebSocket `open` event.
+         *
+         * @type {(ev: Event) => void}
+         */
+        this.onOpen = (ev) => { };
+        this.id = StringUtils_1.StringUtils.newGuid();
+        this.request = req;
+        this.socket = socket;
+        this.socket.addEventListener("message", (event) => {
+            this.onMessage(new WebSocketMessage_1.WebSocketMessage(event.data, typeof event.data !== "string"));
+        });
+    }
+    /**
+     * The current ready state of the WebSocket connection.
+     *
+     * @readonly
+     * @type {number}
+     */
+    get readyState() {
+        return this.socket.readyState;
+    }
+    /**
+     * Sends a ping message to maintain the connection or test latency.
+     */
+    ping() {
+        var _a, _b;
+        // Assumes the WebSocket implementation supports ping.
+        (_b = (_a = this.socket).ping) === null || _b === void 0 ? void 0 : _b.call(_a);
+    }
+}
+exports.WebSocketMessageTransport = WebSocketMessageTransport;

package/build/src/Utils/BufferUtils.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Utility class for buffer and binary operations.
+ *
+ * @export
+ * @class BufferUtils
+ */
+export declare class BufferUtils {
+    /**
+     * Converts a string into a `Uint8Array` buffer.
+     *
+     * @static
+     * @param {string} str - The input string to convert.
+     * @returns {Uint8Array} The resulting buffer as a `Uint8Array`.
+     */
+    static stringToBuffer(str: string): Uint8Array;
+    /**
+     * Converts a `Uint8Array` to a long integer.
+     *
+     * @static
+     * @param {Uint8Array} byteArray - The input byte array.
+     * @returns {number} The resulting long integer.
+     */
+    static arrayToLong(byteArray: Uint8Array): number;
+    /**
+     * Converts a long integer to an array of bytes.
+     *
+     * @static
+     * @param {number} long - The long integer to convert.
+     * @returns {Array<number>} The resulting array of bytes.
+     */
+    static longToArray(long: number): Array<number>;
+}

package/build/src/Utils/BufferUtils.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BufferUtils = void 0;
+/**
+ * Utility class for buffer and binary operations.
+ *
+ * @export
+ * @class BufferUtils
+ */
+class BufferUtils {
+    /**
+     * Converts a string into a `Uint8Array` buffer.
+     *
+     * @static
+     * @param {string} str - The input string to convert.
+     * @returns {Uint8Array} The resulting buffer as a `Uint8Array`.
+     */
+    static stringToBuffer(str) {
+        let len = str.length;
+        let arr = new Array(len);
+        for (let i = 0; i < len; i++) {
+            arr[i] = str.charCodeAt(i) & 0xFF;
+        }
+        return new Uint8Array(arr);
+    }
+    /**
+     * Converts a `Uint8Array` to a long integer.
+     *
+     * @static
+     * @param {Uint8Array} byteArray - The input byte array.
+     * @returns {number} The resulting long integer.
+     */
+    static arrayToLong(byteArray) {
+        let value = 0;
+        for (let i = byteArray.byteLength - 1; i >= 0; i--) {
+            value = (value * 256) + byteArray[i];
+        }
+        return value;
+    }
+    /**
+     * Converts a long integer to an array of bytes.
+     *
+     * @static
+     * @param {number} long - The long integer to convert.
+     * @returns {Array<number>} The resulting array of bytes.
+     */
+    static longToArray(long) {
+        const byteArray = [0, 0, 0, 0, 0, 0, 0, 0];
+        for (let index = 0; index < byteArray.length; index++) {
+            const byte = long & 0xff;
+            byteArray[index] = byte;
+            long = (long - byte) / 256;
+        }
+        return byteArray;
+    }
+}
+exports.BufferUtils = BufferUtils;

package/build/src/Utils/StringUtils.d.ts

@@ -0,0 +1,15 @@
+export declare class StringUtils {
+    /**
+     * Generates a GUID/UUID-like string.
+     *
+     * @returns {string} A GUID/UUID-like string.
+     */
+    static newGuid(): string;
+    /**
+     * Extracts key-value parameters from a query string.
+     *
+     * @param {string} query - The query string to parse.
+     * @returns {Record<string, string>} An object containing the parsed key-value pairs.
+     */
+    static getParamsFromString(query: string): Record<string, string>;
+}

package/build/src/Utils/StringUtils.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringUtils = void 0;
+class StringUtils {
+    /**
+     * Generates a GUID/UUID-like string.
+     *
+     * @returns {string} A GUID/UUID-like string.
+     */
+    static newGuid() {
+        const s4 = () => {
+            return Math.floor((1 + Math.random()) * 0x10000).toString(16).substring(1);
+        };
+        return s4() + s4() + "-" + s4() + "-" + s4() + "-" + s4() + "-" + s4() + s4() + s4();
+    }
+    /**
+     * Extracts key-value parameters from a query string.
+     *
+     * @param {string} query - The query string to parse.
+     * @returns {Record<string, string>} An object containing the parsed key-value pairs.
+     */
+    static getParamsFromString(query) {
+        const params = {};
+        query.replace(/^\?/, '').split('&').forEach(param => {
+            const [key, value] = param.split('=');
+            params[decodeURIComponent(key)] = decodeURIComponent(value || '');
+        });
+        return params;
+    }
+}
+exports.StringUtils = StringUtils;

package/build/src/test.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BrokerController_1 = require("./Controllers/BrokerController/BrokerController");
+const ThorIOServer_1 = require("./ThorIOServer");
+const thorio = ThorIOServer_1.ThorIOServer.createInstance([BrokerController_1.BrokerController]);

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/hierarchy.js

@@ -0,0 +1 @@
+window.hierarchyData = "eJyN0rFqwzAQBuB3ufnS2JZcKRq7ZSgUWugQPLj2ORFx5CApU9C7FxMa3NSuNAmk//iO013BDoN3oHZCcpQ5rxAsdT01Xg/GgboCE9l4mPpEoOBNn+mVnKv3BAhHbVpQeSERLrYHBU1fO0duPYk9HfypB7w9gQLv2tVYt7pdBAQm2UT4pK/3oTmST2AeswnWhk+sl0vXkU2AfgXjCs/K+Zl92Nq482B94vDu+QSTiX+mmAQvFiXooliaaxI9XxF3hZz+5/avVZTPP5Y2nmxXN+TW2zhxT4+PB923lgyoHRcF8qxEzkQVEGQ+7z/uVKyN2GotdMM2HJnIkElWhRC+AV/rRJE="

package/docs/assets/highlight.css

@@ -0,0 +1,43 @@
+:root {
+    --light-hl-0: #000000;
+    --dark-hl-0: #D4D4D4;
+    --light-hl-1: #795E26;
+    --dark-hl-1: #DCDCAA;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+pre, code { background: var(--code-background); }