@nsshunt/stssocketioutils 2.0.6 → 2.0.8

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/commonTypes.ts","../node_modules/detect-node/index.esm.js","../src/socketIoClient.ts"],"sourcesContent":["/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF\nimport { Server, Socket, Namespace } from \"socket.io\";\nimport { ISTSLogger } from '@nsshunt/stsutils'\n\nexport interface STSDefaultClientToServerEvents {\n    /**\n     * Join the room(s) specified for this client.\n     * @param room The room(s) to join for this client.\n     * @returns \n     */\n\t__STSjoinRoom: (room: string[]) => void;\n\n    /**\n     * Remove this client from the specified room(s).\n     * @param room The room(s) to remove the client from within the server.\n     * @returns \n     */\n\t__STSleaveRoom: (room: string[]) => void;\n\n    /**\n     * Alerts the server that this client has flagged to disconnect. Allows server to perform clean-up if required. The server must call-back with the result of the disconnecting event.\n     * @param reason Reason for the disconnecting event.\n     * @param callback The server must call-back with the result of the disconnecting event.\n     * @returns \n     */\n\t__STSdisconnecting: (reason: string, callback: (data: string) => void) => void;\n\n    /**\n     * Alerts the server to disconnect this client.\n     * @param reason Reason for the disconnect event.\n     * @returns \n     */\n\t__STSdisconnect: (reason: string) => void; // server and client event\n\n    /**\n     * Send a payload of data to 1 or more rooms registered on the server.\n     * @param rooms Room array for broadcasting.\n     * @param payload The data to be sent to every client within each of the rooms provided. The command within the payload must be a valid STSServerToClientEvents event. This includes any\n     * interface that extends STSServerToClientEvents.\n     * @returns \n     */\n    __STSsendToRoom: (rooms: string[], payload: { command: string, payload: any }) => void;\n\n    /**\n     * Send a payload of data to 1 or more rooms registered on the server.\n     * @param room Single room for broadcasting.\n\t * @param timeout Number of ms to try and get responses from all clients\n     * @param payload The data to be sent to every client within each of the rooms provided. The command within the payload must be a valid STSServerToClientEvents event. This includes any\n     * interface that extends STSServerToClientEvents.\n\t * @param callback The callback function to be invoked once all clients have responded with their respective payloads\n     * @returns \n     */\n    __STSsendToRoomWithCallback: (room: string, timeout: number, payload: { command: string, payload: any }, callback: (data: any) => void) => void;    \n\n    /**\n     * Send a payload of data to 1 or more rooms registered on the server.\n     * @param rooms Array of rooms for broadcasting.\n\t * @param timeout Number of ms to try and get responses from all clients\n     * @param payload The data to be sent to every client within each of the rooms provided. The command within the payload must be a valid STSServerToClientEvents event. This includes any\n     * interface that extends STSServerToClientEvents.\n\t * @param callback The callback function to be invoked once all clients have responded with their respective payloads\n     * @returns \n     */\n    __STSsendToRoomsWithCallback: (rooms: string[], timeout: number, payload: { command: string, payload: any }, callback: (data: any) => void) => void;    \n}\n\nexport interface STSDefaultServerToClientEvents {\n    /**\n     * The server may emit an unsolicited disconnect event to flag that all clients should disconnect. Most likely becuase the server may be shutting down.\n     * @param reason Reason why the server is emitting this disconnect event.\n     * @returns \n     */\n\t__STSdisconnect: (reason: string) => void;\n}\n\nexport enum STSNamespace {\n\tSTSMonitor = 'stsinstrumentmanager/stsmonitor',\n\tSTSControl = 'stsinstrumentmanager/stscontrol',\n    STSTestingNamespace = 'ststestingnamespace/ststesting'\n}\n\nexport enum STSRoom {\n\t// STSMonitor rooms\n\tSTSInstrumentDataRoom = 'stsinstrumentdataroom', // This room is for all instrument data messages\n\tSTSInstrumentDataSubscriptionRoom = 'stsinstrumentdatasubscriptionroom', // This room is only for subscribed instrument data messages\n\n\t// STSControl rooms\n\tSTSRunnerRoom = 'stsrunnerroom',\n\tSTSNodeRunnerRoom = 'stsnoderunnerroom'\n}\n\nexport enum STSEvent {\n\t// STSInstrumentData\n\tSTSInstrumentData = 'stsinstrumentdata',\n\tSTSSubInstrumentData = 'stssubinstrumentdata', // sub-scribed instrument data. This only outputs the nodes that have been subscribed by the client(s).\n\tSTSResetInstrumentData = 'stsresetinstrumentdata',\n\n\tSTSStartLoggingInstrumentData = 'stsStartLoggingInstrumentData',\n\tSTSStopLoggingInstrumentData = 'stsStopLoggingInstrumentData',\n\n\t// STSRunner events\n\tSTSStart = 'stsstart', // Start a test run with options as payload.\n\tSTSStop = 'stsstop', // Stop test run(s).\n\tSTSPause = 'stspause', // Pause test run(s).\n\tSTSResume = 'stsresume', // Resume test run(s).\n\tSTSTerminate = 'ststerminate', // Terminate runner instances and exit applications.\n\t// This may also be uysed to force trigger self healing (i.e. auto re-start) when\n\t// running within a container orchestrator such as K8, K3 or Docker Swarm.\n\tSTSUpdateStaticConfig = 'stsupdatestaticconfig', // Update base configuration. Options as payload.\n\tSTSUpdateDynamicConfig = 'stsupdatedynamicconfig', // Update running configuration. This is used\n\t// to control the runnning behaviour of test(s) in-flight. Options as payload.\n\n\tSTSSendToRoom = 'sendToRoom',\n\n\t// Standard socket events\n\tconnect = 'connect'\n}\n\n// https://socket.io/docs/v4/typescript/\n\nexport interface InterServerEvents {\n\tping: () => void;\n}\n\nexport interface STSSocketIONamespace {\n\tnamespace: string\n\tpid: number\n\tsocketionamespace: Namespace<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents, InterServerEvents>\n}\n\nexport type STSSocketIONamespaces = Record<string, STSSocketIONamespace>;\n\nexport type STSServerSocket = Socket<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents, InterServerEvents>\nexport type STSClientSocket = Socket<STSDefaultServerToClientEvents, STSDefaultClientToServerEvents, InterServerEvents>\n","// Only Node.JS has a process variable that is of [[Class]] process\nexport default Object.prototype.toString.call(typeof process !== 'undefined' ? process : 0) === '[object process]';\n","import { io, SocketOptions, ManagerOptions, Socket } from 'socket.io-client'\n//import { EventNames, EventParams } from \"@socket.io/component-emitter\";\n\nimport isNode from 'detect-node';\n\nimport { ISTSLogger, AgentManager } from '@nsshunt/stsutils'\n\nimport { STSDefaultClientToServerEvents, STSDefaultServerToClientEvents } from './commonTypes'\n\nimport { TinyEmitter } from 'tiny-emitter';\n\nexport abstract class SocketIoClient<ServerToClientEvents extends STSDefaultServerToClientEvents, ClientToServerEvents extends STSDefaultClientToServerEvents> extends TinyEmitter {\n    #agentManager?: AgentManager\n    #logger?: ISTSLogger\n    #name: string\n    #address?: string\n    #socketIoCustomPath?: string\n    #authToken?: string\n    #socket?: Socket<ServerToClientEvents, ClientToServerEvents>;\n\n    constructor(name: string) {\n        super();\n        this.#name = name;\n    }\n    \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    protected LogDebugMessage(message: any): void {\n        if (this.#logger) this.#logger.debug(message);\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    protected LogErrorMessage(message: any): void {\n        if (this.#logger) this.#logger.error(message);\n    }\n\n    get name(): string {\n        return this.#name;\n    }\n\n    get agentManager(): AgentManager | undefined {\n        return this.#agentManager;\n    }\n\n    get logger(): ISTSLogger | undefined {\n        return this.#logger;\n    }\n\n    get address(): string | undefined {\n        return this.#address;\n    }\n\n    get authToken(): string | undefined {\n        return this.#authToken;\n    }\n\n    get socketIoCustomPath(): string | undefined {\n        return this.#socketIoCustomPath;\n    }\n\n    get socket(): Socket<ServerToClientEvents, ClientToServerEvents> | undefined {\n        return this.#socket;\n    }\n\n    WithAddress(address: string) {\n        this.#address = address;\n        return this;\n    }\n\n    WithAuthToken(authToken: string) {\n        this.#authToken = authToken;\n        return this;\n    }\n\n    WithSocketIoCustomPath(socketIoCustomPath: string) {\n        this.#socketIoCustomPath = socketIoCustomPath;\n        return this;\n    }\n\n    WithLogger(logger: ISTSLogger) {\n        this.#logger = logger;\n        return this;\n    }\n\n    WithAgentManager(agentManager: AgentManager) {\n        this.#agentManager = agentManager;\n        return this;\n    }\n\n    SetupSocket() {\n        if (!this.#address) {\n            throw new Error(`SocketIoClientHelper:SetupSocket(): Error: [address not provided]`);\n        }\n\n        this.#EstablishSocketConnect();\n\n        return this;\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    protected ConnectCallBack(socket: Socket<ServerToClientEvents, ClientToServerEvents>): void { };\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    protected SocketEventsCallBack(socket: Socket<ServerToClientEvents, ClientToServerEvents>): void { };\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    protected ErrorCallBack(error: Error): void { };\n\n    /*\n    emit<Ev extends EventNames<ClientToServerEvents>>(ev: Ev, ...args: EventParams<ClientToServerEvents, Ev>): Socket<ServerToClientEvents, ClientToServerEvents> {\n        if (this.#socket) {\n            return this.#socket!.emit(ev, ...args);\n        } else {\n            throw new Error('SocketIoClient:emit(): Error: [socket instance not defined.]');\n        }\n    }\n    */\n\n    #EstablishSocketConnect(): void {\n        if (this.#socket !== undefined) {\n            // We already have a socket object (may or may not be connected)\n            if (this.#socket.connected === true) {\n                this.#socket.disconnect();\n            }\n            this.#socket = undefined;\n            if (isNode) {\n                setTimeout(() => this.#EstablishSocketConnect(), 100).unref(); //@@ config\n            } else {\n                setTimeout(() => this.#EstablishSocketConnect(), 100); //@@ config\n            }\n            return;\n        }\n\n        let socketOptions: Partial<SocketOptions & ManagerOptions>;\n        if (isNode) {\n            // https://socket.io/docs/v4/client-options/#reconnection\n            // https://github.com/socketio/engine.io-client#methods\n            socketOptions = {\n                transports: [\"websocket\" ]\n            }\n            if (this.#agentManager) {\n                if (!this.#address) {\n                    throw new Error(`SocketIoClientHelper:SetupSocket(): Error: [address not provided when using agentManager]`);\n                }\n                socketOptions.agent = this.#agentManager.GetAgent(this.#address);\n            }\n        } else {\n            socketOptions = {\n                transports: [\"websocket\" ]\n            }\n        }\n\n        // https://socket.io/docs/v4/middlewares/\n        // Send auth token for connections\n        if (this.#authToken) {\n            socketOptions.auth = (cb) => {\n                cb({\n                    token: this.#authToken\n                });\n            }\n        }\n\n        // On Server use;\n        /*\n        io.use((socket, next) => {\n            const token = socket.handshake.auth.token;\n            // ...\n        });\n        */\n\n        if (this.#socketIoCustomPath && this.#socketIoCustomPath.localeCompare('') !== 0) {\n            socketOptions.path = this.#socketIoCustomPath;\n        }\n\n        this.#socket = io(this.#address, socketOptions) as Socket<ServerToClientEvents, ClientToServerEvents>\n\n        // Manager errors\n        this.#socket.io.on('error', (err: Error) => {\n            this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.io.on('error'): [${err}] Address: [${this.#address}]`);\n        });\n\n        this.#socket.io.on('reconnect_error', (err: Error) => {\n            this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.io.on('reconnect_error'): [${err}] Address: [${this.#address}]`);\n        });\n\n        // suppress automatic console logging by not letting it bubble up\n        this.#socket.on(\"connect_error\", (err) => {\n            this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.on('connect_error'): [${err}] Address: [${this.#address}]`);\n        });\n\n        this.#socket.io.on('reconnect', (attempt: number) => {\n            this.LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.io.on('reconnect'): Number: [${attempt}] Address: [${this.#address}]`);\n        });\n\n        /*\n        this.#socket.on(\"connect_timeout\", () => {\n            this.#LogErrorMessage(`SocketIoClientHelper(): socketDetail.socket.on('connect_timeout') Address: [${this.#address}]`);\n        });\n        */\n\n        this.#socket.on(\"connect\", () => {\n            if (this.#socket) {\n                this.LogDebugMessage(`SocketIoClientHelper(): Socket: [${this.#socket.id}]: connected, Address: [${this.#address}]`);\n\n                setTimeout(() => {\n                    this.ConnectCallBack(this.#socket as Socket<ServerToClientEvents, ClientToServerEvents>);\n                }, 0);\n\n                this.SocketEventsCallBack(this.#socket);\n\n            } else {\n                const errorMessage: string = 'SocketIoClientHelper(): Could not get socket object from socket.io, Address: [${socketDetail.address}]';\n                this.LogErrorMessage(errorMessage);\n                this.ErrorCallBack(new Error(errorMessage));\n            }\n        })\n\n        // https://socket.io/docs/v4/client-socket-instance/#disconnect\n        this.#socket.on(\"disconnect\", (reason: string) => {\n            this.LogDebugMessage('SocketIoClientHelper(): socket disconnect: ' + reason);\n            switch (reason) {\n            case 'io server disconnect' : {\n                // The server disconnect using disconnectSockets (i.e. normal safe shutdown)\n                this.LogDebugMessage('SocketIoClientHelper(): The server disconnected using disconnectSockets, i.e. normal safe shutdown from explicit disconnection by the server.');\n                this.LogDebugMessage('SocketIoClientHelper(): The connection will be re-established when the server becomes available.');\n                this.#socket = undefined;\n                if (isNode) {\n                    if (this.#agentManager) {\n                        this.#agentManager.ResetAgent();\n                    }\n                    setTimeout(() => this.#EstablishSocketConnect(), 100).unref(); //@@ config\n                } else {\n                    setTimeout(() => this.#EstablishSocketConnect(), 100); //@@ config\n                }\n            }\n                break;\n            case 'io client disconnect' :\n                this.LogDebugMessage('SocketIoClientHelper(): The client disconnected using disconnectSockets, i.e. normal safe disconnection from explicit disconnection by the client.');\n                this.LogDebugMessage('SocketIoClientHelper(): The connection will not be re-established automatically.');\n                // Do nothing\n                break;\n            case 'transport close' :\n            case 'ping timeout' :\n            case 'transport error' : {\n                this.LogDebugMessage(`SocketIoClientHelper(): Server unexpectedly disconnected. Reason: [${reason}]`);\n                this.LogDebugMessage('SocketIoClientHelper(): The connection will be re-established when the server becomes available.');\n                if (this.#socket) {\n                    this.#socket.disconnect();\n                }\n                this.#socket = undefined;\n                if (isNode) {\n                    if (this.#agentManager) {\n                        this.#agentManager?.ResetAgent();\n                    }\n                    setTimeout(() => this.#EstablishSocketConnect(), 100).unref(); //@@ config\n                } else {\n                    setTimeout(() => this.#EstablishSocketConnect(), 100); //@@ config\n                }\n            }\n                break;\n            }\n        });\n    }\n}\n"],"names":["STSNamespace","STSRoom","STSEvent","TinyEmitter"],"mappings":";;AA2EO,IAAK,iCAAAA,kBAAL;AACNA,gBAAA,YAAA,IAAa;AACbA,gBAAA,YAAA,IAAa;AACVA,gBAAA,qBAAA,IAAsB;AAHd,SAAAA;AAAA,GAAA,gBAAA,CAAA,CAAA;AAML,IAAK,4BAAAC,aAAL;AAENA,WAAA,uBAAA,IAAwB;AACxBA,WAAA,mCAAA,IAAoC;AAGpCA,WAAA,eAAA,IAAgB;AAChBA,WAAA,mBAAA,IAAoB;AAPT,SAAAA;AAAA,GAAA,WAAA,CAAA,CAAA;AAUL,IAAK,6BAAAC,cAAL;AAENA,YAAA,mBAAA,IAAoB;AACpBA,YAAA,sBAAA,IAAuB;AACvBA,YAAA,wBAAA,IAAyB;AAEzBA,YAAA,+BAAA,IAAgC;AAChCA,YAAA,8BAAA,IAA+B;AAG/BA,YAAA,UAAA,IAAW;AACXA,YAAA,SAAA,IAAU;AACVA,YAAA,UAAA,IAAW;AACXA,YAAA,WAAA,IAAY;AACZA,YAAA,cAAA,IAAe;AAGfA,YAAA,uBAAA,IAAwB;AACxBA,YAAA,wBAAA,IAAyB;AAGzBA,YAAA,eAAA,IAAgB;AAGhBA,YAAA,SAAA,IAAU;AAxBC,SAAAA;AAAA,GAAA,YAAA,CAAA,CAAA;AC1FZ,MAAA,SAAe,OAAO,UAAU,SAAS,KAAK,OAAO,YAAY,cAAc,UAAU,CAAC,MAAM;ACUzF,MAAe,uBAAiJC,mBAAAA,YAAY;AAAA,EAC/K;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,YAAY,MAAc;AACtB,UAAA;AACA,SAAK,QAAQ;AAAA,EACjB;AAAA;AAAA,EAGU,gBAAgB,SAAoB;AAC1C,QAAI,KAAK,QAAS,MAAK,QAAQ,MAAM,OAAO;AAAA,EAChD;AAAA;AAAA,EAGU,gBAAgB,SAAoB;AAC1C,QAAI,KAAK,QAAS,MAAK,QAAQ,MAAM,OAAO;AAAA,EAChD;AAAA,EAEA,IAAI,OAAe;AACf,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,eAAyC;AACzC,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,SAAiC;AACjC,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,UAA8B;AAC9B,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,YAAgC;AAChC,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,qBAAyC;AACzC,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,SAAyE;AACzE,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,YAAY,SAAiB;AACzB,SAAK,WAAW;AAChB,WAAO;AAAA,EACX;AAAA,EAEA,cAAc,WAAmB;AAC7B,SAAK,aAAa;AAClB,WAAO;AAAA,EACX;AAAA,EAEA,uBAAuB,oBAA4B;AAC/C,SAAK,sBAAsB;AAC3B,WAAO;AAAA,EACX;AAAA,EAEA,WAAW,QAAoB;AAC3B,SAAK,UAAU;AACf,WAAO;AAAA,EACX;AAAA,EAEA,iBAAiB,cAA4B;AACzC,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACX;AAAA,EAEA,cAAc;AACV,QAAI,CAAC,KAAK,UAAU;AAChB,YAAM,IAAI,MAAM,mEAAmE;AAAA,IACvF;AAEA,SAAK,wBAAA;AAEL,WAAO;AAAA,EACX;AAAA;AAAA,EAGU,gBAAgB,QAAkE;AAAA,EAAE;AAAA;AAAA,EAEpF,qBAAqB,QAAkE;AAAA,EAAE;AAAA;AAAA,EAEzF,cAAc,OAAoB;AAAA,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9C,0BAAgC;AAC5B,QAAI,KAAK,YAAY,QAAW;AAE5B,UAAI,KAAK,QAAQ,cAAc,MAAM;AACjC,aAAK,QAAQ,WAAA;AAAA,MACjB;AACA,WAAK,UAAU;AACf,UAAI,QAAQ;AACR,mBAAW,MAAM,KAAK,wBAAA,GAA2B,GAAG,EAAE,MAAA;AAAA,MAC1D,OAAO;AACH,mBAAW,MAAM,KAAK,wBAAA,GAA2B,GAAG;AAAA,MACxD;AACA;AAAA,IACJ;AAEA,QAAI;AACJ,QAAI,QAAQ;AAGR,sBAAgB;AAAA,QACZ,YAAY,CAAC,WAAY;AAAA,MAAA;AAE7B,UAAI,KAAK,eAAe;AACpB,YAAI,CAAC,KAAK,UAAU;AAChB,gBAAM,IAAI,MAAM,2FAA2F;AAAA,QAC/G;AACA,sBAAc,QAAQ,KAAK,cAAc,SAAS,KAAK,QAAQ;AAAA,MACnE;AAAA,IACJ,OAAO;AACH,sBAAgB;AAAA,QACZ,YAAY,CAAC,WAAY;AAAA,MAAA;AAAA,IAEjC;AAIA,QAAI,KAAK,YAAY;AACjB,oBAAc,OAAO,CAAC,OAAO;AACzB,WAAG;AAAA,UACC,OAAO,KAAK;AAAA,QAAA,CACf;AAAA,MACL;AAAA,IACJ;AAUA,QAAI,KAAK,uBAAuB,KAAK,oBAAoB,cAAc,EAAE,MAAM,GAAG;AAC9E,oBAAc,OAAO,KAAK;AAAA,IAC9B;AAEA,SAAK,UAAU,GAAG,KAAK,UAAU,aAAa;AAG9C,SAAK,QAAQ,GAAG,GAAG,SAAS,CAAC,QAAe;AACxC,WAAK,gBAAgB,gEAAgE,GAAG,eAAe,KAAK,QAAQ,GAAG;AAAA,IAC3H,CAAC;AAED,SAAK,QAAQ,GAAG,GAAG,mBAAmB,CAAC,QAAe;AAClD,WAAK,gBAAgB,0EAA0E,GAAG,eAAe,KAAK,QAAQ,GAAG;AAAA,IACrI,CAAC;AAGD,SAAK,QAAQ,GAAG,iBAAiB,CAAC,QAAQ;AACtC,WAAK,gBAAgB,qEAAqE,GAAG,eAAe,KAAK,QAAQ,GAAG;AAAA,IAChI,CAAC;AAED,SAAK,QAAQ,GAAG,GAAG,aAAa,CAAC,YAAoB;AACjD,WAAK,gBAAgB,4EAA4E,OAAO,eAAe,KAAK,QAAQ,GAAG;AAAA,IAC3I,CAAC;AAQD,SAAK,QAAQ,GAAG,WAAW,MAAM;AAC7B,UAAI,KAAK,SAAS;AACd,aAAK,gBAAgB,oCAAoC,KAAK,QAAQ,EAAE,2BAA2B,KAAK,QAAQ,GAAG;AAEnH,mBAAW,MAAM;AACb,eAAK,gBAAgB,KAAK,OAA6D;AAAA,QAC3F,GAAG,CAAC;AAEJ,aAAK,qBAAqB,KAAK,OAAO;AAAA,MAE1C,OAAO;AACH,cAAM,eAAuB;AAC7B,aAAK,gBAAgB,YAAY;AACjC,aAAK,cAAc,IAAI,MAAM,YAAY,CAAC;AAAA,MAC9C;AAAA,IACJ,CAAC;AAGD,SAAK,QAAQ,GAAG,cAAc,CAAC,WAAmB;AAC9C,WAAK,gBAAgB,gDAAgD,MAAM;AAC3E,cAAQ,QAAA;AAAA,QACR,KAAK;AAAyB;AAE1B,iBAAK,gBAAgB,+IAA+I;AACpK,iBAAK,gBAAgB,kGAAkG;AACvH,iBAAK,UAAU;AACf,gBAAI,QAAQ;AACR,kBAAI,KAAK,eAAe;AACpB,qBAAK,cAAc,WAAA;AAAA,cACvB;AACA,yBAAW,MAAM,KAAK,wBAAA,GAA2B,GAAG,EAAE,MAAA;AAAA,YAC1D,OAAO;AACH,yBAAW,MAAM,KAAK,wBAAA,GAA2B,GAAG;AAAA,YACxD;AAAA,UACJ;AACI;AAAA,QACJ,KAAK;AACD,eAAK,gBAAgB,oJAAoJ;AACzK,eAAK,gBAAgB,kFAAkF;AAEvG;AAAA,QACJ,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAoB;AACrB,iBAAK,gBAAgB,sEAAsE,MAAM,GAAG;AACpG,iBAAK,gBAAgB,kGAAkG;AACvH,gBAAI,KAAK,SAAS;AACd,mBAAK,QAAQ,WAAA;AAAA,YACjB;AACA,iBAAK,UAAU;AACf,gBAAI,QAAQ;AACR,kBAAI,KAAK,eAAe;AACpB,qBAAK,eAAe,WAAA;AAAA,cACxB;AACA,yBAAW,MAAM,KAAK,wBAAA,GAA2B,GAAG,EAAE,MAAA;AAAA,YAC1D,OAAO;AACH,yBAAW,MAAM,KAAK,wBAAA,GAA2B,GAAG;AAAA,YACxD;AAAA,UACJ;AACI;AAAA,MAAA;AAAA,IAER,CAAC;AAAA,EACL;AACJ;","x_google_ignoreList":[1]}

