nodecommons-esm-socket-io 0.0.2

package/dist/classes/commons-socket-io-api.d.mts

@@ -0,0 +1,14 @@
+import { Socket } from 'socket.io';
+import { TEncoded } from 'tscommons-esm-core';
+import { CommonsSocketIoServer } from '../servers/commons-socket-io.server.mjs';
+type TCallback = (data: TEncoded) => TEncoded | undefined;
+type TAsyncCallback = (data: TEncoded) => Promise<TEncoded | undefined>;
+export declare abstract class CommonsSocketIoApi {
+    private socketIoServer;
+    constructor(socketIoServer: CommonsSocketIoServer);
+    protected on(command: string, callback: TCallback): void;
+    onAsync(command: string, callback: TAsyncCallback): void;
+    broadcast(command: string, data?: TEncoded): Promise<void>;
+    direct(socket: Socket, command: string, data?: TEncoded): Promise<void>;
+}
+export {};

package/dist/classes/commons-socket-io-api.mjs

@@ -0,0 +1,19 @@
+export class CommonsSocketIoApi {
+    socketIoServer;
+    constructor(socketIoServer) {
+        this.socketIoServer = socketIoServer;
+    }
+    on(command, callback) {
+        this.socketIoServer.on(command, callback);
+    }
+    onAsync(command, callback) {
+        this.socketIoServer.onAsync(command, callback);
+    }
+    async broadcast(command, data) {
+        await this.socketIoServer.broadcast(command, data);
+    }
+    async direct(socket, command, data) {
+        await this.socketIoServer.direct(socket, command, data);
+    }
+}
+//# sourceMappingURL=commons-socket-io-api.mjs.map

package/dist/classes/commons-socket-io-api.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commons-socket-io-api.mjs","sourceRoot":"","sources":["../../src/classes/commons-socket-io-api.mts"],"names":[],"mappings":"AASA,MAAM,OAAgB,kBAAkB;IAE7B;IADV,YACU,cAAqC;QAArC,mBAAc,GAAd,cAAc,CAAuB;IAC5C,CAAC;IAEM,EAAE,CACV,OAAe,EACf,QAAmB;QAEpB,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEM,OAAO,CACZ,OAAe,EACf,QAAwB;QAEzB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,SAAS,CACpB,OAAe,EACf,IAAe;QAEhB,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,MAAM,CACjB,MAAc,EACd,OAAe,EACf,IAAe;QAEhB,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;CACD"}

package/dist/index.d.mts

@@ -0,0 +1,4 @@
+import { commonsSocketIoBuildOptions, commonsSocketIoBuildUrl, CommonsSocketIoClientService } from './services/commons-socket-io-client.service.mjs';
+import { commonsSocketIoBuildDefaultOptions, CommonsSocketIoServer } from './servers/commons-socket-io.server.mjs';
+import { CommonsSocketIoApi } from './classes/commons-socket-io-api.mjs';
+export { commonsSocketIoBuildOptions, commonsSocketIoBuildUrl, CommonsSocketIoClientService, commonsSocketIoBuildDefaultOptions, CommonsSocketIoServer, CommonsSocketIoApi };

package/dist/index.mjs

@@ -0,0 +1,5 @@
+import { commonsSocketIoBuildOptions, commonsSocketIoBuildUrl, CommonsSocketIoClientService } from './services/commons-socket-io-client.service.mjs';
+import { commonsSocketIoBuildDefaultOptions, CommonsSocketIoServer } from './servers/commons-socket-io.server.mjs';
+import { CommonsSocketIoApi } from './classes/commons-socket-io-api.mjs';
+export { commonsSocketIoBuildOptions, commonsSocketIoBuildUrl, CommonsSocketIoClientService, commonsSocketIoBuildDefaultOptions, CommonsSocketIoServer, CommonsSocketIoApi };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,MAAM,iDAAiD,CAAC;AACrJ,OAAO,EAAE,kCAAkC,EAAE,qBAAqB,EAAE,MAAM,wCAAwC,CAAC;AACnH,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EACN,2BAA2B,EAC3B,uBAAuB,EACvB,4BAA4B,EAC5B,kCAAkC,EAClC,qBAAqB,EACrB,kBAAkB,EAClB,CAAC"}

package/dist/servers/commons-socket-io.server.d.mts

