underpost 3.1.3 → 3.2.2

package/src/ws/core/core.ws.emit.js

@@ -1,29 +1,24 @@
 /**
- * Module for standardized WebSocket message emission (sending).
- * @module ws/core.ws.emit
- * @namespace CoreWsEmitter
+ * Standardized WebSocket message emission.
+ * @module ws/core/core.ws.emit
  */
 
 import { loggerFactory } from '../../server/logger.js';
-import { Socket } from 'socket.io';
 
 const logger = loggerFactory(import.meta);
 
 /**
  * @class CoreWsEmitter
- * @alias CoreWsEmitter
- * @memberof CoreWsEmitter
- * @classdesc Provides a static utility method for safely emitting messages over a WebSocket connection.
+ * @classdesc Provides a static utility for safely emitting JSON-serialized messages over Socket.IO.
  */
 class CoreWsEmitter {
   /**
-   * Emits a payload to a specific client over a given channel.
-   * The payload is automatically JSON stringified.
+   * Emits a JSON-stringified payload to a client on a given channel.
    *
    * @static
-   * @param {string} [channel=''] - The name of the channel/event to emit on.
-   * @param {Socket | Object} [client={}] - The Socket.IO client/socket object. Must have an `emit` method.
-   * @param {Object} [payload={}] - The data object to send.
+   * @param {string} channel - The channel/event name to emit on.
+   * @param {import('socket.io').Socket} client - The Socket.IO socket to emit to.
+   * @param {Object} payload - The data object to send.
    * @returns {void}
    */
   static emit(channel = '', client = {}, payload = {}) {
@@ -31,23 +26,12 @@ class CoreWsEmitter {
       if (client && typeof client.emit === 'function') {
         client.emit(channel, JSON.stringify(payload));
       } else {
-        logger.error('Invalid client: Cannot emit message.', { channel, client, payload });
+        logger.error('Invalid client: Cannot emit message.', { channel, payload });
       }
     } catch (error) {
-      logger.error(error, { channel, client, payload, stack: error.stack });
+      logger.error(error, { channel, payload, stack: error.stack });
     }
   }
 }
 
-/**
- * Backward compatibility export for the `emit` function.
- * @memberof CoreWsEmitter
- * @function CoreWsEmit
- * @param {string} [channel=''] - The name of the channel/event to emit on.
- * @param {Socket | Object} [client={}] - The Socket.IO client/socket object.
- * @param {Object} [payload={}] - The data object to send.
- * @returns {void}
- */
-const CoreWsEmit = CoreWsEmitter.emit;
-
-export { CoreWsEmitter, CoreWsEmit };
+export { CoreWsEmitter };

package/src/ws/core/core.ws.server.js

@@ -1,76 +1,43 @@
 /**
- * Module for creating and initializing the main WebSocket server instance.
- * @module ws/core.ws.server
- * @namespace CoreWsServer
+ * Core WebSocket server factory — initializes channels and creates the Socket.IO server.
+ * @module ws/core/core.ws.server
  */
 
 'use strict';
 
-import { IoServerClass } from '../IoServer.js';
-import { CoreWsConnection } from './core.ws.connection.js';
-import { CoreWsChatManagement } from './management/core.ws.chat.js';
-import { CoreWsMailerManagement } from './management/core.ws.mailer.js';
-import { CoreWsStreamManagement } from './management/core.ws.stream.js';
-import http from 'http'; // Added for JSDoc type hinting
-
-// https://socket.io/docs/v3/
+import { IoServer } from '../IoServer.js';
+import { CoreWsConnectionHandler } from './core.ws.connection.js';
+import { CoreWsChatChannel } from './channels/core.ws.chat.js';
+import { CoreWsMailerChannel } from './channels/core.ws.mailer.js';
+import { CoreWsStreamChannel } from './channels/core.ws.stream.js';
 
 /**
- * @class CoreWsServerClass
- * @alias CoreWsServerClass
- * @memberof CoreWsServer
- * @classdesc Manages the creation and initialization of the main WebSocket server,
- * including setting up the management instances for all channels.
+ * @class CoreWsServer
+ * @classdesc Creates the core WebSocket server, initializing all channel state
+ * before attaching the connection handler.
  */
-class CoreWsServerClass {
+class CoreWsServer {
   /**
-   * Initializes channel management instances and creates the Socket.IO server.
-   *
-   * @static
-   * @async
-   * @param {http.Server} httpServer - The HTTP server instance to attach the WebSocket server to.
-   * @param {Object} options - Configuration options for the WebSocket server.
-   * @param {string} options.host - The host address.
-   * @param {string} options.path - The base path for the API.
-   * @returns {Promise<Object>} The result object from IoServer creation.
+   * Initializes channel state 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 async create(httpServer, options) {
+  static create(httpServer, options) {
     const { host, path } = options;
-    if (!host || !path) {
-      throw new Error('Host and path must be provided in server options.');
-    }
-
-    // Create a unique identifier for this server instance's management context
     const wsManagementId = `${host}${path}`;
 
-    // Initialize/Retrieve singleton management instances for all channels
-    CoreWsChatManagement.instance(wsManagementId);
-    CoreWsMailerManagement.instance(wsManagementId);
-    CoreWsStreamManagement.instance(wsManagementId);
+    CoreWsChatChannel.init(wsManagementId);
+    CoreWsMailerChannel.init(wsManagementId);
+    CoreWsStreamChannel.init(wsManagementId);
 
-    // Use the IoServerClass factory to create the server, passing the connection handler
-    return IoServerClass.create(httpServer, options, (socket) => CoreWsConnection(socket, wsManagementId));
+    return IoServer.create(httpServer, options, (socket) => CoreWsConnectionHandler.handle(socket, wsManagementId));
   }
 }
 
-/**
- * Backward compatibility export for the server creation function.
- * @memberof CoreWsServer
- * @function createIoServer
- * @param {http.Server} httpServer - The HTTP server instance.
- * @param {Object} options - Configuration options.
- * @returns {Promise<Object>} The server creation result.
- */
-const createIoServer = CoreWsServerClass.create;
-
-/**
- * Backward compatibility alias.
- * @memberof CoreWsServer
- * @function CoreWsServer
- * @param {import('http').Server} httpServer - The HTTP server instance.
- * @param {Object} options - Configuration options.
- * @returns {Promise<Object>} The server creation result.
- */
-const CoreWsServer = createIoServer;
+/** Required by Express.js dynamic import: `const { createIoServer } = await import(...)` */
+const createIoServer = CoreWsServer.create.bind(CoreWsServer);
 
-export { CoreWsServerClass, createIoServer, CoreWsServer };
+export { CoreWsServer, createIoServer };

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 };