node-server-engine 1.0.5

package/dist/entities/SocketClient/SocketClient.js

@@ -0,0 +1,394 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SocketClient = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _crypto = require("crypto");
+var _parseMessage = require("./parseMessage");
+var _const = require("../../const");
+var _EngineError = require("../EngineError");
+var _MessageHandler = require("../MessageHandler");
+var _ValidationError = require("../ValidationError");
+var _WebError = require("../WebError");
+var _jwt = require("../../utils/jwt");
+var _report = require("../../utils/report");
+const namespace = 'SocketClient';
+
+/**
+ * Class where each instance represents a client connected through web-sockets
+ */
+let SocketClient = exports.SocketClient = /*#__PURE__*/function () {
+  /**
+   * Create a WS client
+   */
+  function SocketClient(webSocket, request, options) {
+    (0, _classCallCheck2.default)(this, SocketClient);
+    /** Unique identifier of the client */
+    this.id = void 0;
+    /** Date at which the client connection was established */
+    this.establishedAt = void 0;
+    /** WS instance of the client connection */
+    this.ws = void 0;
+    /** List of message handlers that are registered with the client */
+    this.handlers = void 0;
+    /** Callback function that are called when the client is created */
+    this.initCallbacks = [];
+    /** Callback function that are called when the client successfully authenticates */
+    this.authCallbacks = [];
+    /** Callback function that are called when the client connection is terminated */
+    this.shutdownCallbacks = [];
+    /** Authentication status of the client */
+    this.authenticated = false;
+    /** Timer used to track when to send authentication renewal reminder to the client */
+    this.authRenewTimer = void 0;
+    /** Timers used to track the time at which a user losses authentication */
+    this.authExpireTimer = void 0;
+    /** ID of the user that is authenticated */
+    this.userId = void 0;
+    /** ID of the device with which the client authenticated */
+    this.deviceId = void 0;
+    /** Id of the token with which the client authenticated */
+    this.tokenId = void 0;
+    /** Audience claims that were in the latest authentication token used by the client */
+    this.audience = void 0;
+    /** Status tracking variable used to check the liveness of connections */
+    this.isAlive = true;
+    /** Timer used to track interval between client pinging */
+    this.pingInterval = void 0;
+    this.id = (0, _crypto.randomUUID)();
+    this.ws = webSocket;
+    this.establishedAt = new Date();
+    (0, _report.reportDebug)({
+      namespace,
+      message: `Creating socket client [${this.id}]`
+    });
+
+    // Make sure that callbacks are made as lists of functions
+    // Init
+    if (typeof options.initCallbacks === 'function') this.initCallbacks = [options.initCallbacks];else if (options.initCallbacks instanceof Array) this.initCallbacks = options.initCallbacks;
+    // Auth
+    if (typeof options.authCallbacks === 'function') this.authCallbacks = [options.authCallbacks];else if (options.authCallbacks instanceof Array) this.authCallbacks = options.authCallbacks;
+    // Shutdown
+    if (typeof options.shutdownCallbacks === 'function') this.shutdownCallbacks = [options.shutdownCallbacks];else if (options.shutdownCallbacks instanceof Array) this.shutdownCallbacks = options.shutdownCallbacks;
+
+    // Check that all handlers are valid
+    this.handlers = options.handlers;
+    for (const handler of this.handlers) {
+      if (!(handler instanceof _MessageHandler.MessageHandler)) throw new _EngineError.EngineError({
+        message: 'Handler is not an instance of MessageHandler'
+      });
+    }
+    // Register in clients list
+    SocketClient.socketClients[this.id] = this;
+    (0, _report.reportInfo)({
+      message: `Client connected [${this.id}]`
+    });
+    // On socket close, deregister from clients list
+    this.ws.on('close', () => {
+      this.handleClose.bind(this)().catch(error => {
+        (0, _report.reportError)(error);
+      });
+    });
+    // On socket error, log the error
+    this.ws.on('error', error => {
+      (0, _report.reportError)(new _EngineError.EngineError({
+        severity: _const.LogSeverity.WARNING,
+        message: `Error [${this.id}]`
+      }));
+      (0, _report.reportError)(error);
+    });
+    // When receiving a message, call message handler
+    this.ws.on('message', data => {
+      this.handleMessage.bind(this)(data).catch(error => {
+        (0, _report.reportError)(error);
+      });
+    });
+
+    // Run all the init callbacks
+    // For proper error handling of potential asynchronous callbacks, we wrap the execution in an auto-executing async function
+    (async () => {
+      const callbackResults = await Promise.allSettled(this.initCallbacks.map(callback => callback(this)));
+      callbackResults.forEach(result => {
+        if (result.status === 'rejected') (0, _report.reportError)(result.reason);
+      });
+    })().catch(error => {
+      (0, _report.reportError)(error);
+    });
+
+    // Server -> client ping mechanism using WS standard ping control frames
+    // We terminate the connection if we did not get a reply in the previous interval
+    this.pingInterval = setInterval(() => {
+      if (!this.isAlive) {
+        (0, _report.reportError)(new _EngineError.EngineError({
+          severity: _const.LogSeverity.WARNING,
+          message: `Terminating socket connection, ping timeout [${this.id}]`
+        }));
+        this.ws.terminate();
+        return;
+      }
+      this.isAlive = false;
+      this.ws.ping();
+      (0, _report.reportDebug)({
+        namespace,
+        message: `Ping sent to client [${this.id}]`
+      });
+    }, process.env.WS_PING_INTERVAL ? parseInt(process.env.WS_PING_INTERVAL) * 1000 : 30000);
+
+    // Track the connection as alive as we get a pong back
+    this.ws.on('pong', () => {
+      (0, _report.reportDebug)({
+        namespace,
+        message: `Client responded to ping [${this.id}]`
+      });
+      this.isAlive = true;
+    });
+  }
+
+  /** Get the list of all connected clients indexed by ID */
+  return (0, _createClass2.default)(SocketClient, [{
+    key: "sendMessage",
+    value:
+    /**
+     * Send a message to the client
+     */
+    function sendMessage(type, payload = {}, options = {}) {
+      (0, _report.reportDebug)({
+        namespace,
+        message: `Received request to send message to client of type "${type}" [${this.id}]`,
+        data: {
+          options
+        }
+      });
+      let send = false;
+      // If the message is sent to unauthenticated user skip auth check
+      if (options.noAuth) send = true;
+      // If the message is authenticated and with the correct audience, it gets sent
+      else if (this.authenticated && this.audience.includes(options.audience ?? process.env.DEFAULT_MESSAGE_AUDIENCE)) send = true;
+      if (send) {
+        (0, _report.reportDebug)({
+          namespace,
+          message: `Sending message to client of type "${type ?? 'unknown'}" [${this.id}]`
+        });
+        this.ws.send(JSON.stringify({
+          type,
+          payload
+        }));
+      }
+    }
+
+    /** Get the client authentication status */
+  }, {
+    key: "isAuthenticated",
+    value: function isAuthenticated() {
+      return this.authenticated;
+    }
+
+    /** Fetch data on the user if he is authenticated */
+  }, {
+    key: "getUser",
+    value: function getUser() {
+      if (this.authenticated) return {
+        userId: this.userId,
+        deviceId: this.deviceId,
+        tokenId: this.tokenId,
+        audience: this.audience
+      };
+    }
+
+    /** Process an incoming message */
+  }, {
+    key: "handleMessage",
+    value: async function handleMessage(data) {
+      try {
+        const message = (0, _parseMessage.parseMessage)(data.toString('utf-8'));
+        (0, _report.reportInfo)({
+          message: `Received message of type "${message?.type ?? 'unknown'}" [${this.id}]`
+        });
+        switch (message.type) {
+          case 'authenticate':
+            await this.authenticate(message);
+            break;
+          // As not all client libraries allow sending pings through WS control frames,
+          // we add a higher level ping mechanism
+          case 'ping':
+            (0, _report.reportDebug)({
+              namespace,
+              message: `Received ping from client [${this.id}]`
+            });
+            this.sendMessage('pong', {}, {
+              noAuth: true
+            });
+            break;
+          default:
+            for (const handler of this.handlers) {
+              await handler.handle(message, this);
+            }
+        }
+      } catch (error) {
+        this.handleError(error);
+      }
+    }
+
+    /**
+     * Process an authentication request
+     * @param {String} message - Authentication message
+     */
+  }, {
+    key: "authenticate",
+    value: async function authenticate(message) {
+      const token = message.payload?.token;
+      if (!token) {
+        throw new _WebError.WebError({
+          errorCode: 'no-token',
+          message: 'No token was given',
+          data: {
+            message
+          }
+        });
+      }
+      const payload = await (0, _jwt.jwtVerify)(token);
+      this.setUserData(payload);
+      this.authenticated = true;
+      // Time remaining before token expiration
+      const authExpiration = payload.exp * 1000 - Date.now();
+      // Clear previously created timers
+      this.clearTimeouts();
+      // Send a refresh request to the client 1 minute before expiration
+      this.authRenewTimer = setTimeout(() => {
+        this.sendMessage('renewAuthentication');
+      }, authExpiration - 60 * 1000);
+      // Expire client authentication
+      this.authExpireTimer = setTimeout(() => {
+        this.authenticated = false;
+      }, authExpiration);
+
+      // Run all the post-authentication callbacks
+      const callbackResults = await Promise.allSettled(this.authCallbacks.map(callback => callback(this)));
+      callbackResults.forEach(result => {
+        if (result.status === 'rejected') (0, _report.reportError)(result.reason);
+      });
+    }
+
+    // Clear all the pending timers
+    /** */
+  }, {
+    key: "clearTimeouts",
+    value: function clearTimeouts() {
+      if (this.authRenewTimer) clearTimeout(this.authRenewTimer);
+      if (this.authExpireTimer) clearTimeout(this.authExpireTimer);
+    }
+
+    /**
+     * Fetch the user's data and attach it to the connection for new connections. For existing connections, it checks that the authentication is done on the same user.
+     */
+  }, {
+    key: "setUserData",
+    value: function setUserData({
+      sub,
+      dev,
+      jti,
+      aud
+    }) {
+      // Check if the user is already authenticated
+      if (this.userId) {
+        // Check that the token is for the same connection as before
+        if (this.userId && this.userId !== sub) throw new _WebError.WebError({
+          errorCode: 'wrong-user-token',
+          message: 'A user tried to authenticate with a token that is not for him [userId]'
+        });
+      } else {
+        // Set the user's ID
+        this.userId = sub;
+        // Set the user's Device Id
+        this.deviceId = dev;
+        // Set the token ID
+        this.tokenId = jti;
+        // Set the aud
+        this.audience = aud instanceof Array ? aud : [aud];
+        (0, _report.reportDebug)({
+          namespace,
+          message: `Successfully authenticated client [${this.id}]`,
+          data: {
+            userId: this.userId,
+            deviceId: this.deviceId,
+            tokenId: this.tokenId,
+            audience: this.audience
+          }
+        });
+      }
+    }
+
+    /**
+     * Properly return errors to clients
+     */
+  }, {
+    key: "handleError",
+    value: function handleError(error) {
+      (0, _report.reportError)(error);
+      if (error instanceof _WebError.WebError) {
+        this.sendMessage('error', {
+          errorCode: error.errorCode,
+          hint: error.hint
+        }, {
+          noAuth: true
+        });
+      } else if (error instanceof _ValidationError.ValidationError) {
+        this.sendMessage('error', {
+          errorCode: 'validation-error',
+          hint: error.data
+        }, {
+          noAuth: true
+        });
+      } else {
+        this.sendMessage('error', {
+          errorCode: 'server-error'
+        }, {
+          noAuth: true
+        });
+      }
+    }
+
+    /**
+     * Process a socket close event
+     */
+  }, {
+    key: "handleClose",
+    value: async function handleClose(code, reason) {
+      delete SocketClient.socketClients[this.id];
+      this.clearTimeouts();
+      // Stop ping process
+      if (this.pingInterval) clearInterval(this.pingInterval);
+      // Run all the shutdown callbacks
+      const callbackResults = await Promise.allSettled(this.shutdownCallbacks.map(callback => callback(this)));
+      callbackResults.forEach(result => {
+        if (result.status === 'rejected') (0, _report.reportError)(result.reason);
+      });
+      (0, _report.reportInfo)({
+        message: `Client disconnected [${this.id}]`,
+        data: {
+          code,
+          reason
+        }
+      });
+    }
+  }], [{
+    key: "getSocketClients",
+    value: function getSocketClients() {
+      return this.socketClients;
+    }
+
+    /** Get a client by his ID */
+  }, {
+    key: "getSocketClient",
+    value: function getSocketClient(id) {
+      return this.socketClients[id];
+    }
+  }]);
+}();
+/** Mapping of all the connected socket clients */
+SocketClient.socketClients = {};
+//# sourceMappingURL=SocketClient.js.map

