jimpex 8.0.0 → 10.0.0

package/dist/esm/app/jimpex.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../chunk-T2T6Q22Z.js";
+} from "../chunk-F3FYYIAV.js";
 import * as path from "path";
 import fs from "fs/promises";
 import { createServer as createHTTPSServer } from "https";
@@ -11,6 +11,7 @@ import { envUtilsProvider } from "@homer0/env-utils";
 import { packageInfoProvider } from "@homer0/package-info";
 import { pathUtilsProvider } from "@homer0/path-utils";
 import { rootFileProvider } from "@homer0/root-file";
+import { tsAsyncImport } from "@homer0/ts-async-import";
 import { EventsHub } from "@homer0/events-hub";
 import { simpleConfigProvider } from "@homer0/simple-config";
 import compression from "compression";
@@ -29,14 +30,50 @@ import {
   statuses
 } from "../utils";
 class Jimpex extends Jimple {
+  /**
+   * @param options  Preferences to customize the application.
+   * @param config   The default settings for the configuration service. It's a
+   *                 shortcuit for `options.config.default`
+   */
   constructor(options = {}, config = {}) {
     super();
+    /**
+     * The customization settings for the application.
+     */
     __publicField(this, "_options");
+    /**
+     * The Express application Jimpex uses under the hood.
+     */
     __publicField(this, "_express");
+    /**
+     * Since the configuration service has an async initialization, the class uses this flag
+     * internally to validate if the configuration has been initialized or not.
+     */
     __publicField(this, "_configReady", false);
+    /**
+     * A reference to the actuall HTTP the application will use. This can vary depending on
+     * whether HTTPS, or HTTP2 are enabled. If HTTPS is not enabled, it will be the same as
+     * the `express` property; if HTTPS is enabled, it will be an `https` server; and if
+     * HTTP2 is enabled, it will be an `spdy` server.
+     */
     __publicField(this, "_server");
+    /**
+     * The instance of the server that is listening for requests.
+     */
     __publicField(this, "_instance");
+    /**
+     * A list of functions that implement controllers and middlewares. When the application
+     * starts, the queue will be processed and those controllers and middlewares will be
+     * added to the server instance. The reason they are not added directly like with a
+     * regular Express implementation is that services on Jimple use lazy loading, and
+     * adding middlewares and controllers as they come could cause errors if they depend on
+     * services that are not yet registered.
+     */
     __publicField(this, "_mountQueue", []);
+    /**
+     * A list with all the top routes controlled by the application. Every time a controller
+     * is mounted, its route will be added here.
+     */
     __publicField(this, "_controlledRoutes", []);
     this._options = deepAssignWithOverwrite(
       {
@@ -87,14 +124,26 @@ class Jimpex extends Jimple {
       this.boot();
     }
   }
+  /**
+   * This is where the app would register all its specific services, middlewares and controllers.
+   */
   boot() {
   }
+  /**
+   * Disables the server TLS validation. Meant to be used for development purposes.
+   */
   disableTLSValidation() {
     process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
     this.logger.warn("TLS validation has been disabled");
   }
+  /**
+   * Starts the app server.
+   *
+   * @param onStart  A callback function to be called when the server actually starts.
+   * @returns The server instance.
+   */
   async start(onStart) {
-    await this._setupConfig();
+    await Promise.all([this._setupConfig(), this._loadESMModules()]);
     const config = this.getConfig();
     const port = config.get("port");
     if (!port) {
@@ -114,14 +163,28 @@ class Jimpex extends Jimple {
     });
     return this._instance;
   }
+  /**
+   * This is an alias of `start`. The idea is for it to be used on serverless platforms,
+   * where you don't get to start your app, you just have export it.
+   *
+   * @param port     In case the configuration doesn't already have it,
+   *                 this is the port where the application will use to run. If this
+   *                 parameter is used, the method will overwrite the `port`
+   *                 setting on the configuration service.
+   * @param onStart  A callback function to be called when the server starts.
+   * @returns The server instance.
+   */
   async listen(port, onStart) {
     if (port) {
-      await this._setupConfig();
+      await Promise.all([this._setupConfig(), this._loadESMModules()]);
       const config = this.getConfig();
       config.set("port", port);
     }
     return this.start(onStart);
   }
+  /**
+   * Stops the server instance.
+   */
   stop() {
     if (!this._instance)
       return;
@@ -130,6 +193,12 @@ class Jimpex extends Jimple {
     this._instance = void 0;
     this._emitEvent("afterStop", { app: this });
   }
+  /**
+   * Mounts a route controller or a middleware into a server routes.
+   *
+   * @param route       The route for the controller/middleware.
+   * @param controller  The controller/middleware resource to be mounted.
+   */
   mount(route, controller) {
     let useController;
     if ("register" in controller && typeof controller.register === "function" && controller.provider === true) {
@@ -156,6 +225,11 @@ class Jimpex extends Jimple {
       this._controlledRoutes.push(route);
     });
   }
+  /**
+   * Adds a global middleware to the application.
+   *
+   * @param middleware  The middleware resource to be added.
+   */
   use(middleware) {
     const useMiddleware = "register" in middleware && typeof middleware.register === "function" ? middleware.register(this) : middleware;
     this._mountQueue.push((server) => {
@@ -177,6 +251,15 @@ class Jimpex extends Jimple {
       );
     });
   }
+  /**
+   * Gets a setting from the configuration, or the configuration itself.
+   *
+   * @param setting  The setting or settings to be retrieved. If is not specified, it
+   *                 will return the entire configuration.
+   * @param asArray  If `true` and `setting` is an array, it will return the values as
+   *                 an array instead of an object.
+   * @template T  The type of the setting to be retrieved.
+   */
   getConfig(setting, asArray = false) {
     const config = this.try("config");
     if (!config) {
@@ -187,41 +270,107 @@ class Jimpex extends Jimple {
     }
     return config.get(setting, asArray);
   }
+  /**
+   * Creates a new router instance.
+   */
   getRouter() {
     return this.get("router");
   }
+  /**
+   * The logger service.
+   */
   get logger() {
     return this.get("logger");
   }
+  /**
+   * The Express application Jimpex uses under the hood.
+   */
   get express() {
     return this._express;
   }
+  /**
+   * The server instance that gets created when the app is started.
+   */
   get instance() {
     return this._instance;
   }
+  /**
+   * The application customization options.
+   */
   get options() {
     return deepAssignWithOverwrite({}, this._options);
   }
+  /**
+   * Gets the events service.
+   */
   get eventsHub() {
     return this.get("events");
   }
+  /**
+   * A list of the routes that have controllers mounted on them.
+   */
   get routes() {
     return this._controlledRoutes.slice();
   }
+  /**
+   * Adds a listener for an application event.
+   *
+   * @param eventName  The name of the event to listen for.
+   * @param listener   The listener function.
+   * @returns A function to unsubscribe the listener.
+   * @template EventName  The name of the event, to match the type of the listener
+   *                      function.
+   */
   on(eventName, listener) {
     return this.eventsHub.on(eventName, listener);
   }
+  /**
+   * Adds a listener for an application event that will only be execuded once: the first
+   * time the event is triggered.
+   *
+   * @param eventName  The name of the event to listen for.
+   * @param listener   The listener function.
+   * @returns A function to unsubscribe the listener.
+   * @template EventName  The name of the event, to match the type of the listener
+   *                      function.
+   */
   once(eventName, listener) {
     return this.eventsHub.once(eventName, listener);
   }
+  /**
+   * Based on the application options, it returns wheter the application is healthy or
+   * not.
+   */
   isHealthy() {
     return this._options.healthCheck(this);
   }
+  /**
+   * This method is like a "lifecycle method", it gets executed on the constructor right
+   * before the "boot step". The idea is for the method to be a helper when the
+   * application is defined by subclassing {@link Jimpex}: the application could register
+   * all important services here and the routes on boot, then, if the implementation needs
+   * to access or overwrite a something, it can send `boot: false`, access/register what
+   * it needs, and then call `boot()`. That would be impossible for an application without
+   * overwriting the constructor and the boot functionality.
+   */
   _init() {
   }
+  /**
+   * It generates overwrites for the application options when it gets created. This method
+   * is a helper for when the application is defined by subclassing {@link Jimpex}: It's
+   * highly probable that if the application needs to change the default options, it would
+   * want to do it right from the class, instead of having to do it on every
+   * implementation. A way to do it would be overwriting the constructor and calling
+   * `super` with the custom overwrites, but this method exists so that won't be
+   * necessary: when creating the `options`, the constructor will merge the result of this
+   * method on top of the default ones.
+   */
   _initOptions() {
     return {};
   }
+  /**
+   * Registers the "core services" on the container: logger, events, utils, etc.
+   */
   _setupCoreServices() {
     this.register(
       appLoggerProvider({
@@ -242,6 +391,9 @@ class Jimpex extends Jimple {
     this.set("events", () => new EventsHub());
     this.set("statuses", () => statuses);
   }
+  /**
+   * Configures the Express application based on the class options.
+   */
   _setupExpress() {
     const { statics, filesizeLimit, express: expressOptions } = this._options;
     if (expressOptions.trustProxy) {
@@ -277,6 +429,18 @@ class Jimpex extends Jimple {
       this.factory(() => express.Router())
     );
   }
+  /**
+   * Adds a static folder to the application.
+   *
+   * @param route   The route to add the folder to.
+   * @param folder  The path to the folder in the file system. If not defined, it will
+   *                be use the same value as `route`. The path could be relative to the
+   *                project root, or where the application executable is located,
+   *                depending on the value of the `onHome` parameter.
+   * @param onHome  If `true`, the path to the folder will be relative to the project
+   *                root. If `false`, it will be relative to where the application
+   *                executable is located.
+   */
   _addStaticsFolder(route, folder = "", onHome = false) {
     const location = onHome ? "home" : "app";
     const staticRoute = route.replace(/^\/+/, "");
@@ -287,6 +451,16 @@ class Jimpex extends Jimple {
       controller: true
     });
   }
+  /**
+   * This helper method validates the `path` options in order to register the `app`
+   * location in the `pathUtils` service. The `app` location should be the path to where
+   * the application executable is located, but due to how ESM works, we can't infer it
+   * from the `module` object, so we need either recieved as the `appPath` setting, or try
+   * to get it from the parent module.
+   *
+   * @throws If the method should use the path from the parent module, but can't find
+   *         it.
+   */
   _configurePath() {
     const pathUtils = this.get("pathUtils");
     const {
@@ -316,6 +490,12 @@ class Jimpex extends Jimple {
       );
     }
   }
+  /**
+   * Setups the configuration service. The new configuration service requires async calls
+   * in order to load the configuration files (as it uses `import` instead of `require`),
+   * so it can't be instantiated as the other services.
+   * This method is called just before starting the application.
+   */
   async _setupConfig() {
     if (this._configReady)
       return;
@@ -346,16 +526,56 @@ class Jimpex extends Jimple {
       await config.loadFromEnv();
     }
   }
+  /**
+   * Loads the ESM modules that are needed by Jimpex. This is called just before the starting
+   * the application so they'll be available for all the services.
+   */
+  async _loadESMModules() {
+    const { default: nodeFetch } = await tsAsyncImport("node-fetch");
+    const { default: mime } = await tsAsyncImport("mime");
+    this.set("node-fetch", () => nodeFetch);
+    this.set("mime", () => mime);
+  }
+  /**
+   * Processes the resources from the mount queue (added with {@link Jimpex.mount} and
+   * {@link Jimpex.use}), and adds them to the Express application.
+   */
   _mountResources() {
     this._mountQueue.forEach((mount) => mount(this._express));
     this._mountQueue.length = 0;
   }
+  /**
+   * Emits an event using the `events` service.
+   *
+   * @param name     The name of the event to emit.
+   * @param payload  The event payload.
+   * @template EventName  The literal name of the event, to type the event payload.
+   */
   _emitEvent(name, payload) {
     this.eventsHub.emit(name, payload);
   }
+  /**
+   * Sends a target object to a list of reducer events so they can modify or replace it.
+   *
+   * @param name     The name of the event to use.
+   * @param target   The object to reduce with the event.
+   * @param payload  Extra context for the listeners.
+   */
   _reduceWithEvent(name, target, payload) {
     return this.eventsHub.reduceSync(name, target, payload);
   }
+  /**
+   * Loads the contents of a dictionary of credentials files that need to be used to
+   * configure HTTPS.
+   *
+   * @param credentialsInfo  The dictionary where the keys are the type of credentials
+   *                         (`ca`, `cert`, `key`) and the values are the paths to the
+   *                         files.
+   * @param onHome           If this is `true`, the path of the files will be relative
+   *                         to the project root. If it is `false`, it will be relative
+   *                         to where the application executable is located.
+   * @returns
+   */
   async _loadCredentials(credentialsInfo, onHome = true) {
     const location = onHome ? "home" : "app";
     const pathUtils = this.get("pathUtils");
@@ -379,6 +599,18 @@ class Jimpex extends Jimple {
       return acc;
     }, {});
   }
+  /**
+   * Validates the configuration and chooses the server the application needs to use: If
+   * HTTP2 is enabled, it will use Spdy; if HTTPS is enabled but HTTP is not, it will use
+   * the native HTTPS server; otherwise, it will be just the Express instance.
+   *
+   * @returns {Server}
+   * @throws {Error} If HTTP2 is enabled but HTTPS is not.
+   * @throws {Error} If HTTPS is enabled but there's no `https.credentials` object.
+   * @throws {Error} If HTTPS is enabled and no creadentials are found.
+   * @access protected
+   * @ignore
+   */
   async _createServer() {
     const [http2Config = {}, httpsConfig = {}] = this.getConfig(["http2", "https"], true);
     if (!http2Config.enabled && !httpsConfig.enabled) {

package/dist/esm/app/jimpex.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/app/jimpex.ts"],"sourcesContent":["import * as path from 'path';\nimport fs from 'fs/promises';\nimport { createServer as createHTTPSServer } from 'https';\nimport { Jimple } from '@homer0/jimple';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { appLoggerProvider } from '@homer0/simple-logger';\nimport { envUtilsProvider } from '@homer0/env-utils';\nimport { packageInfoProvider } from '@homer0/package-info';\nimport { pathUtilsProvider } from '@homer0/path-utils';\nimport { rootFileProvider } from '@homer0/root-file';\nimport { EventsHub } from '@homer0/events-hub';\nimport { simpleConfigProvider } from '@homer0/simple-config';\nimport compression from 'compression';\nimport bodyParser from 'body-parser';\nimport multer from 'multer';\nimport {\n  createServer as createSpdyServer,\n  type ServerOptions as SpdyServerOptions,\n} from 'spdy';\nimport express from 'express';\nimport {\n  commonServicesProvider,\n  httpServicesProvider,\n  utilsServicesProvider,\n} from '../services';\nimport {\n  statuses,\n  type Controller,\n  type ControllerLike,\n  type MiddlewareLike,\n  type MiddlewareProvider,\n  type Middleware,\n} from '../utils';\nimport type {\n  DeepPartial,\n  Express,\n  ExpressMiddlewareLike,\n  PathUtils,\n  Config,\n  Logger,\n  JimpexOptions,\n  JimpexHTTPSCredentials,\n  JimpexHTTP2Options,\n  JimpexHTTPSOptions,\n  JimpexStartCallback,\n  JimpexServer,\n  JimpexServerInstance,\n  JimpexEventName,\n  JimpexEventPayload,\n  DeepReadonly,\n  JimpexReducerEventName,\n  JimpexReducerEventPayload,\n  JimpexReducerEventTarget,\n  JimpexEventNameLike,\n  JimpexEventListener,\n  JimpexHealthCheckFn,\n  Router,\n} from '../types';\n/**\n * Jimpex is a mix of Jimple, a Javascript port of Pimple dependency injection container,\n * and Express, one of the most popular web frameworks for Node.\n *\n * @group Jimpex\n * @todo Implement `helmet`.\n */\nexport class Jimpex extends Jimple {\n  /**\n   * The customization settings for the application.\n   */\n  protected _options: JimpexOptions;\n  /**\n   * The Express application Jimpex uses under the hood.\n   */\n  protected _express: Express;\n  /**\n   * Since the configuration service has an async initialization, the class uses this flag\n   * internally to validate if the configuration has been initialized or not.\n   */\n  protected _configReady: boolean = false;\n  /**\n   * A reference to the actuall HTTP the application will use. This can vary depending on\n   * whether HTTPS, or HTTP2 are enabled. If HTTPS is not enabled, it will be the same as\n   * the `express` property; if HTTPS is enabled, it will be an `https` server; and if\n   * HTTP2 is enabled, it will be an `spdy` server.\n   */\n  protected _server?: JimpexServer;\n  /**\n   * The instance of the server that is listening for requests.\n   */\n  protected _instance?: JimpexServerInstance;\n  /**\n   * A list of functions that implement controllers and middlewares. When the application\n   * starts, the queue will be processed and those controllers and middlewares will be\n   * added to the server instance. The reason they are not added directly like with a\n   * regular Express implementation is that services on Jimple use lazy loading, and\n   * adding middlewares and controllers as they come could cause errors if they depend on\n   * services that are not yet registered.\n   */\n  protected _mountQueue: Array<(server: Express) => void> = [];\n  /**\n   * A list with all the top routes controlled by the application. Every time a controller\n   * is mounted, its route will be added here.\n   */\n  protected _controlledRoutes: string[] = [];\n  /**\n   * @param options  Preferences to customize the application.\n   * @param config   The default settings for the configuration service. It's a\n   *                 shortcuit for `options.config.default`\n   */\n  constructor(options: DeepPartial<JimpexOptions> = {}, config: unknown = {}) {\n    super();\n\n    this._options = deepAssignWithOverwrite(\n      {\n        filesizeLimit: '15MB',\n        boot: true,\n        path: {\n          appPath: '',\n          useParentPath: true,\n        },\n        config: {\n          default: options?.config?.default || config,\n          name: 'app',\n          path: 'config/',\n          hasFolder: false,\n          loadFromEnvironment: true,\n          environmentVariable: 'CONFIG',\n          defaultConfigFilename: '[app-name].config.js',\n          filenameFormat: '[app-name].[config-name].config.js',\n        },\n        statics: {\n          enabled: true,\n          onHome: false,\n          route: 'statics',\n        },\n        express: {\n          trustProxy: true,\n          disableXPoweredBy: true,\n          compression: true,\n          bodyParser: true,\n          multer: true,\n        },\n        services: {\n          common: true,\n          http: true,\n          utils: true,\n        },\n        healthCheck: () => Promise.resolve(true),\n      },\n      options,\n      this._initOptions(),\n    );\n\n    this._express = express();\n\n    this._setupCoreServices();\n    this._setupExpress();\n    this._configurePath();\n\n    this._init();\n    if (this._options.boot) {\n      this.boot();\n    }\n  }\n  /**\n   * This is where the app would register all its specific services, middlewares and controllers.\n   */\n  boot(): void {}\n  /**\n   * Disables the server TLS validation. Meant to be used for development purposes.\n   */\n  disableTLSValidation() {\n    // eslint-disable-next-line no-process-env, dot-notation\n    process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = '0';\n    this.logger.warn('TLS validation has been disabled');\n  }\n  /**\n   * Starts the app server.\n   *\n   * @param onStart  A callback function to be called when the server actually starts.\n   * @returns The server instance.\n   */\n  async start(onStart?: JimpexStartCallback): Promise<JimpexServerInstance> {\n    await this._setupConfig();\n    const config = this.getConfig();\n    const port = config.get<number | undefined>('port');\n    if (!port) {\n      throw new Error('No port configured');\n    }\n    this._emitEvent('beforeStart', { app: this });\n    this._server = await this._createServer();\n    this._instance = this._server!.listen(port, () => {\n      this._emitEvent('start', { app: this });\n      this._mountResources();\n      this.logger.success(`Starting on port ${port}`);\n      this._emitEvent('afterStart', { app: this });\n      if (onStart) {\n        onStart(config);\n      }\n      this._emitEvent('afterStartCallback', { app: this });\n    });\n\n    return this._instance!;\n  }\n  /**\n   * This is an alias of `start`. The idea is for it to be used on serverless platforms,\n   * where you don't get to start your app, you just have export it.\n   *\n   * @param port     In case the configuration doesn't already have it,\n   *                 this is the port where the application will use to run. If this\n   *                 parameter is used, the method will overwrite the `port`\n   *                 setting on the configuration service.\n   * @param onStart  A callback function to be called when the server starts.\n   * @returns The server instance.\n   */\n  async listen(\n    port?: number,\n    onStart?: JimpexStartCallback,\n  ): Promise<JimpexServerInstance> {\n    if (port) {\n      await this._setupConfig();\n      const config = this.getConfig();\n      config.set('port', port);\n    }\n\n    return this.start(onStart);\n  }\n  /**\n   * Stops the server instance.\n   */\n  stop(): void {\n    if (!this._instance) return;\n    this._emitEvent('beforeStop', { app: this });\n    this._instance.close();\n    this._instance = undefined;\n    this._emitEvent('afterStop', { app: this });\n  }\n  /**\n   * Mounts a route controller or a middleware into a server routes.\n   *\n   * @param route       The route for the controller/middleware.\n   * @param controller  The controller/middleware resource to be mounted.\n   */\n  mount(route: string, controller: ControllerLike): void {\n    let useController: Controller | Middleware;\n    if (\n      'register' in controller &&\n      typeof controller.register === 'function' &&\n      controller.provider === true\n    ) {\n      useController = controller.register(this, route);\n    } else if (\n      'connect' in controller &&\n      typeof controller.connect === 'function' &&\n      (('middleware' in controller && controller.middleware === true) ||\n        ('controller' in controller && controller.controller === true))\n    ) {\n      useController = controller;\n    } else {\n      useController = {\n        middleware: true,\n        connect: () => controller as ExpressMiddlewareLike,\n      };\n    }\n\n    this._mountQueue.push((server) => {\n      const connected = useController.connect(this, route);\n      if (!connected) return;\n      const router = this._reduceWithEvent('controllerWillBeMounted', connected, {\n        route,\n        controller: useController,\n        app: this,\n      });\n      server.use(route, router);\n      this._emitEvent('routeAdded', { route, app: this });\n      this._controlledRoutes.push(route);\n    });\n  }\n  /**\n   * Adds a global middleware to the application.\n   *\n   * @param middleware  The middleware resource to be added.\n   */\n  use(middleware: MiddlewareLike): void {\n    const useMiddleware =\n      'register' in middleware && typeof middleware.register === 'function'\n        ? (middleware as MiddlewareProvider).register(this)\n        : (middleware as Middleware | ExpressMiddlewareLike);\n    this._mountQueue.push((server) => {\n      if ('connect' in useMiddleware && typeof useMiddleware.connect === 'function') {\n        const handler = useMiddleware.connect(this);\n        if (handler) {\n          server.use(\n            this._reduceWithEvent('middlewareWillBeUsed', handler, { app: this }),\n          );\n        }\n\n        return;\n      }\n\n      server.use(\n        this._reduceWithEvent(\n          'middlewareWillBeUsed',\n          useMiddleware as ExpressMiddlewareLike,\n          { app: this },\n        ),\n      );\n    });\n  }\n\n  getConfig(): Config;\n  getConfig<T = unknown>(setting: string | string[], asArray?: boolean): T;\n  /**\n   * Gets a setting from the configuration, or the configuration itself.\n   *\n   * @param setting  The setting or settings to be retrieved. If is not specified, it\n   *                 will return the entire configuration.\n   * @param asArray  If `true` and `setting` is an array, it will return the values as\n   *                 an array instead of an object.\n   * @template T  The type of the setting to be retrieved.\n   */\n  getConfig<T = unknown>(\n    setting?: string | string[],\n    asArray: boolean = false,\n  ): Config | T {\n    const config = this.try<Config>('config');\n    if (!config) {\n      throw new Error('The config service is not available until the app starts');\n    }\n    if (typeof setting === 'undefined') {\n      return config;\n    }\n\n    return config.get<T>(setting, asArray);\n  }\n  /**\n   * Creates a new router instance.\n   */\n  getRouter(): Router {\n    return this.get('router');\n  }\n  /**\n   * The logger service.\n   */\n  get logger(): Logger {\n    return this.get<Logger>('logger');\n  }\n  /**\n   * The Express application Jimpex uses under the hood.\n   */\n  get express(): Express {\n    return this._express;\n  }\n  /**\n   * The server instance that gets created when the app is started.\n   */\n  get instance(): JimpexServerInstance | undefined {\n    return this._instance;\n  }\n  /**\n   * The application customization options.\n   */\n  get options(): DeepReadonly<JimpexOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Gets the events service.\n   */\n  get eventsHub(): EventsHub {\n    return this.get<EventsHub>('events');\n  }\n  /**\n   * A list of the routes that have controllers mounted on them.\n   */\n  get routes(): string[] {\n    return this._controlledRoutes.slice();\n  }\n  /**\n   * Adds a listener for an application event.\n   *\n   * @param eventName  The name of the event to listen for.\n   * @param listener   The listener function.\n   * @returns A function to unsubscribe the listener.\n   * @template EventName  The name of the event, to match the type of the listener\n   *                      function.\n   */\n  on<EventName extends JimpexEventNameLike>(\n    eventName: EventName,\n    listener: JimpexEventListener<EventName>,\n  ): () => boolean {\n    return this.eventsHub.on(eventName, listener);\n  }\n  /**\n   * Adds a listener for an application event that will only be execuded once: the first\n   * time the event is triggered.\n   *\n   * @param eventName  The name of the event to listen for.\n   * @param listener   The listener function.\n   * @returns A function to unsubscribe the listener.\n   * @template EventName  The name of the event, to match the type of the listener\n   *                      function.\n   */\n  once<EventName extends JimpexEventNameLike>(\n    eventName: EventName,\n    listener: JimpexEventListener<EventName>,\n  ): () => boolean {\n    return this.eventsHub.once(eventName, listener);\n  }\n  /**\n   * Based on the application options, it returns wheter the application is healthy or\n   * not.\n   */\n  isHealthy(): ReturnType<JimpexHealthCheckFn> {\n    return this._options.healthCheck(this);\n  }\n  /**\n   * This method is like a \"lifecycle method\", it gets executed on the constructor right\n   * before the \"boot step\". The idea is for the method to be a helper when the\n   * application is defined by subclassing {@link Jimpex}: the application could register\n   * all important services here and the routes on boot, then, if the implementation needs\n   * to access or overwrite a something, it can send `boot: false`, access/register what\n   * it needs, and then call `boot()`. That would be impossible for an application without\n   * overwriting the constructor and the boot functionality.\n   */\n  protected _init(): void {}\n  /**\n   * It generates overwrites for the application options when it gets created. This method\n   * is a helper for when the application is defined by subclassing {@link Jimpex}: It's\n   * highly probable that if the application needs to change the default options, it would\n   * want to do it right from the class, instead of having to do it on every\n   * implementation. A way to do it would be overwriting the constructor and calling\n   * `super` with the custom overwrites, but this method exists so that won't be\n   * necessary: when creating the `options`, the constructor will merge the result of this\n   * method on top of the default ones.\n   */\n  protected _initOptions(): DeepPartial<JimpexOptions> {\n    return {};\n  }\n  /**\n   * Registers the \"core services\" on the container: logger, events, utils, etc.\n   */\n  protected _setupCoreServices(): void {\n    this.register(\n      appLoggerProvider({\n        serviceName: 'logger',\n      }),\n    );\n    this.register(envUtilsProvider);\n    this.register(packageInfoProvider);\n    this.register(pathUtilsProvider);\n    this.register(rootFileProvider);\n    const { services: enabledServices } = this._options;\n    if (enabledServices.common) this.register(commonServicesProvider);\n    if (enabledServices.http) this.register(httpServicesProvider);\n    if (enabledServices.utils) this.register(utilsServicesProvider);\n\n    this.set('events', () => new EventsHub());\n    this.set('statuses', () => statuses);\n  }\n  /**\n   * Configures the Express application based on the class options.\n   */\n  protected _setupExpress(): void {\n    const { statics, filesizeLimit, express: expressOptions } = this._options;\n    if (expressOptions.trustProxy) {\n      this._express.enable('trust proxy');\n    }\n\n    if (expressOptions.disableXPoweredBy) {\n      this._express.disable('x-powered-by');\n    }\n\n    if (expressOptions.compression) {\n      this._express.use(compression());\n    }\n\n    if (statics.enabled) {\n      this._addStaticsFolder(statics.route, statics.folder, statics.onHome);\n    }\n\n    if (expressOptions.bodyParser) {\n      this._express.use(\n        bodyParser.json({\n          limit: filesizeLimit,\n        }),\n      );\n      this._express.use(\n        bodyParser.urlencoded({\n          extended: true,\n          limit: filesizeLimit,\n        }),\n      );\n    }\n\n    if (expressOptions.multer) {\n      this._express.use(multer().any());\n    }\n\n    this.set(\n      'router',\n      this.factory(() => express.Router()),\n    );\n  }\n  /**\n   * Adds a static folder to the application.\n   *\n   * @param route   The route to add the folder to.\n   * @param folder  The path to the folder in the file system. If not defined, it will\n   *                be use the same value as `route`. The path could be relative to the\n   *                project root, or where the application executable is located,\n   *                depending on the value of the `onHome` parameter.\n   * @param onHome  If `true`, the path to the folder will be relative to the project\n   *                root. If `false`, it will be relative to where the application\n   *                executable is located.\n   */\n  protected _addStaticsFolder(\n    route: string,\n    folder: string = '',\n    onHome: boolean = false,\n  ) {\n    const location = onHome ? 'home' : 'app';\n    const staticRoute = route.replace(/^\\/+/, '');\n    const pathUtils = this.get<PathUtils>('pathUtils');\n    const staticFolder = pathUtils.joinFrom(location, folder || staticRoute);\n    this.mount(`/${staticRoute}`, {\n      connect: () => express.static(staticFolder),\n      controller: true,\n    });\n  }\n  /**\n   * This helper method validates the `path` options in order to register the `app`\n   * location in the `pathUtils` service. The `app` location should be the path to where\n   * the application executable is located, but due to how ESM works, we can't infer it\n   * from the `module` object, so we need either recieved as the `appPath` setting, or try\n   * to get it from the parent module.\n   *\n   * @throws If the method should use the path from the parent module, but can't find\n   *         it.\n   */\n  protected _configurePath(): void {\n    const pathUtils = this.get<PathUtils>('pathUtils');\n    const {\n      path: { appPath, useParentPath },\n    } = this._options;\n    if (appPath) {\n      pathUtils.addLocation('app', appPath);\n      return;\n    }\n    let foundPath = false;\n    if (useParentPath) {\n      const stack = new Error().stack!;\n      const stackList = stack.split('\\n');\n      stackList.shift();\n      const parentFromStack = stackList.find((line) => !line.includes(__filename));\n      if (parentFromStack) {\n        const parentFile = parentFromStack.replace(/^.*?\\s\\(([^\\s]+):\\d+:\\d+\\)/, '$1');\n        if (parentFile !== parentFromStack) {\n          foundPath = true;\n          pathUtils.addLocation('app', path.dirname(parentFile));\n        }\n      }\n    }\n\n    if (!foundPath) {\n      throw new Error(\n        'The app location cannot be determined. Please specify the appPath option.',\n      );\n    }\n  }\n  /**\n   * Setups the configuration service. The new configuration service requires async calls\n   * in order to load the configuration files (as it uses `import` instead of `require`),\n   * so it can't be instantiated as the other services.\n   * This method is called just before starting the application.\n   */\n  protected async _setupConfig(): Promise<void> {\n    if (this._configReady) return;\n    this._configReady = true;\n    const { config: options } = this._options;\n\n    let configsPath = options.path.replace(/\\/$/, '');\n    if (options.hasFolder) {\n      configsPath = `${configsPath}${path.sep}${options.name}${path.sep}`;\n    }\n\n    const filenameFormat = options.filenameFormat\n      .replace(/\\[app-name\\]/gi, options.name)\n      .replace(/\\[config-name\\]/gi, '[name]');\n    const defaultConfigFilename = options.defaultConfigFilename.replace(\n      /\\[app-name\\]/gi,\n      options.name,\n    );\n\n    this.register(\n      simpleConfigProvider({\n        name: options.name,\n        defaultConfig: options.default,\n        defaultConfigFilename,\n        envVarName: options.environmentVariable,\n        path: configsPath,\n        filenameFormat,\n      }),\n    );\n\n    const config = this.getConfig();\n    await config.loadFromFile('', true, false);\n    if (options.loadFromEnvironment) {\n      await config.loadFromEnv();\n    }\n  }\n  /**\n   * Processes the resources from the mount queue (added with {@link Jimpex.mount} and\n   * {@link Jimpex.use}), and adds them to the Express application.\n   */\n  protected _mountResources(): void {\n    this._mountQueue.forEach((mount) => mount(this._express));\n    this._mountQueue.length = 0;\n  }\n  /**\n   * Emits an event using the `events` service.\n   *\n   * @param name     The name of the event to emit.\n   * @param payload  The event payload.\n   * @template EventName  The literal name of the event, to type the event payload.\n   */\n  protected _emitEvent<EventName extends JimpexEventName>(\n    name: EventName,\n    payload: JimpexEventPayload<EventName>,\n  ): void {\n    this.eventsHub.emit(name, payload);\n  }\n  /**\n   * Sends a target object to a list of reducer events so they can modify or replace it.\n   *\n   * @param name     The name of the event to use.\n   * @param target   The object to reduce with the event.\n   * @param payload  Extra context for the listeners.\n   */\n  protected _reduceWithEvent<EventName extends JimpexReducerEventName>(\n    name: EventName,\n    target: JimpexReducerEventTarget<EventName>,\n    payload: JimpexReducerEventPayload<EventName>,\n  ): JimpexReducerEventTarget<EventName> {\n    return this.eventsHub.reduceSync(name, target, payload);\n  }\n  /**\n   * Loads the contents of a dictionary of credentials files that need to be used to\n   * configure HTTPS.\n   *\n   * @param credentialsInfo  The dictionary where the keys are the type of credentials\n   *                         (`ca`, `cert`, `key`) and the values are the paths to the\n   *                         files.\n   * @param onHome           If this is `true`, the path of the files will be relative\n   *                         to the project root. If it is `false`, it will be relative\n   *                         to where the application executable is located.\n   * @returns\n   */\n  protected async _loadCredentials(\n    credentialsInfo: JimpexHTTPSCredentials,\n    onHome: boolean = true,\n  ): Promise<JimpexHTTPSCredentials> {\n    const location = onHome ? 'home' : 'app';\n    const pathUtils = this.get<PathUtils>('pathUtils');\n    const keys: Array<keyof JimpexHTTPSCredentials> = ['ca', 'cert', 'key'];\n    const info = await Promise.all(\n      keys.map(async (key) => {\n        const filepath = credentialsInfo[key];\n        if (!filepath) return undefined;\n        const file = await fs.readFile(pathUtils.joinFrom(location, filepath), 'utf8');\n        return {\n          key,\n          file,\n        };\n      }),\n    );\n\n    return info.reduce<JimpexHTTPSCredentials>((acc, item) => {\n      if (item) {\n        acc[item.key] = item.file;\n      }\n\n      return acc;\n    }, {});\n  }\n  /**\n   * Validates the configuration and chooses the server the application needs to use: If\n   * HTTP2 is enabled, it will use Spdy; if HTTPS is enabled but HTTP is not, it will use\n   * the native HTTPS server; otherwise, it will be just the Express instance.\n   *\n   * @returns {Server}\n   * @throws {Error} If HTTP2 is enabled but HTTPS is not.\n   * @throws {Error} If HTTPS is enabled but there's no `https.credentials` object.\n   * @throws {Error} If HTTPS is enabled and no creadentials are found.\n   * @access protected\n   * @ignore\n   */\n  protected async _createServer(): Promise<JimpexServer> {\n    const [http2Config = {}, httpsConfig = {}] = this.getConfig<\n      [JimpexHTTP2Options, JimpexHTTPSOptions]\n    >(['http2', 'https'], true);\n\n    if (!http2Config.enabled && !httpsConfig.enabled) {\n      return this._express;\n    }\n\n    if (http2Config.enabled && !httpsConfig.enabled) {\n      throw new Error('HTTP2 requires for HTTPS to be enabled');\n    }\n\n    if (!httpsConfig.credentials) {\n      throw new Error('The `credentials` object on the HTTPS settings is missing');\n    }\n\n    const credentials = await this._loadCredentials(\n      httpsConfig.credentials,\n      httpsConfig.credentials.onHome,\n    );\n\n    if (!Object.keys(credentials).length) {\n      throw new Error('No credentials were found for HTTPS');\n    }\n\n    if (http2Config.enabled) {\n      const serverOptions: SpdyServerOptions = {\n        ...credentials,\n        spdy: http2Config.spdy,\n      };\n\n      return createSpdyServer(serverOptions, this._express);\n    }\n\n    return createHTTPSServer(credentials, this._express);\n  }\n}\n/**\n * Shorthand for `new Jimpex()`.\n *\n * @param args  The same parameters as the {@link Jimpex} constructor.\n * @returns A new instance of {@link Jimpex}.\n * @group Jimpex\n */\nexport const jimpex = (...args: ConstructorParameters<typeof Jimpex>): Jimpex =>\n  new Jimpex(...args);\n"],"mappings":";;;AAAA,YAAY,UAAU;AACtB,OAAO,QAAQ;AACf,SAAS,gBAAgB,yBAAyB;AAClD,SAAS,cAAc;AACvB,SAAS,+BAA+B;AACxC,SAAS,yBAAyB;AAClC,SAAS,wBAAwB;AACjC,SAAS,2BAA2B;AACpC,SAAS,yBAAyB;AAClC,SAAS,wBAAwB;AACjC,SAAS,iBAAiB;AAC1B,SAAS,4BAA4B;AACrC,OAAO,iBAAiB;AACxB,OAAO,gBAAgB;AACvB,OAAO,YAAY;AACnB;AAAA,EACE,gBAAgB;AAAA,OAEX;AACP,OAAO,aAAa;AACpB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,OAMK;AAiCA,MAAM,eAAe,OAAO;AAAA,EA4CjC,YAAY,UAAsC,CAAC,GAAG,SAAkB,CAAC,GAAG;AAC1E,UAAM;AAzCR,wBAAU;AAIV,wBAAU;AAKV,wBAAU,gBAAwB;AAOlC,wBAAU;AAIV,wBAAU;AASV,wBAAU,eAAgD,CAAC;AAK3D,wBAAU,qBAA8B,CAAC;AASvC,SAAK,WAAW;AAAA,MACd;AAAA,QACE,eAAe;AAAA,QACf,MAAM;AAAA,QACN,MAAM;AAAA,UACJ,SAAS;AAAA,UACT,eAAe;AAAA,QACjB;AAAA,QACA,QAAQ;AAAA,UACN,SAAS,SAAS,QAAQ,WAAW;AAAA,UACrC,MAAM;AAAA,UACN,MAAM;AAAA,UACN,WAAW;AAAA,UACX,qBAAqB;AAAA,UACrB,qBAAqB;AAAA,UACrB,uBAAuB;AAAA,UACvB,gBAAgB;AAAA,QAClB;AAAA,QACA,SAAS;AAAA,UACP,SAAS;AAAA,UACT,QAAQ;AAAA,UACR,OAAO;AAAA,QACT;AAAA,QACA,SAAS;AAAA,UACP,YAAY;AAAA,UACZ,mBAAmB;AAAA,UACnB,aAAa;AAAA,UACb,YAAY;AAAA,UACZ,QAAQ;AAAA,QACV;AAAA,QACA,UAAU;AAAA,UACR,QAAQ;AAAA,UACR,MAAM;AAAA,UACN,OAAO;AAAA,QACT;AAAA,QACA,aAAa,MAAM,QAAQ,QAAQ,IAAI;AAAA,MACzC;AAAA,MACA;AAAA,MACA,KAAK,aAAa;AAAA,IACpB;AAEA,SAAK,WAAW,QAAQ;AAExB,SAAK,mBAAmB;AACxB,SAAK,cAAc;AACnB,SAAK,eAAe;AAEpB,SAAK,MAAM;AACX,QAAI,KAAK,SAAS,MAAM;AACtB,WAAK,KAAK;AAAA,IACZ;AAAA,EACF;AAAA,EAIA,OAAa;AAAA,EAAC;AAAA,EAId,uBAAuB;AAErB,YAAQ,IAAI,kCAAkC;AAC9C,SAAK,OAAO,KAAK,kCAAkC;AAAA,EACrD;AAAA,EAOA,MAAM,MAAM,SAA8D;AACxE,UAAM,KAAK,aAAa;AACxB,UAAM,SAAS,KAAK,UAAU;AAC9B,UAAM,OAAO,OAAO,IAAwB,MAAM;AAClD,QAAI,CAAC,MAAM;AACT,YAAM,IAAI,MAAM,oBAAoB;AAAA,IACtC;AACA,SAAK,WAAW,eAAe,EAAE,KAAK,KAAK,CAAC;AAC5C,SAAK,UAAU,MAAM,KAAK,cAAc;AACxC,SAAK,YAAY,KAAK,QAAS,OAAO,MAAM,MAAM;AAChD,WAAK,WAAW,SAAS,EAAE,KAAK,KAAK,CAAC;AACtC,WAAK,gBAAgB;AACrB,WAAK,OAAO,QAAQ,oBAAoB,MAAM;AAC9C,WAAK,WAAW,cAAc,EAAE,KAAK,KAAK,CAAC;AAC3C,UAAI,SAAS;AACX,gBAAQ,MAAM;AAAA,MAChB;AACA,WAAK,WAAW,sBAAsB,EAAE,KAAK,KAAK,CAAC;AAAA,IACrD,CAAC;AAED,WAAO,KAAK;AAAA,EACd;AAAA,EAYA,MAAM,OACJ,MACA,SAC+B;AAC/B,QAAI,MAAM;AACR,YAAM,KAAK,aAAa;AACxB,YAAM,SAAS,KAAK,UAAU;AAC9B,aAAO,IAAI,QAAQ,IAAI;AAAA,IACzB;AAEA,WAAO,KAAK,MAAM,OAAO;AAAA,EAC3B;AAAA,EAIA,OAAa;AACX,QAAI,CAAC,KAAK;AAAW;AACrB,SAAK,WAAW,cAAc,EAAE,KAAK,KAAK,CAAC;AAC3C,SAAK,UAAU,MAAM;AACrB,SAAK,YAAY;AACjB,SAAK,WAAW,aAAa,EAAE,KAAK,KAAK,CAAC;AAAA,EAC5C;AAAA,EAOA,MAAM,OAAe,YAAkC;AACrD,QAAI;AACJ,QACE,cAAc,cACd,OAAO,WAAW,aAAa,cAC/B,WAAW,aAAa,MACxB;AACA,sBAAgB,WAAW,SAAS,MAAM,KAAK;AAAA,IACjD,WACE,aAAa,cACb,OAAO,WAAW,YAAY,eAC5B,gBAAgB,cAAc,WAAW,eAAe,QACvD,gBAAgB,cAAc,WAAW,eAAe,OAC3D;AACA,sBAAgB;AAAA,IAClB,OAAO;AACL,sBAAgB;AAAA,QACd,YAAY;AAAA,QACZ,SAAS,MAAM;AAAA,MACjB;AAAA,IACF;AAEA,SAAK,YAAY,KAAK,CAAC,WAAW;AAChC,YAAM,YAAY,cAAc,QAAQ,MAAM,KAAK;AACnD,UAAI,CAAC;AAAW;AAChB,YAAM,SAAS,KAAK,iBAAiB,2BAA2B,WAAW;AAAA,QACzE;AAAA,QACA,YAAY;AAAA,QACZ,KAAK;AAAA,MACP,CAAC;AACD,aAAO,IAAI,OAAO,MAAM;AACxB,WAAK,WAAW,cAAc,EAAE,OAAO,KAAK,KAAK,CAAC;AAClD,WAAK,kBAAkB,KAAK,KAAK;AAAA,IACnC,CAAC;AAAA,EACH;AAAA,EAMA,IAAI,YAAkC;AACpC,UAAM,gBACJ,cAAc,cAAc,OAAO,WAAW,aAAa,aACtD,WAAkC,SAAS,IAAI,IAC/C;AACP,SAAK,YAAY,KAAK,CAAC,WAAW;AAChC,UAAI,aAAa,iBAAiB,OAAO,cAAc,YAAY,YAAY;AAC7E,cAAM,UAAU,cAAc,QAAQ,IAAI;AAC1C,YAAI,SAAS;AACX,iBAAO;AAAA,YACL,KAAK,iBAAiB,wBAAwB,SAAS,EAAE,KAAK,KAAK,CAAC;AAAA,UACtE;AAAA,QACF;AAEA;AAAA,MACF;AAEA,aAAO;AAAA,QACL,KAAK;AAAA,UACH;AAAA,UACA;AAAA,UACA,EAAE,KAAK,KAAK;AAAA,QACd;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAaA,UACE,SACA,UAAmB,OACP;AACZ,UAAM,SAAS,KAAK,IAAY,QAAQ;AACxC,QAAI,CAAC,QAAQ;AACX,YAAM,IAAI,MAAM,0DAA0D;AAAA,IAC5E;AACA,QAAI,OAAO,YAAY,aAAa;AAClC,aAAO;AAAA,IACT;AAEA,WAAO,OAAO,IAAO,SAAS,OAAO;AAAA,EACvC;AAAA,EAIA,YAAoB;AAClB,WAAO,KAAK,IAAI,QAAQ;AAAA,EAC1B;AAAA,EAIA,IAAI,SAAiB;AACnB,WAAO,KAAK,IAAY,QAAQ;AAAA,EAClC;AAAA,EAIA,IAAI,UAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,IAAI,WAA6C;AAC/C,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,IAAI,UAAuC;AACzC,WAAO,wBAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA,EAIA,IAAI,YAAuB;AACzB,WAAO,KAAK,IAAe,QAAQ;AAAA,EACrC;AAAA,EAIA,IAAI,SAAmB;AACrB,WAAO,KAAK,kBAAkB,MAAM;AAAA,EACtC;AAAA,EAUA,GACE,WACA,UACe;AACf,WAAO,KAAK,UAAU,GAAG,WAAW,QAAQ;AAAA,EAC9C;AAAA,EAWA,KACE,WACA,UACe;AACf,WAAO,KAAK,UAAU,KAAK,WAAW,QAAQ;AAAA,EAChD;AAAA,EAKA,YAA6C;AAC3C,WAAO,KAAK,SAAS,YAAY,IAAI;AAAA,EACvC;AAAA,EAUU,QAAc;AAAA,EAAC;AAAA,EAWf,eAA2C;AACnD,WAAO,CAAC;AAAA,EACV;AAAA,EAIU,qBAA2B;AACnC,SAAK;AAAA,MACH,kBAAkB;AAAA,QAChB,aAAa;AAAA,MACf,CAAC;AAAA,IACH;AACA,SAAK,SAAS,gBAAgB;AAC9B,SAAK,SAAS,mBAAmB;AACjC,SAAK,SAAS,iBAAiB;AAC/B,SAAK,SAAS,gBAAgB;AAC9B,UAAM,EAAE,UAAU,gBAAgB,IAAI,KAAK;AAC3C,QAAI,gBAAgB;AAAQ,WAAK,SAAS,sBAAsB;AAChE,QAAI,gBAAgB;AAAM,WAAK,SAAS,oBAAoB;AAC5D,QAAI,gBAAgB;AAAO,WAAK,SAAS,qBAAqB;AAE9D,SAAK,IAAI,UAAU,MAAM,IAAI,UAAU,CAAC;AACxC,SAAK,IAAI,YAAY,MAAM,QAAQ;AAAA,EACrC;AAAA,EAIU,gBAAsB;AAC9B,UAAM,EAAE,SAAS,eAAe,SAAS,eAAe,IAAI,KAAK;AACjE,QAAI,eAAe,YAAY;AAC7B,WAAK,SAAS,OAAO,aAAa;AAAA,IACpC;AAEA,QAAI,eAAe,mBAAmB;AACpC,WAAK,SAAS,QAAQ,cAAc;AAAA,IACtC;AAEA,QAAI,eAAe,aAAa;AAC9B,WAAK,SAAS,IAAI,YAAY,CAAC;AAAA,IACjC;AAEA,QAAI,QAAQ,SAAS;AACnB,WAAK,kBAAkB,QAAQ,OAAO,QAAQ,QAAQ,QAAQ,MAAM;AAAA,IACtE;AAEA,QAAI,eAAe,YAAY;AAC7B,WAAK,SAAS;AAAA,QACZ,WAAW,KAAK;AAAA,UACd,OAAO;AAAA,QACT,CAAC;AAAA,MACH;AACA,WAAK,SAAS;AAAA,QACZ,WAAW,WAAW;AAAA,UACpB,UAAU;AAAA,UACV,OAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,IACF;AAEA,QAAI,eAAe,QAAQ;AACzB,WAAK,SAAS,IAAI,OAAO,EAAE,IAAI,CAAC;AAAA,IAClC;AAEA,SAAK;AAAA,MACH;AAAA,MACA,KAAK,QAAQ,MAAM,QAAQ,OAAO,CAAC;AAAA,IACrC;AAAA,EACF;AAAA,EAaU,kBACR,OACA,SAAiB,IACjB,SAAkB,OAClB;AACA,UAAM,WAAW,SAAS,SAAS;AACnC,UAAM,cAAc,MAAM,QAAQ,QAAQ,EAAE;AAC5C,UAAM,YAAY,KAAK,IAAe,WAAW;AACjD,UAAM,eAAe,UAAU,SAAS,UAAU,UAAU,WAAW;AACvE,SAAK,MAAM,IAAI,eAAe;AAAA,MAC5B,SAAS,MAAM,QAAQ,OAAO,YAAY;AAAA,MAC1C,YAAY;AAAA,IACd,CAAC;AAAA,EACH;AAAA,EAWU,iBAAuB;AAC/B,UAAM,YAAY,KAAK,IAAe,WAAW;AACjD,UAAM;AAAA,MACJ,MAAM,EAAE,SAAS,cAAc;AAAA,IACjC,IAAI,KAAK;AACT,QAAI,SAAS;AACX,gBAAU,YAAY,OAAO,OAAO;AACpC;AAAA,IACF;AACA,QAAI,YAAY;AAChB,QAAI,eAAe;AACjB,YAAM,QAAQ,IAAI,MAAM,EAAE;AAC1B,YAAM,YAAY,MAAM,MAAM,IAAI;AAClC,gBAAU,MAAM;AAChB,YAAM,kBAAkB,UAAU,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,UAAU,CAAC;AAC3E,UAAI,iBAAiB;AACnB,cAAM,aAAa,gBAAgB,QAAQ,8BAA8B,IAAI;AAC7E,YAAI,eAAe,iBAAiB;AAClC,sBAAY;AACZ,oBAAU,YAAY,OAAO,KAAK,QAAQ,UAAU,CAAC;AAAA,QACvD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,WAAW;AACd,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAOA,MAAgB,eAA8B;AAC5C,QAAI,KAAK;AAAc;AACvB,SAAK,eAAe;AACpB,UAAM,EAAE,QAAQ,QAAQ,IAAI,KAAK;AAEjC,QAAI,cAAc,QAAQ,KAAK,QAAQ,OAAO,EAAE;AAChD,QAAI,QAAQ,WAAW;AACrB,oBAAc,GAAG,cAAc,KAAK,MAAM,QAAQ,OAAO,KAAK;AAAA,IAChE;AAEA,UAAM,iBAAiB,QAAQ,eAC5B,QAAQ,kBAAkB,QAAQ,IAAI,EACtC,QAAQ,qBAAqB,QAAQ;AACxC,UAAM,wBAAwB,QAAQ,sBAAsB;AAAA,MAC1D;AAAA,MACA,QAAQ;AAAA,IACV;AAEA,SAAK;AAAA,MACH,qBAAqB;AAAA,QACnB,MAAM,QAAQ;AAAA,QACd,eAAe,QAAQ;AAAA,QACvB;AAAA,QACA,YAAY,QAAQ;AAAA,QACpB,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,SAAS,KAAK,UAAU;AAC9B,UAAM,OAAO,aAAa,IAAI,MAAM,KAAK;AACzC,QAAI,QAAQ,qBAAqB;AAC/B,YAAM,OAAO,YAAY;AAAA,IAC3B;AAAA,EACF;AAAA,EAKU,kBAAwB;AAChC,SAAK,YAAY,QAAQ,CAAC,UAAU,MAAM,KAAK,QAAQ,CAAC;AACxD,SAAK,YAAY,SAAS;AAAA,EAC5B;AAAA,EAQU,WACR,MACA,SACM;AACN,SAAK,UAAU,KAAK,MAAM,OAAO;AAAA,EACnC;AAAA,EAQU,iBACR,MACA,QACA,SACqC;AACrC,WAAO,KAAK,UAAU,WAAW,MAAM,QAAQ,OAAO;AAAA,EACxD;AAAA,EAaA,MAAgB,iBACd,iBACA,SAAkB,MACe;AACjC,UAAM,WAAW,SAAS,SAAS;AACnC,UAAM,YAAY,KAAK,IAAe,WAAW;AACjD,UAAM,OAA4C,CAAC,MAAM,QAAQ,KAAK;AACtE,UAAM,OAAO,MAAM,QAAQ;AAAA,MACzB,KAAK,IAAI,OAAO,QAAQ;AACtB,cAAM,WAAW,gBAAgB;AACjC,YAAI,CAAC;AAAU,iBAAO;AACtB,cAAM,OAAO,MAAM,GAAG,SAAS,UAAU,SAAS,UAAU,QAAQ,GAAG,MAAM;AAC7E,eAAO;AAAA,UACL;AAAA,UACA;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO,KAAK,OAA+B,CAAC,KAAK,SAAS;AACxD,UAAI,MAAM;AACR,YAAI,KAAK,OAAO,KAAK;AAAA,MACvB;AAEA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AAAA,EAaA,MAAgB,gBAAuC;AACrD,UAAM,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC,CAAC,IAAI,KAAK,UAEhD,CAAC,SAAS,OAAO,GAAG,IAAI;AAE1B,QAAI,CAAC,YAAY,WAAW,CAAC,YAAY,SAAS;AAChD,aAAO,KAAK;AAAA,IACd;AAEA,QAAI,YAAY,WAAW,CAAC,YAAY,SAAS;AAC/C,YAAM,IAAI,MAAM,wCAAwC;AAAA,IAC1D;AAEA,QAAI,CAAC,YAAY,aAAa;AAC5B,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,UAAM,cAAc,MAAM,KAAK;AAAA,MAC7B,YAAY;AAAA,MACZ,YAAY,YAAY;AAAA,IAC1B;AAEA,QAAI,CAAC,OAAO,KAAK,WAAW,EAAE,QAAQ;AACpC,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,QAAI,YAAY,SAAS;AACvB,YAAM,gBAAmC;AAAA,QACvC,GAAG;AAAA,QACH,MAAM,YAAY;AAAA,MACpB;AAEA,aAAO,iBAAiB,eAAe,KAAK,QAAQ;AAAA,IACtD;AAEA,WAAO,kBAAkB,aAAa,KAAK,QAAQ;AAAA,EACrD;AACF;AAQO,MAAM,SAAS,IAAI,SACxB,IAAI,OAAO,GAAG,IAAI;","names":[]}
+{"version":3,"sources":["../../../src/app/jimpex.ts"],"sourcesContent":["import * as path from 'path';\nimport fs from 'fs/promises';\nimport { createServer as createHTTPSServer } from 'https';\nimport { Jimple } from '@homer0/jimple';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { appLoggerProvider } from '@homer0/simple-logger';\nimport { envUtilsProvider } from '@homer0/env-utils';\nimport { packageInfoProvider } from '@homer0/package-info';\nimport { pathUtilsProvider } from '@homer0/path-utils';\nimport { rootFileProvider } from '@homer0/root-file';\nimport { tsAsyncImport } from '@homer0/ts-async-import';\nimport { EventsHub } from '@homer0/events-hub';\nimport { simpleConfigProvider } from '@homer0/simple-config';\nimport compression from 'compression';\nimport bodyParser from 'body-parser';\nimport multer from 'multer';\nimport {\n  createServer as createSpdyServer,\n  type ServerOptions as SpdyServerOptions,\n} from 'spdy';\nimport express from 'express';\nimport {\n  commonServicesProvider,\n  httpServicesProvider,\n  utilsServicesProvider,\n} from '../services';\nimport {\n  statuses,\n  type Controller,\n  type ControllerLike,\n  type MiddlewareLike,\n  type MiddlewareProvider,\n  type Middleware,\n} from '../utils';\nimport type {\n  DeepPartial,\n  Express,\n  ExpressMiddlewareLike,\n  PathUtils,\n  Config,\n  Logger,\n  JimpexOptions,\n  JimpexHTTPSCredentials,\n  JimpexHTTP2Options,\n  JimpexHTTPSOptions,\n  JimpexStartCallback,\n  JimpexServer,\n  JimpexServerInstance,\n  JimpexEventName,\n  JimpexEventPayload,\n  DeepReadonly,\n  JimpexReducerEventName,\n  JimpexReducerEventPayload,\n  JimpexReducerEventTarget,\n  JimpexEventNameLike,\n  JimpexEventListener,\n  JimpexHealthCheckFn,\n  Router,\n} from '../types';\n/**\n * Jimpex is a mix of Jimple, a Javascript port of Pimple dependency injection container,\n * and Express, one of the most popular web frameworks for Node.\n *\n * @group Jimpex\n * @todo Implement `helmet`.\n */\nexport class Jimpex extends Jimple {\n  /**\n   * The customization settings for the application.\n   */\n  protected _options: JimpexOptions;\n  /**\n   * The Express application Jimpex uses under the hood.\n   */\n  protected _express: Express;\n  /**\n   * Since the configuration service has an async initialization, the class uses this flag\n   * internally to validate if the configuration has been initialized or not.\n   */\n  protected _configReady: boolean = false;\n  /**\n   * A reference to the actuall HTTP the application will use. This can vary depending on\n   * whether HTTPS, or HTTP2 are enabled. If HTTPS is not enabled, it will be the same as\n   * the `express` property; if HTTPS is enabled, it will be an `https` server; and if\n   * HTTP2 is enabled, it will be an `spdy` server.\n   */\n  protected _server?: JimpexServer;\n  /**\n   * The instance of the server that is listening for requests.\n   */\n  protected _instance?: JimpexServerInstance;\n  /**\n   * A list of functions that implement controllers and middlewares. When the application\n   * starts, the queue will be processed and those controllers and middlewares will be\n   * added to the server instance. The reason they are not added directly like with a\n   * regular Express implementation is that services on Jimple use lazy loading, and\n   * adding middlewares and controllers as they come could cause errors if they depend on\n   * services that are not yet registered.\n   */\n  protected _mountQueue: Array<(server: Express) => void> = [];\n  /**\n   * A list with all the top routes controlled by the application. Every time a controller\n   * is mounted, its route will be added here.\n   */\n  protected _controlledRoutes: string[] = [];\n  /**\n   * @param options  Preferences to customize the application.\n   * @param config   The default settings for the configuration service. It's a\n   *                 shortcuit for `options.config.default`\n   */\n  constructor(options: DeepPartial<JimpexOptions> = {}, config: unknown = {}) {\n    super();\n\n    this._options = deepAssignWithOverwrite(\n      {\n        filesizeLimit: '15MB',\n        boot: true,\n        path: {\n          appPath: '',\n          useParentPath: true,\n        },\n        config: {\n          default: options?.config?.default || config,\n          name: 'app',\n          path: 'config/',\n          hasFolder: false,\n          loadFromEnvironment: true,\n          environmentVariable: 'CONFIG',\n          defaultConfigFilename: '[app-name].config.js',\n          filenameFormat: '[app-name].[config-name].config.js',\n        },\n        statics: {\n          enabled: true,\n          onHome: false,\n          route: 'statics',\n        },\n        express: {\n          trustProxy: true,\n          disableXPoweredBy: true,\n          compression: true,\n          bodyParser: true,\n          multer: true,\n        },\n        services: {\n          common: true,\n          http: true,\n          utils: true,\n        },\n        healthCheck: () => Promise.resolve(true),\n      },\n      options,\n      this._initOptions(),\n    );\n\n    this._express = express();\n\n    this._setupCoreServices();\n    this._setupExpress();\n    this._configurePath();\n\n    this._init();\n    if (this._options.boot) {\n      this.boot();\n    }\n  }\n  /**\n   * This is where the app would register all its specific services, middlewares and controllers.\n   */\n  boot(): void {}\n  /**\n   * Disables the server TLS validation. Meant to be used for development purposes.\n   */\n  disableTLSValidation() {\n    // eslint-disable-next-line no-process-env, dot-notation\n    process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = '0';\n    this.logger.warn('TLS validation has been disabled');\n  }\n  /**\n   * Starts the app server.\n   *\n   * @param onStart  A callback function to be called when the server actually starts.\n   * @returns The server instance.\n   */\n  async start(onStart?: JimpexStartCallback): Promise<JimpexServerInstance> {\n    await Promise.all([this._setupConfig(), this._loadESMModules()]);\n    const config = this.getConfig();\n    const port = config.get<number | undefined>('port');\n    if (!port) {\n      throw new Error('No port configured');\n    }\n    this._emitEvent('beforeStart', { app: this });\n    this._server = await this._createServer();\n    this._instance = this._server!.listen(port, () => {\n      this._emitEvent('start', { app: this });\n      this._mountResources();\n      this.logger.success(`Starting on port ${port}`);\n      this._emitEvent('afterStart', { app: this });\n      if (onStart) {\n        onStart(config);\n      }\n      this._emitEvent('afterStartCallback', { app: this });\n    });\n\n    return this._instance!;\n  }\n  /**\n   * This is an alias of `start`. The idea is for it to be used on serverless platforms,\n   * where you don't get to start your app, you just have export it.\n   *\n   * @param port     In case the configuration doesn't already have it,\n   *                 this is the port where the application will use to run. If this\n   *                 parameter is used, the method will overwrite the `port`\n   *                 setting on the configuration service.\n   * @param onStart  A callback function to be called when the server starts.\n   * @returns The server instance.\n   */\n  async listen(\n    port?: number,\n    onStart?: JimpexStartCallback,\n  ): Promise<JimpexServerInstance> {\n    if (port) {\n      await Promise.all([this._setupConfig(), this._loadESMModules()]);\n      const config = this.getConfig();\n      config.set('port', port);\n    }\n\n    return this.start(onStart);\n  }\n  /**\n   * Stops the server instance.\n   */\n  stop(): void {\n    if (!this._instance) return;\n    this._emitEvent('beforeStop', { app: this });\n    this._instance.close();\n    this._instance = undefined;\n    this._emitEvent('afterStop', { app: this });\n  }\n  /**\n   * Mounts a route controller or a middleware into a server routes.\n   *\n   * @param route       The route for the controller/middleware.\n   * @param controller  The controller/middleware resource to be mounted.\n   */\n  mount(route: string, controller: ControllerLike): void {\n    let useController: Controller | Middleware;\n    if (\n      'register' in controller &&\n      typeof controller.register === 'function' &&\n      controller.provider === true\n    ) {\n      useController = controller.register(this, route);\n    } else if (\n      'connect' in controller &&\n      typeof controller.connect === 'function' &&\n      (('middleware' in controller && controller.middleware === true) ||\n        ('controller' in controller && controller.controller === true))\n    ) {\n      useController = controller;\n    } else {\n      useController = {\n        middleware: true,\n        connect: () => controller as ExpressMiddlewareLike,\n      };\n    }\n\n    this._mountQueue.push((server) => {\n      const connected = useController.connect(this, route);\n      if (!connected) return;\n      const router = this._reduceWithEvent('controllerWillBeMounted', connected, {\n        route,\n        controller: useController,\n        app: this,\n      });\n      server.use(route, router);\n      this._emitEvent('routeAdded', { route, app: this });\n      this._controlledRoutes.push(route);\n    });\n  }\n  /**\n   * Adds a global middleware to the application.\n   *\n   * @param middleware  The middleware resource to be added.\n   */\n  use(middleware: MiddlewareLike): void {\n    const useMiddleware =\n      'register' in middleware && typeof middleware.register === 'function'\n        ? (middleware as MiddlewareProvider).register(this)\n        : (middleware as Middleware | ExpressMiddlewareLike);\n    this._mountQueue.push((server) => {\n      if ('connect' in useMiddleware && typeof useMiddleware.connect === 'function') {\n        const handler = useMiddleware.connect(this);\n        if (handler) {\n          server.use(\n            this._reduceWithEvent('middlewareWillBeUsed', handler, { app: this }),\n          );\n        }\n\n        return;\n      }\n\n      server.use(\n        this._reduceWithEvent(\n          'middlewareWillBeUsed',\n          useMiddleware as ExpressMiddlewareLike,\n          { app: this },\n        ),\n      );\n    });\n  }\n\n  getConfig(): Config;\n  getConfig<T = unknown>(setting: string | string[], asArray?: boolean): T;\n  /**\n   * Gets a setting from the configuration, or the configuration itself.\n   *\n   * @param setting  The setting or settings to be retrieved. If is not specified, it\n   *                 will return the entire configuration.\n   * @param asArray  If `true` and `setting` is an array, it will return the values as\n   *                 an array instead of an object.\n   * @template T  The type of the setting to be retrieved.\n   */\n  getConfig<T = unknown>(\n    setting?: string | string[],\n    asArray: boolean = false,\n  ): Config | T {\n    const config = this.try<Config>('config');\n    if (!config) {\n      throw new Error('The config service is not available until the app starts');\n    }\n    if (typeof setting === 'undefined') {\n      return config;\n    }\n\n    return config.get<T>(setting, asArray);\n  }\n  /**\n   * Creates a new router instance.\n   */\n  getRouter(): Router {\n    return this.get('router');\n  }\n  /**\n   * The logger service.\n   */\n  get logger(): Logger {\n    return this.get<Logger>('logger');\n  }\n  /**\n   * The Express application Jimpex uses under the hood.\n   */\n  get express(): Express {\n    return this._express;\n  }\n  /**\n   * The server instance that gets created when the app is started.\n   */\n  get instance(): JimpexServerInstance | undefined {\n    return this._instance;\n  }\n  /**\n   * The application customization options.\n   */\n  get options(): DeepReadonly<JimpexOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Gets the events service.\n   */\n  get eventsHub(): EventsHub {\n    return this.get<EventsHub>('events');\n  }\n  /**\n   * A list of the routes that have controllers mounted on them.\n   */\n  get routes(): string[] {\n    return this._controlledRoutes.slice();\n  }\n  /**\n   * Adds a listener for an application event.\n   *\n   * @param eventName  The name of the event to listen for.\n   * @param listener   The listener function.\n   * @returns A function to unsubscribe the listener.\n   * @template EventName  The name of the event, to match the type of the listener\n   *                      function.\n   */\n  on<EventName extends JimpexEventNameLike>(\n    eventName: EventName,\n    listener: JimpexEventListener<EventName>,\n  ): () => boolean {\n    return this.eventsHub.on(eventName, listener);\n  }\n  /**\n   * Adds a listener for an application event that will only be execuded once: the first\n   * time the event is triggered.\n   *\n   * @param eventName  The name of the event to listen for.\n   * @param listener   The listener function.\n   * @returns A function to unsubscribe the listener.\n   * @template EventName  The name of the event, to match the type of the listener\n   *                      function.\n   */\n  once<EventName extends JimpexEventNameLike>(\n    eventName: EventName,\n    listener: JimpexEventListener<EventName>,\n  ): () => boolean {\n    return this.eventsHub.once(eventName, listener);\n  }\n  /**\n   * Based on the application options, it returns wheter the application is healthy or\n   * not.\n   */\n  isHealthy(): ReturnType<JimpexHealthCheckFn> {\n    return this._options.healthCheck(this);\n  }\n  /**\n   * This method is like a \"lifecycle method\", it gets executed on the constructor right\n   * before the \"boot step\". The idea is for the method to be a helper when the\n   * application is defined by subclassing {@link Jimpex}: the application could register\n   * all important services here and the routes on boot, then, if the implementation needs\n   * to access or overwrite a something, it can send `boot: false`, access/register what\n   * it needs, and then call `boot()`. That would be impossible for an application without\n   * overwriting the constructor and the boot functionality.\n   */\n  protected _init(): void {}\n  /**\n   * It generates overwrites for the application options when it gets created. This method\n   * is a helper for when the application is defined by subclassing {@link Jimpex}: It's\n   * highly probable that if the application needs to change the default options, it would\n   * want to do it right from the class, instead of having to do it on every\n   * implementation. A way to do it would be overwriting the constructor and calling\n   * `super` with the custom overwrites, but this method exists so that won't be\n   * necessary: when creating the `options`, the constructor will merge the result of this\n   * method on top of the default ones.\n   */\n  protected _initOptions(): DeepPartial<JimpexOptions> {\n    return {};\n  }\n  /**\n   * Registers the \"core services\" on the container: logger, events, utils, etc.\n   */\n  protected _setupCoreServices(): void {\n    this.register(\n      appLoggerProvider({\n        serviceName: 'logger',\n      }),\n    );\n    this.register(envUtilsProvider);\n    this.register(packageInfoProvider);\n    this.register(pathUtilsProvider);\n    this.register(rootFileProvider);\n    const { services: enabledServices } = this._options;\n    if (enabledServices.common) this.register(commonServicesProvider);\n    if (enabledServices.http) this.register(httpServicesProvider);\n    if (enabledServices.utils) this.register(utilsServicesProvider);\n\n    this.set('events', () => new EventsHub());\n    this.set('statuses', () => statuses);\n  }\n  /**\n   * Configures the Express application based on the class options.\n   */\n  protected _setupExpress(): void {\n    const { statics, filesizeLimit, express: expressOptions } = this._options;\n    if (expressOptions.trustProxy) {\n      this._express.enable('trust proxy');\n    }\n\n    if (expressOptions.disableXPoweredBy) {\n      this._express.disable('x-powered-by');\n    }\n\n    if (expressOptions.compression) {\n      this._express.use(compression());\n    }\n\n    if (statics.enabled) {\n      this._addStaticsFolder(statics.route, statics.folder, statics.onHome);\n    }\n\n    if (expressOptions.bodyParser) {\n      this._express.use(\n        bodyParser.json({\n          limit: filesizeLimit,\n        }),\n      );\n      this._express.use(\n        bodyParser.urlencoded({\n          extended: true,\n          limit: filesizeLimit,\n        }),\n      );\n    }\n\n    if (expressOptions.multer) {\n      this._express.use(multer().any());\n    }\n\n    this.set(\n      'router',\n      this.factory(() => express.Router()),\n    );\n  }\n  /**\n   * Adds a static folder to the application.\n   *\n   * @param route   The route to add the folder to.\n   * @param folder  The path to the folder in the file system. If not defined, it will\n   *                be use the same value as `route`. The path could be relative to the\n   *                project root, or where the application executable is located,\n   *                depending on the value of the `onHome` parameter.\n   * @param onHome  If `true`, the path to the folder will be relative to the project\n   *                root. If `false`, it will be relative to where the application\n   *                executable is located.\n   */\n  protected _addStaticsFolder(\n    route: string,\n    folder: string = '',\n    onHome: boolean = false,\n  ) {\n    const location = onHome ? 'home' : 'app';\n    const staticRoute = route.replace(/^\\/+/, '');\n    const pathUtils = this.get<PathUtils>('pathUtils');\n    const staticFolder = pathUtils.joinFrom(location, folder || staticRoute);\n    this.mount(`/${staticRoute}`, {\n      connect: () => express.static(staticFolder),\n      controller: true,\n    });\n  }\n  /**\n   * This helper method validates the `path` options in order to register the `app`\n   * location in the `pathUtils` service. The `app` location should be the path to where\n   * the application executable is located, but due to how ESM works, we can't infer it\n   * from the `module` object, so we need either recieved as the `appPath` setting, or try\n   * to get it from the parent module.\n   *\n   * @throws If the method should use the path from the parent module, but can't find\n   *         it.\n   */\n  protected _configurePath(): void {\n    const pathUtils = this.get<PathUtils>('pathUtils');\n    const {\n      path: { appPath, useParentPath },\n    } = this._options;\n    if (appPath) {\n      pathUtils.addLocation('app', appPath);\n      return;\n    }\n    let foundPath = false;\n    if (useParentPath) {\n      const stack = new Error().stack!;\n      const stackList = stack.split('\\n');\n      stackList.shift();\n      const parentFromStack = stackList.find((line) => !line.includes(__filename));\n      if (parentFromStack) {\n        const parentFile = parentFromStack.replace(/^.*?\\s\\(([^\\s]+):\\d+:\\d+\\)/, '$1');\n        if (parentFile !== parentFromStack) {\n          foundPath = true;\n          pathUtils.addLocation('app', path.dirname(parentFile));\n        }\n      }\n    }\n\n    if (!foundPath) {\n      throw new Error(\n        'The app location cannot be determined. Please specify the appPath option.',\n      );\n    }\n  }\n  /**\n   * Setups the configuration service. The new configuration service requires async calls\n   * in order to load the configuration files (as it uses `import` instead of `require`),\n   * so it can't be instantiated as the other services.\n   * This method is called just before starting the application.\n   */\n  protected async _setupConfig(): Promise<void> {\n    if (this._configReady) return;\n    this._configReady = true;\n    const { config: options } = this._options;\n\n    let configsPath = options.path.replace(/\\/$/, '');\n    if (options.hasFolder) {\n      configsPath = `${configsPath}${path.sep}${options.name}${path.sep}`;\n    }\n\n    const filenameFormat = options.filenameFormat\n      .replace(/\\[app-name\\]/gi, options.name)\n      .replace(/\\[config-name\\]/gi, '[name]');\n    const defaultConfigFilename = options.defaultConfigFilename.replace(\n      /\\[app-name\\]/gi,\n      options.name,\n    );\n\n    this.register(\n      simpleConfigProvider({\n        name: options.name,\n        defaultConfig: options.default,\n        defaultConfigFilename,\n        envVarName: options.environmentVariable,\n        path: configsPath,\n        filenameFormat,\n      }),\n    );\n\n    const config = this.getConfig();\n    await config.loadFromFile('', true, false);\n    if (options.loadFromEnvironment) {\n      await config.loadFromEnv();\n    }\n  }\n  /**\n   * Loads the ESM modules that are needed by Jimpex. This is called just before the starting\n   * the application so they'll be available for all the services.\n   */\n  protected async _loadESMModules(): Promise<void> {\n    const { default: nodeFetch } =\n      await tsAsyncImport<typeof import('node-fetch')>('node-fetch');\n    const { default: mime } = await tsAsyncImport<typeof import('mime')>('mime');\n\n    this.set('node-fetch', () => nodeFetch);\n    this.set('mime', () => mime);\n  }\n  /**\n   * Processes the resources from the mount queue (added with {@link Jimpex.mount} and\n   * {@link Jimpex.use}), and adds them to the Express application.\n   */\n  protected _mountResources(): void {\n    this._mountQueue.forEach((mount) => mount(this._express));\n    this._mountQueue.length = 0;\n  }\n  /**\n   * Emits an event using the `events` service.\n   *\n   * @param name     The name of the event to emit.\n   * @param payload  The event payload.\n   * @template EventName  The literal name of the event, to type the event payload.\n   */\n  protected _emitEvent<EventName extends JimpexEventName>(\n    name: EventName,\n    payload: JimpexEventPayload<EventName>,\n  ): void {\n    this.eventsHub.emit(name, payload);\n  }\n  /**\n   * Sends a target object to a list of reducer events so they can modify or replace it.\n   *\n   * @param name     The name of the event to use.\n   * @param target   The object to reduce with the event.\n   * @param payload  Extra context for the listeners.\n   */\n  protected _reduceWithEvent<EventName extends JimpexReducerEventName>(\n    name: EventName,\n    target: JimpexReducerEventTarget<EventName>,\n    payload: JimpexReducerEventPayload<EventName>,\n  ): JimpexReducerEventTarget<EventName> {\n    return this.eventsHub.reduceSync(name, target, payload);\n  }\n  /**\n   * Loads the contents of a dictionary of credentials files that need to be used to\n   * configure HTTPS.\n   *\n   * @param credentialsInfo  The dictionary where the keys are the type of credentials\n   *                         (`ca`, `cert`, `key`) and the values are the paths to the\n   *                         files.\n   * @param onHome           If this is `true`, the path of the files will be relative\n   *                         to the project root. If it is `false`, it will be relative\n   *                         to where the application executable is located.\n   * @returns\n   */\n  protected async _loadCredentials(\n    credentialsInfo: JimpexHTTPSCredentials,\n    onHome: boolean = true,\n  ): Promise<JimpexHTTPSCredentials> {\n    const location = onHome ? 'home' : 'app';\n    const pathUtils = this.get<PathUtils>('pathUtils');\n    const keys: Array<keyof JimpexHTTPSCredentials> = ['ca', 'cert', 'key'];\n    const info = await Promise.all(\n      keys.map(async (key) => {\n        const filepath = credentialsInfo[key];\n        if (!filepath) return undefined;\n        const file = await fs.readFile(pathUtils.joinFrom(location, filepath), 'utf8');\n        return {\n          key,\n          file,\n        };\n      }),\n    );\n\n    return info.reduce<JimpexHTTPSCredentials>((acc, item) => {\n      if (item) {\n        acc[item.key] = item.file;\n      }\n\n      return acc;\n    }, {});\n  }\n  /**\n   * Validates the configuration and chooses the server the application needs to use: If\n   * HTTP2 is enabled, it will use Spdy; if HTTPS is enabled but HTTP is not, it will use\n   * the native HTTPS server; otherwise, it will be just the Express instance.\n   *\n   * @returns {Server}\n   * @throws {Error} If HTTP2 is enabled but HTTPS is not.\n   * @throws {Error} If HTTPS is enabled but there's no `https.credentials` object.\n   * @throws {Error} If HTTPS is enabled and no creadentials are found.\n   * @access protected\n   * @ignore\n   */\n  protected async _createServer(): Promise<JimpexServer> {\n    const [http2Config = {}, httpsConfig = {}] = this.getConfig<\n      [JimpexHTTP2Options, JimpexHTTPSOptions]\n    >(['http2', 'https'], true);\n\n    if (!http2Config.enabled && !httpsConfig.enabled) {\n      return this._express;\n    }\n\n    if (http2Config.enabled && !httpsConfig.enabled) {\n      throw new Error('HTTP2 requires for HTTPS to be enabled');\n    }\n\n    if (!httpsConfig.credentials) {\n      throw new Error('The `credentials` object on the HTTPS settings is missing');\n    }\n\n    const credentials = await this._loadCredentials(\n      httpsConfig.credentials,\n      httpsConfig.credentials.onHome,\n    );\n\n    if (!Object.keys(credentials).length) {\n      throw new Error('No credentials were found for HTTPS');\n    }\n\n    if (http2Config.enabled) {\n      const serverOptions: SpdyServerOptions = {\n        ...credentials,\n        spdy: http2Config.spdy,\n      };\n\n      return createSpdyServer(serverOptions, this._express);\n    }\n\n    return createHTTPSServer(credentials, this._express);\n  }\n}\n/**\n * Shorthand for `new Jimpex()`.\n *\n * @param args  The same parameters as the {@link Jimpex} constructor.\n * @returns A new instance of {@link Jimpex}.\n * @group Jimpex\n */\nexport const jimpex = (...args: ConstructorParameters<typeof Jimpex>): Jimpex =>\n  new Jimpex(...args);\n"],"mappings":";;;AAAA,YAAY,UAAU;AACtB,OAAO,QAAQ;AACf,SAAS,gBAAgB,yBAAyB;AAClD,SAAS,cAAc;AACvB,SAAS,+BAA+B;AACxC,SAAS,yBAAyB;AAClC,SAAS,wBAAwB;AACjC,SAAS,2BAA2B;AACpC,SAAS,yBAAyB;AAClC,SAAS,wBAAwB;AACjC,SAAS,qBAAqB;AAC9B,SAAS,iBAAiB;AAC1B,SAAS,4BAA4B;AACrC,OAAO,iBAAiB;AACxB,OAAO,gBAAgB;AACvB,OAAO,YAAY;AACnB;AAAA,EACE,gBAAgB;AAAA,OAEX;AACP,OAAO,aAAa;AACpB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,OAMK;AAiCA,MAAM,eAAe,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4CjC,YAAY,UAAsC,CAAC,GAAG,SAAkB,CAAC,GAAG;AAC1E,UAAM;AAzCR;AAAA;AAAA;AAAA,wBAAU;AAIV;AAAA;AAAA;AAAA,wBAAU;AAKV;AAAA;AAAA;AAAA;AAAA,wBAAU,gBAAwB;AAOlC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAU;AAIV;AAAA;AAAA;AAAA,wBAAU;AASV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAU,eAAgD,CAAC;AAK3D;AAAA;AAAA;AAAA;AAAA,wBAAU,qBAA8B,CAAC;AASvC,SAAK,WAAW;AAAA,MACd;AAAA,QACE,eAAe;AAAA,QACf,MAAM;AAAA,QACN,MAAM;AAAA,UACJ,SAAS;AAAA,UACT,eAAe;AAAA,QACjB;AAAA,QACA,QAAQ;AAAA,UACN,SAAS,SAAS,QAAQ,WAAW;AAAA,UACrC,MAAM;AAAA,UACN,MAAM;AAAA,UACN,WAAW;AAAA,UACX,qBAAqB;AAAA,UACrB,qBAAqB;AAAA,UACrB,uBAAuB;AAAA,UACvB,gBAAgB;AAAA,QAClB;AAAA,QACA,SAAS;AAAA,UACP,SAAS;AAAA,UACT,QAAQ;AAAA,UACR,OAAO;AAAA,QACT;AAAA,QACA,SAAS;AAAA,UACP,YAAY;AAAA,UACZ,mBAAmB;AAAA,UACnB,aAAa;AAAA,UACb,YAAY;AAAA,UACZ,QAAQ;AAAA,QACV;AAAA,QACA,UAAU;AAAA,UACR,QAAQ;AAAA,UACR,MAAM;AAAA,UACN,OAAO;AAAA,QACT;AAAA,QACA,aAAa,MAAM,QAAQ,QAAQ,IAAI;AAAA,MACzC;AAAA,MACA;AAAA,MACA,KAAK,aAAa;AAAA,IACpB;AAEA,SAAK,WAAW,QAAQ;AAExB,SAAK,mBAAmB;AACxB,SAAK,cAAc;AACnB,SAAK,eAAe;AAEpB,SAAK,MAAM;AACX,QAAI,KAAK,SAAS,MAAM;AACtB,WAAK,KAAK;AAAA,IACZ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,OAAa;AAAA,EAAC;AAAA;AAAA;AAAA;AAAA,EAId,uBAAuB;AAErB,YAAQ,IAAI,8BAA8B,IAAI;AAC9C,SAAK,OAAO,KAAK,kCAAkC;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,MAAM,SAA8D;AACxE,UAAM,QAAQ,IAAI,CAAC,KAAK,aAAa,GAAG,KAAK,gBAAgB,CAAC,CAAC;AAC/D,UAAM,SAAS,KAAK,UAAU;AAC9B,UAAM,OAAO,OAAO,IAAwB,MAAM;AAClD,QAAI,CAAC,MAAM;AACT,YAAM,IAAI,MAAM,oBAAoB;AAAA,IACtC;AACA,SAAK,WAAW,eAAe,EAAE,KAAK,KAAK,CAAC;AAC5C,SAAK,UAAU,MAAM,KAAK,cAAc;AACxC,SAAK,YAAY,KAAK,QAAS,OAAO,MAAM,MAAM;AAChD,WAAK,WAAW,SAAS,EAAE,KAAK,KAAK,CAAC;AACtC,WAAK,gBAAgB;AACrB,WAAK,OAAO,QAAQ,oBAAoB,IAAI,EAAE;AAC9C,WAAK,WAAW,cAAc,EAAE,KAAK,KAAK,CAAC;AAC3C,UAAI,SAAS;AACX,gBAAQ,MAAM;AAAA,MAChB;AACA,WAAK,WAAW,sBAAsB,EAAE,KAAK,KAAK,CAAC;AAAA,IACrD,CAAC;AAED,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,OACJ,MACA,SAC+B;AAC/B,QAAI,MAAM;AACR,YAAM,QAAQ,IAAI,CAAC,KAAK,aAAa,GAAG,KAAK,gBAAgB,CAAC,CAAC;AAC/D,YAAM,SAAS,KAAK,UAAU;AAC9B,aAAO,IAAI,QAAQ,IAAI;AAAA,IACzB;AAEA,WAAO,KAAK,MAAM,OAAO;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAIA,OAAa;AACX,QAAI,CAAC,KAAK;AAAW;AACrB,SAAK,WAAW,cAAc,EAAE,KAAK,KAAK,CAAC;AAC3C,SAAK,UAAU,MAAM;AACrB,SAAK,YAAY;AACjB,SAAK,WAAW,aAAa,EAAE,KAAK,KAAK,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,OAAe,YAAkC;AACrD,QAAI;AACJ,QACE,cAAc,cACd,OAAO,WAAW,aAAa,cAC/B,WAAW,aAAa,MACxB;AACA,sBAAgB,WAAW,SAAS,MAAM,KAAK;AAAA,IACjD,WACE,aAAa,cACb,OAAO,WAAW,YAAY,eAC5B,gBAAgB,cAAc,WAAW,eAAe,QACvD,gBAAgB,cAAc,WAAW,eAAe,OAC3D;AACA,sBAAgB;AAAA,IAClB,OAAO;AACL,sBAAgB;AAAA,QACd,YAAY;AAAA,QACZ,SAAS,MAAM;AAAA,MACjB;AAAA,IACF;AAEA,SAAK,YAAY,KAAK,CAAC,WAAW;AAChC,YAAM,YAAY,cAAc,QAAQ,MAAM,KAAK;AACnD,UAAI,CAAC;AAAW;AAChB,YAAM,SAAS,KAAK,iBAAiB,2BAA2B,WAAW;AAAA,QACzE;AAAA,QACA,YAAY;AAAA,QACZ,KAAK;AAAA,MACP,CAAC;AACD,aAAO,IAAI,OAAO,MAAM;AACxB,WAAK,WAAW,cAAc,EAAE,OAAO,KAAK,KAAK,CAAC;AAClD,WAAK,kBAAkB,KAAK,KAAK;AAAA,IACnC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,YAAkC;AACpC,UAAM,gBACJ,cAAc,cAAc,OAAO,WAAW,aAAa,aACtD,WAAkC,SAAS,IAAI,IAC/C;AACP,SAAK,YAAY,KAAK,CAAC,WAAW;AAChC,UAAI,aAAa,iBAAiB,OAAO,cAAc,YAAY,YAAY;AAC7E,cAAM,UAAU,cAAc,QAAQ,IAAI;AAC1C,YAAI,SAAS;AACX,iBAAO;AAAA,YACL,KAAK,iBAAiB,wBAAwB,SAAS,EAAE,KAAK,KAAK,CAAC;AAAA,UACtE;AAAA,QACF;AAEA;AAAA,MACF;AAEA,aAAO;AAAA,QACL,KAAK;AAAA,UACH;AAAA,UACA;AAAA,UACA,EAAE,KAAK,KAAK;AAAA,QACd;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,UACE,SACA,UAAmB,OACP;AACZ,UAAM,SAAS,KAAK,IAAY,QAAQ;AACxC,QAAI,CAAC,QAAQ;AACX,YAAM,IAAI,MAAM,0DAA0D;AAAA,IAC5E;AACA,QAAI,OAAO,YAAY,aAAa;AAClC,aAAO;AAAA,IACT;AAEA,WAAO,OAAO,IAAO,SAAS,OAAO;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA,EAIA,YAAoB;AAClB,WAAO,KAAK,IAAI,QAAQ;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,SAAiB;AACnB,WAAO,KAAK,IAAY,QAAQ;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,WAA6C;AAC/C,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAuC;AACzC,WAAO,wBAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,YAAuB;AACzB,WAAO,KAAK,IAAe,QAAQ;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,SAAmB;AACrB,WAAO,KAAK,kBAAkB,MAAM;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GACE,WACA,UACe;AACf,WAAO,KAAK,UAAU,GAAG,WAAW,QAAQ;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,KACE,WACA,UACe;AACf,WAAO,KAAK,UAAU,KAAK,WAAW,QAAQ;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,YAA6C;AAC3C,WAAO,KAAK,SAAS,YAAY,IAAI;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUU,QAAc;AAAA,EAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWf,eAA2C;AACnD,WAAO,CAAC;AAAA,EACV;AAAA;AAAA;AAAA;AAAA,EAIU,qBAA2B;AACnC,SAAK;AAAA,MACH,kBAAkB;AAAA,QAChB,aAAa;AAAA,MACf,CAAC;AAAA,IACH;AACA,SAAK,SAAS,gBAAgB;AAC9B,SAAK,SAAS,mBAAmB;AACjC,SAAK,SAAS,iBAAiB;AAC/B,SAAK,SAAS,gBAAgB;AAC9B,UAAM,EAAE,UAAU,gBAAgB,IAAI,KAAK;AAC3C,QAAI,gBAAgB;AAAQ,WAAK,SAAS,sBAAsB;AAChE,QAAI,gBAAgB;AAAM,WAAK,SAAS,oBAAoB;AAC5D,QAAI,gBAAgB;AAAO,WAAK,SAAS,qBAAqB;AAE9D,SAAK,IAAI,UAAU,MAAM,IAAI,UAAU,CAAC;AACxC,SAAK,IAAI,YAAY,MAAM,QAAQ;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA,EAIU,gBAAsB;AAC9B,UAAM,EAAE,SAAS,eAAe,SAAS,eAAe,IAAI,KAAK;AACjE,QAAI,eAAe,YAAY;AAC7B,WAAK,SAAS,OAAO,aAAa;AAAA,IACpC;AAEA,QAAI,eAAe,mBAAmB;AACpC,WAAK,SAAS,QAAQ,cAAc;AAAA,IACtC;AAEA,QAAI,eAAe,aAAa;AAC9B,WAAK,SAAS,IAAI,YAAY,CAAC;AAAA,IACjC;AAEA,QAAI,QAAQ,SAAS;AACnB,WAAK,kBAAkB,QAAQ,OAAO,QAAQ,QAAQ,QAAQ,MAAM;AAAA,IACtE;AAEA,QAAI,eAAe,YAAY;AAC7B,WAAK,SAAS;AAAA,QACZ,WAAW,KAAK;AAAA,UACd,OAAO;AAAA,QACT,CAAC;AAAA,MACH;AACA,WAAK,SAAS;AAAA,QACZ,WAAW,WAAW;AAAA,UACpB,UAAU;AAAA,UACV,OAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,IACF;AAEA,QAAI,eAAe,QAAQ;AACzB,WAAK,SAAS,IAAI,OAAO,EAAE,IAAI,CAAC;AAAA,IAClC;AAEA,SAAK;AAAA,MACH;AAAA,MACA,KAAK,QAAQ,MAAM,QAAQ,OAAO,CAAC;AAAA,IACrC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,kBACR,OACA,SAAiB,IACjB,SAAkB,OAClB;AACA,UAAM,WAAW,SAAS,SAAS;AACnC,UAAM,cAAc,MAAM,QAAQ,QAAQ,EAAE;AAC5C,UAAM,YAAY,KAAK,IAAe,WAAW;AACjD,UAAM,eAAe,UAAU,SAAS,UAAU,UAAU,WAAW;AACvE,SAAK,MAAM,IAAI,WAAW,IAAI;AAAA,MAC5B,SAAS,MAAM,QAAQ,OAAO,YAAY;AAAA,MAC1C,YAAY;AAAA,IACd,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWU,iBAAuB;AAC/B,UAAM,YAAY,KAAK,IAAe,WAAW;AACjD,UAAM;AAAA,MACJ,MAAM,EAAE,SAAS,cAAc;AAAA,IACjC,IAAI,KAAK;AACT,QAAI,SAAS;AACX,gBAAU,YAAY,OAAO,OAAO;AACpC;AAAA,IACF;AACA,QAAI,YAAY;AAChB,QAAI,eAAe;AACjB,YAAM,QAAQ,IAAI,MAAM,EAAE;AAC1B,YAAM,YAAY,MAAM,MAAM,IAAI;AAClC,gBAAU,MAAM;AAChB,YAAM,kBAAkB,UAAU,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,UAAU,CAAC;AAC3E,UAAI,iBAAiB;AACnB,cAAM,aAAa,gBAAgB,QAAQ,8BAA8B,IAAI;AAC7E,YAAI,eAAe,iBAAiB;AAClC,sBAAY;AACZ,oBAAU,YAAY,OAAO,KAAK,QAAQ,UAAU,CAAC;AAAA,QACvD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,WAAW;AACd,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,eAA8B;AAC5C,QAAI,KAAK;AAAc;AACvB,SAAK,eAAe;AACpB,UAAM,EAAE,QAAQ,QAAQ,IAAI,KAAK;AAEjC,QAAI,cAAc,QAAQ,KAAK,QAAQ,OAAO,EAAE;AAChD,QAAI,QAAQ,WAAW;AACrB,oBAAc,GAAG,WAAW,GAAG,KAAK,GAAG,GAAG,QAAQ,IAAI,GAAG,KAAK,GAAG;AAAA,IACnE;AAEA,UAAM,iBAAiB,QAAQ,eAC5B,QAAQ,kBAAkB,QAAQ,IAAI,EACtC,QAAQ,qBAAqB,QAAQ;AACxC,UAAM,wBAAwB,QAAQ,sBAAsB;AAAA,MAC1D;AAAA,MACA,QAAQ;AAAA,IACV;AAEA,SAAK;AAAA,MACH,qBAAqB;AAAA,QACnB,MAAM,QAAQ;AAAA,QACd,eAAe,QAAQ;AAAA,QACvB;AAAA,QACA,YAAY,QAAQ;AAAA,QACpB,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,SAAS,KAAK,UAAU;AAC9B,UAAM,OAAO,aAAa,IAAI,MAAM,KAAK;AACzC,QAAI,QAAQ,qBAAqB;AAC/B,YAAM,OAAO,YAAY;AAAA,IAC3B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,MAAgB,kBAAiC;AAC/C,UAAM,EAAE,SAAS,UAAU,IACzB,MAAM,cAA2C,YAAY;AAC/D,UAAM,EAAE,SAAS,KAAK,IAAI,MAAM,cAAqC,MAAM;AAE3E,SAAK,IAAI,cAAc,MAAM,SAAS;AACtC,SAAK,IAAI,QAAQ,MAAM,IAAI;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA,EAKU,kBAAwB;AAChC,SAAK,YAAY,QAAQ,CAAC,UAAU,MAAM,KAAK,QAAQ,CAAC;AACxD,SAAK,YAAY,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,WACR,MACA,SACM;AACN,SAAK,UAAU,KAAK,MAAM,OAAO;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,iBACR,MACA,QACA,SACqC;AACrC,WAAO,KAAK,UAAU,WAAW,MAAM,QAAQ,OAAO;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAgB,iBACd,iBACA,SAAkB,MACe;AACjC,UAAM,WAAW,SAAS,SAAS;AACnC,UAAM,YAAY,KAAK,IAAe,WAAW;AACjD,UAAM,OAA4C,CAAC,MAAM,QAAQ,KAAK;AACtE,UAAM,OAAO,MAAM,QAAQ;AAAA,MACzB,KAAK,IAAI,OAAO,QAAQ;AACtB,cAAM,WAAW,gBAAgB,GAAG;AACpC,YAAI,CAAC;AAAU,iBAAO;AACtB,cAAM,OAAO,MAAM,GAAG,SAAS,UAAU,SAAS,UAAU,QAAQ,GAAG,MAAM;AAC7E,eAAO;AAAA,UACL;AAAA,UACA;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO,KAAK,OAA+B,CAAC,KAAK,SAAS;AACxD,UAAI,MAAM;AACR,YAAI,KAAK,GAAG,IAAI,KAAK;AAAA,MACvB;AAEA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAgB,gBAAuC;AACrD,UAAM,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC,CAAC,IAAI,KAAK,UAEhD,CAAC,SAAS,OAAO,GAAG,IAAI;AAE1B,QAAI,CAAC,YAAY,WAAW,CAAC,YAAY,SAAS;AAChD,aAAO,KAAK;AAAA,IACd;AAEA,QAAI,YAAY,WAAW,CAAC,YAAY,SAAS;AAC/C,YAAM,IAAI,MAAM,wCAAwC;AAAA,IAC1D;AAEA,QAAI,CAAC,YAAY,aAAa;AAC5B,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,UAAM,cAAc,MAAM,KAAK;AAAA,MAC7B,YAAY;AAAA,MACZ,YAAY,YAAY;AAAA,IAC1B;AAEA,QAAI,CAAC,OAAO,KAAK,WAAW,EAAE,QAAQ;AACpC,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,QAAI,YAAY,SAAS;AACvB,YAAM,gBAAmC;AAAA,QACvC,GAAG;AAAA,QACH,MAAM,YAAY;AAAA,MACpB;AAEA,aAAO,iBAAiB,eAAe,KAAK,QAAQ;AAAA,IACtD;AAEA,WAAO,kBAAkB,aAAa,KAAK,QAAQ;AAAA,EACrD;AACF;AAQO,MAAM,SAAS,IAAI,SACxB,IAAI,OAAO,GAAG,IAAI;","names":[]}

package/dist/esm/{chunk-T2T6Q22Z.js → chunk-F3FYYIAV.js}

@@ -8,4 +8,4 @@ var __publicField = (obj, key, value) => {
 export {
   __publicField
 };
-//# sourceMappingURL=chunk-T2T6Q22Z.js.map
+//# sourceMappingURL=chunk-F3FYYIAV.js.map

package/dist/esm/controllers/common/config.js

@@ -1,19 +1,34 @@
 import {
   __publicField
-} from "../../chunk-T2T6Q22Z.js";
+} from "../../chunk-F3FYYIAV.js";
 import { controller } from "../../utils";
 class ConfigController {
+  /**
+   * @param options  The options to construct the controller.
+   */
   constructor({ inject }) {
+    /**
+     * The service in charge or building the responses.
+     */
     __publicField(this, "_responsesBuilder");
+    /**
+     * The service in charge of the configuration.
+     */
     __publicField(this, "_config");
     this._responsesBuilder = inject.responsesBuilder;
     this._config = inject.config;
   }
+  /**
+   * Creates the middleware the shows the current configuration.
+   */
   showConfig() {
     return (_, res) => {
       this.respondWithConfig(res);
     };
   }
+  /**
+   * Creates the middleware the allows to switch the configuration.
+   */
   switchConfig() {
     return async (req, res, next) => {
       const { name } = req.params;
@@ -29,6 +44,9 @@ class ConfigController {
       }
     };
   }
+  /**
+   * Utility to respond with the current configuration.
+   */
   respondWithConfig(res) {
     const name = this._config.get("name");
     const data = {

package/dist/esm/controllers/common/config.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/controllers/common/config.ts"],"sourcesContent":["import { controller } from '../../utils';\nimport type { ResponsesBuilder } from '../../services';\nimport type {\n  Config,\n  Response,\n  AsyncExpressMiddleware,\n  ExpressMiddleware,\n} from '../../types';\n/**\n * The options to contruct a {@link ConfigController}.\n *\n * @group Controllers/Config\n */\nexport type ConfigControllerOptions = {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    responsesBuilder: ResponsesBuilder;\n    config: Config;\n  };\n};\n/**\n * The controller class that allows to show and switch the application configuration.\n *\n * @group Controller Classes\n * @group Controllers/Config\n * @prettierignore\n */\nexport class ConfigController {\n  /**\n   * The service in charge or building the responses.\n   */\n  protected readonly _responsesBuilder: ResponsesBuilder;\n  /**\n   * The service in charge of the configuration.\n   */\n  protected readonly _config: Config;\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({ inject }: ConfigControllerOptions) {\n    this._responsesBuilder = inject.responsesBuilder;\n    this._config = inject.config;\n  }\n  /**\n   * Creates the middleware the shows the current configuration.\n   */\n  showConfig(): ExpressMiddleware {\n    return (_, res) => {\n      this.respondWithConfig(res);\n    };\n  }\n  /**\n   * Creates the middleware the allows to switch the configuration.\n   */\n  switchConfig(): AsyncExpressMiddleware {\n    return async (req, res, next) => {\n      const { name } = req.params;\n      if (!name || !this._config.canSwitchConfigs()) {\n        next();\n        return;\n      }\n\n      try {\n        await this._config.switch(name);\n        this.respondWithConfig(res);\n      } catch (error) {\n        next(error);\n      }\n    };\n  }\n  /**\n   * Utility to respond with the current configuration.\n   */\n  protected respondWithConfig(res: Response): void {\n    const name = this._config.get<string>('name');\n    const data = {\n      name,\n      ...this._config.getConfig<Record<string, unknown>>(),\n    };\n\n    this._responsesBuilder.json({\n      res,\n      data,\n    });\n  }\n}\n/**\n * This controller is kind of special as it will only mount the routes if the\n * `debug.configController` setting of the app configuration is set to `true`.\n *\n * It provides routes for:\n * - `/`: Showing the current configuration.\n * - `/switch/:name`: Switching the configuration, but only if the service allows it.\n *\n * @group Controllers\n * @group Controllers/Config\n */\nexport const configController = controller((app) => {\n  const config = app.getConfig();\n  const router = app.getRouter();\n  if (config.get<boolean | undefined>('debug.configController') !== true) {\n    return router;\n  }\n\n  const ctrl = new ConfigController({\n    inject: {\n      config,\n      responsesBuilder: app.get('responsesBuilder'),\n    },\n  });\n\n  return router.get('/', ctrl.showConfig()).get('/switch/:name', ctrl.switchConfig());\n});\n"],"mappings":";;;AAAA,SAAS,kBAAkB;AA6BpB,MAAM,iBAAiB;AAAA,EAY5B,YAAY,EAAE,OAAO,GAA4B;AARjD,wBAAmB;AAInB,wBAAmB;AAKjB,SAAK,oBAAoB,OAAO;AAChC,SAAK,UAAU,OAAO;AAAA,EACxB;AAAA,EAIA,aAAgC;AAC9B,WAAO,CAAC,GAAG,QAAQ;AACjB,WAAK,kBAAkB,GAAG;AAAA,IAC5B;AAAA,EACF;AAAA,EAIA,eAAuC;AACrC,WAAO,OAAO,KAAK,KAAK,SAAS;AAC/B,YAAM,EAAE,KAAK,IAAI,IAAI;AACrB,UAAI,CAAC,QAAQ,CAAC,KAAK,QAAQ,iBAAiB,GAAG;AAC7C,aAAK;AACL;AAAA,MACF;AAEA,UAAI;AACF,cAAM,KAAK,QAAQ,OAAO,IAAI;AAC9B,aAAK,kBAAkB,GAAG;AAAA,MAC5B,SAAS,OAAP;AACA,aAAK,KAAK;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EAIU,kBAAkB,KAAqB;AAC/C,UAAM,OAAO,KAAK,QAAQ,IAAY,MAAM;AAC5C,UAAM,OAAO;AAAA,MACX;AAAA,MACA,GAAG,KAAK,QAAQ,UAAmC;AAAA,IACrD;AAEA,SAAK,kBAAkB,KAAK;AAAA,MAC1B;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAYO,MAAM,mBAAmB,WAAW,CAAC,QAAQ;AAClD,QAAM,SAAS,IAAI,UAAU;AAC7B,QAAM,SAAS,IAAI,UAAU;AAC7B,MAAI,OAAO,IAAyB,wBAAwB,MAAM,MAAM;AACtE,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,IAAI,iBAAiB;AAAA,IAChC,QAAQ;AAAA,MACN;AAAA,MACA,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,IAC9C;AAAA,EACF,CAAC;AAED,SAAO,OAAO,IAAI,KAAK,KAAK,WAAW,CAAC,EAAE,IAAI,iBAAiB,KAAK,aAAa,CAAC;AACpF,CAAC;","names":[]}
+{"version":3,"sources":["../../../../src/controllers/common/config.ts"],"sourcesContent":["import { controller } from '../../utils';\nimport type { ResponsesBuilder } from '../../services';\nimport type {\n  Config,\n  Response,\n  AsyncExpressMiddleware,\n  ExpressMiddleware,\n} from '../../types';\n/**\n * The options to contruct a {@link ConfigController}.\n *\n * @group Controllers/Config\n */\nexport type ConfigControllerOptions = {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    responsesBuilder: ResponsesBuilder;\n    config: Config;\n  };\n};\n/**\n * The controller class that allows to show and switch the application configuration.\n *\n * @group Controller Classes\n * @group Controllers/Config\n * @prettierignore\n */\nexport class ConfigController {\n  /**\n   * The service in charge or building the responses.\n   */\n  protected readonly _responsesBuilder: ResponsesBuilder;\n  /**\n   * The service in charge of the configuration.\n   */\n  protected readonly _config: Config;\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({ inject }: ConfigControllerOptions) {\n    this._responsesBuilder = inject.responsesBuilder;\n    this._config = inject.config;\n  }\n  /**\n   * Creates the middleware the shows the current configuration.\n   */\n  showConfig(): ExpressMiddleware {\n    return (_, res) => {\n      this.respondWithConfig(res);\n    };\n  }\n  /**\n   * Creates the middleware the allows to switch the configuration.\n   */\n  switchConfig(): AsyncExpressMiddleware {\n    return async (req, res, next) => {\n      const { name } = req.params;\n      if (!name || !this._config.canSwitchConfigs()) {\n        next();\n        return;\n      }\n\n      try {\n        await this._config.switch(name);\n        this.respondWithConfig(res);\n      } catch (error) {\n        next(error);\n      }\n    };\n  }\n  /**\n   * Utility to respond with the current configuration.\n   */\n  protected respondWithConfig(res: Response): void {\n    const name = this._config.get<string>('name');\n    const data = {\n      name,\n      ...this._config.getConfig<Record<string, unknown>>(),\n    };\n\n    this._responsesBuilder.json({\n      res,\n      data,\n    });\n  }\n}\n/**\n * This controller is kind of special as it will only mount the routes if the\n * `debug.configController` setting of the app configuration is set to `true`.\n *\n * It provides routes for:\n * - `/`: Showing the current configuration.\n * - `/switch/:name`: Switching the configuration, but only if the service allows it.\n *\n * @group Controllers\n * @group Controllers/Config\n */\nexport const configController = controller((app) => {\n  const config = app.getConfig();\n  const router = app.getRouter();\n  if (config.get<boolean | undefined>('debug.configController') !== true) {\n    return router;\n  }\n\n  const ctrl = new ConfigController({\n    inject: {\n      config,\n      responsesBuilder: app.get('responsesBuilder'),\n    },\n  });\n\n  return router.get('/', ctrl.showConfig()).get('/switch/:name', ctrl.switchConfig());\n});\n"],"mappings":";;;AAAA,SAAS,kBAAkB;AA6BpB,MAAM,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAY5B,YAAY,EAAE,OAAO,GAA4B;AARjD;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAKjB,SAAK,oBAAoB,OAAO;AAChC,SAAK,UAAU,OAAO;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAIA,aAAgC;AAC9B,WAAO,CAAC,GAAG,QAAQ;AACjB,WAAK,kBAAkB,GAAG;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,eAAuC;AACrC,WAAO,OAAO,KAAK,KAAK,SAAS;AAC/B,YAAM,EAAE,KAAK,IAAI,IAAI;AACrB,UAAI,CAAC,QAAQ,CAAC,KAAK,QAAQ,iBAAiB,GAAG;AAC7C,aAAK;AACL;AAAA,MACF;AAEA,UAAI;AACF,cAAM,KAAK,QAAQ,OAAO,IAAI;AAC9B,aAAK,kBAAkB,GAAG;AAAA,MAC5B,SAAS,OAAO;AACd,aAAK,KAAK;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIU,kBAAkB,KAAqB;AAC/C,UAAM,OAAO,KAAK,QAAQ,IAAY,MAAM;AAC5C,UAAM,OAAO;AAAA,MACX;AAAA,MACA,GAAG,KAAK,QAAQ,UAAmC;AAAA,IACrD;AAEA,SAAK,kBAAkB,KAAK;AAAA,MAC1B;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAYO,MAAM,mBAAmB,WAAW,CAAC,QAAQ;AAClD,QAAM,SAAS,IAAI,UAAU;AAC7B,QAAM,SAAS,IAAI,UAAU;AAC7B,MAAI,OAAO,IAAyB,wBAAwB,MAAM,MAAM;AACtE,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,IAAI,iBAAiB;AAAA,IAChC,QAAQ;AAAA,MACN;AAAA,MACA,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,IAC9C;AAAA,EACF,CAAC;AAED,SAAO,OAAO,IAAI,KAAK,KAAK,WAAW,CAAC,EAAE,IAAI,iBAAiB,KAAK,aAAa,CAAC;AACpF,CAAC;","names":[]}