@@ -0,0 +1,29 @@
+import * as http from 'http';
+import * as https from 'https';
+import { Socket, ServerOptions } from 'socket.io';
+import { TEncoded } from 'tscommons-esm-core';
+import { ICommonsHttpConfig } from 'nodecommons-esm-http';
+type TCallback = (data: TEncoded) => TEncoded | undefined;
+type TAsyncCallback = (data: TEncoded) => Promise<TEncoded | undefined>;
+export declare function commonsSocketIoBuildDefaultOptions(httpConfig: ICommonsHttpConfig): Partial<ServerOptions>;
+export declare abstract class CommonsSocketIoServer {
+    private socketIo;
+    private internalEnabled;
+    private sockets;
+    private ons;
+    private onAsyncs;
+    private ids;
+    constructor(httpServer: http.Server | https.Server, defaultEnabled?: boolean, options?: Partial<ServerOptions>);
+    protected onConnect(id: string, socket: Socket): boolean;
+    protected onDisconnect(id: string): void;
+    private init;
+    protected getSocketById(id: string): Socket | undefined;
+    kickAll(): void;
+    get enabled(): boolean;
+    set enabled(state: boolean);
+    on(command: string, callback: TCallback): void;
+    onAsync(command: string, callback: TAsyncCallback): void;
+    broadcast(command: string, data?: TEncoded): Promise<void>;
+    direct(socket: Socket, command: string, data?: TEncoded): Promise<void>;
+}
+export {};

package/dist/servers/commons-socket-io.server.mjs

@@ -0,0 +1,134 @@
+import { Server } from 'socket.io';
+import { commonsBase62GenerateRandomId } from 'tscommons-esm-core';
+import { commonsNginxProxyPath } from 'nodecommons-esm-http';
+export function commonsSocketIoBuildDefaultOptions(httpConfig) {
+    const path = commonsNginxProxyPath(httpConfig.path);
+    const options = {
+        transports: ['websocket', 'polling']
+    };
+    if (path !== undefined)
+        options.path = `${path}${path.endsWith('/') ? '' : '/'}socket.io`;
+    return options;
+}
+export class CommonsSocketIoServer {
+    socketIo;
+    internalEnabled;
+    sockets = new Map();
+    ons = new Map();
+    onAsyncs = new Map();
+    ids = [];
+    constructor(httpServer, defaultEnabled, options) {
+        this.socketIo = new Server(httpServer, options);
+        this.init();
+        this.internalEnabled = defaultEnabled === false ? false : true;
+    }
+    onConnect(id, socket) {
+        this.sockets.set(id, socket);
+        return true;
+    }
+    onDisconnect(id) {
+        this.sockets.delete(id);
+    }
+    init() {
+        this.socketIo.on('connection', (socket) => {
+            let id = '';
+            for (let i = 100; i-- > 0;) {
+                id = commonsBase62GenerateRandomId();
+                if (!this.ids.includes(id))
+                    break;
+            }
+            if (id === '')
+                throw new Error('Unable to generate ID. This is extremely unlikely?');
+            if (!this.onConnect(id, socket)) {
+                socket.disconnect(true);
+                return;
+            }
+            for (const command of this.ons.keys()) {
+                const callback = this.ons.get(command);
+                socket.on(command, callback);
+            }
+            for (const command of this.onAsyncs.keys()) {
+                const callback = this.onAsyncs.get(command);
+                socket.on(command, (a, response) => {
+                    void callback(a, response);
+                });
+            }
+            socket.on('disconnect', () => {
+                this.onDisconnect(id);
+            });
+            // This isn't part of the socket.io library, so is implemented manually
+            socket.on('commons-socket.io-identify-self-uid', (_, response) => {
+                response(id);
+            });
+        });
+    }
+    getSocketById(id) {
+        return this.sockets.get(id);
+    }
+    kickAll() {
+        for (const socket of this.sockets.values()) {
+            socket.disconnect(true);
+        }
+    }
+    get enabled() {
+        return this.internalEnabled;
+    }
+    set enabled(state) {
+        this.internalEnabled = state;
+    }
+    on(command, callback) {
+        this.ons.set(command, (data, response) => {
+            try {
+                const outcome = callback(data);
+                response(outcome);
+            }
+            catch (e) {
+                console.error(`Socket IO server on event generated an Error: ${e.message}`);
+            }
+        });
+    }
+    onAsync(command, callback) {
+        this.onAsyncs.set(command, async (data, response) => {
+            try {
+                const outcome = await callback(data);
+                response(outcome);
+            }
+            catch (e) {
+                console.error(`Socket IO server on event generated an Error: ${e.message}`);
+            }
+        });
+    }
+    async broadcast(command, data) {
+        return new Promise((resolve, reject) => {
+            if (!this.internalEnabled) {
+                reject(new Error('Cannot broadcast: socket is not enabled'));
+                return;
+            }
+            if (data === undefined) {
+                this.socketIo.emit(command);
+                resolve();
+            }
+            else {
+                this.socketIo.emit(command, data);
+                resolve();
+            }
+        });
+    }
+    async direct(socket, command, data) {
+        return new Promise((resolve, reject) => {
+            if (!this.internalEnabled) {
+                reject(new Error('Cannot direct: socket is not enabled'));
+                return;
+            }
+            if (data === undefined) {
+                socket.emit(command);
+                resolve();
+            }
+            else {
+                socket.emit(command, data);
+                resolve();
+            }
+        });
+    }
+}
+//# sourceMappingURL=commons-socket-io.server.mjs.map

