node-server-engine 1.0.5

package/dist/entities/Server/Server.js

@@ -0,0 +1,380 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Server = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _promises = require("timers/promises");
+var _express = _interopRequireDefault(require("express"));
+var _ws = require("ws");
+var _SocketClient = require("../SocketClient");
+var _Server2 = require("./Server.const");
+var _Endpoint = require("../Endpoint");
+var _EngineError = require("../EngineError");
+var _LifecycleController = require("../LifecycleController");
+var _PubSub = require("../PubSub");
+var _utils = require("../../utils");
+var _jwt = require("../../utils/jwt");
+var _report = require("../../utils/report");
+var _tlsConfig = require("../../utils/tlsConfig");
+const namespace = 'engine:Server';
+
+/** Main server class */
+let Server = exports.Server = /*#__PURE__*/function () {
+  /** Create a server */
+  function Server(config) {
+    (0, _classCallCheck2.default)(this, Server);
+    /** The express application powering the main endpoints */
+    this.app = void 0;
+    /** The node HTTP(S) server, serving the main express application */
+    this.httpServer = void 0;
+    /** The express application powering the support endpoints */
+    this.secondaryApp = void 0;
+    /** The node HTTP(S) server, serving the secondary express application */
+    this.secondaryHttpServer = void 0;
+    /** List of endpoint instances that the server should handle */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    this.endpoints = void 0;
+    /** Mapping of env variable name with functions that should run to check their validity */
+    this.checkEnvironment = void 0;
+    /** Middleware that should run on every request before the endpoint specific logic */
+    this.globalMiddleware = void 0;
+    /** Error middleware that should run on every request after the endpoint specific logic, but before the generic global middleware */
+    this.errorMiddleware = void 0;
+    /** Functions that should be called on server startup */
+    this.initCallbacks = void 0;
+    /** Functions that should be called on server shutdown */
+    this.shutdownCallbacks = void 0;
+    /** When set to true, this indicates that init callbacks should run synchronously in the order they are declared. By default they all run in parallel */
+    this.syncCallbacks = void 0;
+    /** Config to set regularly running jobs on the server */
+    this.cron = void 0;
+    /** Global auth related configuration */
+    this.auth = void 0;
+    /** WebSocket server instance, if configured */
+    this.wss = void 0;
+    /** Abort controller that handles signals for the server */
+    this.abortController = new AbortController();
+    this.validate(config);
+    (0, _report.reportDebug)({
+      namespace,
+      message: `Creating server`
+    });
+    this.endpoints = config.endpoints;
+    this.globalMiddleware = config.globalMiddleware ?? [];
+    this.errorMiddleware = config.errorMiddleware ?? [];
+    this.initCallbacks = config.initCallbacks ?? [];
+    this.shutdownCallbacks = config.shutdownCallbacks ?? [];
+    this.syncCallbacks = config.syncCallbacks ?? false;
+    this.cron = config.cron;
+    this.auth = {
+      noFetch: false,
+      ...config.auth
+    };
+
+    // The minimal environment check is different between the migration modes of execution and the regular server execution mode
+    // When running in migration mode, we only check that we have SQL related environment variables
+    this.checkEnvironment = process.env.RUN_MIGRATION === 'true' || process.env.UNDO_MIGRATION === 'true' ? {
+      SQL_HOST: _utils.envAssert.isHost(),
+      SQL_USER: _utils.envAssert.isString(),
+      SQL_PASSWORD: _utils.envAssert.isString(),
+      SQL_DB: _utils.envAssert.isString()
+    } : {
+      NODE_ENV: _utils.envAssert.isString(),
+      PORT: _utils.envAssert.isPort(),
+      SECONDARY_PORT: _utils.envAssert.isPort(),
+      ...config.checkEnvironment
+    };
+    (0, _utils.checkEnvironment)(this.checkEnvironment);
+
+    // Create the primary express core that serves the business logic
+    this.app = (0, _express.default)();
+    this.registerMiddleware(this.app);
+    this.httpServer = (0, _utils.createHttpServer)(this.app);
+
+    // Create a secondary express core that servers metrics and analytics
+    // This will be served on a different port, allowing to specify different firewall rules for these routes
+    this.secondaryApp = (0, _express.default)();
+    [..._Server2.secondaryMiddleware, ..._Server2.defaultErrorMiddleware].forEach(middleware => {
+      if (middleware) this.secondaryApp.use(middleware);
+    });
+    this.secondaryHttpServer = (0, _utils.createHttpServer)(this.secondaryApp);
+
+    // Remove the express headers
+    this.app.disable('x-powered-by');
+    this.secondaryApp.disable('x-powered-by');
+
+    // We remove all node timeout on connections and requests
+    // This responsibility is delegated to the front-facing load balancer
+    [this.httpServer, this.secondaryHttpServer].forEach(server => {
+      server.headersTimeout = 0;
+      server.keepAliveTimeout = 0;
+    });
+    if (config.webSocket) {
+      this.attachWebSocket(config.webSocket);
+    }
+  }
+
+  /** Start the server */
+  return (0, _createClass2.default)(Server, [{
+    key: "init",
+    value: async function init() {
+      (0, _report.reportDebug)({
+        namespace,
+        message: `Starting Server`
+      });
+      // Fetch the keys for JWT authentication
+      // Ignore in test environment as we do symmetrical token signing
+      if (process.env.NODE_ENV !== 'test' && !this.auth.noFetch) await (0, _jwt.initKeySets)();
+      // Run all the init callbacks
+      // We can either run them all 1/1 synchronously or run them all in parallel (default)
+      // Callback can either be direct function or an object with function and parameters attributes
+
+      if (this.syncCallbacks) {
+        for (const callback of this.initCallbacks) {
+          await this.runCallback(callback);
+        }
+      } else {
+        await Promise.all(this.initCallbacks.map(callback => this.runCallback(callback)));
+      }
+
+      // Initialize the Pub/Sub module
+      await _PubSub.PubSub.init();
+      // Run all the cronjob
+      if (this.cron) {
+        this.cron.forEach(job => {
+          this.runCronJob(job);
+        });
+      }
+
+      // Start listening to requests
+      await Promise.all([new Promise(resolve => this.httpServer.listen(process.env.PORT, () => {
+        resolve();
+      })), new Promise(resolve => this.secondaryHttpServer.listen(process.env.SECONDARY_PORT, () => {
+        resolve();
+      }))]);
+      (0, _report.reportInfo)({
+        message: 'SERVER_RUNNING',
+        data: {
+          port: process.env.PORT,
+          secondaryPort: process.env.SECONDARY_PORT,
+          nodeEnv: process.env.NODE_ENV
+        }
+      });
+      this.handleSignal();
+
+      // Watch TSL config files changing
+      this.watchTlsCaFileChange();
+    }
+
+    /** Graceful shutdown */
+  }, {
+    key: "shutdown",
+    value: async function shutdown() {
+      (0, _report.reportDebug)({
+        namespace,
+        message: `Shutting down Server`
+      });
+
+      // Stop listening to HTTP requests
+      await Promise.all([this.httpServer, this.secondaryHttpServer].map(server => {
+        // Ignore if the server was already stopped
+        // We have observed cases where SIGTERM was thrown multiple times
+        if (!server.listening) return;
+        const {
+          port
+        } = server.address();
+        server.on('close', error => {
+          if (error) {
+            (0, _report.reportError)(error);
+            process.exit(1);
+          } else {
+            (0, _report.reportInfo)({
+              message: `Stopped listening to requests on port ${port}`
+            });
+          }
+        });
+        server.close();
+      }));
+
+      // Close all socket connections
+      if (this.wss) {
+        // First ask then to close gracefully
+        this.wss.clients.forEach(socket => {
+          socket.close();
+        });
+        // Hard terminate all connections still open after a defined time
+        const socketKillTimeout = process.env.WEBSOCKET_CLOSE_TIMEOUT ? parseInt(process.env.WEBSOCKET_CLOSE_TIMEOUT) : 5000;
+        await new Promise(resolve => {
+          setTimeout(() => {
+            this.wss.clients.forEach(socket => {
+              if (socket.readyState === socket.CLOSING || socket.readyState === socket.OPEN) {
+                socket.terminate();
+              }
+            });
+            resolve();
+          }, socketKillTimeout);
+        });
+      }
+
+      // Run all the shutdown callback
+      if (this.syncCallbacks) {
+        for (const callback of this.shutdownCallbacks) {
+          await this.runCallback(callback);
+        }
+      } else {
+        await Promise.all(this.shutdownCallbacks.map(callback => this.runCallback(callback)));
+      }
+
+      // Shutdown all the running entities
+      await _LifecycleController.LifecycleController.shutdownRunningInstances();
+
+      // Abort all the cronjob
+      if (this.abortController) this.abortController.abort();
+
+      // Stop the keyset timers
+      (0, _jwt.shutdownKeySets)();
+      _Server2.shutdownSignals.forEach(signal => process.removeAllListeners(signal));
+    }
+
+    /** Get the express app instance of the server */
+  }, {
+    key: "getApp",
+    value: function getApp() {
+      return this.app;
+    }
+
+    /** Get the express app instance of the server */
+  }, {
+    key: "getSecondaryApp",
+    value: function getSecondaryApp() {
+      return this.secondaryApp;
+    }
+
+    /** Registers all the middleware with the express app */
+  }, {
+    key: "registerMiddleware",
+    value: function registerMiddleware(app) {
+      // Global middleware can specify a path to which they apply
+      [..._Server2.defaultMiddleware, ...this.globalMiddleware].forEach(middleware => {
+        if (typeof middleware === 'function') {
+          app.use(middleware);
+        } else {
+          app.use(middleware.path, middleware.middleware);
+        }
+      });
+      // Call the register method of each endpoint
+      this.endpoints.forEach(endpoint => {
+        endpoint.register(app);
+      });
+      // Add error middleware
+      [...this.errorMiddleware, ..._Server2.defaultErrorMiddleware].forEach(middleware => {
+        if (typeof middleware === 'function') {
+          app.use(middleware);
+        } else {
+          app.use(middleware.path, middleware.middleware);
+        }
+      });
+    }
+
+    /** Add a handler for WebSocket connections */
+  }, {
+    key: "attachWebSocket",
+    value: function attachWebSocket(options) {
+      this.wss = new _ws.Server({
+        ...options.server,
+        server: this.httpServer
+      }).on('connection', (webSocket, request) => {
+        new _SocketClient.SocketClient(webSocket, request, options.client);
+      }).on('error', error => {
+        (0, _report.reportError)(error);
+      });
+    }
+
+    /** Call shutdown if signal gets sent to the process */
+  }, {
+    key: "handleSignal",
+    value: function handleSignal() {
+      _Server2.shutdownSignals.forEach(signal => process.on(signal, () => {
+        (async () => {
+          (0, _report.reportInfo)(`Received shutdown signal [${signal}]`);
+          await this.shutdown();
+        })().catch(error => {
+          (0, _report.reportError)(error);
+        });
+      }));
+    }
+
+    /** Watch the TLS certificate change event */
+  }, {
+    key: "watchTlsCaFileChange",
+    value: function watchTlsCaFileChange() {
+      ['TLS_REQUEST_KEY', 'TLS_REQUEST_KEY_PASSPHRASE', 'TLS_REQUEST_CERT', 'TLS_REQUEST_CA', 'TLS_SERVER_KEY', 'TLS_SERVER_KEY_PASSPHRASE', 'TLS_SERVER_CERT', 'TLS_CA'].forEach(key => {
+        const file = process.env[key];
+        if (file) _fs.default.watch(_path.default.resolve(file), event => {
+          if (event !== 'change') return;
+          (0, _report.reportInfo)(`Reloading TLS config [${file} changed]`);
+          (0, _tlsConfig.loadTlsConfig)();
+          this.httpServer.setSecureContext(_tlsConfig.tlsConfig);
+        });
+      });
+    }
+
+    /** Executes a recurring job */
+  }, {
+    key: "runCronJob",
+    value: function runCronJob(job) {
+      (async () => {
+        (0, _report.reportInfo)({
+          message: `Starting scheduled job "${job.handler.name}"`
+        });
+        try {
+          await job.handler();
+          (0, _report.reportInfo)({
+            message: `Job "${job.handler.name}" finished, starting again in ${job.interval} seconds`
+          });
+          await (0, _promises.setTimeout)(job.interval * 1000, undefined, {
+            signal: this.abortController.signal
+          });
+          this.runCronJob(job);
+        } catch (error) {
+          if (error instanceof Error && error.name === 'AbortError') {
+            (0, _report.reportDebug)({
+              namespace,
+              message: `Scheduled job "${job.handler?.name}" has been aborted`
+            });
+          } else {
+            throw error;
+          }
+        }
+      })().catch(error => {
+        (0, _report.reportError)(error);
+      });
+    }
+
+    /** Run a shutdown/init callback */
+  }, {
+    key: "runCallback",
+    value: function runCallback(callback) {
+      return typeof callback === 'function' ? callback() : callback.function.apply(null, callback.parameters ?? []);
+    }
+
+    /**
+     * Validate the Server constructor configuration
+     */
+  }, {
+    key: "validate",
+    value: function validate(config) {
+      if (!config.endpoints || config.endpoints.some(endpoint => !(endpoint instanceof _Endpoint.Endpoint))) throw new _EngineError.EngineError('Server endpoints should be declared and all be Endpoint instances');
+      if (config.checkEnvironment && Object.values(config.checkEnvironment).some(validator => typeof validator !== 'function')) throw new _EngineError.EngineError('Some of the environment checks are not valid functions');
+      if (config.initCallbacks && (!(config.initCallbacks instanceof Array) || config.initCallbacks.some(callback => !(typeof callback === 'function' || typeof callback?.function === 'function')))) throw new _EngineError.EngineError('Init callbacks is not a list of functions');
+      if (config.shutdownCallbacks && (!(config.shutdownCallbacks instanceof Array) || config.shutdownCallbacks.some(callback => !(typeof callback === 'function' || typeof callback?.function === 'function')))) throw new _EngineError.EngineError('Shutdown callbacks is not a list of functions');
+    }
+  }]);
+}();
+//# sourceMappingURL=Server.js.map