package/dist/entities/SocketClient/SocketClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketClient.js","names":["_crypto","require","_parseMessage","_const","_EngineError","_MessageHandler","_ValidationError","_WebError","_jwt","_report","namespace","SocketClient","exports","webSocket","request","options","_classCallCheck2","default","id","establishedAt","ws","handlers","initCallbacks","authCallbacks","shutdownCallbacks","authenticated","authRenewTimer","authExpireTimer","userId","deviceId","tokenId","audience","isAlive","pingInterval","randomUUID","Date","reportDebug","message","Array","handler","MessageHandler","EngineError","socketClients","reportInfo","on","handleClose","bind","catch","error","reportError","severity","LogSeverity","WARNING","data","handleMessage","callbackResults","Promise","allSettled","map","callback","forEach","result","status","reason","setInterval","terminate","ping","process","env","WS_PING_INTERVAL","parseInt","_createClass2","key","value","sendMessage","type","payload","send","noAuth","includes","DEFAULT_MESSAGE_AUDIENCE","JSON","stringify","isAuthenticated","getUser","parseMessage","toString","authenticate","handle","handleError","token","WebError","errorCode","jwtVerify","setUserData","authExpiration","exp","now","clearTimeouts","setTimeout","clearTimeout","sub","dev","jti","aud","hint","ValidationError","code","clearInterval","getSocketClients","getSocketClient"],"sources":["../../../src/entities/SocketClient/SocketClient.ts"],"sourcesContent":["import { randomUUID } from 'crypto';\nimport { IncomingMessage } from 'http';\nimport WS, { RawData } from 'ws';\nimport { parseMessage } from './parseMessage';\nimport {\n  SocketClientOptions,\n  SocketClientSendMessageOptions,\n  SocketAuthenticationMessage,\n  SocketClientCallback,\n  SocketClientList,\n  SocketUser\n} from './SocketClient.types';\nimport { LogSeverity } from 'const';\nimport { EngineError } from 'entities/EngineError';\nimport { MessageHandler } from 'entities/MessageHandler';\nimport { ValidationError } from 'entities/ValidationError';\nimport { WebError } from 'entities/WebError';\nimport { jwtVerify, UserTokenPayload } from 'utils/jwt';\nimport { reportInfo, reportError, reportDebug } from 'utils/report';\n\nconst namespace = 'SocketClient';\n\n/**\n * Class where each instance represents a client connected through web-sockets\n */\nexport class SocketClient {\n  /** Mapping of all the connected socket clients */\n  private static socketClients: SocketClientList = {};\n  /** Unique identifier of the client */\n  public readonly id: string;\n  /** Date at which the client connection was established */\n  public readonly establishedAt: Date;\n  /** WS instance of the client connection */\n  private ws: WS;\n  /** List of message handlers that are registered with the client */\n  private handlers: Array<MessageHandler>;\n  /** Callback function that are called when the client is created */\n  private initCallbacks: Array<SocketClientCallback> = [];\n  /** Callback function that are called when the client successfully authenticates */\n  private authCallbacks: Array<SocketClientCallback> = [];\n  /** Callback function that are called when the client connection is terminated */\n  private shutdownCallbacks: Array<SocketClientCallback> = [];\n  /** Authentication status of the client */\n  private authenticated = false;\n  /** Timer used to track when to send authentication renewal reminder to the client */\n  private authRenewTimer: NodeJS.Timeout | string | number | undefined;\n  /** Timers used to track the time at which a user losses authentication */\n  private authExpireTimer: NodeJS.Timeout | string | number | undefined;\n  /** ID of the user that is authenticated */\n  private userId: undefined | string;\n  /** ID of the device with which the client authenticated */\n  private deviceId: undefined | string;\n  /** Id of the token with which the client authenticated */\n  private tokenId: undefined | string;\n  /** Audience claims that were in the latest authentication token used by the client */\n  private audience: undefined | Array<string>;\n  /** Status tracking variable used to check the liveness of connections */\n  private isAlive = true;\n  /** Timer used to track interval between client pinging */\n  private pingInterval: NodeJS.Timeout | string | number | undefined;\n\n  /**\n   * Create a WS client\n   */\n  public constructor(\n    webSocket: WS,\n    request: IncomingMessage,\n    options: SocketClientOptions\n  ) {\n    this.id = randomUUID();\n    this.ws = webSocket;\n    this.establishedAt = new Date();\n\n    reportDebug({ namespace, message: `Creating socket client [${this.id}]` });\n\n    // Make sure that callbacks are made as lists of functions\n    // Init\n    if (typeof options.initCallbacks === 'function')\n      this.initCallbacks = [options.initCallbacks];\n    else if (options.initCallbacks instanceof Array)\n      this.initCallbacks = options.initCallbacks;\n    // Auth\n    if (typeof options.authCallbacks === 'function')\n      this.authCallbacks = [options.authCallbacks];\n    else if (options.authCallbacks instanceof Array)\n      this.authCallbacks = options.authCallbacks;\n    // Shutdown\n    if (typeof options.shutdownCallbacks === 'function')\n      this.shutdownCallbacks = [options.shutdownCallbacks];\n    else if (options.shutdownCallbacks instanceof Array)\n      this.shutdownCallbacks = options.shutdownCallbacks;\n\n    // Check that all handlers are valid\n    this.handlers = options.handlers;\n    for (const handler of this.handlers) {\n      if (!(handler instanceof MessageHandler))\n        throw new EngineError({\n          message: 'Handler is not an instance of MessageHandler'\n        });\n    }\n    // Register in clients list\n    SocketClient.socketClients[this.id] = this;\n\n    reportInfo({ message: `Client connected [${this.id}]` });\n    // On socket close, deregister from clients list\n    this.ws.on('close', () => {\n      this.handleClose\n        .bind(this)()\n        .catch((error) => {\n          reportError(error);\n        });\n    });\n    // On socket error, log the error\n    this.ws.on('error', (error) => {\n      reportError(\n        new EngineError({\n          severity: LogSeverity.WARNING,\n          message: `Error [${this.id}]`\n        })\n      );\n      reportError(error);\n    });\n    // When receiving a message, call message handler\n    this.ws.on('message', (data) => {\n      this.handleMessage\n        .bind(this)(data)\n        .catch((error) => {\n          reportError(error);\n        });\n    });\n\n    // Run all the init callbacks\n    // For proper error handling of potential asynchronous callbacks, we wrap the execution in an auto-executing async function\n    (async (): Promise<void> => {\n      const callbackResults = await Promise.allSettled(\n        this.initCallbacks.map((callback) => callback(this))\n      );\n      callbackResults.forEach((result) => {\n        if (result.status === 'rejected') reportError(result.reason);\n      });\n    })().catch((error) => {\n      reportError(error);\n    });\n\n    // Server -> client ping mechanism using WS standard ping control frames\n    // We terminate the connection if we did not get a reply in the previous interval\n    this.pingInterval = setInterval(\n      () => {\n        if (!this.isAlive) {\n          reportError(\n            new EngineError({\n              severity: LogSeverity.WARNING,\n              message: `Terminating socket connection, ping timeout [${this.id}]`\n            })\n          );\n          this.ws.terminate();\n          return;\n        }\n        this.isAlive = false;\n        this.ws.ping();\n        reportDebug({ namespace, message: `Ping sent to client [${this.id}]` });\n      },\n      process.env.WS_PING_INTERVAL\n        ? parseInt(process.env.WS_PING_INTERVAL) * 1000\n        : 30000\n    );\n\n    // Track the connection as alive as we get a pong back\n    this.ws.on('pong', () => {\n      reportDebug({\n        namespace,\n        message: `Client responded to ping [${this.id}]`\n      });\n      this.isAlive = true;\n    });\n  }\n\n  /** Get the list of all connected clients indexed by ID */\n  public static getSocketClients(): SocketClientList {\n    return this.socketClients;\n  }\n\n  /** Get a client by his ID */\n  public static getSocketClient(id: string): SocketClient | undefined {\n    return this.socketClients[id];\n  }\n\n  /**\n   * Send a message to the client\n   */\n  public sendMessage(\n    type: string,\n    payload: unknown = {},\n    options: SocketClientSendMessageOptions = {}\n  ): void {\n    reportDebug({\n      namespace,\n      message: `Received request to send message to client of type \"${type}\" [${this.id}]`,\n      data: { options }\n    });\n    let send = false;\n    // If the message is sent to unauthenticated user skip auth check\n    if (options.noAuth) send = true;\n    // If the message is authenticated and with the correct audience, it gets sent\n    else if (\n      this.authenticated &&\n      (this.audience as Array<string>).includes(\n        options.audience ?? (process.env.DEFAULT_MESSAGE_AUDIENCE as string)\n      )\n    )\n      send = true;\n\n    if (send) {\n      reportDebug({\n        namespace,\n        message: `Sending message to client of type \"${type ?? 'unknown'}\" [${this.id}]`\n      });\n      this.ws.send(JSON.stringify({ type, payload }));\n    }\n  }\n\n  /** Get the client authentication status */\n  public isAuthenticated(): boolean {\n    return this.authenticated;\n  }\n\n  /** Fetch data on the user if he is authenticated */\n  public getUser(): SocketUser | undefined {\n    if (this.authenticated)\n      return {\n        userId: this.userId as string,\n        deviceId: this.deviceId as string,\n        tokenId: this.tokenId as string,\n        audience: this.audience as Array<string>\n      };\n  }\n\n  /** Process an incoming message */\n  private async handleMessage(data: RawData): Promise<void> {\n    try {\n      const message = parseMessage(data.toString('utf-8'));\n      reportInfo({\n        message: `Received message of type \"${message?.type ?? 'unknown'}\" [${this.id}]`\n      });\n      switch (message.type) {\n        case 'authenticate':\n          await this.authenticate(message as SocketAuthenticationMessage);\n          break;\n        // As not all client libraries allow sending pings through WS control frames,\n        // we add a higher level ping mechanism\n        case 'ping':\n          reportDebug({\n            namespace,\n            message: `Received ping from client [${this.id}]`\n          });\n          this.sendMessage('pong', {}, { noAuth: true });\n          break;\n        default:\n          for (const handler of this.handlers) {\n            await handler.handle(message, this);\n          }\n      }\n    } catch (error) {\n      this.handleError(error);\n    }\n  }\n\n  /**\n   * Process an authentication request\n   * @param {String} message - Authentication message\n   */\n  private async authenticate(\n    message: SocketAuthenticationMessage\n  ): Promise<void> {\n    const token = message.payload?.token;\n    if (!token) {\n      throw new WebError({\n        errorCode: 'no-token',\n        message: 'No token was given',\n        data: { message }\n      });\n    }\n    const payload = await jwtVerify(token);\n    this.setUserData(payload);\n\n    this.authenticated = true;\n    // Time remaining before token expiration\n    const authExpiration = payload.exp * 1000 - Date.now();\n    // Clear previously created timers\n    this.clearTimeouts();\n    // Send a refresh request to the client 1 minute before expiration\n    this.authRenewTimer = setTimeout(\n      () => {\n        this.sendMessage('renewAuthentication');\n      },\n      authExpiration - 60 * 1000\n    );\n    // Expire client authentication\n    this.authExpireTimer = setTimeout(() => {\n      this.authenticated = false;\n    }, authExpiration);\n\n    // Run all the post-authentication callbacks\n    const callbackResults = await Promise.allSettled(\n      this.authCallbacks.map((callback) => callback(this))\n    );\n    callbackResults.forEach((result) => {\n      if (result.status === 'rejected') reportError(result.reason);\n    });\n  }\n\n  // Clear all the pending timers\n  /** */\n  private clearTimeouts(): void {\n    if (this.authRenewTimer) clearTimeout(this.authRenewTimer);\n    if (this.authExpireTimer) clearTimeout(this.authExpireTimer);\n  }\n\n  /**\n   * Fetch the user's data and attach it to the connection for new connections. For existing connections, it checks that the authentication is done on the same user.\n   */\n  private setUserData({ sub, dev, jti, aud }: UserTokenPayload): void {\n    // Check if the user is already authenticated\n    if (this.userId) {\n      // Check that the token is for the same connection as before\n      if (this.userId && this.userId !== sub)\n        throw new WebError({\n          errorCode: 'wrong-user-token',\n          message:\n            'A user tried to authenticate with a token that is not for him [userId]'\n        });\n    } else {\n      // Set the user's ID\n      this.userId = sub;\n      // Set the user's Device Id\n      this.deviceId = dev;\n      // Set the token ID\n      this.tokenId = jti;\n      // Set the aud\n      this.audience = aud instanceof Array ? aud : [aud];\n\n      reportDebug({\n        namespace,\n        message: `Successfully authenticated client [${this.id}]`,\n        data: {\n          userId: this.userId,\n          deviceId: this.deviceId,\n          tokenId: this.tokenId,\n          audience: this.audience\n        }\n      });\n    }\n  }\n\n  /**\n   * Properly return errors to clients\n   */\n  private handleError(error: unknown): void {\n    reportError(error);\n    if (error instanceof WebError) {\n      this.sendMessage(\n        'error',\n        { errorCode: error.errorCode, hint: error.hint },\n        { noAuth: true }\n      );\n    } else if (error instanceof ValidationError) {\n      this.sendMessage(\n        'error',\n        { errorCode: 'validation-error', hint: error.data },\n        { noAuth: true }\n      );\n    } else {\n      this.sendMessage(\n        'error',\n        { errorCode: 'server-error' },\n        { noAuth: true }\n      );\n    }\n  }\n\n  /**\n   * Process a socket close event\n   */\n  private async handleClose(code?: string, reason?: string): Promise<void> {\n    delete SocketClient.socketClients[this.id];\n    this.clearTimeouts();\n    // Stop ping process\n    if (this.pingInterval) clearInterval(this.pingInterval);\n    // Run all the shutdown callbacks\n    const callbackResults = await Promise.allSettled(\n      this.shutdownCallbacks.map((callback) => callback(this))\n    );\n    callbackResults.forEach((result) => {\n      if (result.status === 'rejected') reportError(result.reason);\n    });\n    reportInfo({\n      message: `Client disconnected [${this.id}]`,\n      data: { code, reason }\n    });\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAGA,IAAAC,aAAA,GAAAD,OAAA;AASA,IAAAE,MAAA,GAAAF,OAAA;AACA,IAAAG,YAAA,GAAAH,OAAA;AACA,IAAAI,eAAA,GAAAJ,OAAA;AACA,IAAAK,gBAAA,GAAAL,OAAA;AACA,IAAAM,SAAA,GAAAN,OAAA;AACA,IAAAO,IAAA,GAAAP,OAAA;AACA,IAAAQ,OAAA,GAAAR,OAAA;AAEA,MAAMS,SAAS,GAAG,cAAc;;AAEhC;AACA;AACA;AAFA,IAGaC,YAAY,GAAAC,OAAA,CAAAD,YAAA;EAoCvB;AACF;AACA;EACE,SAAAA,aACEE,SAAa,EACbC,OAAwB,EACxBC,OAA4B,EAC5B;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAN,YAAA;IAxCF;IAAA,KACgBO,EAAE;IAClB;IAAA,KACgBC,aAAa;IAC7B;IAAA,KACQC,EAAE;IACV;IAAA,KACQC,QAAQ;IAChB;IAAA,KACQC,aAAa,GAAgC,EAAE;IACvD;IAAA,KACQC,aAAa,GAAgC,EAAE;IACvD;IAAA,KACQC,iBAAiB,GAAgC,EAAE;IAC3D;IAAA,KACQC,aAAa,GAAG,KAAK;IAC7B;IAAA,KACQC,cAAc;IACtB;IAAA,KACQC,eAAe;IACvB;IAAA,KACQC,MAAM;IACd;IAAA,KACQC,QAAQ;IAChB;IAAA,KACQC,OAAO;IACf;IAAA,KACQC,QAAQ;IAChB;IAAA,KACQC,OAAO,GAAG,IAAI;IACtB;IAAA,KACQC,YAAY;IAUlB,IAAI,CAACf,EAAE,GAAG,IAAAgB,kBAAU,EAAC,CAAC;IACtB,IAAI,CAACd,EAAE,GAAGP,SAAS;IACnB,IAAI,CAACM,aAAa,GAAG,IAAIgB,IAAI,CAAC,CAAC;IAE/B,IAAAC,mBAAW,EAAC;MAAE1B,SAAS;MAAE2B,OAAO,EAAE,2BAA2B,IAAI,CAACnB,EAAE;IAAI,CAAC,CAAC;;IAE1E;IACA;IACA,IAAI,OAAOH,OAAO,CAACO,aAAa,KAAK,UAAU,EAC7C,IAAI,CAACA,aAAa,GAAG,CAACP,OAAO,CAACO,aAAa,CAAC,CAAC,KAC1C,IAAIP,OAAO,CAACO,aAAa,YAAYgB,KAAK,EAC7C,IAAI,CAAChB,aAAa,GAAGP,OAAO,CAACO,aAAa;IAC5C;IACA,IAAI,OAAOP,OAAO,CAACQ,aAAa,KAAK,UAAU,EAC7C,IAAI,CAACA,aAAa,GAAG,CAACR,OAAO,CAACQ,aAAa,CAAC,CAAC,KAC1C,IAAIR,OAAO,CAACQ,aAAa,YAAYe,KAAK,EAC7C,IAAI,CAACf,aAAa,GAAGR,OAAO,CAACQ,aAAa;IAC5C;IACA,IAAI,OAAOR,OAAO,CAACS,iBAAiB,KAAK,UAAU,EACjD,IAAI,CAACA,iBAAiB,GAAG,CAACT,OAAO,CAACS,iBAAiB,CAAC,CAAC,KAClD,IAAIT,OAAO,CAACS,iBAAiB,YAAYc,KAAK,EACjD,IAAI,CAACd,iBAAiB,GAAGT,OAAO,CAACS,iBAAiB;;IAEpD;IACA,IAAI,CAACH,QAAQ,GAAGN,OAAO,CAACM,QAAQ;IAChC,KAAK,MAAMkB,OAAO,IAAI,IAAI,CAAClB,QAAQ,EAAE;MACnC,IAAI,EAAEkB,OAAO,YAAYC,8BAAc,CAAC,EACtC,MAAM,IAAIC,wBAAW,CAAC;QACpBJ,OAAO,EAAE;MACX,CAAC,CAAC;IACN;IACA;IACA1B,YAAY,CAAC+B,aAAa,CAAC,IAAI,CAACxB,EAAE,CAAC,GAAG,IAAI;IAE1C,IAAAyB,kBAAU,EAAC;MAAEN,OAAO,EAAE,qBAAqB,IAAI,CAACnB,EAAE;IAAI,CAAC,CAAC;IACxD;IACA,IAAI,CAACE,EAAE,CAACwB,EAAE,CAAC,OAAO,EAAE,MAAM;MACxB,IAAI,CAACC,WAAW,CACbC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CACZC,KAAK,CAAEC,KAAK,IAAK;QAChB,IAAAC,mBAAW,EAACD,KAAK,CAAC;MACpB,CAAC,CAAC;IACN,CAAC,CAAC;IACF;IACA,IAAI,CAAC5B,EAAE,CAACwB,EAAE,CAAC,OAAO,EAAGI,KAAK,IAAK;MAC7B,IAAAC,mBAAW,EACT,IAAIR,wBAAW,CAAC;QACdS,QAAQ,EAAEC,kBAAW,CAACC,OAAO;QAC7Bf,OAAO,EAAE,UAAU,IAAI,CAACnB,EAAE;MAC5B,CAAC,CACH,CAAC;MACD,IAAA+B,mBAAW,EAACD,KAAK,CAAC;IACpB,CAAC,CAAC;IACF;IACA,IAAI,CAAC5B,EAAE,CAACwB,EAAE,CAAC,SAAS,EAAGS,IAAI,IAAK;MAC9B,IAAI,CAACC,aAAa,CACfR,IAAI,CAAC,IAAI,CAAC,CAACO,IAAI,CAAC,CAChBN,KAAK,CAAEC,KAAK,IAAK;QAChB,IAAAC,mBAAW,EAACD,KAAK,CAAC;MACpB,CAAC,CAAC;IACN,CAAC,CAAC;;IAEF;IACA;IACA,CAAC,YAA2B;MAC1B,MAAMO,eAAe,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC9C,IAAI,CAACnC,aAAa,CAACoC,GAAG,CAAEC,QAAQ,IAAKA,QAAQ,CAAC,IAAI,CAAC,CACrD,CAAC;MACDJ,eAAe,CAACK,OAAO,CAAEC,MAAM,IAAK;QAClC,IAAIA,MAAM,CAACC,MAAM,KAAK,UAAU,EAAE,IAAAb,mBAAW,EAACY,MAAM,CAACE,MAAM,CAAC;MAC9D,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,CAAChB,KAAK,CAAEC,KAAK,IAAK;MACpB,IAAAC,mBAAW,EAACD,KAAK,CAAC;IACpB,CAAC,CAAC;;IAEF;IACA;IACA,IAAI,CAACf,YAAY,GAAG+B,WAAW,CAC7B,MAAM;MACJ,IAAI,CAAC,IAAI,CAAChC,OAAO,EAAE;QACjB,IAAAiB,mBAAW,EACT,IAAIR,wBAAW,CAAC;UACdS,QAAQ,EAAEC,kBAAW,CAACC,OAAO;UAC7Bf,OAAO,EAAE,gDAAgD,IAAI,CAACnB,EAAE;QAClE,CAAC,CACH,CAAC;QACD,IAAI,CAACE,EAAE,CAAC6C,SAAS,CAAC,CAAC;QACnB;MACF;MACA,IAAI,CAACjC,OAAO,GAAG,KAAK;MACpB,IAAI,CAACZ,EAAE,CAAC8C,IAAI,CAAC,CAAC;MACd,IAAA9B,mBAAW,EAAC;QAAE1B,SAAS;QAAE2B,OAAO,EAAE,wBAAwB,IAAI,CAACnB,EAAE;MAAI,CAAC,CAAC;IACzE,CAAC,EACDiD,OAAO,CAACC,GAAG,CAACC,gBAAgB,GACxBC,QAAQ,CAACH,OAAO,CAACC,GAAG,CAACC,gBAAgB,CAAC,GAAG,IAAI,GAC7C,KACN,CAAC;;IAED;IACA,IAAI,CAACjD,EAAE,CAACwB,EAAE,CAAC,MAAM,EAAE,MAAM;MACvB,IAAAR,mBAAW,EAAC;QACV1B,SAAS;QACT2B,OAAO,EAAE,6BAA6B,IAAI,CAACnB,EAAE;MAC/C,CAAC,CAAC;MACF,IAAI,CAACc,OAAO,GAAG,IAAI;IACrB,CAAC,CAAC;EACJ;;EAEA;EAAA,WAAAuC,aAAA,CAAAtD,OAAA,EAAAN,YAAA;IAAA6D,GAAA;IAAAC,KAAA;IAUA;AACF;AACA;IACE,SAAOC,WAAWA,CAChBC,IAAY,EACZC,OAAgB,GAAG,CAAC,CAAC,EACrB7D,OAAuC,GAAG,CAAC,CAAC,EACtC;MACN,IAAAqB,mBAAW,EAAC;QACV1B,SAAS;QACT2B,OAAO,EAAE,uDAAuDsC,IAAI,MAAM,IAAI,CAACzD,EAAE,GAAG;QACpFmC,IAAI,EAAE;UAAEtC;QAAQ;MAClB,CAAC,CAAC;MACF,IAAI8D,IAAI,GAAG,KAAK;MAChB;MACA,IAAI9D,OAAO,CAAC+D,MAAM,EAAED,IAAI,GAAG,IAAI;MAC/B;MAAA,KACK,IACH,IAAI,CAACpD,aAAa,IACjB,IAAI,CAACM,QAAQ,CAAmBgD,QAAQ,CACvChE,OAAO,CAACgB,QAAQ,IAAKoC,OAAO,CAACC,GAAG,CAACY,wBACnC,CAAC,EAEDH,IAAI,GAAG,IAAI;MAEb,IAAIA,IAAI,EAAE;QACR,IAAAzC,mBAAW,EAAC;UACV1B,SAAS;UACT2B,OAAO,EAAE,sCAAsCsC,IAAI,IAAI,SAAS,MAAM,IAAI,CAACzD,EAAE;QAC/E,CAAC,CAAC;QACF,IAAI,CAACE,EAAE,CAACyD,IAAI,CAACI,IAAI,CAACC,SAAS,CAAC;UAAEP,IAAI;UAAEC;QAAQ,CAAC,CAAC,CAAC;MACjD;IACF;;IAEA;EAAA;IAAAJ,GAAA;IAAAC,KAAA,EACA,SAAOU,eAAeA,CAAA,EAAY;MAChC,OAAO,IAAI,CAAC1D,aAAa;IAC3B;;IAEA;EAAA;IAAA+C,GAAA;IAAAC,KAAA,EACA,SAAOW,OAAOA,CAAA,EAA2B;MACvC,IAAI,IAAI,CAAC3D,aAAa,EACpB,OAAO;QACLG,MAAM,EAAE,IAAI,CAACA,MAAgB;QAC7BC,QAAQ,EAAE,IAAI,CAACA,QAAkB;QACjCC,OAAO,EAAE,IAAI,CAACA,OAAiB;QAC/BC,QAAQ,EAAE,IAAI,CAACA;MACjB,CAAC;IACL;;IAEA;EAAA;IAAAyC,GAAA;IAAAC,KAAA,EACA,eAAcnB,aAAaA,CAACD,IAAa,EAAiB;MACxD,IAAI;QACF,MAAMhB,OAAO,GAAG,IAAAgD,0BAAY,EAAChC,IAAI,CAACiC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpD,IAAA3C,kBAAU,EAAC;UACTN,OAAO,EAAE,6BAA6BA,OAAO,EAAEsC,IAAI,IAAI,SAAS,MAAM,IAAI,CAACzD,EAAE;QAC/E,CAAC,CAAC;QACF,QAAQmB,OAAO,CAACsC,IAAI;UAClB,KAAK,cAAc;YACjB,MAAM,IAAI,CAACY,YAAY,CAAClD,OAAsC,CAAC;YAC/D;UACF;UACA;UACA,KAAK,MAAM;YACT,IAAAD,mBAAW,EAAC;cACV1B,SAAS;cACT2B,OAAO,EAAE,8BAA8B,IAAI,CAACnB,EAAE;YAChD,CAAC,CAAC;YACF,IAAI,CAACwD,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE;cAAEI,MAAM,EAAE;YAAK,CAAC,CAAC;YAC9C;UACF;YACE,KAAK,MAAMvC,OAAO,IAAI,IAAI,CAAClB,QAAQ,EAAE;cACnC,MAAMkB,OAAO,CAACiD,MAAM,CAACnD,OAAO,EAAE,IAAI,CAAC;YACrC;QACJ;MACF,CAAC,CAAC,OAAOW,KAAK,EAAE;QACd,IAAI,CAACyC,WAAW,CAACzC,KAAK,CAAC;MACzB;IACF;;IAEA;AACF;AACA;AACA;EAHE;IAAAwB,GAAA;IAAAC,KAAA,EAIA,eAAcc,YAAYA,CACxBlD,OAAoC,EACrB;MACf,MAAMqD,KAAK,GAAGrD,OAAO,CAACuC,OAAO,EAAEc,KAAK;MACpC,IAAI,CAACA,KAAK,EAAE;QACV,MAAM,IAAIC,kBAAQ,CAAC;UACjBC,SAAS,EAAE,UAAU;UACrBvD,OAAO,EAAE,oBAAoB;UAC7BgB,IAAI,EAAE;YAAEhB;UAAQ;QAClB,CAAC,CAAC;MACJ;MACA,MAAMuC,OAAO,GAAG,MAAM,IAAAiB,cAAS,EAACH,KAAK,CAAC;MACtC,IAAI,CAACI,WAAW,CAAClB,OAAO,CAAC;MAEzB,IAAI,CAACnD,aAAa,GAAG,IAAI;MACzB;MACA,MAAMsE,cAAc,GAAGnB,OAAO,CAACoB,GAAG,GAAG,IAAI,GAAG7D,IAAI,CAAC8D,GAAG,CAAC,CAAC;MACtD;MACA,IAAI,CAACC,aAAa,CAAC,CAAC;MACpB;MACA,IAAI,CAACxE,cAAc,GAAGyE,UAAU,CAC9B,MAAM;QACJ,IAAI,CAACzB,WAAW,CAAC,qBAAqB,CAAC;MACzC,CAAC,EACDqB,cAAc,GAAG,EAAE,GAAG,IACxB,CAAC;MACD;MACA,IAAI,CAACpE,eAAe,GAAGwE,UAAU,CAAC,MAAM;QACtC,IAAI,CAAC1E,aAAa,GAAG,KAAK;MAC5B,CAAC,EAAEsE,cAAc,CAAC;;MAElB;MACA,MAAMxC,eAAe,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC9C,IAAI,CAAClC,aAAa,CAACmC,GAAG,CAAEC,QAAQ,IAAKA,QAAQ,CAAC,IAAI,CAAC,CACrD,CAAC;MACDJ,eAAe,CAACK,OAAO,CAAEC,MAAM,IAAK;QAClC,IAAIA,MAAM,CAACC,MAAM,KAAK,UAAU,EAAE,IAAAb,mBAAW,EAACY,MAAM,CAACE,MAAM,CAAC;MAC9D,CAAC,CAAC;IACJ;;IAEA;IACA;EAAA;IAAAS,GAAA;IAAAC,KAAA,EACA,SAAQyB,aAAaA,CAAA,EAAS;MAC5B,IAAI,IAAI,CAACxE,cAAc,EAAE0E,YAAY,CAAC,IAAI,CAAC1E,cAAc,CAAC;MAC1D,IAAI,IAAI,CAACC,eAAe,EAAEyE,YAAY,CAAC,IAAI,CAACzE,eAAe,CAAC;IAC9D;;IAEA;AACF;AACA;EAFE;IAAA6C,GAAA;IAAAC,KAAA,EAGA,SAAQqB,WAAWA,CAAC;MAAEO,GAAG;MAAEC,GAAG;MAAEC,GAAG;MAAEC;IAAsB,CAAC,EAAQ;MAClE;MACA,IAAI,IAAI,CAAC5E,MAAM,EAAE;QACf;QACA,IAAI,IAAI,CAACA,MAAM,IAAI,IAAI,CAACA,MAAM,KAAKyE,GAAG,EACpC,MAAM,IAAIV,kBAAQ,CAAC;UACjBC,SAAS,EAAE,kBAAkB;UAC7BvD,OAAO,EACL;QACJ,CAAC,CAAC;MACN,CAAC,MAAM;QACL;QACA,IAAI,CAACT,MAAM,GAAGyE,GAAG;QACjB;QACA,IAAI,CAACxE,QAAQ,GAAGyE,GAAG;QACnB;QACA,IAAI,CAACxE,OAAO,GAAGyE,GAAG;QAClB;QACA,IAAI,CAACxE,QAAQ,GAAGyE,GAAG,YAAYlE,KAAK,GAAGkE,GAAG,GAAG,CAACA,GAAG,CAAC;QAElD,IAAApE,mBAAW,EAAC;UACV1B,SAAS;UACT2B,OAAO,EAAE,sCAAsC,IAAI,CAACnB,EAAE,GAAG;UACzDmC,IAAI,EAAE;YACJzB,MAAM,EAAE,IAAI,CAACA,MAAM;YACnBC,QAAQ,EAAE,IAAI,CAACA,QAAQ;YACvBC,OAAO,EAAE,IAAI,CAACA,OAAO;YACrBC,QAAQ,EAAE,IAAI,CAACA;UACjB;QACF,CAAC,CAAC;MACJ;IACF;;IAEA;AACF;AACA;EAFE;IAAAyC,GAAA;IAAAC,KAAA,EAGA,SAAQgB,WAAWA,CAACzC,KAAc,EAAQ;MACxC,IAAAC,mBAAW,EAACD,KAAK,CAAC;MAClB,IAAIA,KAAK,YAAY2C,kBAAQ,EAAE;QAC7B,IAAI,CAACjB,WAAW,CACd,OAAO,EACP;UAAEkB,SAAS,EAAE5C,KAAK,CAAC4C,SAAS;UAAEa,IAAI,EAAEzD,KAAK,CAACyD;QAAK,CAAC,EAChD;UAAE3B,MAAM,EAAE;QAAK,CACjB,CAAC;MACH,CAAC,MAAM,IAAI9B,KAAK,YAAY0D,gCAAe,EAAE;QAC3C,IAAI,CAAChC,WAAW,CACd,OAAO,EACP;UAAEkB,SAAS,EAAE,kBAAkB;UAAEa,IAAI,EAAEzD,KAAK,CAACK;QAAK,CAAC,EACnD;UAAEyB,MAAM,EAAE;QAAK,CACjB,CAAC;MACH,CAAC,MAAM;QACL,IAAI,CAACJ,WAAW,CACd,OAAO,EACP;UAAEkB,SAAS,EAAE;QAAe,CAAC,EAC7B;UAAEd,MAAM,EAAE;QAAK,CACjB,CAAC;MACH;IACF;;IAEA;AACF;AACA;EAFE;IAAAN,GAAA;IAAAC,KAAA,EAGA,eAAc5B,WAAWA,CAAC8D,IAAa,EAAE5C,MAAe,EAAiB;MACvE,OAAOpD,YAAY,CAAC+B,aAAa,CAAC,IAAI,CAACxB,EAAE,CAAC;MAC1C,IAAI,CAACgF,aAAa,CAAC,CAAC;MACpB;MACA,IAAI,IAAI,CAACjE,YAAY,EAAE2E,aAAa,CAAC,IAAI,CAAC3E,YAAY,CAAC;MACvD;MACA,MAAMsB,eAAe,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC9C,IAAI,CAACjC,iBAAiB,CAACkC,GAAG,CAAEC,QAAQ,IAAKA,QAAQ,CAAC,IAAI,CAAC,CACzD,CAAC;MACDJ,eAAe,CAACK,OAAO,CAAEC,MAAM,IAAK;QAClC,IAAIA,MAAM,CAACC,MAAM,KAAK,UAAU,EAAE,IAAAb,mBAAW,EAACY,MAAM,CAACE,MAAM,CAAC;MAC9D,CAAC,CAAC;MACF,IAAApB,kBAAU,EAAC;QACTN,OAAO,EAAE,wBAAwB,IAAI,CAACnB,EAAE,GAAG;QAC3CmC,IAAI,EAAE;UAAEsD,IAAI;UAAE5C;QAAO;MACvB,CAAC,CAAC;IACJ;EAAC;IAAAS,GAAA;IAAAC,KAAA,EA7ND,SAAcoC,gBAAgBA,CAAA,EAAqB;MACjD,OAAO,IAAI,CAACnE,aAAa;IAC3B;;IAEA;EAAA;IAAA8B,GAAA;IAAAC,KAAA,EACA,SAAcqC,eAAeA,CAAC5F,EAAU,EAA4B;MAClE,OAAO,IAAI,CAACwB,aAAa,CAACxB,EAAE,CAAC;IAC/B;EAAC;AAAA;AA/JD;AADWP,YAAY,CAER+B,aAAa,GAAqB,CAAC,CAAC","ignoreList":[]}

package/dist/entities/SocketClient/SocketClient.types.d.ts

@@ -0,0 +1,53 @@
+import { SocketClient } from './SocketClient';
+import { MessageHandler } from '../../entities/MessageHandler';
+export type SocketClientCallback = (client: SocketClient) => void | Promise<void>;
+/** SocketClient creation option */
+export interface SocketClientOptions {
+    /** List of message handlers that are registered with the client */
+    handlers: Array<MessageHandler>;
+    /** Callback function that are called when the client is created */
+    initCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
+    /** Callback function that are called when the client successfully authenticates */
+    authCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
+    /** Callback function that are called when the client connection is terminated */
+    shutdownCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
+}
+/** Socket Message abstract typing */
+export interface SocketMessage<T = unknown> {
+    /** A string that identifies the message type */
+    type: string;
+    /** Free-form data payload of the message */
+    payload: T;
+}
+/** SocketMessage used by client for authentication */
+export interface SocketAuthenticationMessage extends SocketMessage {
+    /** Sting that identifies the message type */
+    type: 'authenticate';
+    /** Data payload of the message */
+    payload: {
+        /** Authentication token */
+        token: string;
+    };
+}
+/** Options for sending a message with the client */
+export interface SocketClientSendMessageOptions {
+    /** Send message event if the user is not authenticated */
+    noAuth?: boolean;
+    /** Audience that the authenticated user must have on his token to continue */
+    audience?: string;
+}
+/** Map of socket clients connected to the server */
+export interface SocketClientList {
+    [id: string]: SocketClient;
+}
+/** User that authenticated though his socket */
+export interface SocketUser {
+    /** ID od the user */
+    userId: string;
+    /** ID of the device */
+    deviceId: string;
+    /** ID of the token used */
+    tokenId: string;
+    /** Audience included in the token */
+    audience: Array<string>;
+}

package/dist/entities/SocketClient/SocketClient.types.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=SocketClient.types.js.map

package/dist/entities/SocketClient/SocketClient.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketClient.types.js","names":[],"sources":["../../../src/entities/SocketClient/SocketClient.types.ts"],"sourcesContent":["import { SocketClient } from './SocketClient';\nimport { MessageHandler } from 'entities/MessageHandler';\n\nexport type SocketClientCallback = (\n  client: SocketClient\n) => void | Promise<void>;\n\n/** SocketClient creation option */\nexport interface SocketClientOptions {\n  /** List of message handlers that are registered with the client */\n  handlers: Array<MessageHandler>;\n  /** Callback function that are called when the client is created */\n  initCallbacks?: SocketClientCallback | Array<SocketClientCallback>;\n  /** Callback function that are called when the client successfully authenticates */\n  authCallbacks?: SocketClientCallback | Array<SocketClientCallback>;\n  /** Callback function that are called when the client connection is terminated */\n  shutdownCallbacks?: SocketClientCallback | Array<SocketClientCallback>;\n}\n\n/** Socket Message abstract typing */\nexport interface SocketMessage<T = unknown> {\n  /** A string that identifies the message type */\n  type: string;\n  /** Free-form data payload of the message */\n  payload: T;\n}\n\n/** SocketMessage used by client for authentication */\nexport interface SocketAuthenticationMessage extends SocketMessage {\n  /** Sting that identifies the message type */\n  type: 'authenticate';\n  /** Data payload of the message */\n  payload: {\n    /** Authentication token */\n    token: string;\n  };\n}\n\n/** Options for sending a message with the client */\nexport interface SocketClientSendMessageOptions {\n  /** Send message event if the user is not authenticated */\n  noAuth?: boolean;\n  /** Audience that the authenticated user must have on his token to continue */\n  audience?: string;\n}\n\n/** Map of socket clients connected to the server */\nexport interface SocketClientList {\n  [id: string]: SocketClient;\n}\n\n/** User that authenticated though his socket */\nexport interface SocketUser {\n  /** ID od the user */\n  userId: string;\n  /** ID of the device */\n  deviceId: string;\n  /** ID of the token used */\n  tokenId: string;\n  /** Audience included in the token */\n  audience: Array<string>;\n}\n"],"mappings":"","ignoreList":[]}

package/dist/entities/SocketClient/index.d.ts

@@ -0,0 +1,2 @@
+export * from './SocketClient';
+export * from './SocketClient.types';

package/dist/entities/SocketClient/index.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _SocketClient = require("./SocketClient");
+Object.keys(_SocketClient).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _SocketClient[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _SocketClient[key];
+    }
+  });
+});
+var _SocketClient2 = require("./SocketClient.types");
+Object.keys(_SocketClient2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _SocketClient2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _SocketClient2[key];
+    }
+  });
+});
+//# sourceMappingURL=index.js.map