package/dist/servers/commons-socket-io.server.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commons-socket-io.server.mjs","sourceRoot":"","sources":["../../src/servers/commons-socket-io.server.mts"],"names":[],"mappings":"AAGA,OAAO,EAAU,MAAM,EAAiB,MAAM,WAAW,CAAC;AAE1D,OAAO,EAAE,6BAA6B,EAAY,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAsB,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAQjF,MAAM,UAAU,kCAAkC,CAAC,UAA8B;IAChF,MAAM,IAAI,GAAW,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE5D,MAAM,OAAO,GAA2B;QACtC,UAAU,EAAE,CAAE,WAAW,EAAE,SAAS,CAAE;KACvC,CAAC;IAEF,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,CAAC,IAAI,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IAE1F,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,MAAM,OAAgB,qBAAqB;IAClC,QAAQ,CAAS;IACjB,eAAe,CAAU;IACzB,OAAO,GAAwB,IAAI,GAAG,EAAkB,CAAC;IACzD,GAAG,GAA6B,IAAI,GAAG,EAAuB,CAAC;IAC/D,QAAQ,GAAkC,IAAI,GAAG,EAA4B,CAAC;IAC9E,GAAG,GAAa,EAAE,CAAC;IAE3B,YACE,UAAoC,EACpC,cAAwB,EACxB,OAAgC;QAEjC,IAAI,CAAC,QAAQ,GAAG,IAAI,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAEhD,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,IAAI,CAAC,eAAe,GAAG,cAAc,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,CAAC;IAES,SAAS,CAAC,EAAU,EAAE,MAAc;QAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACb,CAAC;IACS,YAAY,CAAC,EAAU;QAChC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAEO,IAAI;QACX,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAc,EAAQ,EAAE;YACvD,IAAI,EAAE,GAAW,EAAE,CAAC;YACpB,KAAK,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;gBAC5B,EAAE,GAAG,6BAA6B,EAAE,CAAC;gBACrC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAAE,MAAM;YACnC,CAAC;YACD,IAAI,EAAE,KAAK,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YAErF,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC;gBACjC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBACxB,OAAO;YACR,CAAC;YAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAgB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC;gBACrD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9B,CAAC;YACD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC5C,MAAM,QAAQ,GAAqB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC;gBAC/D,MAAM,CAAC,EAAE,CACP,OAAO,EACP,CAAC,CAAW,EAAE,QAAmB,EAAQ,EAAE;oBAC1C,KAAK,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC5B,CAAC,CACF,CAAC;YACH,CAAC;YAED,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,GAAS,EAAE;gBAClC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;YAEH,uEAAuE;YACvE,MAAM,CAAC,EAAE,CACP,qCAAqC,EACrC,CAAC,CAAU,EAAE,QAAmB,EAAQ,EAAE;gBACzC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACd,CAAC,CACF,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC;IAES,aAAa,CAAC,EAAU;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAEM,OAAO;QACb,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;IACD,IAAW,OAAO,CAAC,KAAc;QAChC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;IAC9B,CAAC;IAEM,EAAE,CACP,OAAe,EACf,QAAmB;QAEpB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,IAAc,EAAE,QAAmB,EAAE,EAAE;YAC7D,IAAI,CAAC;gBACJ,MAAM,OAAO,GAAuB,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACnD,QAAQ,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,OAAO,CAAC,KAAK,CAAC,iDAAkD,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;YACxF,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,OAAO,CACZ,OAAe,EACf,QAAwB;QAEzB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,IAAc,EAAE,QAAmB,EAAE,EAAE;YACxE,IAAI,CAAC;gBACJ,MAAM,OAAO,GAAuB,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACzD,QAAQ,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,OAAO,CAAC,KAAK,CAAC,iDAAkD,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;YACxF,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,SAAS,CACpB,OAAe,EACf,IAAe;QAEhB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAmB,EAAE,MAA0B,EAAQ,EAAE;YAClF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC,CAAC;gBAC7D,OAAO;YACR,CAAC;YAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5B,OAAO,EAAE,CAAC;YACX,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAClC,OAAO,EAAE,CAAC;YACX,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,CACjB,MAAc,EACd,OAAe,EACf,IAAe;QAEhB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAmB,EAAE,MAA0B,EAAQ,EAAE;YAClF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,CAAC;gBAC1D,OAAO;YACR,CAAC;YAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrB,OAAO,EAAE,CAAC;YACX,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAC3B,OAAO,EAAE,CAAC;YACX,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;CACD"}