package/dist/entities/Server/Server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Server.js","names":["_fs","_interopRequireDefault","require","_path","_promises","_express","_ws","_SocketClient","_Server2","_Endpoint","_EngineError","_LifecycleController","_PubSub","_utils","_jwt","_report","_tlsConfig","namespace","Server","exports","config","_classCallCheck2","default","app","httpServer","secondaryApp","secondaryHttpServer","endpoints","checkEnvironment","globalMiddleware","errorMiddleware","initCallbacks","shutdownCallbacks","syncCallbacks","cron","auth","wss","abortController","AbortController","validate","reportDebug","message","noFetch","process","env","RUN_MIGRATION","UNDO_MIGRATION","SQL_HOST","envAssert","isHost","SQL_USER","isString","SQL_PASSWORD","SQL_DB","NODE_ENV","PORT","isPort","SECONDARY_PORT","express","registerMiddleware","createHttpServer","secondaryMiddleware","defaultErrorMiddleware","forEach","middleware","use","disable","server","headersTimeout","keepAliveTimeout","webSocket","attachWebSocket","_createClass2","key","value","init","initKeySets","callback","runCallback","Promise","all","map","PubSub","job","runCronJob","resolve","listen","reportInfo","data","port","secondaryPort","nodeEnv","handleSignal","watchTlsCaFileChange","shutdown","listening","address","on","error","reportError","exit","close","clients","socket","socketKillTimeout","WEBSOCKET_CLOSE_TIMEOUT","parseInt","setTimeout","readyState","CLOSING","OPEN","terminate","LifecycleController","shutdownRunningInstances","abort","shutdownKeySets","shutdownSignals","signal","removeAllListeners","getApp","getSecondaryApp","defaultMiddleware","path","endpoint","register","options","WebSocketServer","request","SocketClient","client","catch","file","fs","watch","event","loadTlsConfig","setSecureContext","tlsConfig","handler","name","interval","setTimeoutPromise","undefined","Error","function","apply","parameters","some","Endpoint","EngineError","Object","values","validator","Array"],"sources":["../../../src/entities/Server/Server.ts"],"sourcesContent":["import fs from 'fs';\nimport http from 'http';\nimport https from 'https';\nimport { AddressInfo } from 'net';\nimport path from 'path';\nimport { setTimeout as setTimeoutPromise } from 'timers/promises';\nimport { ValidatorSpec } from 'envalid';\nimport express, { Application } from 'express';\nimport { Server as WebSocketServer } from 'ws';\nimport { SocketClient } from '../SocketClient';\nimport {\n  defaultMiddleware,\n  defaultErrorMiddleware,\n  secondaryMiddleware,\n  shutdownSignals\n} from './Server.const';\nimport {\n  ServerOptions,\n  ServerCronJon,\n  ServerAuthConfig,\n  ServerWebSocketConfig,\n  ServerGlobalMiddleware,\n  ServerErrorMiddleWare,\n  ServerCallback\n} from './Server.types';\nimport { Endpoint } from 'entities/Endpoint';\nimport { EngineError } from 'entities/EngineError';\nimport { LifecycleController } from 'entities/LifecycleController';\nimport { PubSub } from 'entities/PubSub';\nimport { checkEnvironment, envAssert, createHttpServer } from 'utils';\nimport { initKeySets, shutdownKeySets } from 'utils/jwt';\nimport { reportInfo, reportError, reportDebug } from 'utils/report';\nimport { tlsConfig, loadTlsConfig, TlsConfig } from 'utils/tlsConfig';\n\nconst namespace = 'engine:Server';\n\n/** Main server class */\nexport class Server {\n  /** The express application powering the main endpoints */\n  private app: Application;\n  /** The node HTTP(S) server, serving the main express application */\n  private httpServer: http.Server | https.Server;\n  /** The express application powering the support endpoints */\n  private secondaryApp: Application;\n  /** The node HTTP(S) server, serving the secondary express application */\n  private secondaryHttpServer: http.Server | https.Server;\n  /** List of endpoint instances that the server should handle */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  private endpoints: Array<Endpoint<any>>;\n  /** Mapping of env variable name with functions that should run to check their validity */\n  private checkEnvironment: Record<string, ValidatorSpec<unknown>>;\n  /** Middleware that should run on every request before the endpoint specific logic */\n  private globalMiddleware: Array<ServerGlobalMiddleware>;\n  /** Error middleware that should run on every request after the endpoint specific logic, but before the generic global middleware */\n  private errorMiddleware: Array<\n    ServerGlobalMiddleware | ServerErrorMiddleWare\n  >;\n  /** Functions that should be called on server startup */\n  private initCallbacks: Array<ServerCallback>;\n  /** Functions that should be called on server shutdown */\n  private shutdownCallbacks: Array<ServerCallback>;\n  /** When set to true, this indicates that init callbacks should run synchronously in the order they are declared. By default they all run in parallel */\n  private syncCallbacks: boolean;\n  /** Config to set regularly running jobs on the server */\n  private cron?: Array<ServerCronJon>;\n  /** Global auth related configuration */\n  private auth: ServerAuthConfig;\n  /** WebSocket server instance, if configured */\n  private wss?: WebSocketServer;\n  /** Abort controller that handles signals for the server */\n  private abortController = new AbortController();\n\n  /** Create a server */\n  public constructor(config: ServerOptions) {\n    this.validate(config);\n\n    reportDebug({\n      namespace,\n      message: `Creating server`\n    });\n\n    this.endpoints = config.endpoints;\n    this.globalMiddleware = config.globalMiddleware ?? [];\n    this.errorMiddleware = config.errorMiddleware ?? [];\n    this.initCallbacks = config.initCallbacks ?? [];\n    this.shutdownCallbacks = config.shutdownCallbacks ?? [];\n    this.syncCallbacks = config.syncCallbacks ?? false;\n    this.cron = config.cron;\n    this.auth = { noFetch: false, ...config.auth };\n\n    // The minimal environment check is different between the migration modes of execution and the regular server execution mode\n    // When running in migration mode, we only check that we have SQL related environment variables\n    this.checkEnvironment =\n      process.env.RUN_MIGRATION === 'true' ||\n      process.env.UNDO_MIGRATION === 'true'\n        ? {\n            SQL_HOST: envAssert.isHost(),\n            SQL_USER: envAssert.isString(),\n            SQL_PASSWORD: envAssert.isString(),\n            SQL_DB: envAssert.isString()\n          }\n        : {\n            NODE_ENV: envAssert.isString(),\n            PORT: envAssert.isPort(),\n            SECONDARY_PORT: envAssert.isPort(),\n            ...config.checkEnvironment\n          };\n\n    checkEnvironment(this.checkEnvironment);\n\n    // Create the primary express core that serves the business logic\n    this.app = express();\n    this.registerMiddleware(this.app);\n    this.httpServer = createHttpServer(this.app);\n\n    // Create a secondary express core that servers metrics and analytics\n    // This will be served on a different port, allowing to specify different firewall rules for these routes\n    this.secondaryApp = express();\n    [...secondaryMiddleware, ...defaultErrorMiddleware].forEach(\n      (middleware) => {\n        if (middleware) this.secondaryApp.use(middleware);\n      }\n    );\n    this.secondaryHttpServer = createHttpServer(this.secondaryApp);\n\n    // Remove the express headers\n    this.app.disable('x-powered-by');\n    this.secondaryApp.disable('x-powered-by');\n\n    // We remove all node timeout on connections and requests\n    // This responsibility is delegated to the front-facing load balancer\n    [this.httpServer, this.secondaryHttpServer].forEach((server) => {\n      server.headersTimeout = 0;\n      server.keepAliveTimeout = 0;\n    });\n\n    if (config.webSocket) {\n      this.attachWebSocket(config.webSocket);\n    }\n  }\n\n  /** Start the server */\n  public async init(): Promise<void> {\n    reportDebug({ namespace, message: `Starting Server` });\n    // Fetch the keys for JWT authentication\n    // Ignore in test environment as we do symmetrical token signing\n    if (process.env.NODE_ENV !== 'test' && !this.auth.noFetch)\n      await initKeySets();\n    // Run all the init callbacks\n    // We can either run them all 1/1 synchronously or run them all in parallel (default)\n    // Callback can either be direct function or an object with function and parameters attributes\n\n    if (this.syncCallbacks) {\n      for (const callback of this.initCallbacks) {\n        await this.runCallback(callback);\n      }\n    } else {\n      await Promise.all(\n        this.initCallbacks.map((callback) => this.runCallback(callback))\n      );\n    }\n\n    // Initialize the Pub/Sub module\n    await PubSub.init();\n    // Run all the cronjob\n    if (this.cron) {\n      this.cron.forEach((job) => {\n        this.runCronJob(job);\n      });\n    }\n\n    // Start listening to requests\n    await Promise.all([\n      new Promise<void>((resolve) =>\n        this.httpServer.listen(process.env.PORT, () => {\n          resolve();\n        })\n      ),\n      new Promise<void>((resolve) =>\n        this.secondaryHttpServer.listen(process.env.SECONDARY_PORT, () => {\n          resolve();\n        })\n      )\n    ]);\n    reportInfo({\n      message: 'SERVER_RUNNING',\n      data: {\n        port: process.env.PORT,\n        secondaryPort: process.env.SECONDARY_PORT,\n        nodeEnv: process.env.NODE_ENV\n      }\n    });\n\n    this.handleSignal();\n\n    // Watch TSL config files changing\n    this.watchTlsCaFileChange();\n  }\n\n  /** Graceful shutdown */\n  public async shutdown(): Promise<void> {\n    reportDebug({ namespace, message: `Shutting down Server` });\n\n    // Stop listening to HTTP requests\n    await Promise.all(\n      [this.httpServer, this.secondaryHttpServer].map((server) => {\n        // Ignore if the server was already stopped\n        // We have observed cases where SIGTERM was thrown multiple times\n        if (!server.listening) return;\n        const { port } = server.address() as AddressInfo;\n        server.on('close', (error: unknown) => {\n          if (error) {\n            reportError(error);\n            process.exit(1);\n          } else {\n            reportInfo({\n              message: `Stopped listening to requests on port ${port}`\n            });\n          }\n        });\n        server.close();\n      })\n    );\n\n    // Close all socket connections\n    if (this.wss) {\n      // First ask then to close gracefully\n      this.wss.clients.forEach((socket) => {\n        socket.close();\n      });\n      // Hard terminate all connections still open after a defined time\n      const socketKillTimeout = process.env.WEBSOCKET_CLOSE_TIMEOUT\n        ? parseInt(process.env.WEBSOCKET_CLOSE_TIMEOUT)\n        : 5000;\n      await new Promise<void>((resolve) => {\n        setTimeout(() => {\n          (this.wss as WebSocketServer).clients.forEach((socket) => {\n            if (\n              socket.readyState === socket.CLOSING ||\n              socket.readyState === socket.OPEN\n            ) {\n              socket.terminate();\n            }\n          });\n          resolve();\n        }, socketKillTimeout);\n      });\n    }\n\n    // Run all the shutdown callback\n    if (this.syncCallbacks) {\n      for (const callback of this.shutdownCallbacks) {\n        await this.runCallback(callback);\n      }\n    } else {\n      await Promise.all(\n        this.shutdownCallbacks.map((callback) => this.runCallback(callback))\n      );\n    }\n\n    // Shutdown all the running entities\n    await LifecycleController.shutdownRunningInstances();\n\n    // Abort all the cronjob\n    if (this.abortController) this.abortController.abort();\n\n    // Stop the keyset timers\n    shutdownKeySets();\n\n    shutdownSignals.forEach((signal) => process.removeAllListeners(signal));\n  }\n\n  /** Get the express app instance of the server */\n  public getApp(): Application {\n    return this.app;\n  }\n\n  /** Get the express app instance of the server */\n  public getSecondaryApp(): Application {\n    return this.secondaryApp;\n  }\n\n  /** Registers all the middleware with the express app */\n  private registerMiddleware(app: Application): void {\n    // Global middleware can specify a path to which they apply\n    [...defaultMiddleware, ...this.globalMiddleware].forEach((middleware) => {\n      if (typeof middleware === 'function') {\n        app.use(middleware);\n      } else {\n        app.use(middleware.path, middleware.middleware);\n      }\n    });\n    // Call the register method of each endpoint\n    this.endpoints.forEach((endpoint) => {\n      endpoint.register(app);\n    });\n    // Add error middleware\n    [...this.errorMiddleware, ...defaultErrorMiddleware].forEach(\n      (middleware) => {\n        if (typeof middleware === 'function') {\n          app.use(middleware);\n        } else {\n          app.use(middleware.path, middleware.middleware);\n        }\n      }\n    );\n  }\n\n  /** Add a handler for WebSocket connections */\n  private attachWebSocket(options: ServerWebSocketConfig): void {\n    this.wss = new WebSocketServer({\n      ...options.server,\n      server: this.httpServer\n    })\n      .on('connection', (webSocket, request) => {\n        new SocketClient(webSocket, request, options.client);\n      })\n      .on('error', (error) => {\n        reportError(error);\n      });\n  }\n\n  /** Call shutdown if signal gets sent to the process */\n  private handleSignal(): void {\n    shutdownSignals.forEach((signal) =>\n      process.on(signal, () => {\n        (async (): Promise<void> => {\n          reportInfo(`Received shutdown signal [${signal}]`);\n          await this.shutdown();\n        })().catch((error) => {\n          reportError(error);\n        });\n      })\n    );\n  }\n\n  /** Watch the TLS certificate change event */\n  private watchTlsCaFileChange(): void {\n    [\n      'TLS_REQUEST_KEY',\n      'TLS_REQUEST_KEY_PASSPHRASE',\n      'TLS_REQUEST_CERT',\n      'TLS_REQUEST_CA',\n      'TLS_SERVER_KEY',\n      'TLS_SERVER_KEY_PASSPHRASE',\n      'TLS_SERVER_CERT',\n      'TLS_CA'\n    ].forEach((key) => {\n      const file = process.env[key];\n      if (file)\n        fs.watch(path.resolve(file), (event) => {\n          if (event !== 'change') return;\n          reportInfo(`Reloading TLS config [${file} changed]`);\n          loadTlsConfig();\n          (this.httpServer as https.Server).setSecureContext(\n            tlsConfig as TlsConfig\n          );\n        });\n    });\n  }\n\n  /** Executes a recurring job */\n  private runCronJob(job: ServerCronJon): void {\n    (async (): Promise<void> => {\n      reportInfo({ message: `Starting scheduled job \"${job.handler.name}\"` });\n      try {\n        await job.handler();\n        reportInfo({\n          message: `Job \"${job.handler.name}\" finished, starting again in ${job.interval} seconds`\n        });\n        await setTimeoutPromise(job.interval * 1000, undefined, {\n          signal: this.abortController.signal\n        });\n        this.runCronJob(job);\n      } catch (error) {\n        if (error instanceof Error && error.name === 'AbortError') {\n          reportDebug({\n            namespace,\n            message: `Scheduled job \"${job.handler?.name}\" has been aborted`\n          });\n        } else {\n          throw error;\n        }\n      }\n    })().catch((error) => {\n      reportError(error);\n    });\n  }\n\n  /** Run a shutdown/init callback */\n  private runCallback(callback: ServerCallback): unknown {\n    return typeof callback === 'function'\n      ? callback()\n      : callback.function.apply(null, callback.parameters ?? []);\n  }\n\n  /**\n   * Validate the Server constructor configuration\n   */\n  private validate(config: ServerOptions): void {\n    if (\n      !config.endpoints ||\n      config.endpoints.some((endpoint) => !(endpoint instanceof Endpoint))\n    )\n      throw new EngineError(\n        'Server endpoints should be declared and all be Endpoint instances'\n      );\n\n    if (\n      config.checkEnvironment &&\n      Object.values(config.checkEnvironment).some(\n        (validator) => typeof validator !== 'function'\n      )\n    )\n      throw new EngineError(\n        'Some of the environment checks are not valid functions'\n      );\n\n    if (\n      config.initCallbacks &&\n      (!(config.initCallbacks instanceof Array) ||\n        config.initCallbacks.some(\n          (callback) =>\n            !(\n              typeof callback === 'function' ||\n              typeof callback?.function === 'function'\n            )\n        ))\n    )\n      throw new EngineError('Init callbacks is not a list of functions');\n\n    if (\n      config.shutdownCallbacks &&\n      (!(config.shutdownCallbacks instanceof Array) ||\n        config.shutdownCallbacks.some(\n          (callback) =>\n            !(\n              typeof callback === 'function' ||\n              typeof callback?.function === 'function'\n            )\n        ))\n    )\n      throw new EngineError('Shutdown callbacks is not a list of functions');\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,IAAAA,GAAA,GAAAC,sBAAA,CAAAC,OAAA;AAIA,IAAAC,KAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AAEA,IAAAG,QAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,GAAA,GAAAJ,OAAA;AACA,IAAAK,aAAA,GAAAL,OAAA;AACA,IAAAM,QAAA,GAAAN,OAAA;AAeA,IAAAO,SAAA,GAAAP,OAAA;AACA,IAAAQ,YAAA,GAAAR,OAAA;AACA,IAAAS,oBAAA,GAAAT,OAAA;AACA,IAAAU,OAAA,GAAAV,OAAA;AACA,IAAAW,MAAA,GAAAX,OAAA;AACA,IAAAY,IAAA,GAAAZ,OAAA;AACA,IAAAa,OAAA,GAAAb,OAAA;AACA,IAAAc,UAAA,GAAAd,OAAA;AAEA,MAAMe,SAAS,GAAG,eAAe;;AAEjC;AAAA,IACaC,MAAM,GAAAC,OAAA,CAAAD,MAAA;EAmCjB;EACA,SAAAA,OAAmBE,MAAqB,EAAE;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAJ,MAAA;IAnC1C;IAAA,KACQK,GAAG;IACX;IAAA,KACQC,UAAU;IAClB;IAAA,KACQC,YAAY;IACpB;IAAA,KACQC,mBAAmB;IAC3B;IACA;IAAA,KACQC,SAAS;IACjB;IAAA,KACQC,gBAAgB;IACxB;IAAA,KACQC,gBAAgB;IACxB;IAAA,KACQC,eAAe;IAGvB;IAAA,KACQC,aAAa;IACrB;IAAA,KACQC,iBAAiB;IACzB;IAAA,KACQC,aAAa;IACrB;IAAA,KACQC,IAAI;IACZ;IAAA,KACQC,IAAI;IACZ;IAAA,KACQC,GAAG;IACX;IAAA,KACQC,eAAe,GAAG,IAAIC,eAAe,CAAC,CAAC;IAI7C,IAAI,CAACC,QAAQ,CAACnB,MAAM,CAAC;IAErB,IAAAoB,mBAAW,EAAC;MACVvB,SAAS;MACTwB,OAAO,EAAE;IACX,CAAC,CAAC;IAEF,IAAI,CAACd,SAAS,GAAGP,MAAM,CAACO,SAAS;IACjC,IAAI,CAACE,gBAAgB,GAAGT,MAAM,CAACS,gBAAgB,IAAI,EAAE;IACrD,IAAI,CAACC,eAAe,GAAGV,MAAM,CAACU,eAAe,IAAI,EAAE;IACnD,IAAI,CAACC,aAAa,GAAGX,MAAM,CAACW,aAAa,IAAI,EAAE;IAC/C,IAAI,CAACC,iBAAiB,GAAGZ,MAAM,CAACY,iBAAiB,IAAI,EAAE;IACvD,IAAI,CAACC,aAAa,GAAGb,MAAM,CAACa,aAAa,IAAI,KAAK;IAClD,IAAI,CAACC,IAAI,GAAGd,MAAM,CAACc,IAAI;IACvB,IAAI,CAACC,IAAI,GAAG;MAAEO,OAAO,EAAE,KAAK;MAAE,GAAGtB,MAAM,CAACe;IAAK,CAAC;;IAE9C;IACA;IACA,IAAI,CAACP,gBAAgB,GACnBe,OAAO,CAACC,GAAG,CAACC,aAAa,KAAK,MAAM,IACpCF,OAAO,CAACC,GAAG,CAACE,cAAc,KAAK,MAAM,GACjC;MACEC,QAAQ,EAAEC,gBAAS,CAACC,MAAM,CAAC,CAAC;MAC5BC,QAAQ,EAAEF,gBAAS,CAACG,QAAQ,CAAC,CAAC;MAC9BC,YAAY,EAAEJ,gBAAS,CAACG,QAAQ,CAAC,CAAC;MAClCE,MAAM,EAAEL,gBAAS,CAACG,QAAQ,CAAC;IAC7B,CAAC,GACD;MACEG,QAAQ,EAAEN,gBAAS,CAACG,QAAQ,CAAC,CAAC;MAC9BI,IAAI,EAAEP,gBAAS,CAACQ,MAAM,CAAC,CAAC;MACxBC,cAAc,EAAET,gBAAS,CAACQ,MAAM,CAAC,CAAC;MAClC,GAAGpC,MAAM,CAACQ;IACZ,CAAC;IAEP,IAAAA,uBAAgB,EAAC,IAAI,CAACA,gBAAgB,CAAC;;IAEvC;IACA,IAAI,CAACL,GAAG,GAAG,IAAAmC,gBAAO,EAAC,CAAC;IACpB,IAAI,CAACC,kBAAkB,CAAC,IAAI,CAACpC,GAAG,CAAC;IACjC,IAAI,CAACC,UAAU,GAAG,IAAAoC,uBAAgB,EAAC,IAAI,CAACrC,GAAG,CAAC;;IAE5C;IACA;IACA,IAAI,CAACE,YAAY,GAAG,IAAAiC,gBAAO,EAAC,CAAC;IAC7B,CAAC,GAAGG,4BAAmB,EAAE,GAAGC,+BAAsB,CAAC,CAACC,OAAO,CACxDC,UAAU,IAAK;MACd,IAAIA,UAAU,EAAE,IAAI,CAACvC,YAAY,CAACwC,GAAG,CAACD,UAAU,CAAC;IACnD,CACF,CAAC;IACD,IAAI,CAACtC,mBAAmB,GAAG,IAAAkC,uBAAgB,EAAC,IAAI,CAACnC,YAAY,CAAC;;IAE9D;IACA,IAAI,CAACF,GAAG,CAAC2C,OAAO,CAAC,cAAc,CAAC;IAChC,IAAI,CAACzC,YAAY,CAACyC,OAAO,CAAC,cAAc,CAAC;;IAEzC;IACA;IACA,CAAC,IAAI,CAAC1C,UAAU,EAAE,IAAI,CAACE,mBAAmB,CAAC,CAACqC,OAAO,CAAEI,MAAM,IAAK;MAC9DA,MAAM,CAACC,cAAc,GAAG,CAAC;MACzBD,MAAM,CAACE,gBAAgB,GAAG,CAAC;IAC7B,CAAC,CAAC;IAEF,IAAIjD,MAAM,CAACkD,SAAS,EAAE;MACpB,IAAI,CAACC,eAAe,CAACnD,MAAM,CAACkD,SAAS,CAAC;IACxC;EACF;;EAEA;EAAA,WAAAE,aAAA,CAAAlD,OAAA,EAAAJ,MAAA;IAAAuD,GAAA;IAAAC,KAAA,EACA,eAAaC,IAAIA,CAAA,EAAkB;MACjC,IAAAnC,mBAAW,EAAC;QAAEvB,SAAS;QAAEwB,OAAO,EAAE;MAAkB,CAAC,CAAC;MACtD;MACA;MACA,IAAIE,OAAO,CAACC,GAAG,CAACU,QAAQ,KAAK,MAAM,IAAI,CAAC,IAAI,CAACnB,IAAI,CAACO,OAAO,EACvD,MAAM,IAAAkC,gBAAW,EAAC,CAAC;MACrB;MACA;MACA;;MAEA,IAAI,IAAI,CAAC3C,aAAa,EAAE;QACtB,KAAK,MAAM4C,QAAQ,IAAI,IAAI,CAAC9C,aAAa,EAAE;UACzC,MAAM,IAAI,CAAC+C,WAAW,CAACD,QAAQ,CAAC;QAClC;MACF,CAAC,MAAM;QACL,MAAME,OAAO,CAACC,GAAG,CACf,IAAI,CAACjD,aAAa,CAACkD,GAAG,CAAEJ,QAAQ,IAAK,IAAI,CAACC,WAAW,CAACD,QAAQ,CAAC,CACjE,CAAC;MACH;;MAEA;MACA,MAAMK,cAAM,CAACP,IAAI,CAAC,CAAC;MACnB;MACA,IAAI,IAAI,CAACzC,IAAI,EAAE;QACb,IAAI,CAACA,IAAI,CAAC6B,OAAO,CAAEoB,GAAG,IAAK;UACzB,IAAI,CAACC,UAAU,CAACD,GAAG,CAAC;QACtB,CAAC,CAAC;MACJ;;MAEA;MACA,MAAMJ,OAAO,CAACC,GAAG,CAAC,CAChB,IAAID,OAAO,CAAQM,OAAO,IACxB,IAAI,CAAC7D,UAAU,CAAC8D,MAAM,CAAC3C,OAAO,CAACC,GAAG,CAACW,IAAI,EAAE,MAAM;QAC7C8B,OAAO,CAAC,CAAC;MACX,CAAC,CACH,CAAC,EACD,IAAIN,OAAO,CAAQM,OAAO,IACxB,IAAI,CAAC3D,mBAAmB,CAAC4D,MAAM,CAAC3C,OAAO,CAACC,GAAG,CAACa,cAAc,EAAE,MAAM;QAChE4B,OAAO,CAAC,CAAC;MACX,CAAC,CACH,CAAC,CACF,CAAC;MACF,IAAAE,kBAAU,EAAC;QACT9C,OAAO,EAAE,gBAAgB;QACzB+C,IAAI,EAAE;UACJC,IAAI,EAAE9C,OAAO,CAACC,GAAG,CAACW,IAAI;UACtBmC,aAAa,EAAE/C,OAAO,CAACC,GAAG,CAACa,cAAc;UACzCkC,OAAO,EAAEhD,OAAO,CAACC,GAAG,CAACU;QACvB;MACF,CAAC,CAAC;MAEF,IAAI,CAACsC,YAAY,CAAC,CAAC;;MAEnB;MACA,IAAI,CAACC,oBAAoB,CAAC,CAAC;IAC7B;;IAEA;EAAA;IAAApB,GAAA;IAAAC,KAAA,EACA,eAAaoB,QAAQA,CAAA,EAAkB;MACrC,IAAAtD,mBAAW,EAAC;QAAEvB,SAAS;QAAEwB,OAAO,EAAE;MAAuB,CAAC,CAAC;;MAE3D;MACA,MAAMsC,OAAO,CAACC,GAAG,CACf,CAAC,IAAI,CAACxD,UAAU,EAAE,IAAI,CAACE,mBAAmB,CAAC,CAACuD,GAAG,CAAEd,MAAM,IAAK;QAC1D;QACA;QACA,IAAI,CAACA,MAAM,CAAC4B,SAAS,EAAE;QACvB,MAAM;UAAEN;QAAK,CAAC,GAAGtB,MAAM,CAAC6B,OAAO,CAAC,CAAgB;QAChD7B,MAAM,CAAC8B,EAAE,CAAC,OAAO,EAAGC,KAAc,IAAK;UACrC,IAAIA,KAAK,EAAE;YACT,IAAAC,mBAAW,EAACD,KAAK,CAAC;YAClBvD,OAAO,CAACyD,IAAI,CAAC,CAAC,CAAC;UACjB,CAAC,MAAM;YACL,IAAAb,kBAAU,EAAC;cACT9C,OAAO,EAAE,yCAAyCgD,IAAI;YACxD,CAAC,CAAC;UACJ;QACF,CAAC,CAAC;QACFtB,MAAM,CAACkC,KAAK,CAAC,CAAC;MAChB,CAAC,CACH,CAAC;;MAED;MACA,IAAI,IAAI,CAACjE,GAAG,EAAE;QACZ;QACA,IAAI,CAACA,GAAG,CAACkE,OAAO,CAACvC,OAAO,CAAEwC,MAAM,IAAK;UACnCA,MAAM,CAACF,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC;QACF;QACA,MAAMG,iBAAiB,GAAG7D,OAAO,CAACC,GAAG,CAAC6D,uBAAuB,GACzDC,QAAQ,CAAC/D,OAAO,CAACC,GAAG,CAAC6D,uBAAuB,CAAC,GAC7C,IAAI;QACR,MAAM,IAAI1B,OAAO,CAAQM,OAAO,IAAK;UACnCsB,UAAU,CAAC,MAAM;YACd,IAAI,CAACvE,GAAG,CAAqBkE,OAAO,CAACvC,OAAO,CAAEwC,MAAM,IAAK;cACxD,IACEA,MAAM,CAACK,UAAU,KAAKL,MAAM,CAACM,OAAO,IACpCN,MAAM,CAACK,UAAU,KAAKL,MAAM,CAACO,IAAI,EACjC;gBACAP,MAAM,CAACQ,SAAS,CAAC,CAAC;cACpB;YACF,CAAC,CAAC;YACF1B,OAAO,CAAC,CAAC;UACX,CAAC,EAAEmB,iBAAiB,CAAC;QACvB,CAAC,CAAC;MACJ;;MAEA;MACA,IAAI,IAAI,CAACvE,aAAa,EAAE;QACtB,KAAK,MAAM4C,QAAQ,IAAI,IAAI,CAAC7C,iBAAiB,EAAE;UAC7C,MAAM,IAAI,CAAC8C,WAAW,CAACD,QAAQ,CAAC;QAClC;MACF,CAAC,MAAM;QACL,MAAME,OAAO,CAACC,GAAG,CACf,IAAI,CAAChD,iBAAiB,CAACiD,GAAG,CAAEJ,QAAQ,IAAK,IAAI,CAACC,WAAW,CAACD,QAAQ,CAAC,CACrE,CAAC;MACH;;MAEA;MACA,MAAMmC,wCAAmB,CAACC,wBAAwB,CAAC,CAAC;;MAEpD;MACA,IAAI,IAAI,CAAC5E,eAAe,EAAE,IAAI,CAACA,eAAe,CAAC6E,KAAK,CAAC,CAAC;;MAEtD;MACA,IAAAC,oBAAe,EAAC,CAAC;MAEjBC,wBAAe,CAACrD,OAAO,CAAEsD,MAAM,IAAK1E,OAAO,CAAC2E,kBAAkB,CAACD,MAAM,CAAC,CAAC;IACzE;;IAEA;EAAA;IAAA5C,GAAA;IAAAC,KAAA,EACA,SAAO6C,MAAMA,CAAA,EAAgB;MAC3B,OAAO,IAAI,CAAChG,GAAG;IACjB;;IAEA;EAAA;IAAAkD,GAAA;IAAAC,KAAA,EACA,SAAO8C,eAAeA,CAAA,EAAgB;MACpC,OAAO,IAAI,CAAC/F,YAAY;IAC1B;;IAEA;EAAA;IAAAgD,GAAA;IAAAC,KAAA,EACA,SAAQf,kBAAkBA,CAACpC,GAAgB,EAAQ;MACjD;MACA,CAAC,GAAGkG,0BAAiB,EAAE,GAAG,IAAI,CAAC5F,gBAAgB,CAAC,CAACkC,OAAO,CAAEC,UAAU,IAAK;QACvE,IAAI,OAAOA,UAAU,KAAK,UAAU,EAAE;UACpCzC,GAAG,CAAC0C,GAAG,CAACD,UAAU,CAAC;QACrB,CAAC,MAAM;UACLzC,GAAG,CAAC0C,GAAG,CAACD,UAAU,CAAC0D,IAAI,EAAE1D,UAAU,CAACA,UAAU,CAAC;QACjD;MACF,CAAC,CAAC;MACF;MACA,IAAI,CAACrC,SAAS,CAACoC,OAAO,CAAE4D,QAAQ,IAAK;QACnCA,QAAQ,CAACC,QAAQ,CAACrG,GAAG,CAAC;MACxB,CAAC,CAAC;MACF;MACA,CAAC,GAAG,IAAI,CAACO,eAAe,EAAE,GAAGgC,+BAAsB,CAAC,CAACC,OAAO,CACzDC,UAAU,IAAK;QACd,IAAI,OAAOA,UAAU,KAAK,UAAU,EAAE;UACpCzC,GAAG,CAAC0C,GAAG,CAACD,UAAU,CAAC;QACrB,CAAC,MAAM;UACLzC,GAAG,CAAC0C,GAAG,CAACD,UAAU,CAAC0D,IAAI,EAAE1D,UAAU,CAACA,UAAU,CAAC;QACjD;MACF,CACF,CAAC;IACH;;IAEA;EAAA;IAAAS,GAAA;IAAAC,KAAA,EACA,SAAQH,eAAeA,CAACsD,OAA8B,EAAQ;MAC5D,IAAI,CAACzF,GAAG,GAAG,IAAI0F,UAAe,CAAC;QAC7B,GAAGD,OAAO,CAAC1D,MAAM;QACjBA,MAAM,EAAE,IAAI,CAAC3C;MACf,CAAC,CAAC,CACCyE,EAAE,CAAC,YAAY,EAAE,CAAC3B,SAAS,EAAEyD,OAAO,KAAK;QACxC,IAAIC,0BAAY,CAAC1D,SAAS,EAAEyD,OAAO,EAAEF,OAAO,CAACI,MAAM,CAAC;MACtD,CAAC,CAAC,CACDhC,EAAE,CAAC,OAAO,EAAGC,KAAK,IAAK;QACtB,IAAAC,mBAAW,EAACD,KAAK,CAAC;MACpB,CAAC,CAAC;IACN;;IAEA;EAAA;IAAAzB,GAAA;IAAAC,KAAA,EACA,SAAQkB,YAAYA,CAAA,EAAS;MAC3BwB,wBAAe,CAACrD,OAAO,CAAEsD,MAAM,IAC7B1E,OAAO,CAACsD,EAAE,CAACoB,MAAM,EAAE,MAAM;QACvB,CAAC,YAA2B;UAC1B,IAAA9B,kBAAU,EAAC,6BAA6B8B,MAAM,GAAG,CAAC;UAClD,MAAM,IAAI,CAACvB,QAAQ,CAAC,CAAC;QACvB,CAAC,EAAE,CAAC,CAACoC,KAAK,CAAEhC,KAAK,IAAK;UACpB,IAAAC,mBAAW,EAACD,KAAK,CAAC;QACpB,CAAC,CAAC;MACJ,CAAC,CACH,CAAC;IACH;;IAEA;EAAA;IAAAzB,GAAA;IAAAC,KAAA,EACA,SAAQmB,oBAAoBA,CAAA,EAAS;MACnC,CACE,iBAAiB,EACjB,4BAA4B,EAC5B,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,2BAA2B,EAC3B,iBAAiB,EACjB,QAAQ,CACT,CAAC9B,OAAO,CAAEU,GAAG,IAAK;QACjB,MAAM0D,IAAI,GAAGxF,OAAO,CAACC,GAAG,CAAC6B,GAAG,CAAC;QAC7B,IAAI0D,IAAI,EACNC,WAAE,CAACC,KAAK,CAACX,aAAI,CAACrC,OAAO,CAAC8C,IAAI,CAAC,EAAGG,KAAK,IAAK;UACtC,IAAIA,KAAK,KAAK,QAAQ,EAAE;UACxB,IAAA/C,kBAAU,EAAC,yBAAyB4C,IAAI,WAAW,CAAC;UACpD,IAAAI,wBAAa,EAAC,CAAC;UACd,IAAI,CAAC/G,UAAU,CAAkBgH,gBAAgB,CAChDC,oBACF,CAAC;QACH,CAAC,CAAC;MACN,CAAC,CAAC;IACJ;;IAEA;EAAA;IAAAhE,GAAA;IAAAC,KAAA,EACA,SAAQU,UAAUA,CAACD,GAAkB,EAAQ;MAC3C,CAAC,YAA2B;QAC1B,IAAAI,kBAAU,EAAC;UAAE9C,OAAO,EAAE,2BAA2B0C,GAAG,CAACuD,OAAO,CAACC,IAAI;QAAI,CAAC,CAAC;QACvE,IAAI;UACF,MAAMxD,GAAG,CAACuD,OAAO,CAAC,CAAC;UACnB,IAAAnD,kBAAU,EAAC;YACT9C,OAAO,EAAE,QAAQ0C,GAAG,CAACuD,OAAO,CAACC,IAAI,iCAAiCxD,GAAG,CAACyD,QAAQ;UAChF,CAAC,CAAC;UACF,MAAM,IAAAC,oBAAiB,EAAC1D,GAAG,CAACyD,QAAQ,GAAG,IAAI,EAAEE,SAAS,EAAE;YACtDzB,MAAM,EAAE,IAAI,CAAChF,eAAe,CAACgF;UAC/B,CAAC,CAAC;UACF,IAAI,CAACjC,UAAU,CAACD,GAAG,CAAC;QACtB,CAAC,CAAC,OAAOe,KAAK,EAAE;UACd,IAAIA,KAAK,YAAY6C,KAAK,IAAI7C,KAAK,CAACyC,IAAI,KAAK,YAAY,EAAE;YACzD,IAAAnG,mBAAW,EAAC;cACVvB,SAAS;cACTwB,OAAO,EAAE,kBAAkB0C,GAAG,CAACuD,OAAO,EAAEC,IAAI;YAC9C,CAAC,CAAC;UACJ,CAAC,MAAM;YACL,MAAMzC,KAAK;UACb;QACF;MACF,CAAC,EAAE,CAAC,CAACgC,KAAK,CAAEhC,KAAK,IAAK;QACpB,IAAAC,mBAAW,EAACD,KAAK,CAAC;MACpB,CAAC,CAAC;IACJ;;IAEA;EAAA;IAAAzB,GAAA;IAAAC,KAAA,EACA,SAAQI,WAAWA,CAACD,QAAwB,EAAW;MACrD,OAAO,OAAOA,QAAQ,KAAK,UAAU,GACjCA,QAAQ,CAAC,CAAC,GACVA,QAAQ,CAACmE,QAAQ,CAACC,KAAK,CAAC,IAAI,EAAEpE,QAAQ,CAACqE,UAAU,IAAI,EAAE,CAAC;IAC9D;;IAEA;AACF;AACA;EAFE;IAAAzE,GAAA;IAAAC,KAAA,EAGA,SAAQnC,QAAQA,CAACnB,MAAqB,EAAQ;MAC5C,IACE,CAACA,MAAM,CAACO,SAAS,IACjBP,MAAM,CAACO,SAAS,CAACwH,IAAI,CAAExB,QAAQ,IAAK,EAAEA,QAAQ,YAAYyB,kBAAQ,CAAC,CAAC,EAEpE,MAAM,IAAIC,wBAAW,CACnB,mEACF,CAAC;MAEH,IACEjI,MAAM,CAACQ,gBAAgB,IACvB0H,MAAM,CAACC,MAAM,CAACnI,MAAM,CAACQ,gBAAgB,CAAC,CAACuH,IAAI,CACxCK,SAAS,IAAK,OAAOA,SAAS,KAAK,UACtC,CAAC,EAED,MAAM,IAAIH,wBAAW,CACnB,wDACF,CAAC;MAEH,IACEjI,MAAM,CAACW,aAAa,KACnB,EAAEX,MAAM,CAACW,aAAa,YAAY0H,KAAK,CAAC,IACvCrI,MAAM,CAACW,aAAa,CAACoH,IAAI,CACtBtE,QAAQ,IACP,EACE,OAAOA,QAAQ,KAAK,UAAU,IAC9B,OAAOA,QAAQ,EAAEmE,QAAQ,KAAK,UAAU,CAE9C,CAAC,CAAC,EAEJ,MAAM,IAAIK,wBAAW,CAAC,2CAA2C,CAAC;MAEpE,IACEjI,MAAM,CAACY,iBAAiB,KACvB,EAAEZ,MAAM,CAACY,iBAAiB,YAAYyH,KAAK,CAAC,IAC3CrI,MAAM,CAACY,iBAAiB,CAACmH,IAAI,CAC1BtE,QAAQ,IACP,EACE,OAAOA,QAAQ,KAAK,UAAU,IAC9B,OAAOA,QAAQ,EAAEmE,QAAQ,KAAK,UAAU,CAE9C,CAAC,CAAC,EAEJ,MAAM,IAAIK,wBAAW,CAAC,+CAA+C,CAAC;IAC1E;EAAC;AAAA","ignoreList":[]}

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

@@ -0,0 +1,75 @@
+import { ValidatorSpec } from 'envalid';
+import { ErrorRequestHandler, RequestHandler } from 'express';
+import { ServerOptions as WebSocketServerOptions } from 'ws';
+import { Endpoint } from '../../entities/Endpoint';
+import { SocketClientOptions } from '../../entities/SocketClient';
+/** Options to create a server */
+export interface ServerOptions {
+    /** List of endpoint instances that the server should handle */
+    endpoints: Array<Endpoint<any>>;
+    /** Mapping of env variable name with functions that should run to check their validity */
+    checkEnvironment?: Record<string, ValidatorSpec<unknown>>;
+    /** Middleware that should run on every request before the endpoint specific logic */
+    globalMiddleware?: Array<ServerGlobalMiddleware>;
+    /** Error middleware that should run on every request after the endpoint specific logic, but before the generic global middleware */
+    errorMiddleware?: Array<ServerGlobalMiddleware | ServerErrorMiddleWare>;
+    /** Functions that should be called on server startup */
+    initCallbacks?: Array<ServerCallback>;
+    /** Functions that should be called on server shutdown */
+    shutdownCallbacks?: Array<ServerCallback>;
+    /** When set to true, this indicates that init callbacks should run synchronously in the order they are declared. By default they all run in parallel */
+    syncCallbacks?: boolean;
+    /** Config to set regularly running jobs on the server */
+    cron?: Array<ServerCronJon>;
+    /** Global auth related configuration */
+    auth?: ServerAuthConfig;
+    /** Configuration to enable webSocket connections to the server */
+    webSocket?: ServerWebSocketConfig;
+}
+/** Options for a CRON task on the server */
+export interface ServerCronJon {
+    /** Function that is called when the job needs to run */
+    handler: () => unknown;
+    /** Interval (in seconds) between each job execution. The interval starts after the previous execution finished */
+    interval: number;
+    /** When this is set, the job is only run on the instance that is that has been elected leader of the service */
+    leaderOnly?: boolean;
+}
+/** Common server authentication related config */
+export interface ServerAuthConfig {
+    /** Do not fetch JWT authentication parameters, this should be used on servers that do not receive public requests and therefore do not need access to the authentication service */
+    noFetch?: boolean;
+}
+/** Configuration for WebSocket on this server */
+export interface ServerWebSocketConfig {
+    /** Options to pass to create the webSocket server */
+    server: WebSocketServerOptions;
+    /** Options to pass when creating socket client instances */
+    client: SocketClientOptions;
+}
+/** Middleware function definition with path */
+export interface ServerObjectGlobalMiddleware {
+    /** Path on which the middleware is used */
+    path: string;
+    /** Middleware function */
+    middleware: RequestHandler;
+}
+export type ServerGlobalMiddleware = RequestHandler | ServerObjectGlobalMiddleware;
+/** Error middleware function definition with path */
+export interface ServerObjectErrorMiddleware {
+    /** Path on which the middleware is used */
+    path: string;
+    /** Middleware function */
+    middleware: ErrorRequestHandler;
+}
+export type ServerErrorMiddleWare = ErrorRequestHandler | ServerObjectErrorMiddleware;
+type ServerFunctionCallback = (...args: Array<unknown>) => unknown;
+/** Callback definition with parameters */
+interface ServerObjectCallback {
+    /** Callback function */
+    function: ServerFunctionCallback;
+    /** Parameters to pass to the callback function */
+    parameters?: Parameters<ServerFunctionCallback>;
+}
+export type ServerCallback = ServerFunctionCallback | ServerObjectCallback;
+export {};

package/dist/entities/Server/Server.types.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Server.types.js","names":[],"sources":["../../../src/entities/Server/Server.types.ts"],"sourcesContent":["import { ValidatorSpec } from 'envalid';\nimport { ErrorRequestHandler, RequestHandler } from 'express';\nimport { ServerOptions as WebSocketServerOptions } from 'ws';\nimport { Endpoint } from 'entities/Endpoint';\nimport { SocketClientOptions } from 'entities/SocketClient';\n\n/** Options to create a server */\nexport interface ServerOptions {\n  /** List of endpoint instances that the server should handle */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  endpoints: Array<Endpoint<any>>;\n  /** Mapping of env variable name with functions that should run to check their validity */\n  checkEnvironment?: Record<string, ValidatorSpec<unknown>>;\n  /** Middleware that should run on every request before the endpoint specific logic */\n  globalMiddleware?: Array<ServerGlobalMiddleware>;\n  /** Error middleware that should run on every request after the endpoint specific logic, but before the generic global middleware */\n  errorMiddleware?: Array<ServerGlobalMiddleware | ServerErrorMiddleWare>;\n  /** Functions that should be called on server startup */\n  initCallbacks?: Array<ServerCallback>;\n  /** Functions that should be called on server shutdown */\n  shutdownCallbacks?: Array<ServerCallback>;\n  /** When set to true, this indicates that init callbacks should run synchronously in the order they are declared. By default they all run in parallel */\n  syncCallbacks?: boolean;\n  /** Config to set regularly running jobs on the server */\n  cron?: Array<ServerCronJon>;\n  /** Global auth related configuration */\n  auth?: ServerAuthConfig;\n  /** Configuration to enable webSocket connections to the server */\n  webSocket?: ServerWebSocketConfig;\n}\n\n/** Options for a CRON task on the server */\nexport interface ServerCronJon {\n  /** Function that is called when the job needs to run */\n  handler: () => unknown;\n  /** Interval (in seconds) between each job execution. The interval starts after the previous execution finished */\n  interval: number;\n  /** When this is set, the job is only run on the instance that is that has been elected leader of the service */\n  leaderOnly?: boolean;\n}\n\n/** Common server authentication related config */\nexport interface ServerAuthConfig {\n  /** Do not fetch JWT authentication parameters, this should be used on servers that do not receive public requests and therefore do not need access to the authentication service */\n  noFetch?: boolean;\n}\n\n/** Configuration for WebSocket on this server */\nexport interface ServerWebSocketConfig {\n  /** Options to pass to create the webSocket server */\n  server: WebSocketServerOptions;\n  /** Options to pass when creating socket client instances */\n  client: SocketClientOptions;\n}\n\n/** Middleware function definition with path */\nexport interface ServerObjectGlobalMiddleware {\n  /** Path on which the middleware is used */\n  path: string;\n  /** Middleware function */\n  middleware: RequestHandler;\n}\nexport type ServerGlobalMiddleware =\n  | RequestHandler\n  | ServerObjectGlobalMiddleware;\n\n/** Error middleware function definition with path */\nexport interface ServerObjectErrorMiddleware {\n  /** Path on which the middleware is used */\n  path: string;\n  /** Middleware function */\n  middleware: ErrorRequestHandler;\n}\nexport type ServerErrorMiddleWare =\n  | ErrorRequestHandler\n  | ServerObjectErrorMiddleware;\n\ntype ServerFunctionCallback = (...args: Array<unknown>) => unknown;\n\n/** Callback definition with parameters */\ninterface ServerObjectCallback {\n  /** Callback function */\n  function: ServerFunctionCallback;\n  /** Parameters to pass to the callback function */\n  parameters?: Parameters<ServerFunctionCallback>;\n}\n\nexport type ServerCallback = ServerFunctionCallback | ServerObjectCallback;\n"],"mappings":"","ignoreList":[]}

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

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

package/dist/entities/Server/index.js

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

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

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

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

@@ -0,0 +1,79 @@
+import { IncomingMessage } from 'http';
+import WS from 'ws';
+import { SocketClientOptions, SocketClientSendMessageOptions, SocketClientList, SocketUser } from './SocketClient.types';
+/**
+ * Class where each instance represents a client connected through web-sockets
+ */
+export declare class SocketClient {
+    /** Mapping of all the connected socket clients */
+    private static socketClients;
+    /** Unique identifier of the client */
+    readonly id: string;
+    /** Date at which the client connection was established */
+    readonly establishedAt: Date;
+    /** WS instance of the client connection */
+    private ws;
+    /** List of message handlers that are registered with the client */
+    private handlers;
+    /** Callback function that are called when the client is created */
+    private initCallbacks;
+    /** Callback function that are called when the client successfully authenticates */
+    private authCallbacks;
+    /** Callback function that are called when the client connection is terminated */
+    private shutdownCallbacks;
+    /** Authentication status of the client */
+    private authenticated;
+    /** Timer used to track when to send authentication renewal reminder to the client */
+    private authRenewTimer;
+    /** Timers used to track the time at which a user losses authentication */
+    private authExpireTimer;
+    /** ID of the user that is authenticated */
+    private userId;
+    /** ID of the device with which the client authenticated */
+    private deviceId;
+    /** Id of the token with which the client authenticated */
+    private tokenId;
+    /** Audience claims that were in the latest authentication token used by the client */
+    private audience;
+    /** Status tracking variable used to check the liveness of connections */
+    private isAlive;
+    /** Timer used to track interval between client pinging */
+    private pingInterval;
+    /**
+     * Create a WS client
+     */
+    constructor(webSocket: WS, request: IncomingMessage, options: SocketClientOptions);
+    /** Get the list of all connected clients indexed by ID */
+    static getSocketClients(): SocketClientList;
+    /** Get a client by his ID */
+    static getSocketClient(id: string): SocketClient | undefined;
+    /**
+     * Send a message to the client
+     */
+    sendMessage(type: string, payload?: unknown, options?: SocketClientSendMessageOptions): void;
+    /** Get the client authentication status */
+    isAuthenticated(): boolean;
+    /** Fetch data on the user if he is authenticated */
+    getUser(): SocketUser | undefined;
+    /** Process an incoming message */
+    private handleMessage;
+    /**
+     * Process an authentication request
+     * @param {String} message - Authentication message
+     */
+    private authenticate;
+    /** */
+    private clearTimeouts;
+    /**
+     * 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.
+     */
+    private setUserData;
+    /**
+     * Properly return errors to clients
+     */
+    private handleError;
+    /**
+     * Process a socket close event
+     */
+    private handleClose;
+}