@nsshunt/stssocketioutils 2.0.6 → 2.0.7

package/dist/stssocketioutils.umd.js

@@ -1,609 +0,0 @@
-(function(global, factory) {
-  typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("socket.io-client"), require("@nsshunt/stsutils"), require("socket.io"), require("ioredis"), require("@socket.io/cluster-adapter"), require("@socket.io/redis-streams-adapter")) : typeof define === "function" && define.amd ? define(["exports", "socket.io-client", "@nsshunt/stsutils", "socket.io", "ioredis", "@socket.io/cluster-adapter", "@socket.io/redis-streams-adapter"], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global["@nsshunt/stssocketioutils"] = {}, global.socket["io-client"], global.stsutils, global.socket.io, global.ioredis, global["@socket"]["io/cluster-adapter"], global["@socket"]["io/redis-streams-adapter"]));
-})(this, (function(exports2, socket_ioClient, stsutils, socket_io, ioredis, clusterAdapter, redisStreamsAdapter) {
-  "use strict";
-  var STSNamespace = /* @__PURE__ */ ((STSNamespace2) => {
-    STSNamespace2["STSMonitor"] = "stsinstrumentmanager/stsmonitor";
-    STSNamespace2["STSControl"] = "stsinstrumentmanager/stscontrol";
-    STSNamespace2["STSTestingNamespace"] = "ststestingnamespace/ststesting";
-    return STSNamespace2;
-  })(STSNamespace || {});
-  var STSRoom = /* @__PURE__ */ ((STSRoom2) => {
-    STSRoom2["STSInstrumentDataRoom"] = "stsinstrumentdataroom";
-    STSRoom2["STSInstrumentDataSubscriptionRoom"] = "stsinstrumentdatasubscriptionroom";
-    STSRoom2["STSRunnerRoom"] = "stsrunnerroom";
-    STSRoom2["STSNodeRunnerRoom"] = "stsnoderunnerroom";
-    return STSRoom2;
-  })(STSRoom || {});
-  var STSEvent = /* @__PURE__ */ ((STSEvent2) => {
-    STSEvent2["STSInstrumentData"] = "stsinstrumentdata";
-    STSEvent2["STSSubInstrumentData"] = "stssubinstrumentdata";
-    STSEvent2["STSResetInstrumentData"] = "stsresetinstrumentdata";
-    STSEvent2["STSStartLoggingInstrumentData"] = "stsStartLoggingInstrumentData";
-    STSEvent2["STSStopLoggingInstrumentData"] = "stsStopLoggingInstrumentData";
-    STSEvent2["STSStart"] = "stsstart";
-    STSEvent2["STSStop"] = "stsstop";
-    STSEvent2["STSPause"] = "stspause";
-    STSEvent2["STSResume"] = "stsresume";
-    STSEvent2["STSTerminate"] = "ststerminate";
-    STSEvent2["STSUpdateStaticConfig"] = "stsupdatestaticconfig";
-    STSEvent2["STSUpdateDynamicConfig"] = "stsupdatedynamicconfig";
-    STSEvent2["STSSendToRoom"] = "sendToRoom";
-    STSEvent2["connect"] = "connect";
-    return STSEvent2;
-  })(STSEvent || {});
-  const isNode = Object.prototype.toString.call(typeof process !== "undefined" ? process : 0) === "[object process]";
-  var tinyEmitter = { exports: {} };
-  var hasRequiredTinyEmitter;
-  function requireTinyEmitter() {
-    if (hasRequiredTinyEmitter) return tinyEmitter.exports;
-    hasRequiredTinyEmitter = 1;
-    function E() {
-    }
-    E.prototype = {
-      on: function(name, callback, ctx) {
-        var e = this.e || (this.e = {});
-        (e[name] || (e[name] = [])).push({
-          fn: callback,
-          ctx
-        });
-        return this;
-      },
-      once: function(name, callback, ctx) {
-        var self2 = this;
-        function listener() {
-          self2.off(name, listener);
-          callback.apply(ctx, arguments);
-        }
-        listener._ = callback;
-        return this.on(name, listener, ctx);
-      },
-      emit: function(name) {
-        var data = [].slice.call(arguments, 1);
-        var evtArr = ((this.e || (this.e = {}))[name] || []).slice();
-        var i = 0;
-        var len = evtArr.length;
-        for (i; i < len; i++) {
-          evtArr[i].fn.apply(evtArr[i].ctx, data);
-        }
-        return this;
-      },
-      off: function(name, callback) {
-        var e = this.e || (this.e = {});
-        var evts = e[name];
-        var liveEvents = [];
-        if (evts && callback) {
-          for (var i = 0, len = evts.length; i < len; i++) {
-            if (evts[i].fn !== callback && evts[i].fn._ !== callback)
-              liveEvents.push(evts[i]);
-          }
-        }
-        liveEvents.length ? e[name] = liveEvents : delete e[name];
-        return this;
-      }
-    };
-    tinyEmitter.exports = E;
-    tinyEmitter.exports.TinyEmitter = E;
-    return tinyEmitter.exports;
-  }
-  var tinyEmitterExports = requireTinyEmitter();
-  class SocketIoClient extends tinyEmitterExports.TinyEmitter {
-    #agentManager;
-    #logger;
-    #name;
-    #address;
-    #socketIoCustomPath;
-    #authToken;
-    #socket;
-    constructor(name) {
-      super();
-      this.#name = name;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    LogDebugMessage(message) {
-      if (this.#logger) this.#logger.debug(message);
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    LogErrorMessage(message) {
-      if (this.#logger) this.#logger.error(message);
-    }
-    get name() {
-      return this.#name;
-    }
-    get agentManager() {
-      return this.#agentManager;
-    }
-    get logger() {
-      return this.#logger;
-    }
-    get address() {
-      return this.#address;
-    }
-    get authToken() {
-      return this.#authToken;
-    }
-    get socketIoCustomPath() {
-      return this.#socketIoCustomPath;
-    }
-    get socket() {
-      return this.#socket;
-    }
-    WithAddress(address) {
-      this.#address = address;
-      return this;
-    }
-    WithAuthToken(authToken) {
-      this.#authToken = authToken;
-      return this;
-    }
-    WithSocketIoCustomPath(socketIoCustomPath) {
-      this.#socketIoCustomPath = socketIoCustomPath;
-      return this;
-    }
-    WithLogger(logger) {
-      this.#logger = logger;
-      return this;
-    }
-    WithAgentManager(agentManager) {
-      this.#agentManager = agentManager;
-      return this;
-    }
-    SetupSocket() {
-      if (!this.#address) {
-        throw new Error(`SocketIoClientHelper:SetupSocket(): Error: [address not provided]`);
-      }
-      this.#EstablishSocketConnect();
-      return this;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ConnectCallBack(socket) {
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    SocketEventsCallBack(socket) {
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ErrorCallBack(error) {
-    }
-    /*
-    emit<Ev extends EventNames<ClientToServerEvents>>(ev: Ev, ...args: EventParams<ClientToServerEvents, Ev>): Socket<ServerToClientEvents, ClientToServerEvents> {
-        if (this.#socket) {
-            return this.#socket!.emit(ev, ...args);
-        } else {
-            throw new Error('SocketIoClient:emit(): Error: [socket instance not defined.]');
-        }
-    }
-    */
-    #EstablishSocketConnect() {
-      if (this.#socket !== void 0) {
-        if (this.#socket.connected === true) {
-          this.#socket.disconnect();
-        }
-        this.#socket = void 0;
-        if (isNode) {
-          setTimeout(() => this.#EstablishSocketConnect(), 100).unref();
-        } else {
-          setTimeout(() => this.#EstablishSocketConnect(), 100);
-        }
-        return;
-      }
-      let socketOptions;
-      if (isNode) {
-        socketOptions = {
-          transports: ["websocket"]
-        };
-        if (this.#agentManager) {
-          if (!this.#address) {
-            throw new Error(`SocketIoClientHelper:SetupSocket(): Error: [address not provided when using agentManager]`);
-          }
-          socketOptions.agent = this.#agentManager.GetAgent(this.#address);
-        }
-      } else {
-        socketOptions = {
-          transports: ["websocket"]
-        };
-      }
-      if (this.#authToken) {
-        socketOptions.auth = (cb) => {
-          cb({
-            token: this.#authToken
-          });
-        };
-      }
-      if (this.#socketIoCustomPath && this.#socketIoCustomPath.localeCompare("") !== 0) {
-        socketOptions.path = this.#socketIoCustomPath;
-      }
-      this.#socket = socket_ioClient.io(this.#address, socketOptions);
-      this.#socket.io.on("error", (err) => {
-        this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.io.on('error'): [${err}] Address: [${this.#address}]`);
-      });
-      this.#socket.io.on("reconnect_error", (err) => {
-        this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.io.on('reconnect_error'): [${err}] Address: [${this.#address}]`);
-      });
-      this.#socket.on("connect_error", (err) => {
-        this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.on('connect_error'): [${err}] Address: [${this.#address}]`);
-      });
-      this.#socket.io.on("reconnect", (attempt) => {
-        this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.io.on('reconnect'): Number: [${attempt}] Address: [${this.#address}]`);
-      });
-      this.#socket.on("connect", () => {
-        if (this.#socket) {
-          this.LogDebugMessage(`SocketIoClientHelper(): Socket: [${this.#socket.id}]: connected, Address: [${this.#address}]`);
-          setTimeout(() => {
-            this.ConnectCallBack(this.#socket);
-          }, 0);
-          this.SocketEventsCallBack(this.#socket);
-        } else {
-          const errorMessage = "SocketIoClientHelper(): Could not get socket object from socket.io, Address: [${socketDetail.address}]";
-          this.LogErrorMessage(errorMessage);
-          this.ErrorCallBack(new Error(errorMessage));
-        }
-      });
-      this.#socket.on("disconnect", (reason) => {
-        this.LogDebugMessage("SocketIoClientHelper(): socket disconnect: " + reason);
-        switch (reason) {
-          case "io server disconnect":
-            {
-              this.LogDebugMessage("SocketIoClientHelper(): The server disconnected using disconnectSockets, i.e. normal safe shutdown from explicit disconnection by the server.");
-              this.LogDebugMessage("SocketIoClientHelper(): The connection will be re-established when the server becomes available.");
-              this.#socket = void 0;
-              if (isNode) {
-                if (this.#agentManager) {
-                  this.#agentManager.ResetAgent();
-                }
-                setTimeout(() => this.#EstablishSocketConnect(), 100).unref();
-              } else {
-                setTimeout(() => this.#EstablishSocketConnect(), 100);
-              }
-            }
-            break;
-          case "io client disconnect":
-            this.LogDebugMessage("SocketIoClientHelper(): The client disconnected using disconnectSockets, i.e. normal safe disconnection from explicit disconnection by the client.");
-            this.LogDebugMessage("SocketIoClientHelper(): The connection will not be re-established automatically.");
-            break;
-          case "transport close":
-          case "ping timeout":
-          case "transport error":
-            {
-              this.LogDebugMessage(`SocketIoClientHelper(): Server unexpectedly disconnected. Reason: [${reason}]`);
-              this.LogDebugMessage("SocketIoClientHelper(): The connection will be re-established when the server becomes available.");
-              if (this.#socket) {
-                this.#socket.disconnect();
-              }
-              this.#socket = void 0;
-              if (isNode) {
-                if (this.#agentManager) {
-                  this.#agentManager?.ResetAgent();
-                }
-                setTimeout(() => this.#EstablishSocketConnect(), 100).unref();
-              } else {
-                setTimeout(() => this.#EstablishSocketConnect(), 100);
-              }
-            }
-            break;
-        }
-      });
-    }
-  }
-  class SocketIoServer extends tinyEmitterExports.TinyEmitter {
-    namespace;
-    socketionamespace;
-    //protected socketionamespace?: Namespace<ClientToServerEvents, ServerToClientEvents, InterServerEvents>
-    logger;
-    io;
-    //#redisClient: RedisClientType | Redis | null = null;
-    redisClient;
-    listenPort;
-    socketIoCustomPath;
-    ioRedisMessageProcessorUrl;
-    serverClusterMode;
-    rooms;
-    constructor() {
-      super();
-    }
-    LogErrorMessage(message) {
-      if (this.logger) {
-        this.logger.error(`${this.namespace}: ${message}`);
-      }
-    }
-    LogDebugMessage(message) {
-      if (this.logger) {
-        this.logger.debug(`${this.namespace}: ${message}`);
-      }
-    }
-    LogInfoMessage(message) {
-      if (this.logger) {
-        this.logger.info(`${this.namespace}: ${message}`);
-      }
-    }
-    LogWarnMessage(message) {
-      if (this.logger) {
-        this.logger.warn(`${this.namespace}: ${message}`);
-      }
-    }
-    // https://socket.io/docs/v4/middlewares/
-    // https://socket.io/docs/v4/server-socket-instance/#sockethandshake
-    // https://socket.io/docs/v4/server-socket-instance/#socket-middlewares
-    // Use this middleward to check every incomming connection
-    SetupConnectionMiddleware = () => {
-    };
-    // Use this middleware to check every packet being received
-    SetupMessageMiddleware = (socket) => {
-    };
-    SocketConnectCallBack = (socket) => {
-    };
-    SocketEventsCallBack = (socket) => {
-    };
-    GetConfig = (socketIoServeroptions) => {
-      const options = {
-        transports: ["websocket"]
-        // or [ "websocket", "polling" ] (to use long-poolling. Note that the order matters)
-      };
-      if (socketIoServeroptions.ioRedisMessageProcessorUrl && socketIoServeroptions.ioRedisMessageProcessorUrl !== "") {
-        this.redisClient = new ioredis.Redis(socketIoServeroptions.ioRedisMessageProcessorUrl);
-        options.adapter = redisStreamsAdapter.createAdapter(this.redisClient);
-      } else if (socketIoServeroptions.serverClusterMode && socketIoServeroptions.serverClusterMode === true) {
-        options.adapter = clusterAdapter.createAdapter();
-      }
-      if (socketIoServeroptions.wssCustomPath && socketIoServeroptions.wssCustomPath.localeCompare("") !== 0) {
-        options.path = socketIoServeroptions.wssCustomPath;
-      }
-      return options;
-    };
-    SetEngineEvents = () => {
-      if (this.io) {
-        this.io.engine.on("connection_error", (err) => {
-          this.LogInfoMessage(err.req);
-          this.LogInfoMessage(err.code);
-          this.LogInfoMessage(err.message);
-          this.LogInfoMessage(err.context);
-        });
-      }
-    };
-    WithLogger = (logger) => {
-      this.logger = logger;
-      return this;
-    };
-    WithExistingServer = (server) => {
-      if (this.io) {
-        throw new Error(`SocketIoServer:AttachServer(): Error: [Server already attached]`);
-      }
-      this.io = server;
-      return this;
-    };
-    WithListenPort = (listenPort) => {
-      this.listenPort = listenPort;
-      return this;
-    };
-    WithSocketIoCustomPath = (socketIoCustomPath) => {
-      this.socketIoCustomPath = socketIoCustomPath;
-      return this;
-    };
-    WithIoRedisMessageProcessorUrl = (ioRedisMessageProcessorUrl) => {
-      this.ioRedisMessageProcessorUrl = ioRedisMessageProcessorUrl;
-      return this;
-    };
-    WithClusterMode = (serverClusterMode) => {
-      this.serverClusterMode = serverClusterMode;
-      return this;
-    };
-    WithRooms = (rooms) => {
-      this.rooms = rooms;
-      return this;
-    };
-    WithNamespace = (namespace) => {
-      this.namespace = namespace;
-      return this;
-    };
-    StartServer = async () => {
-      if (!this.namespace) {
-        throw new Error(`SocketIoServer:StartServer(): Error: [namespace not specified]`);
-      }
-      if (!this.io) {
-        if (!this.listenPort) {
-          throw new Error(`SocketIoServer:StartServer(): Error: [listenPort not specified]`);
-        }
-        const options = {
-          transports: ["websocket"]
-          // or [ "websocket", "polling" ] (to use long-poolling. Note that the order matters)
-        };
-        if (this.ioRedisMessageProcessorUrl && this.ioRedisMessageProcessorUrl !== "") {
-          this.redisClient = new ioredis.Redis(this.ioRedisMessageProcessorUrl);
-          options.adapter = redisStreamsAdapter.createAdapter(this.redisClient);
-        } else if (this.serverClusterMode && this.serverClusterMode === true) {
-          options.adapter = clusterAdapter.createAdapter();
-        }
-        if (this.socketIoCustomPath && this.socketIoCustomPath.localeCompare("") !== 0) {
-          options.path = this.socketIoCustomPath;
-        }
-        this.io = new socket_io.Server(this.listenPort, options);
-        this.SetEngineEvents();
-        await stsutils.Sleep(500);
-      }
-      let autoJoinRooms;
-      let rooms;
-      if (this.rooms && this.rooms.length > 0) {
-        autoJoinRooms = true;
-        rooms = [...this.rooms];
-      } else {
-        autoJoinRooms = false;
-        rooms = [];
-      }
-      this.SetupNamespace(rooms, autoJoinRooms);
-      return this;
-    };
-    AttachServer = async (server) => {
-      if (this.io) {
-        throw new Error(`SocketIoServer:AttachServer(): Error: [Server already attached]`);
-      }
-      this.io = server;
-    };
-    StopServer = async () => {
-      if (this.io) {
-        await this.CloseNamespaceAdaptors();
-        this.DisconnectNamespaceSockets();
-        await this.io.of("/").adapter.close();
-        if (this.redisClient) {
-          await this.redisClient.disconnect();
-          await stsutils.Sleep(50);
-        }
-        this.io.disconnectSockets();
-        this.io = void 0;
-      }
-    };
-    LeaveRoom = (socket, room) => {
-      this.LogDebugMessage(`Leaving room [${room}]`);
-      socket.leave(room);
-    };
-    JoinRoom = (socket, room) => {
-      this.LogDebugMessage(`Socket joining room [${room}], ID: [${socket.id}]`);
-      socket.join(room);
-    };
-    SetupStandardEvents = (socket) => {
-      socket.on("disconnect", (reason) => {
-        this.LogDebugMessage(`socket disconnect, ID: [${socket.id}] [${reason}]`);
-      });
-      socket.on("disconnecting", (reason) => {
-        this.LogDebugMessage(`socket disconnecting, ID: [${socket.id}] [${reason}]`);
-      });
-      socket.on("error", (error) => {
-        this.LogDebugMessage(`socket error, ID: [${socket.id}] [${error}]`);
-      });
-      socket.on("__STSdisconnect", (reason) => {
-        this.LogDebugMessage(`__STSdisconnect: socket disconnect, ID: [${socket.id}] [${reason}]`);
-      });
-      socket.on("__STSdisconnecting", (reason, callBackResult) => {
-        this.LogDebugMessage(`__STSdisconnecting: socket disconnecting, ID: [${socket.id}] [${reason}]`);
-        callBackResult("__STSdisconnecting accepted by server.");
-      });
-      socket.on("__STSjoinRoom", (rooms) => {
-        rooms.forEach((room) => {
-          this.JoinRoom(socket, room);
-        });
-      });
-      socket.on("__STSleaveRoom", (rooms) => {
-        rooms.forEach((room) => {
-          this.LeaveRoom(socket, room);
-        });
-      });
-      socket.on("__STSsendToRoom", (rooms, payload) => {
-        rooms.forEach((room) => {
-          if (this.socketionamespace) {
-            this.LogDebugMessage(`socket.on: __STSsendToRoom: Sending to room [${room}], ID: [${socket.id}]`);
-            this.socketionamespace.to(room).emit(payload.command, payload);
-          }
-        });
-      });
-      socket.on("__STSsendToRoomWithCallback", (room, timeout, payload, cb) => {
-        if (this.socketionamespace) {
-          this.socketionamespace.to(room).timeout(timeout).emit(payload.command, payload, (err, dataResponse) => {
-            if (err) {
-              console.error(err);
-              const errorResponse = {
-                error: true,
-                errorName: err.name,
-                errorMessage: err.message
-                //errorCause: err.cause,
-                //errorStack: err.stack
-              };
-              this.LogErrorMessage(`__STSsendToRoomWithCallback broadcast (error): [${JSON.stringify(errorResponse)}]`);
-              cb(errorResponse);
-            } else {
-              this.LogDebugMessage(`__STSsendToRoomWithCallback broadcast: [${JSON.stringify(dataResponse)}]`);
-              cb(dataResponse);
-            }
-          });
-        }
-      });
-      socket.on("__STSsendToRoomsWithCallback", (rooms, timeout, payload, cb) => {
-        const responses = [];
-        const timeoutForComplete = setTimeout(() => {
-          responses.push({
-            room: "",
-            responses: {
-              error: true,
-              errorName: "timeout",
-              errorMessage: `__STSsendToRoomsWithCallback timeout: [${timeout}] before all responses received`
-            }
-          });
-          cb(responses);
-        }, timeout).unref();
-        rooms.forEach((room) => {
-          if (this.socketionamespace) {
-            this.socketionamespace.to(room).timeout(timeout).emit(payload.command, payload, (err, dataResponse) => {
-              if (err) {
-                console.error(err);
-                const errorResponse = {
-                  error: true,
-                  errorName: err.name,
-                  errorMessage: err.message
-                  //errorCause: err.cause,
-                  //errorStack: err.stack
-                };
-                this.LogErrorMessage(`__STSsendToRoomWithCallback broadcast (error): [${JSON.stringify(errorResponse)}]`);
-                responses.push({
-                  room,
-                  responses: errorResponse
-                });
-              } else {
-                this.LogDebugMessage(`__STSsendToRoomWithCallback broadcast: [${JSON.stringify(dataResponse)}]`);
-                responses.push({
-                  room,
-                  responses: dataResponse
-                });
-              }
-              if (responses.length === rooms.length) {
-                clearTimeout(timeoutForComplete);
-                cb(responses);
-              }
-            });
-          }
-        });
-      });
-    };
-    SetupNamespace = (rooms, autoJoinRooms) => {
-      if (this.io) {
-        this.socketionamespace = this.io.of(`/${this.namespace}/`);
-        this.SetupConnectionMiddleware();
-        this.socketionamespace.on("connection", (socket) => {
-          this.LogDebugMessage(`Socket connected, ID: [${socket.id}]`);
-          this.LogDebugMessage(`Authentication Handshake (auth): [${JSON.stringify(socket.handshake.auth)}]`);
-          this.LogDebugMessage(`Authentication Handshake (host): [${JSON.stringify(socket.handshake.headers.host)}]`);
-          this.LogDebugMessage(`Authentication Handshake (url): [${JSON.stringify(socket.handshake.url)}]`);
-          this.LogDebugMessage(`Authentication Handshake: [${JSON.stringify(socket.handshake)}]`);
-          this.SetupMessageMiddleware(socket);
-          if (autoJoinRooms) {
-            rooms.map((room) => {
-              this.JoinRoom(socket, room);
-            });
-          }
-          this.SetupStandardEvents(socket);
-          setTimeout(() => {
-            this.SocketConnectCallBack(socket);
-          }, 0);
-          this.SocketEventsCallBack(socket);
-        });
-      } else {
-        throw new Error("SocketIoServer:SetupNamespace(): Error: [No server attached");
-      }
-      return this;
-    };
-    CloseNamespaceAdaptors = async () => {
-      if (this.socketionamespace) {
-        await this.socketionamespace.adapter.close();
-      }
-    };
-    DisconnectNamespaceSockets = () => {
-      if (this.socketionamespace) {
-        this.socketionamespace.disconnectSockets();
-        this.socketionamespace = void 0;
-      }
-    };
-  }
-  exports2.STSEvent = STSEvent;
-  exports2.STSNamespace = STSNamespace;
-  exports2.STSRoom = STSRoom;
-  exports2.SocketIoClient = SocketIoClient;
-  exports2.SocketIoServer = SocketIoServer;
-  Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
-}));
-//# sourceMappingURL=stssocketioutils.umd.js.map