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

package/package.json

@@ -1,50 +1,48 @@
-{
-    "name": "thor-io.vnext",
-    "author": {
-        "name": "Magnus Thor",
-        "email": "magnus.thor74@gmail.com"
-    },
-    "contributors": [
-        {
-            "name": "Ricky Davies",
-            "email": "rdavies@zen.co.uk"
-        }
-    ],
-    "description": "thor-io.vnext represents the next generation of thor-io.Thor-IO is a fundament for stateful real-time communication.TCP/IP,WebSockets & WebRTC or whatever you need and desire.",
-    "version": "2.0.5-beta.3",
-    "license": "MIT",
-    "main": "index.js",
-    "typings": " typings/index",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/MagnusThor/thor-io.vnext.git"
-    },
-    "keywords": [
-        "unity",
-        ".net",
-        "realtime",
-        "websockets",
-        "WebRTC",
-        "PubSub",
-        "RPC",
-        "Smart-RPC",
-        "IoT",
-        "NodeJS",
-        "RTC",
-        "Typescript"
-    ],
-    "dependencies": {
-        "@types/node": "^10.17.26",
-        "@types/reflect-metadata": "^0.1.0",
-        "ws": "^7.3.0"
-    },
-    "devDependencies": {
-        "@types/ws": "^7.2.5",
-        "express": "^4.17.1",
-        "express-ws": "^4.0.0",
-        "thor-io.client-vnext": "^2.0.2-beta.2",
-        "typescript": "^3.9.5",
-        "typings": "^2.1.1",
-        "webpack": "^4.43.0"
-    }
-}
+{
+    "name": "thor-io.vnext",
+    "author": {
+        "name": "Magnus Thor",
+        "email": "magnus.thor74@gmail.com"
+    },
+    "contributors": [
+        {
+            "name": "Ricky Davies",
+            "email": "rdavies@zen.co.uk"
+        }
+    ],
+    "description": "thor-io.vnext represents the next generation of thor-io.Thor-IO is a fundament for stateful real-time communication.TCP/IP,WebSockets & WebRTC or whatever you need and desire.",
+    "version": "3.1.0-beta.1",
+    "license": "MIT",
+    "main": "build/index.js",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/MagnusThor/thor-io.vnext.git"
+    },
+    "keywords": [
+        "unity",
+        ".net",
+        "realtime",
+        "websockets",
+        "WebRTC",
+        "PubSub",
+        "RPC",
+        "Smart-RPC",
+        "IoT",
+        "NodeJS",
+        "RTC",
+        "Typescript"
+    ],
+    "dependencies": {
+        "@types/node": "^10.17.26",
+        "@types/reflect-metadata": "^0.1.0",
+        "ws": "^7.3.0"
+    },
+    "devDependencies": {
+        "@types/ws": "^7.2.5",
+        "express": "^4.17.1",
+        "express-ws": "^4.0.0",
+        "typedoc": "^0.27.6",
+        "typings": "^0.6.10",
+        "webpack": "^5.97.1"
+    }
+}

package/readme.md

@@ -1 +1,32 @@
-See https://github.com/MagnusThor/thor-io.vnext/wiki for a brief documnentation.
+**The Foundation for Next-Gen, Stateful Real-Time Communication**
+
+thor-io.vnext empowers you to build cutting-edge, real-time applications with unparalleled flexibility and performance. 
+
+**Key Features:**
+
+* **Rock-Solid Foundation:** Built for demanding applications, thor-io.vnext provides a robust framework for stateful real-time communication.
+* **Unleash Your Creativity:** Seamlessly integrate with your preferred transport layer: TCP/IP, WebSockets, WebRTC, or any custom solution you envision.
+* **Effortless Integration:** Easily plug into your existing Node.js ecosystem – works flawlessly with Express and other popular middleware. 
+* **WebRTC Signaling Made Easy:** Leverage built-in WebRTC signaling capabilities to simplify the development of peer-to-peer applications.
+
+**What can you build with thor-io.vnext?**
+
+* **Real-time Collaboration:** Power collaborative tools like shared editors, whiteboards, and online design platforms.
+* **Immersive Experiences:** Create captivating online games, interactive simulations, and virtual/augmented reality applications.
+* **High-Performance Applications:** Build robust applications that demand real-time data synchronization, such as financial trading platforms and IoT solutions.
+* **And Much More!** The possibilities are limited only by your imagination.
+
+**Getting Started:**
+
+**Install**
+  ```bash
+   npm install thor-io.vnext
+```
+
+ **Documentation**
+
+ https://../doc 
+
+
+
+/Magnus Thor

