npm - node-server-engine - Versions diffs - 2.0.2 → 2.1.0 - Mend

node-server-engine 2.0.2 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/README.md +25 -21
package/dist/entities/Sequelize/Sequelize.config.js +11 -7
package/dist/entities/Sequelize/Sequelize.config.js.map +1 -1
package/dist/entities/SocketClient/SocketClient.d.ts +12 -0
package/dist/entities/SocketClient/SocketClient.js +34 -3
package/dist/entities/SocketClient/SocketClient.js.map +1 -1
package/dist/entities/SocketClient/SocketClient.types.d.ts +6 -0
package/dist/entities/SocketClient/SocketClient.types.js.map +1 -1
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -528,22 +528,24 @@ const server = new Server({
 });
 ```
-| Parameter         | Type                                       | Description                                               | Default      |
-| ----------------- | ------------------------------------------ | --------------------------------------------------------- | ------------ |
-| handlers          | Array\<[MessageHandler](#message-handler)> | A list of message handlers to use                         | **required** |
-| authCallbacks     | Function \| Array\<Function>               | Callbacks called when a client successfully authenticates | []           |
-| initCallbacks     | Function \| Array\<Function>               | Callbacks called when the socket client is created        | []           |
-| shutdownCallbacks | Function \| Array\<Function>               | Callbacks called when the socket client is destroyed      | []           |
+| Parameter         | Type                                       | Description                                                                       | Default      |
+| ----------------- | ------------------------------------------ | --------------------------------------------------------------------------------- | ------------ |
+| handlers          | Array\<[MessageHandler](#message-handler)> | A list of message handlers to use                                                 | **required** |
+| authCallbacks     | Function \| Array\<Function>               | Callbacks called when a client successfully authenticates                         | []           |
+| initCallbacks     | Function \| Array\<Function>               | Callbacks called when the socket client is created                                | []           |
+| shutdownCallbacks | Function \| Array\<Function>               | Callbacks called when the socket client is destroyed                              | []           |
+| authTimeoutMs     | Number                                     | Close the socket with code 4401 if it has not authenticated within this time (ms) | never        |
 #### Client Properties & Methods
-| Property/Method   | Type                          | Description                                                       |
-| ----------------- | ----------------------------- | ----------------------------------------------------------------- |
-| id                | String                        | Unique identifier for the connection                              |
-| establishedAt     | Date                          | Timestamp when connection was established                         |
-| isAuthenticated() | () => Boolean                 | Check if client is authenticated                                  |
-| getUser()         | () => SocketUser \| undefined | Get authenticated user data (userId, deviceId, tokenId, audience) |
-| sendMessage()     | (type, payload, options)      | Send a message to the client                                      |
+| Property/Method   | Type                          | Description                                                                                              |
+| ----------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------- |
+| id                | String                        | Unique identifier for the connection                                                                     |
+| establishedAt     | Date                          | Timestamp when connection was established                                                                |
+| isAuthenticated() | () => Boolean                 | Check if client is authenticated                                                                         |
+| getUser()         | () => SocketUser \| undefined | Get authenticated user data (userId, deviceId, tokenId, audience, the token's `user` claim, `expiresAt`) |
+| sendMessage()     | (type, payload, options)      | Send a message to the client                                                                             |
+| close()           | (code?, reason?)              | Close the connection, e.g. `close(4403, 'Not allowed')` from an `authCallbacks` check                    |
 #### Client Authentication
@@ -1055,14 +1057,16 @@ Sequelize.closeSequelize();
 It can be configured through environment variables
-| env          | description                                       | default  |
-| ------------ | ------------------------------------------------- | -------- |
-| SQL_HOST     | Host to which connect to                          |          |
-| SQL_PORT     | Port on which SQL is served                       | 5432     |
-| SQL_PASSWORD | Password used to authenticate with the SQL server |          |
-| SQL_USER     | User used to authenticate with the SQL server     |          |
-| SQL_DB       | Database to which connect to                      |          |
-| SQL_TYPE     | SQL type which connect to                         | postgres |
+| env                   | description                                                                                | default  |
+| --------------------- | ------------------------------------------------------------------------------------------ | -------- |
+| SQL_HOST              | Host to which connect to                                                                   |          |
+| SQL_PORT              | Port on which SQL is served                                                                | 5432     |
+| SQL_PASSWORD          | Password used to authenticate with the SQL server                                          |          |
+| SQL_USER              | User used to authenticate with the SQL server                                              |          |
+| SQL_DB                | Database to which connect to                                                               |          |
+| SQL_TYPE              | SQL type which connect to                                                                  | postgres |
+| SQL_ENCRYPT           | `mssql` only: set to `false` to disable TLS                                                | true     |
+| SQL_TRUST_SERVER_CERT | `mssql` only: `true` skips certificate verification (self-signed development servers only) | false    |
 ---

package/dist/entities/Sequelize/Sequelize.config.js CHANGED Viewed

@@ -45,14 +45,18 @@ const config = {
 // Additional configurations for MSSQL
 if (config.dialect === 'mssql') {
+  // tedious connection options live under dialectOptions.options
   config.dialectOptions = {
-    requestTimeout: 30000,
-    // Increase request timeout for MSSQL
-    connectTimeout: 30000,
-    // Increase connection timeout for MSSQL
-    encrypt: true,
-    // Use encryption for MSSQL (set to false if not needed)
-    trustServerCertificate: true // Set to true if using self-signed certificates
+    options: {
+      requestTimeout: 30000,
+      // Increase request timeout for MSSQL
+      connectTimeout: 30000,
+      // Increase connection timeout for MSSQL
+      // Encrypted connections by default; SQL_ENCRYPT=false only for servers without TLS
+      encrypt: process.env.SQL_ENCRYPT !== 'false',
+      // The server certificate is verified unless SQL_TRUST_SERVER_CERT=true (self-signed development servers)
+      trustServerCertificate: process.env.SQL_TRUST_SERVER_CERT === 'true'
+    }
   };
 }

package/dist/entities/Sequelize/Sequelize.config.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"Sequelize.config.js","names":["_Sequelize","require","validateSequelizeEnvironment","isUnixSocket","process","env","SQL_HOST","startsWith","config","username","SQL_USER","password","SQL_PASSWORD","database","SQL_DB","host","port","undefined","SQL_PORT","parseInt","dialect","SQL_TYPE","logging","SQL_LOGGING","console","log","define","freezeTableName","charset","collate","retry","max","NODE_ENV","dialectOptions","pool","min","acquire","idle","evict","requestTimeout","connectTimeout","encrypt","trustServerCertificate","timezone","ssl","PG_SSL","rejectUnauthorized","development","exports","staging","production","test","_default","default"],"sources":["../../../src/entities/Sequelize/Sequelize.config.ts"],"sourcesContent":["import { Options, Dialect } from 'sequelize';\nimport { validateSequelizeEnvironment } from './Sequelize.validate';\n\n// Check that environment variables are correctly set\nvalidateSequelizeEnvironment();\n\n// Check if SQL_HOST is a Unix socket path (Cloud SQL)\nconst isUnixSocket = process.env.SQL_HOST?.startsWith('/');\n\nconst config: Options = {\n username: process.env.SQL_USER,\n password: process.env.SQL_PASSWORD,\n database: process.env.SQL_DB,\n host: process.env.SQL_HOST,\n // Don't set port for Unix socket connections (Cloud SQL)\n port: isUnixSocket\n ? undefined\n : process.env.SQL_PORT\n ? parseInt(process.env.SQL_PORT)\n : 5432,\n dialect: (process.env.SQL_TYPE ?? 'postgres') as Dialect, // Dynamically set the dialect (postgres, mysql, mssql)\n logging: process.env.SQL_LOGGING === 'true' ? console.log : false, // Enable SQL logging with SQL_LOGGING=true\n define: {\n freezeTableName: false, // Prevent automatic pluralization of table names\n charset: 'utf8mb4', // Set character set for MySQL/MariaDB\n collate: 'utf8mb4_unicode_ci' // Set collation for MySQL/MariaDB\n },\n retry: {\n max: process.env.NODE_ENV === 'test' ? 0 : 3 // Disable retries in test environment to prevent unhandled rejections\n },\n dialectOptions: {},\n pool: {\n max: process.env.NODE_ENV === 'test' ? 1 : 5,\n min: 0,\n acquire: process.env.NODE_ENV === 'test' ? 1000 : 30000, // Reduce acquire timeout in test\n idle: process.env.NODE_ENV === 'test' ? 1000 : 10000, // Reduce idle time in test\n evict: process.env.NODE_ENV === 'test' ? 100 : 1000 // How often to check for idle connections\n }\n};\n\n// Additional configurations for MSSQL\nif (config.dialect === 'mssql') {\n config.dialectOptions = {\n requestTimeout: 30000, // Increase request timeout for MSSQL\n connectTimeout: 30000, // Increase connection timeout for MSSQL\n ~~encrypt: true,~~ // ~~Use~~ ~~encryption~~ ~~for~~ ~~MSSQL~~ ~~(set~~ to ~~false~~ if ~~not~~ ~~needed)~~\n ~~trustServerCertificate~~: ~~true~~ // ~~Set~~ to ~~true~~ if ~~using~~ self-signed ~~certificates~~\n };\n}\n\n// Add specific dialect configurations if necessary for MySQL/PostgreSQL\nif (config.dialect === 'mysql') {\n config.dialectOptions = {\n timezone: 'Z' // Set timezone for MySQL\n };\n}\n\nif (config.dialect === 'postgres') {\n config.dialectOptions = {\n ssl: process.env.PG_SSL === 'true' ? { rejectUnauthorized: false } : false // SSL options for PostgreSQL (if required)\n };\n}\n\nexport const development = config;\nexport const staging = config;\nexport const production = config;\nexport const test = config;\nexport default config;\n"],"mappings":";;;;;;AACA,IAAAA,UAAA,GAAAC,OAAA;AAEA;AACA,IAAAC,uCAA4B,EAAC,CAAC;;AAE9B;AACA,MAAMC,YAAY,GAAGC,OAAO,CAACC,GAAG,CAACC,QAAQ,EAAEC,UAAU,CAAC,GAAG,CAAC;AAE1D,MAAMC,MAAe,GAAG;EACtBC,QAAQ,EAAEL,OAAO,CAACC,GAAG,CAACK,QAAQ;EAC9BC,QAAQ,EAAEP,OAAO,CAACC,GAAG,CAACO,YAAY;EAClCC,QAAQ,EAAET,OAAO,CAACC,GAAG,CAACS,MAAM;EAC5BC,IAAI,EAAEX,OAAO,CAACC,GAAG,CAACC,QAAQ;EAC1B;EACAU,IAAI,EAAEb,YAAY,GACdc,SAAS,GACTb,OAAO,CAACC,GAAG,CAACa,QAAQ,GAClBC,QAAQ,CAACf,OAAO,CAACC,GAAG,CAACa,QAAQ,CAAC,GAC9B,IAAI;EACVE,OAAO,EAAGhB,OAAO,CAACC,GAAG,CAACgB,QAAQ,IAAI,UAAsB;EAAE;EAC1DC,OAAO,EAAElB,OAAO,CAACC,GAAG,CAACkB,WAAW,KAAK,MAAM,GAAGC,OAAO,CAACC,GAAG,GAAG,KAAK;EAAE;EACnEC,MAAM,EAAE;IACNC,eAAe,EAAE,KAAK;IAAE;IACxBC,OAAO,EAAE,SAAS;IAAE;IACpBC,OAAO,EAAE,oBAAoB,CAAC;EAChC,CAAC;EACDC,KAAK,EAAE;IACLC,GAAG,EAAE3B,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;EAC/C,CAAC;EACDC,cAAc,EAAE,CAAC,CAAC;EAClBC,IAAI,EAAE;IACJH,GAAG,EAAE3B,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,CAAC,GAAG,CAAC;IAC5CG,GAAG,EAAE,CAAC;IACNC,OAAO,EAAEhC,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,IAAI,GAAG,KAAK;IAAE;IACzDK,IAAI,EAAEjC,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,IAAI,GAAG,KAAK;IAAE;IACtDM,KAAK,EAAElC,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC;EACtD;AACF,CAAC;;AAED;AACA,IAAIxB,MAAM,CAACY,OAAO,KAAK,OAAO,EAAE;~~EAC9BZ~~,MAAM,CAACyB,cAAc,GAAG;IACtBM,cAAc,EAAE,KAAK;~~IAAE~~;~~IACvBC~~,cAAc,EAAE,KAAK;~~IAAE~~;~~IACvBC~~,OAAO,~~EAAE~~,~~IAAI~~;~~IAAE~~;~~IACfC~~,sBAAsB,~~EAAE~~,~~IAAI~~,~~CAAC~~;~~EAC/B~~,CAAC;AACH;;AAEA;AACA,~~IAAIlC~~,MAAM,CAACY,OAAO,KAAK,OAAO,EAAE;EAC9BZ,MAAM,CAACyB,cAAc,GAAG;~~IACtBU~~,QAAQ,EAAE,GAAG,CAAC;EAChB,CAAC;AACH;AAEA,~~IAAInC~~,MAAM,CAACY,OAAO,KAAK,UAAU,EAAE;EACjCZ,MAAM,CAACyB,cAAc,GAAG;~~IACtBW~~,GAAG,~~EAAExC~~,OAAO,CAACC,GAAG,~~CAACwC~~,MAAM,KAAK,MAAM,GAAG;MAAEC,kBAAkB,EAAE;IAAM,CAAC,GAAG,KAAK,CAAC;EAC7E,CAAC;AACH;AAEO,MAAMC,WAAW,GAAAC,OAAA,CAAAD,WAAA,~~GAAGvC~~,MAAM;AAC1B,~~MAAMyC~~,OAAO,GAAAD,OAAA,CAAAC,OAAA,~~GAAGzC~~,MAAM;AACtB,~~MAAM0C~~,UAAU,GAAAF,OAAA,CAAAE,UAAA,~~GAAG1C~~,MAAM;AACzB,~~MAAM2C~~,IAAI,GAAAH,OAAA,CAAAG,IAAA,~~GAAG3C~~,MAAM;AAAC,~~IAAA4C~~,QAAA,GAAAJ,OAAA,CAAAK,OAAA,~~GACZ7C~~,MAAM","ignoreList":[]}
1	+ {"version":3,"file":"Sequelize.config.js","names":["_Sequelize","require","validateSequelizeEnvironment","isUnixSocket","process","env","SQL_HOST","startsWith","config","username","SQL_USER","password","SQL_PASSWORD","database","SQL_DB","host","port","undefined","SQL_PORT","parseInt","dialect","SQL_TYPE","logging","SQL_LOGGING","console","log","define","freezeTableName","charset","collate","retry","max","NODE_ENV","dialectOptions","pool","min","acquire","idle","evict","options","requestTimeout","connectTimeout","encrypt","SQL_ENCRYPT","trustServerCertificate","SQL_TRUST_SERVER_CERT","timezone","ssl","PG_SSL","rejectUnauthorized","development","exports","staging","production","test","_default","default"],"sources":["../../../src/entities/Sequelize/Sequelize.config.ts"],"sourcesContent":["import { Options, Dialect } from 'sequelize';\nimport { validateSequelizeEnvironment } from './Sequelize.validate';\n\n// Check that environment variables are correctly set\nvalidateSequelizeEnvironment();\n\n// Check if SQL_HOST is a Unix socket path (Cloud SQL)\nconst isUnixSocket = process.env.SQL_HOST?.startsWith('/');\n\nconst config: Options = {\n username: process.env.SQL_USER,\n password: process.env.SQL_PASSWORD,\n database: process.env.SQL_DB,\n host: process.env.SQL_HOST,\n // Don't set port for Unix socket connections (Cloud SQL)\n port: isUnixSocket\n ? undefined\n : process.env.SQL_PORT\n ? parseInt(process.env.SQL_PORT)\n : 5432,\n dialect: (process.env.SQL_TYPE ?? 'postgres') as Dialect, // Dynamically set the dialect (postgres, mysql, mssql)\n logging: process.env.SQL_LOGGING === 'true' ? console.log : false, // Enable SQL logging with SQL_LOGGING=true\n define: {\n freezeTableName: false, // Prevent automatic pluralization of table names\n charset: 'utf8mb4', // Set character set for MySQL/MariaDB\n collate: 'utf8mb4_unicode_ci' // Set collation for MySQL/MariaDB\n },\n retry: {\n max: process.env.NODE_ENV === 'test' ? 0 : 3 // Disable retries in test environment to prevent unhandled rejections\n },\n dialectOptions: {},\n pool: {\n max: process.env.NODE_ENV === 'test' ? 1 : 5,\n min: 0,\n acquire: process.env.NODE_ENV === 'test' ? 1000 : 30000, // Reduce acquire timeout in test\n idle: process.env.NODE_ENV === 'test' ? 1000 : 10000, // Reduce idle time in test\n evict: process.env.NODE_ENV === 'test' ? 100 : 1000 // How often to check for idle connections\n }\n};\n\n// Additional configurations for MSSQL\nif (config.dialect === 'mssql') {\n // tedious connection options live under dialectOptions.options\n config.dialectOptions = {\n options: {\n requestTimeout: 30000, // Increase request timeout for MSSQL\n connectTimeout: 30000, // Increase connection timeout for MSSQL\n // Encrypted connections by default; SQL_ENCRYPT=false only for servers without TLS\n encrypt: process.env.SQL_ENCRYPT !== 'false',\n // The server certificate is verified unless SQL_TRUST_SERVER_CERT=true (self-signed development servers)\n trustServerCertificate: process.env.SQL_TRUST_SERVER_CERT === 'true'\n }\n };\n}\n\n// Add specific dialect configurations if necessary for MySQL/PostgreSQL\nif (config.dialect === 'mysql') {\n config.dialectOptions = {\n timezone: 'Z' // Set timezone for MySQL\n };\n}\n\nif (config.dialect === 'postgres') {\n config.dialectOptions = {\n ssl: process.env.PG_SSL === 'true' ? { rejectUnauthorized: false } : false // SSL options for PostgreSQL (if required)\n };\n}\n\nexport const development = config;\nexport const staging = config;\nexport const production = config;\nexport const test = config;\nexport default config;\n"],"mappings":";;;;;;AACA,IAAAA,UAAA,GAAAC,OAAA;AAEA;AACA,IAAAC,uCAA4B,EAAC,CAAC;;AAE9B;AACA,MAAMC,YAAY,GAAGC,OAAO,CAACC,GAAG,CAACC,QAAQ,EAAEC,UAAU,CAAC,GAAG,CAAC;AAE1D,MAAMC,MAAe,GAAG;EACtBC,QAAQ,EAAEL,OAAO,CAACC,GAAG,CAACK,QAAQ;EAC9BC,QAAQ,EAAEP,OAAO,CAACC,GAAG,CAACO,YAAY;EAClCC,QAAQ,EAAET,OAAO,CAACC,GAAG,CAACS,MAAM;EAC5BC,IAAI,EAAEX,OAAO,CAACC,GAAG,CAACC,QAAQ;EAC1B;EACAU,IAAI,EAAEb,YAAY,GACdc,SAAS,GACTb,OAAO,CAACC,GAAG,CAACa,QAAQ,GAClBC,QAAQ,CAACf,OAAO,CAACC,GAAG,CAACa,QAAQ,CAAC,GAC9B,IAAI;EACVE,OAAO,EAAGhB,OAAO,CAACC,GAAG,CAACgB,QAAQ,IAAI,UAAsB;EAAE;EAC1DC,OAAO,EAAElB,OAAO,CAACC,GAAG,CAACkB,WAAW,KAAK,MAAM,GAAGC,OAAO,CAACC,GAAG,GAAG,KAAK;EAAE;EACnEC,MAAM,EAAE;IACNC,eAAe,EAAE,KAAK;IAAE;IACxBC,OAAO,EAAE,SAAS;IAAE;IACpBC,OAAO,EAAE,oBAAoB,CAAC;EAChC,CAAC;EACDC,KAAK,EAAE;IACLC,GAAG,EAAE3B,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;EAC/C,CAAC;EACDC,cAAc,EAAE,CAAC,CAAC;EAClBC,IAAI,EAAE;IACJH,GAAG,EAAE3B,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,CAAC,GAAG,CAAC;IAC5CG,GAAG,EAAE,CAAC;IACNC,OAAO,EAAEhC,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,IAAI,GAAG,KAAK;IAAE;IACzDK,IAAI,EAAEjC,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,IAAI,GAAG,KAAK;IAAE;IACtDM,KAAK,EAAElC,OAAO,CAACC,GAAG,CAAC2B,QAAQ,KAAK,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC;EACtD;AACF,CAAC;;AAED;AACA,IAAIxB,MAAM,CAACY,OAAO,KAAK,OAAO,EAAE;EAC9B;EACAZ,MAAM,CAACyB,cAAc,GAAG;IACtBM,OAAO,EAAE;MACPC,cAAc,EAAE,KAAK;MAAE;MACvBC,cAAc,EAAE,KAAK;MAAE;MACvB;MACAC,OAAO,EAAEtC,OAAO,CAACC,GAAG,CAACsC,WAAW,KAAK,OAAO;MAC5C;MACAC,sBAAsB,EAAExC,OAAO,CAACC,GAAG,CAACwC,qBAAqB,KAAK;IAChE;EACF,CAAC;AACH;;AAEA;AACA,IAAIrC,MAAM,CAACY,OAAO,KAAK,OAAO,EAAE;EAC9BZ,MAAM,CAACyB,cAAc,GAAG;IACtBa,QAAQ,EAAE,GAAG,CAAC;EAChB,CAAC;AACH;AAEA,IAAItC,MAAM,CAACY,OAAO,KAAK,UAAU,EAAE;EACjCZ,MAAM,CAACyB,cAAc,GAAG;IACtBc,GAAG,EAAE3C,OAAO,CAACC,GAAG,CAAC2C,MAAM,KAAK,MAAM,GAAG;MAAEC,kBAAkB,EAAE;IAAM,CAAC,GAAG,KAAK,CAAC;EAC7E,CAAC;AACH;AAEO,MAAMC,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG1C,MAAM;AAC1B,MAAM4C,OAAO,GAAAD,OAAA,CAAAC,OAAA,GAAG5C,MAAM;AACtB,MAAM6C,UAAU,GAAAF,OAAA,CAAAE,UAAA,GAAG7C,MAAM;AACzB,MAAM8C,IAAI,GAAAH,OAAA,CAAAG,IAAA,GAAG9C,MAAM;AAAC,IAAA+C,QAAA,GAAAJ,OAAA,CAAAK,OAAA,GACZhD,MAAM","ignoreList":[]}

package/dist/entities/SocketClient/SocketClient.d.ts CHANGED Viewed

@@ -37,6 +37,12 @@ export declare class SocketClient {
     private audience;
     /** Status tracking variable used to check the liveness of connections */
     private isAlive;
+    /** The `user` claim of the token the client authenticated with */
+    private tokenUser;
+    /** Timestamp (ms) at which the current authentication expires */
+    private authExpiresAt;
+    /** Closes the connection if the client does not authenticate in time */
+    private authTimeout;
     /** Timer used to track interval between client pinging */
     private pingInterval;
     /**
@@ -54,6 +60,12 @@ export declare class SocketClient {
      * Send a message to the client
      */
     sendMessage(type: string, payload?: unknown, options?: SocketClientSendMessageOptions): void;
+    /**
+     * Close the connection
+     * @param code - WebSocket close code (4000-4999 are free for applications, e.g. 4401 / 4403)
+     * @param reason - Human readable reason, sent to the client
+     */
+    close(code?: number, reason?: string): void;
     /** Get the client authentication status */
     isAuthenticated(): boolean;
     /** Fetch data on the user if he is authenticated */

package/dist/entities/SocketClient/SocketClient.js CHANGED Viewed

@@ -61,6 +61,12 @@ let SocketClient = exports.SocketClient = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "audience", void 0);
     /** Status tracking variable used to check the liveness of connections */
     (0, _defineProperty2.default)(this, "isAlive", true);
+    /** The `user` claim of the token the client authenticated with */
+    (0, _defineProperty2.default)(this, "tokenUser", void 0);
+    /** Timestamp (ms) at which the current authentication expires */
+    (0, _defineProperty2.default)(this, "authExpiresAt", void 0);
+    /** Closes the connection if the client does not authenticate in time */
+    (0, _defineProperty2.default)(this, "authTimeout", void 0);
     /** Timer used to track interval between client pinging */
     (0, _defineProperty2.default)(this, "pingInterval", void 0);
     this.id = (0, _crypto.randomUUID)();
@@ -91,9 +97,15 @@ let SocketClient = exports.SocketClient = /*#__PURE__*/function () {
     (0, _report.reportInfo)({
       message: `Client connected [${this.id}]`
     });
+    // Optionally close connections that do not authenticate in time
+    if (options.authTimeoutMs && options.authTimeoutMs > 0) {
+      this.authTimeout = setTimeout(() => {
+        if (!this.authenticated) this.close(4401, 'Authentication required');
+      }, options.authTimeoutMs);
+    }
     // On socket close, deregister from clients list
-    this.ws.on('close', () => {
-      this.handleClose.bind(this)().catch(error => {
+    this.ws.on('close', (code, reason) => {
+      this.handleClose.bind(this)(code, reason?.toString()).catch(error => {
         (0, _report.reportError)(error);
       });
     });
@@ -184,6 +196,19 @@ let SocketClient = exports.SocketClient = /*#__PURE__*/function () {
       }
     }
+    /**
+     * Close the connection
+     * @param code - WebSocket close code (4000-4999 are free for applications, e.g. 4401 / 4403)
+     * @param reason - Human readable reason, sent to the client
+     */
+  }, {
+    key: "close",
+    value: function close(code = 1000, reason) {
+      this.clearTimeouts();
+      if (this.authTimeout) clearTimeout(this.authTimeout);
+      this.ws.close(code, reason);
+    }
     /** Get the client authentication status */
   }, {
     key: "isAuthenticated",
@@ -199,7 +224,9 @@ let SocketClient = exports.SocketClient = /*#__PURE__*/function () {
         userId: this.userId,
         deviceId: this.deviceId,
         tokenId: this.tokenId,
-        audience: this.audience
+        audience: this.audience,
+        user: this.tokenUser,
+        expiresAt: this.authExpiresAt
       };
       return undefined;
     }
@@ -258,6 +285,9 @@ let SocketClient = exports.SocketClient = /*#__PURE__*/function () {
       const payload = await (0, _jwt.jwtVerify)(token);
       this.setUserData(payload);
       this.authenticated = true;
+      this.tokenUser = payload.user;
+      this.authExpiresAt = payload.exp * 1000;
+      if (this.authTimeout) clearTimeout(this.authTimeout);
       // Time remaining before token expiration
       const authExpiration = payload.exp * 1000 - Date.now();
       // Clear previously created timers
@@ -365,6 +395,7 @@ let SocketClient = exports.SocketClient = /*#__PURE__*/function () {
     value: async function handleClose(code, reason) {
       delete SocketClient.socketClients[this.id];
       this.clearTimeouts();
+      if (this.authTimeout) clearTimeout(this.authTimeout);
       // Stop ping process
       if (this.pingInterval) clearInterval(this.pingInterval);
       // Run all the shutdown callbacks

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

	@@ -1 +1 @@
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","_defineProperty2","id","randomUUID","ws","establishedAt","Date","reportDebug","message","initCallbacks","Array","authCallbacks","shutdownCallbacks","handlers","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","pingInterval","setInterval","isAlive","terminate","ping","process","env","WS_PING_INTERVAL","parseInt","_createClass2","key","value","sendMessage","type","payload","send","noAuth","authenticated","audience","includes","DEFAULT_MESSAGE_AUDIENCE","JSON","stringify","isAuthenticated","getUser","userId","deviceId","tokenId","undefined","parseMessage","toString","authenticate","handle","handleError","token","WebError","errorCode","jwtVerify","setUserData","authExpiration","exp","now","clearTimeouts","authRenewTimer","setTimeout","authExpireTimer","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 * @param webSocket - The WebSocket instance\n * @param _request - The incoming HTTP request (reserved for future use)\n * @param options - Socket client configuration options\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 return undefined;\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;AACA;AACA;AACA;EACE,SAAAA,aACEE,SAAa,EACbC,QAAyB,EACzBC,OAA4B,EAC5B;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAN,YAAA;IA3CF;IAAA,IAAAO,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA,yBACqD,EAAE;IACvD;IAAA,IAAAC,gBAAA,CAAAD,OAAA,yBACqD,EAAE;IACvD;IAAA,IAAAC,gBAAA,CAAAD,OAAA,6BACyD,EAAE;IAC3D;IAAA,IAAAC,gBAAA,CAAAD,OAAA,yBACwB,KAAK;IAC7B;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA,mBACkB,IAAI;IACtB;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAcE,IAAI,CAACE,EAAE,GAAG,IAAAC,kBAAU,EAAC,CAAC;IACtB,IAAI,CAACC,EAAE,GAAGR,SAAS;IACnB,IAAI,CAACS,aAAa,GAAG,IAAIC,IAAI,CAAC,CAAC;IAE/B,IAAAC,mBAAW,EAAC;MAAEd,SAAS;MAAEe,OAAO,EAAE,2BAA2B,IAAI,CAACN,EAAE;IAAI,CAAC,CAAC;;IAE1E;IACA;IACA,IAAI,OAAOJ,OAAO,CAACW,aAAa,KAAK,UAAU,EAC7C,IAAI,CAACA,aAAa,GAAG,CAACX,OAAO,CAACW,aAAa,CAAC,CAAC,KAC1C,IAAIX,OAAO,CAACW,aAAa,YAAYC,KAAK,EAC7C,IAAI,CAACD,aAAa,GAAGX,OAAO,CAACW,aAAa;IAC5C;IACA,IAAI,OAAOX,OAAO,CAACa,aAAa,KAAK,UAAU,EAC7C,IAAI,CAACA,aAAa,GAAG,CAACb,OAAO,CAACa,aAAa,CAAC,CAAC,KAC1C,IAAIb,OAAO,CAACa,aAAa,YAAYD,KAAK,EAC7C,IAAI,CAACC,aAAa,GAAGb,OAAO,CAACa,aAAa;IAC5C;IACA,IAAI,OAAOb,OAAO,CAACc,iBAAiB,KAAK,UAAU,EACjD,IAAI,CAACA,iBAAiB,GAAG,CAACd,OAAO,CAACc,iBAAiB,CAAC,CAAC,KAClD,IAAId,OAAO,CAACc,iBAAiB,YAAYF,KAAK,EACjD,IAAI,CAACE,iBAAiB,GAAGd,OAAO,CAACc,iBAAiB;;IAEpD;IACA,IAAI,CAACC,QAAQ,GAAGf,OAAO,CAACe,QAAQ;IAChC,KAAK,MAAMC,OAAO,IAAI,IAAI,CAACD,QAAQ,EAAE;MACnC,IAAI,EAAEC,OAAO,YAAYC,8BAAc,CAAC,EACtC,MAAM,IAAIC,wBAAW,CAAC;QACpBR,OAAO,EAAE;MACX,CAAC,CAAC;IACN;IACA;IACAd,YAAY,CAACuB,aAAa,CAAC,IAAI,CAACf,EAAE,CAAC,GAAG,IAAI;IAE1C,IAAAgB,kBAAU,EAAC;MAAEV,OAAO,EAAE,qBAAqB,IAAI,CAACN,EAAE;IAAI,CAAC,CAAC;IACxD;IACA,IAAI,CAACE,EAAE,CAACe,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,CAACnB,EAAE,CAACe,EAAE,CAAC,OAAO,EAAGI,KAAK,IAAK;MAC7B,IAAAC,mBAAW,EACT,IAAIR,wBAAW,CAAC;QACdS,QAAQ,EAAEC,kBAAW,CAACC,OAAO;QAC7BnB,OAAO,EAAE,UAAU,IAAI,CAACN,EAAE;MAC5B,CAAC,CACH,CAAC;MACD,IAAAsB,mBAAW,EAACD,KAAK,CAAC;IACpB,CAAC,CAAC;IACF;IACA,IAAI,CAACnB,EAAE,CAACe,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,CAACvB,aAAa,CAACwB,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,CAACgB,YAAY,GAAGC,WAAW,CAC7B,MAAM;MACJ,IAAI,CAAC,IAAI,CAACC,OAAO,EAAE;QACjB,IAAAjB,mBAAW,EACT,IAAIR,wBAAW,CAAC;UACdS,QAAQ,EAAEC,kBAAW,CAACC,OAAO;UAC7BnB,OAAO,EAAE,gDAAgD,IAAI,CAACN,EAAE;QAClE,CAAC,CACH,CAAC;QACD,IAAI,CAACE,EAAE,CAACsC,SAAS,CAAC,CAAC;QACnB;MACF;MACA,IAAI,CAACD,OAAO,GAAG,KAAK;MACpB,IAAI,CAACrC,EAAE,CAACuC,IAAI,CAAC,CAAC;MACd,IAAApC,mBAAW,EAAC;QAAEd,SAAS;QAAEe,OAAO,EAAE,wBAAwB,IAAI,CAACN,EAAE;MAAI,CAAC,CAAC;IACzE,CAAC,EACD0C,OAAO,CAACC,GAAG,CAACC,gBAAgB,GACxBC,QAAQ,CAACH,OAAO,CAACC,GAAG,CAACC,gBAAgB,CAAC,GAAG,IAAI,GAC7C,KACN,CAAC;;IAED;IACA,IAAI,CAAC1C,EAAE,CAACe,EAAE,CAAC,MAAM,EAAE,MAAM;MACvB,IAAAZ,mBAAW,EAAC;QACVd,SAAS;QACTe,OAAO,EAAE,6BAA6B,IAAI,CAACN,EAAE;MAC/C,CAAC,CAAC;MACF,IAAI,CAACuC,OAAO,GAAG,IAAI;IACrB,CAAC,CAAC;EACJ;;EAEA;EAAA,WAAAO,aAAA,CAAAhD,OAAA,EAAAN,YAAA;IAAAuD,GAAA;IAAAC,KAAA;IAUA;AACF;AACA;IACE,SAAOC,WAAWA,CAChBC,IAAY,EACZC,OAAgB,GAAG,CAAC,CAAC,EACrBvD,OAAuC,GAAG,CAAC,CAAC,EACtC;MACN,IAAAS,mBAAW,EAAC;QACVd,SAAS;QACTe,OAAO,EAAE,uDAAuD4C,IAAI,MAAM,IAAI,CAAClD,EAAE,GAAG;QACpF0B,IAAI,EAAE;UAAE9B;QAAQ;MAClB,CAAC,CAAC;MACF,IAAIwD,IAAI,GAAG,KAAK;MAChB;MACA,IAAIxD,OAAO,CAACyD,MAAM,EAAED,IAAI,GAAG,IAAI;MAC/B;MAAA,KACK,IACH,IAAI,CAACE,aAAa,IACjB,IAAI,CAACC,QAAQ,CAAmBC,QAAQ,CACvC5D,OAAO,CAAC2D,QAAQ,IAAKb,OAAO,CAACC,GAAG,CAACc,wBACnC,CAAC,EAEDL,IAAI,GAAG,IAAI;MAEb,IAAIA,IAAI,EAAE;QACR,IAAA/C,mBAAW,EAAC;UACVd,SAAS;UACTe,OAAO,EAAE,sCAAsC4C,IAAI,IAAI,SAAS,MAAM,IAAI,CAAClD,EAAE;QAC/E,CAAC,CAAC;QACF,IAAI,CAACE,EAAE,CAACkD,IAAI,CAACM,IAAI,CAACC,SAAS,CAAC;UAAET,IAAI;UAAEC;QAAQ,CAAC,CAAC,CAAC;MACjD;IACF;;IAEA;EAAA;IAAAJ,GAAA;IAAAC,KAAA,EACA,SAAOY,eAAeA,CAAA,EAAY;MAChC,OAAO,IAAI,CAACN,aAAa;IAC3B;;IAEA;EAAA;IAAAP,GAAA;IAAAC,KAAA,EACA,SAAOa,OAAOA,CAAA,EAA2B;MACvC,IAAI,IAAI,CAACP,aAAa,EACpB,OAAO;QACLQ,MAAM,EAAE,IAAI,CAACA,MAAgB;QAC7BC,QAAQ,EAAE,IAAI,CAACA,QAAkB;QACjCC,OAAO,EAAE,IAAI,CAACA,OAAiB;QAC/BT,QAAQ,EAAE,IAAI,CAACA;MACjB,CAAC;MACH,OAAOU,SAAS;IAClB;;IAEA;EAAA;IAAAlB,GAAA;IAAAC,KAAA,EACA,eAAcrB,aAAaA,CAACD,IAAa,EAAiB;MACxD,IAAI;QACF,MAAMpB,OAAO,GAAG,IAAA4D,0BAAY,EAACxC,IAAI,CAACyC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpD,IAAAnD,kBAAU,EAAC;UACTV,OAAO,EAAE,6BAA6BA,OAAO,EAAE4C,IAAI,IAAI,SAAS,MAAM,IAAI,CAAClD,EAAE;QAC/E,CAAC,CAAC;QACF,QAAQM,OAAO,CAAC4C,IAAI;UAClB,KAAK,cAAc;YACjB,MAAM,IAAI,CAACkB,YAAY,CAAC9D,OAAsC,CAAC;YAC/D;UACF;UACA;UACA,KAAK,MAAM;YACT,IAAAD,mBAAW,EAAC;cACVd,SAAS;cACTe,OAAO,EAAE,8BAA8B,IAAI,CAACN,EAAE;YAChD,CAAC,CAAC;YACF,IAAI,CAACiD,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE;cAAEI,MAAM,EAAE;YAAK,CAAC,CAAC;YAC9C;UACF;YACE,KAAK,MAAMzC,OAAO,IAAI,IAAI,CAACD,QAAQ,EAAE;cACnC,MAAMC,OAAO,CAACyD,MAAM,CAAC/D,OAAO,EAAE,IAAI,CAAC;YACrC;QACJ;MACF,CAAC,CAAC,OAAOe,KAAK,EAAE;QACd,IAAI,CAACiD,WAAW,CAACjD,KAAK,CAAC;MACzB;IACF;;IAEA;AACF;AACA;AACA;EAHE;IAAA0B,GAAA;IAAAC,KAAA,EAIA,eAAcoB,YAAYA,CACxB9D,OAAoC,EACrB;MACf,MAAMiE,KAAK,GAAGjE,OAAO,CAAC6C,OAAO,EAAEoB,KAAK;MACpC,IAAI,CAACA,KAAK,EAAE;QACV,MAAM,IAAIC,kBAAQ,CAAC;UACjBC,SAAS,EAAE,UAAU;UACrBnE,OAAO,EAAE,oBAAoB;UAC7BoB,IAAI,EAAE;YAAEpB;UAAQ;QAClB,CAAC,CAAC;MACJ;MACA,MAAM6C,OAAO,GAAG,MAAM,IAAAuB,cAAS,EAACH,KAAK,CAAC;MACtC,IAAI,CAACI,WAAW,CAACxB,OAAO,CAAC;MAEzB,IAAI,CAACG,aAAa,GAAG,IAAI;MACzB;MACA,MAAMsB,cAAc,GAAGzB,OAAO,CAAC0B,GAAG,GAAG,IAAI,GAAGzE,IAAI,CAAC0E,GAAG,CAAC,CAAC;MACtD;MACA,IAAI,CAACC,aAAa,CAAC,CAAC;MACpB;MACA,IAAI,CAACC,cAAc,GAAGC,UAAU,CAC9B,MAAM;QACJ,IAAI,CAAChC,WAAW,CAAC,qBAAqB,CAAC;MACzC,CAAC,EACD2B,cAAc,GAAG,EAAE,GAAG,IACxB,CAAC;MACD;MACA,IAAI,CAACM,eAAe,GAAGD,UAAU,CAAC,MAAM;QACtC,IAAI,CAAC3B,aAAa,GAAG,KAAK;MAC5B,CAAC,EAAEsB,cAAc,CAAC;;MAElB;MACA,MAAMhD,eAAe,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC9C,IAAI,CAACrB,aAAa,CAACsB,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;IAAAW,GAAA;IAAAC,KAAA,EACA,SAAQ+B,aAAaA,CAAA,EAAS;MAC5B,IAAI,IAAI,CAACC,cAAc,EAAEG,YAAY,CAAC,IAAI,CAACH,cAAc,CAAC;MAC1D,IAAI,IAAI,CAACE,eAAe,EAAEC,YAAY,CAAC,IAAI,CAACD,eAAe,CAAC;IAC9D;;IAEA;AACF;AACA;EAFE;IAAAnC,GAAA;IAAAC,KAAA,EAGA,SAAQ2B,WAAWA,CAAC;MAAES,GAAG;MAAEC,GAAG;MAAEC,GAAG;MAAEC;IAAsB,CAAC,EAAQ;MAClE;MACA,IAAI,IAAI,CAACzB,MAAM,EAAE;QACf;QACA,IAAI,IAAI,CAACA,MAAM,IAAI,IAAI,CAACA,MAAM,KAAKsB,GAAG,EACpC,MAAM,IAAIZ,kBAAQ,CAAC;UACjBC,SAAS,EAAE,kBAAkB;UAC7BnE,OAAO,EACL;QACJ,CAAC,CAAC;MACN,CAAC,MAAM;QACL;QACA,IAAI,CAACwD,MAAM,GAAGsB,GAAG;QACjB;QACA,IAAI,CAACrB,QAAQ,GAAGsB,GAAG;QACnB;QACA,IAAI,CAACrB,OAAO,GAAGsB,GAAG;QAClB;QACA,IAAI,CAAC/B,QAAQ,GAAGgC,GAAG,YAAY/E,KAAK,GAAG+E,GAAG,GAAG,CAACA,GAAG,CAAC;QAElD,IAAAlF,mBAAW,EAAC;UACVd,SAAS;UACTe,OAAO,EAAE,sCAAsC,IAAI,CAACN,EAAE,GAAG;UACzD0B,IAAI,EAAE;YACJoC,MAAM,EAAE,IAAI,CAACA,MAAM;YACnBC,QAAQ,EAAE,IAAI,CAACA,QAAQ;YACvBC,OAAO,EAAE,IAAI,CAACA,OAAO;YACrBT,QAAQ,EAAE,IAAI,CAACA;UACjB;QACF,CAAC,CAAC;MACJ;IACF;;IAEA;AACF;AACA;EAFE;IAAAR,GAAA;IAAAC,KAAA,EAGA,SAAQsB,WAAWA,CAACjD,KAAc,EAAQ;MACxC,IAAAC,mBAAW,EAACD,KAAK,CAAC;MAClB,IAAIA,KAAK,YAAYmD,kBAAQ,EAAE;QAC7B,IAAI,CAACvB,WAAW,CACd,OAAO,EACP;UAAEwB,SAAS,EAAEpD,KAAK,CAACoD,SAAS;UAAEe,IAAI,EAAEnE,KAAK,CAACmE;QAAK,CAAC,EAChD;UAAEnC,MAAM,EAAE;QAAK,CACjB,CAAC;MACH,CAAC,MAAM,IAAIhC,KAAK,YAAYoE,gCAAe,EAAE;QAC3C,IAAI,CAACxC,WAAW,CACd,OAAO,EACP;UAAEwB,SAAS,EAAE,kBAAkB;UAAEe,IAAI,EAAEnE,KAAK,CAACK;QAAK,CAAC,EACnD;UAAE2B,MAAM,EAAE;QAAK,CACjB,CAAC;MACH,CAAC,MAAM;QACL,IAAI,CAACJ,WAAW,CACd,OAAO,EACP;UAAEwB,SAAS,EAAE;QAAe,CAAC,EAC7B;UAAEpB,MAAM,EAAE;QAAK,CACjB,CAAC;MACH;IACF;;IAEA;AACF;AACA;EAFE;IAAAN,GAAA;IAAAC,KAAA,EAGA,eAAc9B,WAAWA,CAACwE,IAAa,EAAEtD,MAAe,EAAiB;MACvE,OAAO5C,YAAY,CAACuB,aAAa,CAAC,IAAI,CAACf,EAAE,CAAC;MAC1C,IAAI,CAAC+E,aAAa,CAAC,CAAC;MACpB;MACA,IAAI,IAAI,CAAC1C,YAAY,EAAEsD,aAAa,CAAC,IAAI,CAACtD,YAAY,CAAC;MACvD;MACA,MAAMT,eAAe,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC9C,IAAI,CAACpB,iBAAiB,CAACqB,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;QACTV,OAAO,EAAE,wBAAwB,IAAI,CAACN,EAAE,GAAG;QAC3C0B,IAAI,EAAE;UAAEgE,IAAI;UAAEtD;QAAO;MACvB,CAAC,CAAC;IACJ;EAAC;IAAAW,GAAA;IAAAC,KAAA,EA9ND,SAAc4C,gBAAgBA,CAAA,EAAqB;MACjD,OAAO,IAAI,CAAC7E,aAAa;IAC3B;;IAEA;EAAA;IAAAgC,GAAA;IAAAC,KAAA,EACA,SAAc6C,eAAeA,CAAC7F,EAAU,EAA4B;MAClE,OAAO,IAAI,CAACe,aAAa,CAACf,EAAE,CAAC;IAC/B;EAAC;AAAA;AAlKD;AAAA,IAAAD,gBAAA,CAAAD,OAAA,EADWN,YAAY,mBAE0B,CAAC,CAAC","ignoreList":[]}
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","_defineProperty2","id","randomUUID","ws","establishedAt","Date","reportDebug","message","initCallbacks","Array","authCallbacks","shutdownCallbacks","handlers","handler","MessageHandler","EngineError","socketClients","reportInfo","authTimeoutMs","authTimeout","setTimeout","authenticated","close","on","code","reason","handleClose","bind","toString","catch","error","reportError","severity","LogSeverity","WARNING","data","handleMessage","callbackResults","Promise","allSettled","map","callback","forEach","result","status","pingInterval","setInterval","isAlive","terminate","ping","process","env","WS_PING_INTERVAL","parseInt","_createClass2","key","value","sendMessage","type","payload","send","noAuth","audience","includes","DEFAULT_MESSAGE_AUDIENCE","JSON","stringify","clearTimeouts","clearTimeout","isAuthenticated","getUser","userId","deviceId","tokenId","user","tokenUser","expiresAt","authExpiresAt","undefined","parseMessage","authenticate","handle","handleError","token","WebError","errorCode","jwtVerify","setUserData","exp","authExpiration","now","authRenewTimer","authExpireTimer","sub","dev","jti","aud","hint","ValidationError","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 /* The `user` claim of the token the client authenticated with /\n private tokenUser: undefined \| Record<string, unknown>;\n /* Timestamp (ms) at which the current authentication expires /\n private authExpiresAt: undefined \| number;\n /* Closes the connection if the client does not authenticate in time /\n private authTimeout: NodeJS.Timeout \| undefined;\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 * @param webSocket - The WebSocket instance\n * @param _request - The incoming HTTP request (reserved for future use)\n * @param options - Socket client configuration options\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 // Optionally close connections that do not authenticate in time\n if (options.authTimeoutMs && options.authTimeoutMs > 0) {\n this.authTimeout = setTimeout(() => {\n if (!this.authenticated) this.close(4401, 'Authentication required');\n }, options.authTimeoutMs);\n }\n // On socket close, deregister from clients list\n this.ws.on('close', (code: number, reason: Buffer) => {\n this.handleClose\n .bind(this)(code, reason?.toString())\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 /\n Close the connection\n * @param code - WebSocket close code (4000-4999 are free for applications, e.g. 4401 / 4403)\n * @param reason - Human readable reason, sent to the client\n /\n public close(code = 1000, reason?: string): void {\n this.clearTimeouts();\n if (this.authTimeout) clearTimeout(this.authTimeout);\n this.ws.close(code, reason);\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 user: this.tokenUser,\n expiresAt: this.authExpiresAt\n };\n return undefined;\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 this.tokenUser = payload.user;\n this.authExpiresAt = payload.exp 1000;\n if (this.authTimeout) clearTimeout(this.authTimeout);\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?: number, reason?: string): Promise<void> {\n delete SocketClient.socketClients[this.id];\n this.clearTimeouts();\n if (this.authTimeout) clearTimeout(this.authTimeout);\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;EA0CvB;AACF;AACA;AACA;AACA;AACA;EACE,SAAAA,aACEE,SAAa,EACbC,QAAyB,EACzBC,OAA4B,EAC5B;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAN,YAAA;IAjDF;IAAA,IAAAO,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA,yBACqD,EAAE;IACvD;IAAA,IAAAC,gBAAA,CAAAD,OAAA,yBACqD,EAAE;IACvD;IAAA,IAAAC,gBAAA,CAAAD,OAAA,6BACyD,EAAE;IAC3D;IAAA,IAAAC,gBAAA,CAAAD,OAAA,yBACwB,KAAK;IAC7B;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA,mBACkB,IAAI;IACtB;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAcE,IAAI,CAACE,EAAE,GAAG,IAAAC,kBAAU,EAAC,CAAC;IACtB,IAAI,CAACC,EAAE,GAAGR,SAAS;IACnB,IAAI,CAACS,aAAa,GAAG,IAAIC,IAAI,CAAC,CAAC;IAE/B,IAAAC,mBAAW,EAAC;MAAEd,SAAS;MAAEe,OAAO,EAAE,2BAA2B,IAAI,CAACN,EAAE;IAAI,CAAC,CAAC;;IAE1E;IACA;IACA,IAAI,OAAOJ,OAAO,CAACW,aAAa,KAAK,UAAU,EAC7C,IAAI,CAACA,aAAa,GAAG,CAACX,OAAO,CAACW,aAAa,CAAC,CAAC,KAC1C,IAAIX,OAAO,CAACW,aAAa,YAAYC,KAAK,EAC7C,IAAI,CAACD,aAAa,GAAGX,OAAO,CAACW,aAAa;IAC5C;IACA,IAAI,OAAOX,OAAO,CAACa,aAAa,KAAK,UAAU,EAC7C,IAAI,CAACA,aAAa,GAAG,CAACb,OAAO,CAACa,aAAa,CAAC,CAAC,KAC1C,IAAIb,OAAO,CAACa,aAAa,YAAYD,KAAK,EAC7C,IAAI,CAACC,aAAa,GAAGb,OAAO,CAACa,aAAa;IAC5C;IACA,IAAI,OAAOb,OAAO,CAACc,iBAAiB,KAAK,UAAU,EACjD,IAAI,CAACA,iBAAiB,GAAG,CAACd,OAAO,CAACc,iBAAiB,CAAC,CAAC,KAClD,IAAId,OAAO,CAACc,iBAAiB,YAAYF,KAAK,EACjD,IAAI,CAACE,iBAAiB,GAAGd,OAAO,CAACc,iBAAiB;;IAEpD;IACA,IAAI,CAACC,QAAQ,GAAGf,OAAO,CAACe,QAAQ;IAChC,KAAK,MAAMC,OAAO,IAAI,IAAI,CAACD,QAAQ,EAAE;MACnC,IAAI,EAAEC,OAAO,YAAYC,8BAAc,CAAC,EACtC,MAAM,IAAIC,wBAAW,CAAC;QACpBR,OAAO,EAAE;MACX,CAAC,CAAC;IACN;IACA;IACAd,YAAY,CAACuB,aAAa,CAAC,IAAI,CAACf,EAAE,CAAC,GAAG,IAAI;IAE1C,IAAAgB,kBAAU,EAAC;MAAEV,OAAO,EAAE,qBAAqB,IAAI,CAACN,EAAE;IAAI,CAAC,CAAC;IACxD;IACA,IAAIJ,OAAO,CAACqB,aAAa,IAAIrB,OAAO,CAACqB,aAAa,GAAG,CAAC,EAAE;MACtD,IAAI,CAACC,WAAW,GAAGC,UAAU,CAAC,MAAM;QAClC,IAAI,CAAC,IAAI,CAACC,aAAa,EAAE,IAAI,CAACC,KAAK,CAAC,IAAI,EAAE,yBAAyB,CAAC;MACtE,CAAC,EAAEzB,OAAO,CAACqB,aAAa,CAAC;IAC3B;IACA;IACA,IAAI,CAACf,EAAE,CAACoB,EAAE,CAAC,OAAO,EAAE,CAACC,IAAY,EAAEC,MAAc,KAAK;MACpD,IAAI,CAACC,WAAW,CACbC,IAAI,CAAC,IAAI,CAAC,CAACH,IAAI,EAAEC,MAAM,EAAEG,QAAQ,CAAC,CAAC,CAAC,CACpCC,KAAK,CAAEC,KAAK,IAAK;QAChB,IAAAC,mBAAW,EAACD,KAAK,CAAC;MACpB,CAAC,CAAC;IACN,CAAC,CAAC;IACF;IACA,IAAI,CAAC3B,EAAE,CAACoB,EAAE,CAAC,OAAO,EAAGO,KAAK,IAAK;MAC7B,IAAAC,mBAAW,EACT,IAAIhB,wBAAW,CAAC;QACdiB,QAAQ,EAAEC,kBAAW,CAACC,OAAO;QAC7B3B,OAAO,EAAE,UAAU,IAAI,CAACN,EAAE;MAC5B,CAAC,CACH,CAAC;MACD,IAAA8B,mBAAW,EAACD,KAAK,CAAC;IACpB,CAAC,CAAC;IACF;IACA,IAAI,CAAC3B,EAAE,CAACoB,EAAE,CAAC,SAAS,EAAGY,IAAI,IAAK;MAC9B,IAAI,CAACC,aAAa,CACfT,IAAI,CAAC,IAAI,CAAC,CAACQ,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,CAAC/B,aAAa,CAACgC,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,CAAClB,MAAM,CAAC;MAC9D,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,CAACI,KAAK,CAAEC,KAAK,IAAK;MACpB,IAAAC,mBAAW,EAACD,KAAK,CAAC;IACpB,CAAC,CAAC;;IAEF;IACA;IACA,IAAI,CAACe,YAAY,GAAGC,WAAW,CAC7B,MAAM;MACJ,IAAI,CAAC,IAAI,CAACC,OAAO,EAAE;QACjB,IAAAhB,mBAAW,EACT,IAAIhB,wBAAW,CAAC;UACdiB,QAAQ,EAAEC,kBAAW,CAACC,OAAO;UAC7B3B,OAAO,EAAE,gDAAgD,IAAI,CAACN,EAAE;QAClE,CAAC,CACH,CAAC;QACD,IAAI,CAACE,EAAE,CAAC6C,SAAS,CAAC,CAAC;QACnB;MACF;MACA,IAAI,CAACD,OAAO,GAAG,KAAK;MACpB,IAAI,CAAC5C,EAAE,CAAC8C,IAAI,CAAC,CAAC;MACd,IAAA3C,mBAAW,EAAC;QAAEd,SAAS;QAAEe,OAAO,EAAE,wBAAwB,IAAI,CAACN,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,CAACoB,EAAE,CAAC,MAAM,EAAE,MAAM;MACvB,IAAAjB,mBAAW,EAAC;QACVd,SAAS;QACTe,OAAO,EAAE,6BAA6B,IAAI,CAACN,EAAE;MAC/C,CAAC,CAAC;MACF,IAAI,CAAC8C,OAAO,GAAG,IAAI;IACrB,CAAC,CAAC;EACJ;;EAEA;EAAA,WAAAO,aAAA,CAAAvD,OAAA,EAAAN,YAAA;IAAA8D,GAAA;IAAAC,KAAA;IAUA;AACF;AACA;IACE,SAAOC,WAAWA,CAChBC,IAAY,EACZC,OAAgB,GAAG,CAAC,CAAC,EACrB9D,OAAuC,GAAG,CAAC,CAAC,EACtC;MACN,IAAAS,mBAAW,EAAC;QACVd,SAAS;QACTe,OAAO,EAAE,uDAAuDmD,IAAI,MAAM,IAAI,CAACzD,EAAE,GAAG;QACpFkC,IAAI,EAAE;UAAEtC;QAAQ;MAClB,CAAC,CAAC;MACF,IAAI+D,IAAI,GAAG,KAAK;MAChB;MACA,IAAI/D,OAAO,CAACgE,MAAM,EAAED,IAAI,GAAG,IAAI;MAC/B;MAAA,KACK,IACH,IAAI,CAACvC,aAAa,IACjB,IAAI,CAACyC,QAAQ,CAAmBC,QAAQ,CACvClE,OAAO,CAACiE,QAAQ,IAAKZ,OAAO,CAACC,GAAG,CAACa,wBACnC,CAAC,EAEDJ,IAAI,GAAG,IAAI;MAEb,IAAIA,IAAI,EAAE;QACR,IAAAtD,mBAAW,EAAC;UACVd,SAAS;UACTe,OAAO,EAAE,sCAAsCmD,IAAI,IAAI,SAAS,MAAM,IAAI,CAACzD,EAAE;QAC/E,CAAC,CAAC;QACF,IAAI,CAACE,EAAE,CAACyD,IAAI,CAACK,IAAI,CAACC,SAAS,CAAC;UAAER,IAAI;UAAEC;QAAQ,CAAC,CAAC,CAAC;MACjD;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAJ,GAAA;IAAAC,KAAA,EAKA,SAAOlC,KAAKA,CAACE,IAAI,GAAG,IAAI,EAAEC,MAAe,EAAQ;MAC/C,IAAI,CAAC0C,aAAa,CAAC,CAAC;MACpB,IAAI,IAAI,CAAChD,WAAW,EAAEiD,YAAY,CAAC,IAAI,CAACjD,WAAW,CAAC;MACpD,IAAI,CAAChB,EAAE,CAACmB,KAAK,CAACE,IAAI,EAAEC,MAAM,CAAC;IAC7B;;IAEA;EAAA;IAAA8B,GAAA;IAAAC,KAAA,EACA,SAAOa,eAAeA,CAAA,EAAY;MAChC,OAAO,IAAI,CAAChD,aAAa;IAC3B;;IAEA;EAAA;IAAAkC,GAAA;IAAAC,KAAA,EACA,SAAOc,OAAOA,CAAA,EAA2B;MACvC,IAAI,IAAI,CAACjD,aAAa,EACpB,OAAO;QACLkD,MAAM,EAAE,IAAI,CAACA,MAAgB;QAC7BC,QAAQ,EAAE,IAAI,CAACA,QAAkB;QACjCC,OAAO,EAAE,IAAI,CAACA,OAAiB;QAC/BX,QAAQ,EAAE,IAAI,CAACA,QAAyB;QACxCY,IAAI,EAAE,IAAI,CAACC,SAAS;QACpBC,SAAS,EAAE,IAAI,CAACC;MAClB,CAAC;MACH,OAAOC,SAAS;IAClB;;IAEA;EAAA;IAAAvB,GAAA;IAAAC,KAAA,EACA,eAAcpB,aAAaA,CAACD,IAAa,EAAiB;MACxD,IAAI;QACF,MAAM5B,OAAO,GAAG,IAAAwE,0BAAY,EAAC5C,IAAI,CAACP,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpD,IAAAX,kBAAU,EAAC;UACTV,OAAO,EAAE,6BAA6BA,OAAO,EAAEmD,IAAI,IAAI,SAAS,MAAM,IAAI,CAACzD,EAAE;QAC/E,CAAC,CAAC;QACF,QAAQM,OAAO,CAACmD,IAAI;UAClB,KAAK,cAAc;YACjB,MAAM,IAAI,CAACsB,YAAY,CAACzE,OAAsC,CAAC;YAC/D;UACF;UACA;UACA,KAAK,MAAM;YACT,IAAAD,mBAAW,EAAC;cACVd,SAAS;cACTe,OAAO,EAAE,8BAA8B,IAAI,CAACN,EAAE;YAChD,CAAC,CAAC;YACF,IAAI,CAACwD,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE;cAAEI,MAAM,EAAE;YAAK,CAAC,CAAC;YAC9C;UACF;YACE,KAAK,MAAMhD,OAAO,IAAI,IAAI,CAACD,QAAQ,EAAE;cACnC,MAAMC,OAAO,CAACoE,MAAM,CAAC1E,OAAO,EAAE,IAAI,CAAC;YACrC;QACJ;MACF,CAAC,CAAC,OAAOuB,KAAK,EAAE;QACd,IAAI,CAACoD,WAAW,CAACpD,KAAK,CAAC;MACzB;IACF;;IAEA;AACF;AACA;AACA;EAHE;IAAAyB,GAAA;IAAAC,KAAA,EAIA,eAAcwB,YAAYA,CACxBzE,OAAoC,EACrB;MACf,MAAM4E,KAAK,GAAG5E,OAAO,CAACoD,OAAO,EAAEwB,KAAK;MACpC,IAAI,CAACA,KAAK,EAAE;QACV,MAAM,IAAIC,kBAAQ,CAAC;UACjBC,SAAS,EAAE,UAAU;UACrB9E,OAAO,EAAE,oBAAoB;UAC7B4B,IAAI,EAAE;YAAE5B;UAAQ;QAClB,CAAC,CAAC;MACJ;MACA,MAAMoD,OAAO,GAAG,MAAM,IAAA2B,cAAS,EAACH,KAAK,CAAC;MACtC,IAAI,CAACI,WAAW,CAAC5B,OAAO,CAAC;MAEzB,IAAI,CAACtC,aAAa,GAAG,IAAI;MACzB,IAAI,CAACsD,SAAS,GAAGhB,OAAO,CAACe,IAAI;MAC7B,IAAI,CAACG,aAAa,GAAGlB,OAAO,CAAC6B,GAAG,GAAG,IAAI;MACvC,IAAI,IAAI,CAACrE,WAAW,EAAEiD,YAAY,CAAC,IAAI,CAACjD,WAAW,CAAC;MACpD;MACA,MAAMsE,cAAc,GAAG9B,OAAO,CAAC6B,GAAG,GAAG,IAAI,GAAGnF,IAAI,CAACqF,GAAG,CAAC,CAAC;MACtD;MACA,IAAI,CAACvB,aAAa,CAAC,CAAC;MACpB;MACA,IAAI,CAACwB,cAAc,GAAGvE,UAAU,CAC9B,MAAM;QACJ,IAAI,CAACqC,WAAW,CAAC,qBAAqB,CAAC;MACzC,CAAC,EACDgC,cAAc,GAAG,EAAE,GAAG,IACxB,CAAC;MACD;MACA,IAAI,CAACG,eAAe,GAAGxE,UAAU,CAAC,MAAM;QACtC,IAAI,CAACC,aAAa,GAAG,KAAK;MAC5B,CAAC,EAAEoE,cAAc,CAAC;;MAElB;MACA,MAAMpD,eAAe,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC9C,IAAI,CAAC7B,aAAa,CAAC8B,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,CAAClB,MAAM,CAAC;MAC9D,CAAC,CAAC;IACJ;;IAEA;IACA;EAAA;IAAA8B,GAAA;IAAAC,KAAA,EACA,SAAQW,aAAaA,CAAA,EAAS;MAC5B,IAAI,IAAI,CAACwB,cAAc,EAAEvB,YAAY,CAAC,IAAI,CAACuB,cAAc,CAAC;MAC1D,IAAI,IAAI,CAACC,eAAe,EAAExB,YAAY,CAAC,IAAI,CAACwB,eAAe,CAAC;IAC9D;;IAEA;AACF;AACA;EAFE;IAAArC,GAAA;IAAAC,KAAA,EAGA,SAAQ+B,WAAWA,CAAC;MAAEM,GAAG;MAAEC,GAAG;MAAEC,GAAG;MAAEC;IAAsB,CAAC,EAAQ;MAClE;MACA,IAAI,IAAI,CAACzB,MAAM,EAAE;QACf;QACA,IAAI,IAAI,CAACA,MAAM,IAAI,IAAI,CAACA,MAAM,KAAKsB,GAAG,EACpC,MAAM,IAAIT,kBAAQ,CAAC;UACjBC,SAAS,EAAE,kBAAkB;UAC7B9E,OAAO,EACL;QACJ,CAAC,CAAC;MACN,CAAC,MAAM;QACL;QACA,IAAI,CAACgE,MAAM,GAAGsB,GAAG;QACjB;QACA,IAAI,CAACrB,QAAQ,GAAGsB,GAAG;QACnB;QACA,IAAI,CAACrB,OAAO,GAAGsB,GAAG;QAClB;QACA,IAAI,CAACjC,QAAQ,GAAGkC,GAAG,YAAYvF,KAAK,GAAGuF,GAAG,GAAG,CAACA,GAAG,CAAC;QAElD,IAAA1F,mBAAW,EAAC;UACVd,SAAS;UACTe,OAAO,EAAE,sCAAsC,IAAI,CAACN,EAAE,GAAG;UACzDkC,IAAI,EAAE;YACJoC,MAAM,EAAE,IAAI,CAACA,MAAM;YACnBC,QAAQ,EAAE,IAAI,CAACA,QAAQ;YACvBC,OAAO,EAAE,IAAI,CAACA,OAAO;YACrBX,QAAQ,EAAE,IAAI,CAACA;UACjB;QACF,CAAC,CAAC;MACJ;IACF;;IAEA;AACF;AACA;EAFE;IAAAP,GAAA;IAAAC,KAAA,EAGA,SAAQ0B,WAAWA,CAACpD,KAAc,EAAQ;MACxC,IAAAC,mBAAW,EAACD,KAAK,CAAC;MAClB,IAAIA,KAAK,YAAYsD,kBAAQ,EAAE;QAC7B,IAAI,CAAC3B,WAAW,CACd,OAAO,EACP;UAAE4B,SAAS,EAAEvD,KAAK,CAACuD,SAAS;UAAEY,IAAI,EAAEnE,KAAK,CAACmE;QAAK,CAAC,EAChD;UAAEpC,MAAM,EAAE;QAAK,CACjB,CAAC;MACH,CAAC,MAAM,IAAI/B,KAAK,YAAYoE,gCAAe,EAAE;QAC3C,IAAI,CAACzC,WAAW,CACd,OAAO,EACP;UAAE4B,SAAS,EAAE,kBAAkB;UAAEY,IAAI,EAAEnE,KAAK,CAACK;QAAK,CAAC,EACnD;UAAE0B,MAAM,EAAE;QAAK,CACjB,CAAC;MACH,CAAC,MAAM;QACL,IAAI,CAACJ,WAAW,CACd,OAAO,EACP;UAAE4B,SAAS,EAAE;QAAe,CAAC,EAC7B;UAAExB,MAAM,EAAE;QAAK,CACjB,CAAC;MACH;IACF;;IAEA;AACF;AACA;EAFE;IAAAN,GAAA;IAAAC,KAAA,EAGA,eAAc9B,WAAWA,CAACF,IAAa,EAAEC,MAAe,EAAiB;MACvE,OAAOhC,YAAY,CAACuB,aAAa,CAAC,IAAI,CAACf,EAAE,CAAC;MAC1C,IAAI,CAACkE,aAAa,CAAC,CAAC;MACpB,IAAI,IAAI,CAAChD,WAAW,EAAEiD,YAAY,CAAC,IAAI,CAACjD,WAAW,CAAC;MACpD;MACA,IAAI,IAAI,CAAC0B,YAAY,EAAEsD,aAAa,CAAC,IAAI,CAACtD,YAAY,CAAC;MACvD;MACA,MAAMR,eAAe,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC9C,IAAI,CAAC5B,iBAAiB,CAAC6B,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,CAAClB,MAAM,CAAC;MAC9D,CAAC,CAAC;MACF,IAAAR,kBAAU,EAAC;QACTV,OAAO,EAAE,wBAAwB,IAAI,CAACN,EAAE,GAAG;QAC3CkC,IAAI,EAAE;UAAEX,IAAI;UAAEC;QAAO;MACvB,CAAC,CAAC;IACJ;EAAC;IAAA8B,GAAA;IAAAC,KAAA,EA/OD,SAAc4C,gBAAgBA,CAAA,EAAqB;MACjD,OAAO,IAAI,CAACpF,aAAa;IAC3B;;IAEA;EAAA;IAAAuC,GAAA;IAAAC,KAAA,EACA,SAAc6C,eAAeA,CAACpG,EAAU,EAA4B;MAClE,OAAO,IAAI,CAACe,aAAa,CAACf,EAAE,CAAC;IAC/B;EAAC;AAAA;AA9KD;AAAA,IAAAD,gBAAA,CAAAD,OAAA,EADWN,YAAY,mBAE0B,CAAC,CAAC","ignoreList":[]}

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

@@ -11,6 +11,8 @@ export interface SocketClientOptions {
     authCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
     /** Callback function that are called when the client connection is terminated */
     shutdownCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
+    /** Close the connection with code 4401 if the client has not authenticated after this many ms (default: never) */
+    authTimeoutMs?: number;
 }
 /** Socket Message abstract typing */
 export interface SocketMessage<T = unknown> {
@@ -50,4 +52,8 @@ export interface SocketUser {
     tokenId: string;
     /** Audience included in the token */
     audience: Array<string>;
+    /** The `user` claim of the authentication token (application data such as role or organisation) */
+    user?: Record<string, unknown>;
+    /** Timestamp (ms) at which the authentication expires */
+    expiresAt?: number;
 }

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

	@@ -1 +1 @@
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":[]}
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 /* Close the connection with code 4401 if the client has not authenticated after this many ms (default: never) /\n authTimeoutMs?: number;\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 /* The `user` claim of the authentication token (application data such as role or organisation) /\n user?: Record<string, unknown>;\n /* Timestamp (ms) at which the authentication expires */\n expiresAt?: number;\n}\n"],"mappings":"","ignoreList":[]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "node-server-engine",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Framework used to develop backend services. This package ships with a lot of features to standardize the creation of services, letting you focus on the business logic.",
   "main": "dist/index.js",
   "scripts": {