package/dist/services/commons-socket-io-client.service.d.mts

@@ -0,0 +1,31 @@
+import { ManagerOptions } from 'socket.io-client';
+import { TEncoded, TPropertyObject } from 'tscommons-esm-core';
+type TConnectionCallback = () => void;
+type TErrorCallback = (error: Error) => void;
+export declare function commonsSocketIoBuildOptions(url: string): Partial<ManagerOptions>;
+export declare function commonsSocketIoBuildUrl(url: string): string;
+export declare abstract class CommonsSocketIoClientService {
+    private url;
+    private defaultEnabled?;
+    private options?;
+    private connectCallbacks;
+    private disconnectCallbacks;
+    private errorCallbacks;
+    private socket?;
+    private internalConnected;
+    private internalEnabled;
+    constructor(url: string, defaultEnabled?: boolean | undefined, options?: Partial<ManagerOptions> | undefined);
+    addConnectCallback(callback: TConnectionCallback): void;
+    addDisconnectCallback(callback: TConnectionCallback): void;
+    addErrorCallback(callback: TErrorCallback): void;
+    getId(): Promise<string | undefined>;
+    connect(params?: TPropertyObject<string | number | boolean>): boolean;
+    disconnect(): void;
+    protected abstract setupOns(): void;
+    get enabled(): boolean;
+    set enabled(state: boolean);
+    get isConnected(): boolean;
+    protected on(command: string, callback: (data?: TEncoded) => void): void;
+    protected emit(command: string, data?: TEncoded): Promise<TEncoded>;
+}
+export {};

package/dist/services/commons-socket-io-client.service.mjs

