underpost 3.1.3 → 3.2.0

package/src/ws/default/channels/default.ws.main.js

@@ -1,16 +1,57 @@
-import { loggerFactory } from '../../../server/logger.js';
-import { IoCreateChannel } from '../../IoInterface.js';
+/**
+ * Default "main" WebSocket channel — minimal no-op channel.
+ * @module ws/default/channels/default.ws.main
+ */
 
-const channel = 'main';
-const logger = loggerFactory(import.meta);
+import { IoChannel } from '../../IoInterface.js';
 
-const DefaultWsMainController = {
-  channel,
-  controller: function (socket, client, payload, wsManagementId) {},
-  connection: function (socket, client, wsManagementId) {},
-  disconnect: function (socket, client, reason, wsManagementId) {},
-};
+/**
+ * @class DefaultWsMainChannel
+ * @classdesc Provides a no-op main channel for the default WebSocket server.
+ */
+class DefaultWsMainChannel {
+  /** @type {Object.<string, Object>} Per-instance state keyed by wsManagementId. */
+  static #state = {};
 
-const DefaultWsMainChannel = IoCreateChannel(DefaultWsMainController);
+  /** @type {IoChannel} */
+  static #io = new IoChannel({ channel: 'main' });
 
-export { DefaultWsMainChannel, DefaultWsMainController };
+  /** @returns {Object.<string, import('socket.io').Socket>} Connected sockets map. */
+  static get client() {
+    return this.#io.client;
+  }
+
+  /** @returns {string} Channel name. */
+  static get channel() {
+    return this.#io.channel;
+  }
+
+  /**
+   * Initializes state for a server instance.
+   * @param {string} wsManagementId
+   */
+  static init(wsManagementId) {
+    this.#state[wsManagementId] = {};
+  }
+
+  /**
+   * Registers a socket connection.
+   * @param {import('socket.io').Socket} socket
+   * @param {string} wsManagementId
+   */
+  static connection(socket, wsManagementId) {
+    return this.#io.connection(socket, wsManagementId);
+  }
+
+  /**
+   * Handles socket disconnection.
+   * @param {import('socket.io').Socket} socket
+   * @param {string} reason
+   * @param {string} wsManagementId
+   */
+  static disconnect(socket, reason, wsManagementId) {
+    return this.#io.disconnect(socket, reason, wsManagementId);
+  }
+}
+
+export { DefaultWsMainChannel };

package/src/ws/default/default.ws.connection.js

@@ -1,22 +1,35 @@
+/**
+ * Default WebSocket connection handler — wires sockets to the main channel.
+ * @module ws/default/default.ws.connection
+ */
+
 import { loggerFactory } from '../../server/logger.js';
 import { DefaultWsMainChannel } from './channels/default.ws.main.js';
 
 const logger = loggerFactory(import.meta);
 
-const DefaultWsConnection = function (socket, wsManagementId) {
-  // const headers = socket.handshake.headers;
-  // const ip = socket.handshake.address;
-  // const { query, auth } = socket.handshake;
-
-  logger.info(`DefaultWsConnection ${socket.id}`);
+/**
+ * @class DefaultWsConnectionHandler
+ * @classdesc Subscribes a new socket to the default main channel
+ * and delegates disconnect events.
+ */
+class DefaultWsConnectionHandler {
+  /**
+   * Handles a new WebSocket connection.
+   * @param {import('socket.io').Socket} socket
+   * @param {string} wsManagementId
+   */
+  static handle(socket, wsManagementId) {
+    logger.info(`DefaultWsConnection ${socket.id}`);
 
-  DefaultWsMainChannel.connection(socket, wsManagementId);
+    DefaultWsMainChannel.connection(socket, wsManagementId);
 
-  socket.on('disconnect', (reason) => {
-    logger.info(`DefaultWsConnection ${socket.id} due to reason: ${reason}`);
+    socket.on('disconnect', (reason) => {
+      logger.info(`DefaultWsConnection ${socket.id} due to reason: ${reason}`);
 
-    DefaultWsMainChannel.disconnect(socket, reason, wsManagementId);
-  });
-};
+      DefaultWsMainChannel.disconnect(socket, reason, wsManagementId);
+    });
+  }
+}
 
-export { DefaultWsConnection };
+export { DefaultWsConnectionHandler };

package/src/ws/default/default.ws.server.js

@@ -1,20 +1,38 @@
+/**
+ * Default WebSocket server factory — initializes the main channel and creates the Socket.IO server.
+ * @module ws/default/default.ws.server
+ */
+
 'use strict';
 
 import { IoServer } from '../IoServer.js';