package/dist/node.cjs

@@ -0,0 +1,325 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const stsutils = require("@nsshunt/stsutils");
+const socket_io = require("socket.io");
+const ioredis = require("ioredis");
+const clusterAdapter = require("@socket.io/cluster-adapter");
+const redisStreamsAdapter = require("@socket.io/redis-streams-adapter");
+const index = require("./index-CbgYj2D4.js");
+class SocketIoServer extends index.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;
+    }
+  };
+}
+exports.SocketIoServer = SocketIoServer;
+//# sourceMappingURL=node.cjs.map

package/dist/node.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.cjs","sources":["../src/socketIoServer.ts"],"sourcesContent":["/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF\nimport { ISTSLogger, JSONObject, Sleep } from '@nsshunt/stsutils'\n\nimport { Server, Namespace, Socket, ServerOptions } from \"socket.io\";\n\nimport { STSDefaultClientToServerEvents, STSDefaultServerToClientEvents, STSServerSocket, \n    InterServerEvents } from './commonTypes'\n\n//import { createClient, RedisClientType } from 'redis';\nimport { Redis } from 'ioredis';\n\nimport { createAdapter as clusterCreateAdapter } from '@socket.io/cluster-adapter'\nimport { createAdapter } from \"@socket.io/redis-streams-adapter\";\n\nimport { TinyEmitter } from 'tiny-emitter';\n\nexport interface ISocketIoServerOpitons {\n    listenPort?: number\n    ioRedisMessageProcessorUrl?: string\n    wssCustomPath?: string\n    serverClusterMode?: boolean\n}\n    \nexport abstract class SocketIoServer<ClientToServerEvents extends STSDefaultClientToServerEvents, ServerToClientEvents extends STSDefaultServerToClientEvents> extends TinyEmitter {\n    protected namespace?: string\n    protected socketionamespace?: Namespace<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents, InterServerEvents>\n    //protected socketionamespace?: Namespace<ClientToServerEvents, ServerToClientEvents, InterServerEvents>\n    protected logger?: ISTSLogger\n    protected io?: Server<ClientToServerEvents, ServerToClientEvents>;\n    //#redisClient: RedisClientType | Redis | null = null;\n    protected redisClient?: Redis;\n    protected listenPort?: number;\n    protected socketIoCustomPath?: string;\n    protected ioRedisMessageProcessorUrl?: string;\n    protected serverClusterMode?: boolean;\n    protected rooms?: string[];\n\n    constructor() { // IProcessBase\n        super();\n    }\n\n    protected LogErrorMessage(message: any) {\n        if (this.logger) {\n            this.logger.error(`${this.namespace}: ${message}`);\n        }\n    }\n\n    protected LogDebugMessage(message: any) {\n        if (this.logger) {\n            this.logger.debug(`${this.namespace}: ${message}`);\n        }\n    }\n\n    protected LogInfoMessage(message: any) {\n        if (this.logger) {\n            this.logger.info(`${this.namespace}: ${message}`);\n        }\n    }\n\n    protected LogWarnMessage(message: any) {\n        if (this.logger) {\n            this.logger.warn(`${this.namespace}: ${message}`);\n        }\n    }\n\n    // https://socket.io/docs/v4/middlewares/\n    // https://socket.io/docs/v4/server-socket-instance/#sockethandshake\n    // https://socket.io/docs/v4/server-socket-instance/#socket-middlewares\n    // Use this middleward to check every incomming connection\n    protected SetupConnectionMiddleware = () => { };\n\n    // Use this middleware to check every packet being received\n    protected SetupMessageMiddleware = (socket: STSServerSocket) => { };\n\n    protected SocketConnectCallBack = (socket: Socket<ClientToServerEvents, ServerToClientEvents>): void => { };\n\n    protected SocketEventsCallBack = (socket: Socket<ClientToServerEvents, ServerToClientEvents>): void => { };\n\n    protected GetConfig = (socketIoServeroptions: ISocketIoServerOpitons): Partial<ServerOptions> => {\n        //this.#redisClient = createClient({url: this.#options.ioRedisMessageProcessorUrl});\n        //await this.#redisClient.connect();\n        const options: Partial<ServerOptions> = {\n            transports: [ \"websocket\" ], // or [ \"websocket\", \"polling\" ] (to use long-poolling. Note that the order matters)\n        }\n\n        if (socketIoServeroptions.ioRedisMessageProcessorUrl && socketIoServeroptions.ioRedisMessageProcessorUrl !== '') {\n            this.redisClient = new Redis(socketIoServeroptions.ioRedisMessageProcessorUrl);\n            options.adapter = createAdapter(this.redisClient) as any;\n        } else if (socketIoServeroptions.serverClusterMode && socketIoServeroptions.serverClusterMode === true) {\n            options.adapter = clusterCreateAdapter() as any;\n        }\n\n        if (socketIoServeroptions.wssCustomPath && socketIoServeroptions.wssCustomPath.localeCompare('') !== 0) {\n            options.path = socketIoServeroptions.wssCustomPath;\n        }\n\n        return options;\n    }\n\n    protected SetEngineEvents = () => {\n        if (this.io) {\n            this.io.engine.on(\"connection_error\", (err) => {\n                this.LogInfoMessage(err.req); // the request object\n                this.LogInfoMessage(err.code); // the error code, for example 1\n                this.LogInfoMessage(err.message); // the error message, for example \"Session ID unknown\"\n                this.LogInfoMessage(err.context); // some additional error context\n            });\n        }\n    }\n\n    WithLogger = (logger: ISTSLogger) => {\n        this.logger = logger;\n        return this;\n    }\n\n    WithExistingServer = (server: Server) => {\n        if (this.io) {\n            throw new Error(`SocketIoServer:AttachServer(): Error: [Server already attached]`);\n        }\n        this.io = server;\n        return this;\n    }\n\n    WithListenPort = (listenPort: number) => {\n        this.listenPort = listenPort;\n        return this;\n    }\n\n    WithSocketIoCustomPath = (socketIoCustomPath: string) => {\n        this.socketIoCustomPath = socketIoCustomPath;\n        return this;\n    }\n\n    WithIoRedisMessageProcessorUrl = (ioRedisMessageProcessorUrl: string) => {\n        this.ioRedisMessageProcessorUrl = ioRedisMessageProcessorUrl;\n        return this;\n    }\n\n    WithClusterMode = (serverClusterMode: boolean) => {\n        this.serverClusterMode = serverClusterMode;\n        return this;\n    }\n\n    WithRooms = (rooms: string[]) => {\n        this.rooms = rooms;\n        return this;\n    }\n\n    WithNamespace = (namespace: string) => {\n        this.namespace = namespace;\n        return this;\n    }\n\n    StartServer = async (): Promise<SocketIoServer<ClientToServerEvents, ServerToClientEvents>> => {\n        //this.#io = require(\"socket.io\")(this.#httpServer, options);\n        if (!this.namespace) {\n            throw new Error(`SocketIoServer:StartServer(): Error: [namespace not specified]`);\n        }\n\n        if (!this.io) {\n            if (!this.listenPort) {\n                throw new Error(`SocketIoServer:StartServer(): Error: [listenPort not specified]`);\n            }\n\n            const options: Partial<ServerOptions> = {\n                transports: [ \"websocket\" ], // or [ \"websocket\", \"polling\" ] (to use long-poolling. Note that the order matters)\n            }\n\n            if (this.ioRedisMessageProcessorUrl && this.ioRedisMessageProcessorUrl !== '') {\n                this.redisClient = new Redis(this.ioRedisMessageProcessorUrl);\n                options.adapter = createAdapter(this.redisClient) as any;\n            } else if (this.serverClusterMode && this.serverClusterMode === true) {\n                options.adapter = clusterCreateAdapter() as any;\n            }\n\n            if (this.socketIoCustomPath && this.socketIoCustomPath.localeCompare('') !== 0) {\n                options.path = this.socketIoCustomPath;\n            }\n\n            this.io = new Server(this.listenPort, options);\n\n            this.SetEngineEvents();\n\n            await Sleep(500);\n        }\n\n        let autoJoinRooms: boolean;\n        let rooms: string[];\n        if (this.rooms && this.rooms.length > 0) {\n            autoJoinRooms = true;\n            rooms = [ ...this.rooms ];\n        } else {\n            autoJoinRooms = false;\n            rooms = [ ];\n        }\n\n        this.SetupNamespace(rooms, autoJoinRooms);\n\n        return this;\n    }\n\n    AttachServer = async (server: Server): Promise<void> => {\n        if (this.io) {\n            throw new Error(`SocketIoServer:AttachServer(): Error: [Server already attached]`);\n        }\n        this.io = server;\n    }\n\n    StopServer = async () => {\n        if (this.io) {\n            await this.CloseNamespaceAdaptors();\n            this.DisconnectNamespaceSockets();\n\n            await this.io.of('/').adapter.close();\n\n            if (this.redisClient) {\n                await this.redisClient.disconnect();\n                await Sleep(50);\n            }\n\n            this.io.disconnectSockets();\n            this.io = undefined;\n        }\n    }\n\n    LeaveRoom = (socket: STSServerSocket, room: string): void => {\n        this.LogDebugMessage(`Leaving room [${room}]`);\n        socket.leave(room);\n    };\n\n    JoinRoom = (socket: STSServerSocket, room: string): void => {\n        this.LogDebugMessage(`Socket joining room [${room}], ID: [${socket.id}]`);\n        socket.join(room);\n    };\n\n    protected SetupStandardEvents = (socket: STSServerSocket): void => {\n        socket.on('disconnect', (reason: string) => {\n            this.LogDebugMessage(`socket disconnect, ID: [${socket.id}] [${reason}]`);\n        });\n\n        socket.on('disconnecting', (reason: string) => {\n            this.LogDebugMessage(`socket disconnecting, ID: [${socket.id}] [${reason}]`);\n        });\n\n        socket.on('error', (error: Error) => {\n            this.LogDebugMessage(`socket error, ID: [${socket.id}] [${error}]`);\n        });\n\n        socket.on(\"__STSdisconnect\", (reason: string) => {\n            this.LogDebugMessage(`__STSdisconnect: socket disconnect, ID: [${socket.id}] [${reason}]`);\n        });\n\n        socket.on(\"__STSdisconnecting\", (reason, callBackResult) => {\n            this.LogDebugMessage(`__STSdisconnecting: socket disconnecting, ID: [${socket.id}] [${reason}]`);\n            callBackResult(\"__STSdisconnecting accepted by server.\");\n        });\n\n        socket.on('__STSjoinRoom', (rooms: string[]): void => { //@@ names\n            rooms.forEach((room) => {\n                this.JoinRoom(socket, room)\n            });\n        });\n\n        socket.on('__STSleaveRoom', (rooms: string[]): void => { //@@ names\n            rooms.forEach((room) => {\n                this.LeaveRoom(socket, room);\n            });\n        });\n\n        socket.on('__STSsendToRoom', (rooms: string[], payload: { command: string, payload: JSONObject }): void => {\n            rooms.forEach((room) => {\n                if (this.socketionamespace) {\n                    this.LogDebugMessage(`socket.on: __STSsendToRoom: Sending to room [${room}], ID: [${socket.id}]`);\n                    this.socketionamespace.to(room).emit(payload.command as any, payload);\n                }\n            });\n        });\n\n        socket.on('__STSsendToRoomWithCallback', (room: string, timeout: number, payload: { command: string, payload: JSONObject }, cb: (data: JSONObject) => void): void => {\n            if (this.socketionamespace) {\n                this.socketionamespace.to(room).timeout(timeout).emit(payload.command as any, payload, (err: Error, dataResponse: JSONObject[]) => {\n                    if (err) {\n                        console.error(err);\n                        const errorResponse = {\n                            error: true, \n                            errorName: err.name, \n                            errorMessage: err.message,\n                            //errorCause: err.cause,\n                            //errorStack: err.stack\n                        };\n                        this.LogErrorMessage(`__STSsendToRoomWithCallback broadcast (error): [${JSON.stringify(errorResponse)}]`)\n                        cb(errorResponse);\n                    } else {\n                        this.LogDebugMessage(`__STSsendToRoomWithCallback broadcast: [${JSON.stringify(dataResponse)}]`)\n                        cb(dataResponse);\n                    }\n                });\n            }\n        });\n\n        socket.on('__STSsendToRoomsWithCallback', (rooms: string[], timeout: number, payload: { command: string, payload: JSONObject }, cb: (data: JSONObject) => void): void => {\n            const responses: any[] = [ ];\n\n            const timeoutForComplete = setTimeout(() => {\n                // for this timeout case, sent back the error response and the responses we have received so far ...\n                responses.push({\n                    room: '',\n                    responses: {\n                        error: true,\n                        errorName: 'timeout',\n                        errorMessage: `__STSsendToRoomsWithCallback timeout: [${timeout}] before all responses received`\n                    }\n                });\n                cb(responses);\n            }, timeout).unref();\n\n            rooms.forEach((room) => {\n                if (this.socketionamespace) {\n                    this.socketionamespace.to(room).timeout(timeout).emit(payload.command as any, payload, (err: Error, dataResponse: JSONObject[]) => {\n                        if (err) {\n                            console.error(err);\n                            const errorResponse = {\n                                error: true, \n                                errorName: err.name, \n                                errorMessage: err.message,\n                                //errorCause: err.cause,\n                                //errorStack: err.stack\n                            };\n                            this.LogErrorMessage(`__STSsendToRoomWithCallback broadcast (error): [${JSON.stringify(errorResponse)}]`)\n                            responses.push({\n                                room,\n                                responses: errorResponse\n                            });\n                        } else {\n                            this.LogDebugMessage(`__STSsendToRoomWithCallback broadcast: [${JSON.stringify(dataResponse)}]`)\n                            responses.push({\n                                room,\n                                responses: dataResponse\n                            });\n                        }\n                        if (responses.length === rooms.length) {\n                            clearTimeout(timeoutForComplete);\n                            cb(responses);\n                        }\n                    });\n                }\n            });\n        });\n    }\n   \n    protected SetupNamespace = (rooms: string[], autoJoinRooms: boolean): SocketIoServer<ClientToServerEvents, ServerToClientEvents> => {\n        // Create STS Command Centre Client namespace\n        if (this.io) {\n            this.socketionamespace = this.io.of(`/${this.namespace}/`);\n\n            this.SetupConnectionMiddleware();\n\n            this.socketionamespace.on(\"connection\", socket => {\n                this.LogDebugMessage(`Socket connected, ID: [${socket.id}]`);\n                this.LogDebugMessage(`Authentication Handshake (auth): [${JSON.stringify(socket.handshake.auth)}]`);\n                this.LogDebugMessage(`Authentication Handshake (host): [${JSON.stringify(socket.handshake.headers.host)}]`);\n                this.LogDebugMessage(`Authentication Handshake (url): [${JSON.stringify(socket.handshake.url)}]`);\n                this.LogDebugMessage(`Authentication Handshake: [${JSON.stringify(socket.handshake)}]`);\n\n                this.SetupMessageMiddleware(socket);\n\n                if (autoJoinRooms) {\n                    rooms.map((room) => {\n                        this.JoinRoom(socket, room);\n                    });\n                }\n\n                this.SetupStandardEvents(socket);\n\n                setTimeout(() => {\n                    this.SocketConnectCallBack(socket);\n                }, 0);\n\n                this.SocketEventsCallBack(socket);\n            });\n        } else {\n            throw new Error('SocketIoServer:SetupNamespace(): Error: [No server attached');\n        }\n\n        return this;\n    }\n\n    CloseNamespaceAdaptors = async (): Promise<void> => {\n        if (this.socketionamespace) {\n            await this.socketionamespace.adapter.close();\n        }\n    }\n\n    DisconnectNamespaceSockets = (): void => {\n        if (this.socketionamespace) {\n            this.socketionamespace.disconnectSockets();\n            this.socketionamespace = undefined;\n        }\n    }\n}\n"],"names":["TinyEmitter","Redis","createAdapter","clusterCreateAdapter","Server","Sleep"],"mappings":";;;;;;;;AAuBO,MAAe,uBAAiJA,MAAAA,mBAAAA,YAAY;AAAA,EACrK;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEV,cAAc;AACV,UAAA;AAAA,EACJ;AAAA,EAEU,gBAAgB,SAAc;AACpC,QAAI,KAAK,QAAQ;AACb,WAAK,OAAO,MAAM,GAAG,KAAK,SAAS,KAAK,OAAO,EAAE;AAAA,IACrD;AAAA,EACJ;AAAA,EAEU,gBAAgB,SAAc;AACpC,QAAI,KAAK,QAAQ;AACb,WAAK,OAAO,MAAM,GAAG,KAAK,SAAS,KAAK,OAAO,EAAE;AAAA,IACrD;AAAA,EACJ;AAAA,EAEU,eAAe,SAAc;AACnC,QAAI,KAAK,QAAQ;AACb,WAAK,OAAO,KAAK,GAAG,KAAK,SAAS,KAAK,OAAO,EAAE;AAAA,IACpD;AAAA,EACJ;AAAA,EAEU,eAAe,SAAc;AACnC,QAAI,KAAK,QAAQ;AACb,WAAK,OAAO,KAAK,GAAG,KAAK,SAAS,KAAK,OAAO,EAAE;AAAA,IACpD;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,4BAA4B,MAAM;AAAA,EAAE;AAAA;AAAA,EAGpC,yBAAyB,CAAC,WAA4B;AAAA,EAAE;AAAA,EAExD,wBAAwB,CAAC,WAAqE;AAAA,EAAE;AAAA,EAEhG,uBAAuB,CAAC,WAAqE;AAAA,EAAE;AAAA,EAE/F,YAAY,CAAC,0BAA0E;AAG7F,UAAM,UAAkC;AAAA,MACpC,YAAY,CAAE,WAAY;AAAA;AAAA,IAAA;AAG9B,QAAI,sBAAsB,8BAA8B,sBAAsB,+BAA+B,IAAI;AAC7G,WAAK,cAAc,IAAIC,cAAM,sBAAsB,0BAA0B;AAC7E,cAAQ,UAAUC,kCAAc,KAAK,WAAW;AAAA,IACpD,WAAW,sBAAsB,qBAAqB,sBAAsB,sBAAsB,MAAM;AACpG,cAAQ,UAAUC,6BAAA;AAAA,IACtB;AAEA,QAAI,sBAAsB,iBAAiB,sBAAsB,cAAc,cAAc,EAAE,MAAM,GAAG;AACpG,cAAQ,OAAO,sBAAsB;AAAA,IACzC;AAEA,WAAO;AAAA,EACX;AAAA,EAEU,kBAAkB,MAAM;AAC9B,QAAI,KAAK,IAAI;AACT,WAAK,GAAG,OAAO,GAAG,oBAAoB,CAAC,QAAQ;AAC3C,aAAK,eAAe,IAAI,GAAG;AAC3B,aAAK,eAAe,IAAI,IAAI;AAC5B,aAAK,eAAe,IAAI,OAAO;AAC/B,aAAK,eAAe,IAAI,OAAO;AAAA,MACnC,CAAC;AAAA,IACL;AAAA,EACJ;AAAA,EAEA,aAAa,CAAC,WAAuB;AACjC,SAAK,SAAS;AACd,WAAO;AAAA,EACX;AAAA,EAEA,qBAAqB,CAAC,WAAmB;AACrC,QAAI,KAAK,IAAI;AACT,YAAM,IAAI,MAAM,iEAAiE;AAAA,IACrF;AACA,SAAK,KAAK;AACV,WAAO;AAAA,EACX;AAAA,EAEA,iBAAiB,CAAC,eAAuB;AACrC,SAAK,aAAa;AAClB,WAAO;AAAA,EACX;AAAA,EAEA,yBAAyB,CAAC,uBAA+B;AACrD,SAAK,qBAAqB;AAC1B,WAAO;AAAA,EACX;AAAA,EAEA,iCAAiC,CAAC,+BAAuC;AACrE,SAAK,6BAA6B;AAClC,WAAO;AAAA,EACX;AAAA,EAEA,kBAAkB,CAAC,sBAA+B;AAC9C,SAAK,oBAAoB;AACzB,WAAO;AAAA,EACX;AAAA,EAEA,YAAY,CAAC,UAAoB;AAC7B,SAAK,QAAQ;AACb,WAAO;AAAA,EACX;AAAA,EAEA,gBAAgB,CAAC,cAAsB;AACnC,SAAK,YAAY;AACjB,WAAO;AAAA,EACX;AAAA,EAEA,cAAc,YAAiF;AAE3F,QAAI,CAAC,KAAK,WAAW;AACjB,YAAM,IAAI,MAAM,gEAAgE;AAAA,IACpF;AAEA,QAAI,CAAC,KAAK,IAAI;AACV,UAAI,CAAC,KAAK,YAAY;AAClB,cAAM,IAAI,MAAM,iEAAiE;AAAA,MACrF;AAEA,YAAM,UAAkC;AAAA,QACpC,YAAY,CAAE,WAAY;AAAA;AAAA,MAAA;AAG9B,UAAI,KAAK,8BAA8B,KAAK,+BAA+B,IAAI;AAC3E,aAAK,cAAc,IAAIF,cAAM,KAAK,0BAA0B;AAC5D,gBAAQ,UAAUC,kCAAc,KAAK,WAAW;AAAA,MACpD,WAAW,KAAK,qBAAqB,KAAK,sBAAsB,MAAM;AAClE,gBAAQ,UAAUC,6BAAA;AAAA,MACtB;AAEA,UAAI,KAAK,sBAAsB,KAAK,mBAAmB,cAAc,EAAE,MAAM,GAAG;AAC5E,gBAAQ,OAAO,KAAK;AAAA,MACxB;AAEA,WAAK,KAAK,IAAIC,UAAAA,OAAO,KAAK,YAAY,OAAO;AAE7C,WAAK,gBAAA;AAEL,YAAMC,SAAAA,MAAM,GAAG;AAAA,IACnB;AAEA,QAAI;AACJ,QAAI;AACJ,QAAI,KAAK,SAAS,KAAK,MAAM,SAAS,GAAG;AACrC,sBAAgB;AAChB,cAAQ,CAAE,GAAG,KAAK,KAAM;AAAA,IAC5B,OAAO;AACH,sBAAgB;AAChB,cAAQ,CAAA;AAAA,IACZ;AAEA,SAAK,eAAe,OAAO,aAAa;AAExC,WAAO;AAAA,EACX;AAAA,EAEA,eAAe,OAAO,WAAkC;AACpD,QAAI,KAAK,IAAI;AACT,YAAM,IAAI,MAAM,iEAAiE;AAAA,IACrF;AACA,SAAK,KAAK;AAAA,EACd;AAAA,EAEA,aAAa,YAAY;AACrB,QAAI,KAAK,IAAI;AACT,YAAM,KAAK,uBAAA;AACX,WAAK,2BAAA;AAEL,YAAM,KAAK,GAAG,GAAG,GAAG,EAAE,QAAQ,MAAA;AAE9B,UAAI,KAAK,aAAa;AAClB,cAAM,KAAK,YAAY,WAAA;AACvB,cAAMA,SAAAA,MAAM,EAAE;AAAA,MAClB;AAEA,WAAK,GAAG,kBAAA;AACR,WAAK,KAAK;AAAA,IACd;AAAA,EACJ;AAAA,EAEA,YAAY,CAAC,QAAyB,SAAuB;AACzD,SAAK,gBAAgB,iBAAiB,IAAI,GAAG;AAC7C,WAAO,MAAM,IAAI;AAAA,EACrB;AAAA,EAEA,WAAW,CAAC,QAAyB,SAAuB;AACxD,SAAK,gBAAgB,wBAAwB,IAAI,WAAW,OAAO,EAAE,GAAG;AACxE,WAAO,KAAK,IAAI;AAAA,EACpB;AAAA,EAEU,sBAAsB,CAAC,WAAkC;AAC/D,WAAO,GAAG,cAAc,CAAC,WAAmB;AACxC,WAAK,gBAAgB,2BAA2B,OAAO,EAAE,MAAM,MAAM,GAAG;AAAA,IAC5E,CAAC;AAED,WAAO,GAAG,iBAAiB,CAAC,WAAmB;AAC3C,WAAK,gBAAgB,8BAA8B,OAAO,EAAE,MAAM,MAAM,GAAG;AAAA,IAC/E,CAAC;AAED,WAAO,GAAG,SAAS,CAAC,UAAiB;AACjC,WAAK,gBAAgB,sBAAsB,OAAO,EAAE,MAAM,KAAK,GAAG;AAAA,IACtE,CAAC;AAED,WAAO,GAAG,mBAAmB,CAAC,WAAmB;AAC7C,WAAK,gBAAgB,4CAA4C,OAAO,EAAE,MAAM,MAAM,GAAG;AAAA,IAC7F,CAAC;AAED,WAAO,GAAG,sBAAsB,CAAC,QAAQ,mBAAmB;AACxD,WAAK,gBAAgB,kDAAkD,OAAO,EAAE,MAAM,MAAM,GAAG;AAC/F,qBAAe,wCAAwC;AAAA,IAC3D,CAAC;AAED,WAAO,GAAG,iBAAiB,CAAC,UAA0B;AAClD,YAAM,QAAQ,CAAC,SAAS;AACpB,aAAK,SAAS,QAAQ,IAAI;AAAA,MAC9B,CAAC;AAAA,IACL,CAAC;AAED,WAAO,GAAG,kBAAkB,CAAC,UAA0B;AACnD,YAAM,QAAQ,CAAC,SAAS;AACpB,aAAK,UAAU,QAAQ,IAAI;AAAA,MAC/B,CAAC;AAAA,IACL,CAAC;AAED,WAAO,GAAG,mBAAmB,CAAC,OAAiB,YAA4D;AACvG,YAAM,QAAQ,CAAC,SAAS;AACpB,YAAI,KAAK,mBAAmB;AACxB,eAAK,gBAAgB,gDAAgD,IAAI,WAAW,OAAO,EAAE,GAAG;AAChG,eAAK,kBAAkB,GAAG,IAAI,EAAE,KAAK,QAAQ,SAAgB,OAAO;AAAA,QACxE;AAAA,MACJ,CAAC;AAAA,IACL,CAAC;AAED,WAAO,GAAG,+BAA+B,CAAC,MAAc,SAAiB,SAAmD,OAAyC;AACjK,UAAI,KAAK,mBAAmB;AACxB,aAAK,kBAAkB,GAAG,IAAI,EAAE,QAAQ,OAAO,EAAE,KAAK,QAAQ,SAAgB,SAAS,CAAC,KAAY,iBAA+B;AAC/H,cAAI,KAAK;AACL,oBAAQ,MAAM,GAAG;AACjB,kBAAM,gBAAgB;AAAA,cAClB,OAAO;AAAA,cACP,WAAW,IAAI;AAAA,cACf,cAAc,IAAI;AAAA;AAAA;AAAA,YAAA;AAItB,iBAAK,gBAAgB,mDAAmD,KAAK,UAAU,aAAa,CAAC,GAAG;AACxG,eAAG,aAAa;AAAA,UACpB,OAAO;AACH,iBAAK,gBAAgB,2CAA2C,KAAK,UAAU,YAAY,CAAC,GAAG;AAC/F,eAAG,YAAY;AAAA,UACnB;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ,CAAC;AAED,WAAO,GAAG,gCAAgC,CAAC,OAAiB,SAAiB,SAAmD,OAAyC;AACrK,YAAM,YAAmB,CAAA;AAEzB,YAAM,qBAAqB,WAAW,MAAM;AAExC,kBAAU,KAAK;AAAA,UACX,MAAM;AAAA,UACN,WAAW;AAAA,YACP,OAAO;AAAA,YACP,WAAW;AAAA,YACX,cAAc,0CAA0C,OAAO;AAAA,UAAA;AAAA,QACnE,CACH;AACD,WAAG,SAAS;AAAA,MAChB,GAAG,OAAO,EAAE,MAAA;AAEZ,YAAM,QAAQ,CAAC,SAAS;AACpB,YAAI,KAAK,mBAAmB;AACxB,eAAK,kBAAkB,GAAG,IAAI,EAAE,QAAQ,OAAO,EAAE,KAAK,QAAQ,SAAgB,SAAS,CAAC,KAAY,iBAA+B;AAC/H,gBAAI,KAAK;AACL,sBAAQ,MAAM,GAAG;AACjB,oBAAM,gBAAgB;AAAA,gBAClB,OAAO;AAAA,gBACP,WAAW,IAAI;AAAA,gBACf,cAAc,IAAI;AAAA;AAAA;AAAA,cAAA;AAItB,mBAAK,gBAAgB,mDAAmD,KAAK,UAAU,aAAa,CAAC,GAAG;AACxG,wBAAU,KAAK;AAAA,gBACX;AAAA,gBACA,WAAW;AAAA,cAAA,CACd;AAAA,YACL,OAAO;AACH,mBAAK,gBAAgB,2CAA2C,KAAK,UAAU,YAAY,CAAC,GAAG;AAC/F,wBAAU,KAAK;AAAA,gBACX;AAAA,gBACA,WAAW;AAAA,cAAA,CACd;AAAA,YACL;AACA,gBAAI,UAAU,WAAW,MAAM,QAAQ;AACnC,2BAAa,kBAAkB;AAC/B,iBAAG,SAAS;AAAA,YAChB;AAAA,UACJ,CAAC;AAAA,QACL;AAAA,MACJ,CAAC;AAAA,IACL,CAAC;AAAA,EACL;AAAA,EAEU,iBAAiB,CAAC,OAAiB,kBAAuF;AAEhI,QAAI,KAAK,IAAI;AACT,WAAK,oBAAoB,KAAK,GAAG,GAAG,IAAI,KAAK,SAAS,GAAG;AAEzD,WAAK,0BAAA;AAEL,WAAK,kBAAkB,GAAG,cAAc,CAAA,WAAU;AAC9C,aAAK,gBAAgB,0BAA0B,OAAO,EAAE,GAAG;AAC3D,aAAK,gBAAgB,qCAAqC,KAAK,UAAU,OAAO,UAAU,IAAI,CAAC,GAAG;AAClG,aAAK,gBAAgB,qCAAqC,KAAK,UAAU,OAAO,UAAU,QAAQ,IAAI,CAAC,GAAG;AAC1G,aAAK,gBAAgB,oCAAoC,KAAK,UAAU,OAAO,UAAU,GAAG,CAAC,GAAG;AAChG,aAAK,gBAAgB,8BAA8B,KAAK,UAAU,OAAO,SAAS,CAAC,GAAG;AAEtF,aAAK,uBAAuB,MAAM;AAElC,YAAI,eAAe;AACf,gBAAM,IAAI,CAAC,SAAS;AAChB,iBAAK,SAAS,QAAQ,IAAI;AAAA,UAC9B,CAAC;AAAA,QACL;AAEA,aAAK,oBAAoB,MAAM;AAE/B,mBAAW,MAAM;AACb,eAAK,sBAAsB,MAAM;AAAA,QACrC,GAAG,CAAC;AAEJ,aAAK,qBAAqB,MAAM;AAAA,MACpC,CAAC;AAAA,IACL,OAAO;AACH,YAAM,IAAI,MAAM,6DAA6D;AAAA,IACjF;AAEA,WAAO;AAAA,EACX;AAAA,EAEA,yBAAyB,YAA2B;AAChD,QAAI,KAAK,mBAAmB;AACxB,YAAM,KAAK,kBAAkB,QAAQ,MAAA;AAAA,IACzC;AAAA,EACJ;AAAA,EAEA,6BAA6B,MAAY;AACrC,QAAI,KAAK,mBAAmB;AACxB,WAAK,kBAAkB,kBAAA;AACvB,WAAK,oBAAoB;AAAA,IAC7B;AAAA,EACJ;AACJ;;"}