@@ -0,0 +1,139 @@
+import { io } from 'socket.io-client';
+import { commonsBase62IsId, commonsTypeIsString } from 'tscommons-esm-core';
+export function commonsSocketIoBuildOptions(url) {
+    const options = {
+        transports: ['websocket', 'polling']
+    };
+    if (url.startsWith('/')) {
+        options.path = `${url}${url.endsWith('/') ? '' : '/'}socket.io`;
+    }
+    else {
+        const regexp = /^http(?:s?):\/\/[^/]+\/(.+)$/i;
+        const match = regexp.exec(url);
+        if (match !== null) {
+            options.path = `/${match[1]}${match[1].endsWith('/') ? '' : '/'}socket.io`;
+        }
+    }
+    return options;
+}
+export function commonsSocketIoBuildUrl(url) {
+    if (url.startsWith('/'))
+        return '/';
+    const regexp = /^(http(?:s?):\/\/[^/]+\/).+$/i;
+    const match = regexp.exec(url);
+    if (match !== null)
+        return match[1];
+    return url;
+}
+export class CommonsSocketIoClientService {
+    url;
+    defaultEnabled;
+    options;
+    connectCallbacks = [];
+    disconnectCallbacks = [];
+    errorCallbacks = [];
+    socket;
+    internalConnected = false;
+    internalEnabled;
+    constructor(url, defaultEnabled, options) {
+        this.url = url;
+        this.defaultEnabled = defaultEnabled;
+        this.options = options;
+    }
+    addConnectCallback(callback) {
+        this.connectCallbacks.push(callback);
+    }
+    addDisconnectCallback(callback) {
+        this.disconnectCallbacks.push(callback);
+    }
+    addErrorCallback(callback) {
+        this.errorCallbacks.push(callback);
+    }
+    // This isn't part of the socket.io library, so requests any server to implement it manually
+    async getId() {
+        const result = await this.emit('commons-socket.io-identify-self-uid', {});
+        if (!commonsTypeIsString(result))
+            return undefined;
+        if (!commonsBase62IsId(result))
+            return undefined;
+        return result;
+    }
+    connect(params) {
+        if (this.socket)
+            return true; // already connected
+        const options = this.options || {};
+        if (params) {
+            const asStrings = {};
+            for (const key of Object.keys(params)) {
+                asStrings[key] = params[key].toString();
+            }
+            options.query = asStrings;
+        }
+        this.socket = io(this.url, options);
+        if (!this.socket)
+            return false;
+        this.socket.on('connect', () => {
+            this.internalConnected = true;
+            if (this.internalEnabled === undefined)
+                this.internalEnabled = this.defaultEnabled === false ? false : true;
+            for (const callback of this.connectCallbacks)
+                callback();
+        });
+        this.socket.on('disconnect', () => {
+            this.internalConnected = false;
+            for (const callback of this.disconnectCallbacks)
+                callback();
+        });
+        this.socket.on('error', (e) => {
+            for (const callback of this.errorCallbacks)
+                callback(e);
+        });
+        this.socket.on('connect_error', (e) => {
+            for (const callback of this.errorCallbacks)
+                callback(e);
+        });
+        this.setupOns();
+        return true;
+    }
+    disconnect() {
+        if (this.socket === undefined)
+            return;
+        this.socket.disconnect();
+    }
+    get enabled() {
+        return this.internalEnabled ? true : false;
+    }
+    set enabled(state) {
+        this.internalEnabled = state;
+    }
+    get isConnected() {
+        return this.socket !== undefined && this.internalConnected;
+    }
+    on(command, callback) {
+        if (!this.socket)
+            return; // shouldn't really be possible if the class is being used properly with setupOns
+        this.socket.on(command, (data) => {
+            if (!this.isConnected)
+                return; // is this possible?
+            if (!this.internalEnabled)
+                return;
+            callback(data);
+        });
+    }
+    async emit(command, data) {
+        return new Promise((resolve, reject) => {
+            if (!this.isConnected) {
+                reject(new Error('Socket is not currently connected'));
+                return;
+            }
+            if (!this.internalEnabled) {
+                reject(new Error('Socket is not currently enabled'));
+                return;
+            }
+            this.socket.emit(command, data, (response) => {
+                resolve(response);
+            });
+        });
+    }
+}
+//# sourceMappingURL=commons-socket-io-client.service.mjs.map