-import { DefaultWsConnection } from './default.ws.connection.js';
-import { DefaultWsMainManagement } from './management/default.ws.main.js';
-
-// https://socket.io/docs/v3/
+import { DefaultWsConnectionHandler } from './default.ws.connection.js';
+import { DefaultWsMainChannel } from './channels/default.ws.main.js';
 
-const createIoServer = async (httpServer, options) => {
-  const { host, path } = options;
-  const wsManagementId = `${host}${path}`;
+/**
+ * @class DefaultWsServer
+ * @classdesc Creates the default WebSocket server with a single main channel.
+ */
+class DefaultWsServer {
+  /**
+   * Initializes the main channel and creates the Socket.IO server.
+   * @param {import('http').Server} httpServer
+   * @param {Object} options
+   * @param {string} options.host
+   * @param {string} options.path
+   * @returns {{ options: import('socket.io').ServerOptions, ioServer: import('socket.io').Server, meta: ImportMeta }}
+   */
+  static create(httpServer, options) {
+    const { host, path } = options;
+    const wsManagementId = `${host}${path}`;
 
-  DefaultWsMainManagement.instance(wsManagementId);
+    DefaultWsMainChannel.init(wsManagementId);
 
-  return IoServer(httpServer, options, (socket) => DefaultWsConnection(socket, wsManagementId));
-};
+    return IoServer.create(httpServer, options, (socket) => DefaultWsConnectionHandler.handle(socket, wsManagementId));
+  }
+}
 
-const DefaultWsServer = createIoServer;
+/** Required by Express.js dynamic import: `const { createIoServer } = await import(...)` */
+const createIoServer = DefaultWsServer.create.bind(DefaultWsServer);
 
-export { createIoServer, DefaultWsServer };
+export { DefaultWsServer, createIoServer };

package/src/client/components/default/ElementsDefault.js

@@ -1,38 +0,0 @@
-import { loggerFactory } from '../core/Logger.js';
-import { BaseElement } from './CommonDefault.js';
-
-const logger = loggerFactory(import.meta);
-
-const ElementsDefault = {
-  Data: BaseElement(),
-  Interval: {},
-  LocalDataScope: {},
-  Init: function (options = { type: 'user', id: 'main', element: {} }) {
-    const { type, id, element } = options;
-    this.Data[type][id] = {
-      ...BaseElement()[type].main,
-      ...this.Data[type][id],
-      ...element,
-    };
-    if (!this.Interval[type]) this.Interval[type] = {};
-    if (!this.Interval[type][id]) this.Interval[type][id] = {};
-    if (!this.LocalDataScope[type]) this.LocalDataScope[type] = {};
-    if (!this.LocalDataScope[type][id])
-      this.LocalDataScope[type][id] = {
-        path: [],
-      };
-  },
-  removeAll: function () {
-    for (const type of Object.keys(this.Data)) {
-      for (const id of Object.keys(this.Data[type])) {
-        if (this.Interval[type] && this.Interval[type][id]) {
-          for (const interval of Object.keys(this.Interval[type][id])) clearInterval(this.Interval[type][id][interval]);
-        }
-      }
-    }
-    this.Interval = {};
-    this.Data = BaseElement();
-  },
-};
-
-export { ElementsDefault };

package/src/ws/core/management/core.ws.chat.js

@@ -1,8 +0,0 @@
-const CoreWsChatManagement = {
-  element: {},
-  instance: function (wsManagementId = '') {
-    this.element[wsManagementId] = {};
-  },
-};
-
-export { CoreWsChatManagement };

package/src/ws/core/management/core.ws.mailer.js

@@ -1,16 +0,0 @@
-const CoreWsMailerManagement = {
-  element: {},
-  instance: function (wsManagementId = '') {
-    this.element[wsManagementId] = {};
-  },
-  getUserWsId: function (wsManagementId = '', id = '') {
-    for (const userWsId of Object.keys(this.element[wsManagementId])) {
-      if (this.element[wsManagementId][userWsId].model.user._id === id) {
-        return userWsId;
-      }
-    }
-    return undefined;
-  },
-};
-
-export { CoreWsMailerManagement };

package/src/ws/core/management/core.ws.stream.js

@@ -1,8 +0,0 @@
-const CoreWsStreamManagement = {
-  element: {},
-  instance: function (wsManagementId = '') {
-    this.element[wsManagementId] = {};
-  },
-};
-
-export { CoreWsStreamManagement };

package/src/ws/default/management/default.ws.main.js

@@ -1,8 +0,0 @@
-const DefaultWsMainManagement = {
-  element: {},
-  instance: function (wsManagementId = '') {
-    this.element[wsManagementId] = {};
-  },
-};
-
-export { DefaultWsMainManagement };