package/src/{Client → Connection}/ClientInfo.ts

@@ -1,43 +1,34 @@
-// todo: refactor this, implememt PI for a sticky session?
-/**
- *
- *
- * @export
- * @class ClientInfo
- */
-export class ClientInfo {
-    /**
-     *
-     *
-     * @type {string}
-     * @memberOf ClientInfo
-     */
-    public CI: string;
-    /**
-     *
-     *
-     * @type {string}
-     * @memberOf ClientInfo
-     */
-    public C: string;
-    /**
-     *
-     *
-     * @type {Date}
-     * @memberOf ClientInfo
-     */
-    public TS: Date;
-    /**
-     * Creates an instance of ClientInfo.
-     *
-     * @param {string} ci
-     * @param {string} controller
-     *
-     * @memberOf ClientInfo
-     */
-    constructor(ci: string, controller: string) {
-        this.CI = ci;
-        this.C = controller;
-        this.TS = new Date();
-    }
-}
+export class ClientInfo {
+    /**
+     * The client identifier.
+     *
+     * @type {string}
+     */
+    public CI: string;
+
+    /**
+     * The controller identifier.
+     *
+     * @type {string}
+     */
+    public C: string;
+
+    /**
+     * The timestamp when the instance was created.
+     *
+     * @type {Date}
+     */
+    public TS: Date;
+
+    /**
+     * Creates an instance of ClientInfo.
+     *
+     * @param {string} ci - The client identifier.
+     * @param {string} controller - The controller identifier.
+     */
+    constructor(ci: string, controller: string) {
+        this.CI = ci;
+        this.C = controller;
+        this.TS = new Date();
+    }
+}

package/src/Connection/Connection.ts

@@ -0,0 +1,229 @@
+import { ControllerBase } from '../Controller/ControllerBase';
+import { ITransport } from '../Interfaces/ITransport';
+import { ITransportMessage } from '../Interfaces/ITransportMessage';
+import { TextMessage } from '../Messages/TextMessage';
+import { Plugin } from '../Server/Plugin';
+import { ClientInfo } from './ClientInfo';
+
+export class Connection {
+
+  /**
+   * An array to store errors.
+   * @public
+   * @type {Array<any>}
+   */
+  public errors: Array<any> = [];
+
+  /**
+   * The ping pong interval.
+   * @public
+   * @type {number}
+   */
+  public pingPongInterval: number = 60;
+
+  /**
+   * A map to store the controller instances.
+   * @public
+   * @type {Map<string, ControllerBase>}
+   */
+  public controllerInstances: Map<string, ControllerBase> = new Map();
+
+  /**
+   * Client information.
+   * @public
+   * @type {ClientInfo | undefined}
+   */
+  public 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(
+    controller: ControllerBase,
+    methodOrProperty: string,
+    data: string,
+    buffer?: 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) as { resultId: string };
+      controller.getProperty(methodOrProperty, resultId);
+    }
+  }
+
+  /**
+   * Getter for the connection ID.
+   * @public
+   * @returns {string} The connection ID.
+   */
+  get id(): string {
+    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(
+    public transport: ITransport,
+    public connections: Map<string, Connection>,
+    private controllers: Map<string, Plugin<ControllerBase>>
+  ) {
+    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.
+   */
+  private setupTransport(transport: ITransport) {
+    if (transport) {
+      this.transport.onMessage = (event: ITransportMessage) => {
+        try {
+          const message = event.isBinary ? 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.
+   */
+  private addError(error: any) {
+    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: string): boolean {
+    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: string): boolean {
+    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: string): ControllerBase | undefined {
+    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.
+   */
+  private addControllerInstance(controller: ControllerBase): ControllerBase {
+    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.
+   */
+  public tryResolveController(alias: string): ControllerBase {
+    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: string): ControllerBase | undefined {
+    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.
+   */
+  private initializeControllerInstance(controllerInstance: ControllerBase) {
+    controllerInstance.invoke(
+      new ClientInfo(this.id, controllerInstance.alias!),
+      '___open',
+      controllerInstance.alias!
+    );
+    if (controllerInstance.onopen) controllerInstance.onopen();
+    this.transport.onClose = (e: any) => {
+      if (controllerInstance.onclose) controllerInstance.onclose();
+    };
+  }
+}

package/src/Connection/IClientInfo.ts

@@ -0,0 +1,22 @@
+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;
+}