package/dist/services/commons-socket-io-client.service.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commons-socket-io-client.service.mjs","sourceRoot":"","sources":["../../src/services/commons-socket-io-client.service.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAA0B,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAA6B,MAAM,oBAAoB,CAAC;AAKvG,MAAM,UAAU,2BAA2B,CAAC,GAAW;IACtD,MAAM,OAAO,GAA4B;QACvC,UAAU,EAAE,CAAE,WAAW,EAAE,SAAS,CAAE;KACvC,CAAC;IAEF,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IACjE,CAAC;SAAM,CAAC;QACP,MAAM,MAAM,GAAW,+BAA+B,CAAC;QACvD,MAAM,KAAK,GAAyB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;QAC5E,CAAC;IACF,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,GAAW;IAClD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IAEpC,MAAM,MAAM,GAAW,+BAA+B,CAAC;IACvD,MAAM,KAAK,GAAyB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAErD,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAEpC,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,MAAM,OAAgB,4BAA4B;IAUxC;IACA;IACA;IAXD,gBAAgB,GAA0B,EAAE,CAAC;IAC7C,mBAAmB,GAA0B,EAAE,CAAC;IAChD,cAAc,GAAqB,EAAE,CAAC;IAEtC,MAAM,CAAU;IAChB,iBAAiB,GAAY,KAAK,CAAC;IACnC,eAAe,CAAoB;IAE3C,YACS,GAAW,EACX,cAAkC,EAClC,OAAiC;QAFjC,QAAG,GAAH,GAAG,CAAQ;QACX,mBAAc,GAAd,cAAc,CAAoB;QAClC,YAAO,GAAP,OAAO,CAA0B;IACvC,CAAC;IAEG,kBAAkB,CAAC,QAA6B;QACtD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAEM,qBAAqB,CAAC,QAA6B;QACzD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEM,gBAAgB,CAAC,QAAwB;QAC/C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,KAAK;QACjB,MAAM,MAAM,GAAY,MAAM,IAAI,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC;YAAE,OAAO,SAAS,CAAC;QACnD,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC;YAAE,OAAO,SAAS,CAAC;QAEjD,OAAO,MAAM,CAAC;IACf,CAAC;IAEM,OAAO,CAAC,MAA+C;QAC7D,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,CAAC,oBAAoB;QAElD,MAAM,OAAO,GAA4B,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAE5D,IAAI,MAAM,EAAE,CAAC;YACZ,MAAM,SAAS,GAAgC,EAAE,CAAC;YAElD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;YACzC,CAAC;YACD,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAE/B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAS,EAAE;YACpC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;YAC9B,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS;gBAAE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;YAC5G,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB;gBAAE,QAAQ,EAAE,CAAC;QAC1D,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,GAAS,EAAE;YACvC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,mBAAmB;gBAAE,QAAQ,EAAE,CAAC;QAC7D,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAQ,EAAQ,EAAE;YAC1C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,cAAc;gBAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAQ,EAAQ,EAAE;YAClD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,cAAc;gBAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,EAAE,CAAC;QAEhB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,UAAU;QAChB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAAE,OAAO;QACtC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAC1B,CAAC;IAID,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5C,CAAC;IACD,IAAW,OAAO,CAAC,KAAc;QAChC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,IAAW,WAAW;QACrB,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,iBAAiB,CAAC;IAC5D,CAAC;IAES,EAAE,CACV,OAAe,EACf,QAAmC;QAEpC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,iFAAiF;QAE3G,IAAI,CAAC,MAAM,CAAC,EAAE,CACZ,OAAO,EACP,CAAC,IAAe,EAAQ,EAAE;YACzB,IAAI,CAAC,IAAI,CAAC,WAAW;gBAAE,OAAO,CAAC,oBAAoB;YACnD,IAAI,CAAC,IAAI,CAAC,eAAe;gBAAE,OAAO;YAElC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CACF,CAAC;IACH,CAAC;IAES,KAAK,CAAC,IAAI,CAClB,OAAe,EACf,IAAe;QAEhB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAqC,EAAE,MAA0B,EAAQ,EAAE;YAC9F,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC;gBACvD,OAAO;YACR,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC,CAAC;gBACrD,OAAO;YACR,CAAC;YAED,IAAI,CAAC,MAAO,CAAC,IAAI,CACf,OAAO,EACP,IAAI,EACJ,CAAC,QAAkB,EAAQ,EAAE;gBAC5B,OAAO,CAAC,QAAQ,CAAC,CAAC;YACnB,CAAC,CACF,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC;CACD"}

package/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "nodecommons-esm-socket-io",
+	"version": "0.0.2",
+	"description": "",
+	"scripts": {
+		"tsc": "./node_modules/typescript/bin/tsc",
+		"preprepare": "rm -rf ./dist; php ~/Dev/etim.php src/ && npm run tsc",
+		"publish-major": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version major && npm install && npm publish && git add . && git commit -m 'publish'",
+		"publish-minor": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version minor && npm install && npm publish && git add . && git commit -m 'publish'",
+		"publish-patch": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version patch && npm install && npm publish && git add . && git commit -m 'publish'"
+	},
+	"main": "dist/index.mjs",
+	"types": "dist/index.d.mjs",
+	"type": "module",
+	"author": "Pete Morris",
+	"license": "ISC",
+	"devDependencies": {
+		"@stylistic/eslint-plugin-ts": "^2.11.0",
+		"@types/node": "^22.10.0",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-prefer-arrow-functions": "^3.4.1",
+		"typescript": "^5.7.2",
+		"typescript-eslint": "^8.16.0"
+	},
+	"files": [
+		"dist/**/*"
+	],
+	"dependencies": {
+		"nodecommons-esm-http": "^0.0.6",
+		"socket.io": "^4.8.1",
+		"socket.io-client": "^4.8.1",
+		"tscommons-esm-core": "^0.0.4"
+	}
+}