package/dist/entities/SocketClient/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_SocketClient","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_SocketClient2"],"sources":["../../../src/entities/SocketClient/index.ts"],"sourcesContent":["export * from './SocketClient';\nexport * from './SocketClient.types';\n"],"mappings":";;;;;AAAA,IAAAA,aAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,aAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,aAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,aAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,cAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,cAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,cAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,cAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/entities/SocketClient/parseMessage/index.d.ts

@@ -0,0 +1 @@
+export * from './parseMessage';

package/dist/entities/SocketClient/parseMessage/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _parseMessage = require("./parseMessage");
+Object.keys(_parseMessage).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _parseMessage[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _parseMessage[key];
+    }
+  });
+});
+//# sourceMappingURL=index.js.map

package/dist/entities/SocketClient/parseMessage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_parseMessage","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sources":["../../../../src/entities/SocketClient/parseMessage/index.ts"],"sourcesContent":["export * from './parseMessage';\n"],"mappings":";;;;;AAAA,IAAAA,aAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,aAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,aAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,aAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/entities/SocketClient/parseMessage/parseMessage.d.ts

@@ -0,0 +1,5 @@
+import { SocketMessage } from '../SocketClient.types';
+/**
+ * Parse an incoming message into a JSON object
+ */
+export declare function parseMessage(data: string): SocketMessage;

package/dist/entities/SocketClient/parseMessage/parseMessage.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseMessage = parseMessage;
+var _WebError = require("../../WebError");
+/**
+ * Parse an incoming message into a JSON object
+ */
+function parseMessage(data) {
+  try {
+    const message = JSON.parse(data);
+    if (message.constructor.name !== 'Object') throw new _WebError.WebError({
+      statusCode: 400,
+      errorCode: 'non-json',
+      message: 'Received message is not an object',
+      data: {
+        data
+      }
+    });
+    return message;
+  } catch {
+    throw new _WebError.WebError({
+      statusCode: 400,
+      errorCode: 'non-json',
+      message: 'Received message is not valid JSON',
+      data: {
+        data
+      }
+    });
+  }
+}
+//# sourceMappingURL=parseMessage.js.map

package/dist/entities/SocketClient/parseMessage/parseMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseMessage.js","names":["_WebError","require","parseMessage","data","message","JSON","parse","constructor","name","WebError","statusCode","errorCode"],"sources":["../../../../src/entities/SocketClient/parseMessage/parseMessage.ts"],"sourcesContent":["import { SocketMessage } from '../SocketClient.types';\nimport { WebError } from 'entities/WebError';\n\n/**\n * Parse an incoming message into a JSON object\n */\nexport function parseMessage(data: string): SocketMessage {\n  try {\n    const message = JSON.parse(data) as SocketMessage;\n    if (message.constructor.name !== 'Object')\n      throw new WebError({\n        statusCode: 400,\n        errorCode: 'non-json',\n        message: 'Received message is not an object',\n        data: { data }\n      });\n    return message;\n  } catch {\n    throw new WebError({\n      statusCode: 400,\n      errorCode: 'non-json',\n      message: 'Received message is not valid JSON',\n      data: { data }\n    });\n  }\n}\n"],"mappings":";;;;;;AACA,IAAAA,SAAA,GAAAC,OAAA;AAEA;AACA;AACA;AACO,SAASC,YAAYA,CAACC,IAAY,EAAiB;EACxD,IAAI;IACF,MAAMC,OAAO,GAAGC,IAAI,CAACC,KAAK,CAACH,IAAI,CAAkB;IACjD,IAAIC,OAAO,CAACG,WAAW,CAACC,IAAI,KAAK,QAAQ,EACvC,MAAM,IAAIC,kBAAQ,CAAC;MACjBC,UAAU,EAAE,GAAG;MACfC,SAAS,EAAE,UAAU;MACrBP,OAAO,EAAE,mCAAmC;MAC5CD,IAAI,EAAE;QAAEA;MAAK;IACf,CAAC,CAAC;IACJ,OAAOC,OAAO;EAChB,CAAC,CAAC,MAAM;IACN,MAAM,IAAIK,kBAAQ,CAAC;MACjBC,UAAU,EAAE,GAAG;MACfC,SAAS,EAAE,UAAU;MACrBP,OAAO,EAAE,oCAAoC;MAC7CD,IAAI,EAAE;QAAEA;MAAK;IACf,CAAC,CAAC;EACJ;AACF","ignoreList":[]}