jimpex 8.0.0 → 9.0.0

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/controllers/common/health.ts"],"sourcesContent":["import { controller, type Statuses } from '../../utils';\nimport type { ResponsesBuilder } from '../../services';\nimport type { JimpexHealthStatus, Config, AsyncExpressMiddleware } from '../../types';\n/**\n * A function that will return the health status of the application.\n *\n * @group Controllers/Health\n */\nexport type GetHealthStatus = () => Promise<JimpexHealthStatus>;\n/**\n * The options to contruct a {@link HealthController}.\n *\n * @group Controllers/Health\n */\nexport type HealthControllerOptions = {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    getHealthStatus: GetHealthStatus;\n    responsesBuilder: ResponsesBuilder;\n    config: Config;\n    statuses: Statuses;\n  };\n};\n/**\n * The controller class that shows the application health status.\n *\n * @group Controller Classes\n * @group Controllers/Health\n * @prettierignore\n */\nexport class HealthController {\n  /**\n   * The function that returns the health status of the application.\n   */\n  protected readonly _getHealthStatus: GetHealthStatus;\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   * The uility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({ inject }: HealthControllerOptions) {\n    this._getHealthStatus = inject.getHealthStatus;\n    this._responsesBuilder = inject.responsesBuilder;\n    this._config = inject.config;\n    this._statuses = inject.statuses;\n  }\n  /**\n   * Creates the middleware the shows the application health status.\n   */\n  showHealth(): AsyncExpressMiddleware {\n    return async (_, res) => {\n      const healthStatus = await this._getHealthStatus();\n      let isHealthy: boolean;\n      let extras: Record<string, unknown>;\n      if (typeof healthStatus === 'boolean') {\n        isHealthy = healthStatus;\n        extras = {};\n      } else {\n        if (typeof healthStatus.isHealthy === 'boolean') {\n          isHealthy = healthStatus.isHealthy;\n        } else if (healthStatus.services) {\n          isHealthy = Object.values(healthStatus.services).every(\n            (value) => value === true,\n          );\n        } else {\n          isHealthy = true;\n        }\n\n        extras = {\n          ...healthStatus.services,\n        };\n      }\n\n      const { name: config, version } = this._config.get<{\n        name: string;\n        version: string;\n      }>(['name', 'version']);\n\n      const status = isHealthy\n        ? this._statuses('ok')\n        : this._statuses('service unavailable');\n\n      this._responsesBuilder.json({\n        res,\n        status,\n        data: {\n          isHealthy,\n          status,\n          config,\n          version,\n          ...extras,\n        },\n      });\n    };\n  }\n}\n/**\n * The controller that once mounted, it will add an endpoint to show the application\n * health status.\n *\n * @group Controllers\n * @group Controllers/Health\n */\nexport const healthController = controller((app) => {\n  const router = app.getRouter();\n  const ctrl = new HealthController({\n    inject: {\n      getHealthStatus: app.isHealthy.bind(app),\n      responsesBuilder: app.get('responsesBuilder'),\n      config: app.get('config'),\n      statuses: app.get('statuses'),\n    },\n  });\n\n  return router.get('/', ctrl.showHealth());\n});\n"],"mappings":";;;AAAA,SAAS,kBAAiC;AAgCnC,MAAM,iBAAiB;AAAA,EAoB5B,YAAY,EAAE,OAAO,GAA4B;AAhBjD,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAKjB,SAAK,mBAAmB,OAAO;AAC/B,SAAK,oBAAoB,OAAO;AAChC,SAAK,UAAU,OAAO;AACtB,SAAK,YAAY,OAAO;AAAA,EAC1B;AAAA,EAIA,aAAqC;AACnC,WAAO,OAAO,GAAG,QAAQ;AACvB,YAAM,eAAe,MAAM,KAAK,iBAAiB;AACjD,UAAI;AACJ,UAAI;AACJ,UAAI,OAAO,iBAAiB,WAAW;AACrC,oBAAY;AACZ,iBAAS,CAAC;AAAA,MACZ,OAAO;AACL,YAAI,OAAO,aAAa,cAAc,WAAW;AAC/C,sBAAY,aAAa;AAAA,QAC3B,WAAW,aAAa,UAAU;AAChC,sBAAY,OAAO,OAAO,aAAa,QAAQ,EAAE;AAAA,YAC/C,CAAC,UAAU,UAAU;AAAA,UACvB;AAAA,QACF,OAAO;AACL,sBAAY;AAAA,QACd;AAEA,iBAAS;AAAA,UACP,GAAG,aAAa;AAAA,QAClB;AAAA,MACF;AAEA,YAAM,EAAE,MAAM,QAAQ,QAAQ,IAAI,KAAK,QAAQ,IAG5C,CAAC,QAAQ,SAAS,CAAC;AAEtB,YAAM,SAAS,YACX,KAAK,UAAU,IAAI,IACnB,KAAK,UAAU,qBAAqB;AAExC,WAAK,kBAAkB,KAAK;AAAA,QAC1B;AAAA,QACA;AAAA,QACA,MAAM;AAAA,UACJ;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA,GAAG;AAAA,QACL;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAQO,MAAM,mBAAmB,WAAW,CAAC,QAAQ;AAClD,QAAM,SAAS,IAAI,UAAU;AAC7B,QAAM,OAAO,IAAI,iBAAiB;AAAA,IAChC,QAAQ;AAAA,MACN,iBAAiB,IAAI,UAAU,KAAK,GAAG;AAAA,MACvC,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,MAC5C,QAAQ,IAAI,IAAI,QAAQ;AAAA,MACxB,UAAU,IAAI,IAAI,UAAU;AAAA,IAC9B;AAAA,EACF,CAAC;AAED,SAAO,OAAO,IAAI,KAAK,KAAK,WAAW,CAAC;AAC1C,CAAC;","names":[]}
+{"version":3,"sources":["../../../../src/controllers/common/health.ts"],"sourcesContent":["import { controller, type Statuses } from '../../utils';\nimport type { ResponsesBuilder } from '../../services';\nimport type { JimpexHealthStatus, Config, AsyncExpressMiddleware } from '../../types';\n/**\n * A function that will return the health status of the application.\n *\n * @group Controllers/Health\n */\nexport type GetHealthStatus = () => Promise<JimpexHealthStatus>;\n/**\n * The options to contruct a {@link HealthController}.\n *\n * @group Controllers/Health\n */\nexport type HealthControllerOptions = {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    getHealthStatus: GetHealthStatus;\n    responsesBuilder: ResponsesBuilder;\n    config: Config;\n    statuses: Statuses;\n  };\n};\n/**\n * The controller class that shows the application health status.\n *\n * @group Controller Classes\n * @group Controllers/Health\n * @prettierignore\n */\nexport class HealthController {\n  /**\n   * The function that returns the health status of the application.\n   */\n  protected readonly _getHealthStatus: GetHealthStatus;\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   * The uility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({ inject }: HealthControllerOptions) {\n    this._getHealthStatus = inject.getHealthStatus;\n    this._responsesBuilder = inject.responsesBuilder;\n    this._config = inject.config;\n    this._statuses = inject.statuses;\n  }\n  /**\n   * Creates the middleware the shows the application health status.\n   */\n  showHealth(): AsyncExpressMiddleware {\n    return async (_, res) => {\n      const healthStatus = await this._getHealthStatus();\n      let isHealthy: boolean;\n      let extras: Record<string, unknown>;\n      if (typeof healthStatus === 'boolean') {\n        isHealthy = healthStatus;\n        extras = {};\n      } else {\n        if (typeof healthStatus.isHealthy === 'boolean') {\n          isHealthy = healthStatus.isHealthy;\n        } else if (healthStatus.services) {\n          isHealthy = Object.values(healthStatus.services).every(\n            (value) => value === true,\n          );\n        } else {\n          isHealthy = true;\n        }\n\n        extras = {\n          ...healthStatus.services,\n        };\n      }\n\n      const { name: config, version } = this._config.get<{\n        name: string;\n        version: string;\n      }>(['name', 'version']);\n\n      const status = isHealthy\n        ? this._statuses('ok')\n        : this._statuses('service unavailable');\n\n      this._responsesBuilder.json({\n        res,\n        status,\n        data: {\n          isHealthy,\n          status,\n          config,\n          version,\n          ...extras,\n        },\n      });\n    };\n  }\n}\n/**\n * The controller that once mounted, it will add an endpoint to show the application\n * health status.\n *\n * @group Controllers\n * @group Controllers/Health\n */\nexport const healthController = controller((app) => {\n  const router = app.getRouter();\n  const ctrl = new HealthController({\n    inject: {\n      getHealthStatus: app.isHealthy.bind(app),\n      responsesBuilder: app.get('responsesBuilder'),\n      config: app.get('config'),\n      statuses: app.get('statuses'),\n    },\n  });\n\n  return router.get('/', ctrl.showHealth());\n});\n"],"mappings":";;;AAAA,SAAS,kBAAiC;AAgCnC,MAAM,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAoB5B,YAAY,EAAE,OAAO,GAA4B;AAhBjD;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAKjB,SAAK,mBAAmB,OAAO;AAC/B,SAAK,oBAAoB,OAAO;AAChC,SAAK,UAAU,OAAO;AACtB,SAAK,YAAY,OAAO;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA,EAIA,aAAqC;AACnC,WAAO,OAAO,GAAG,QAAQ;AACvB,YAAM,eAAe,MAAM,KAAK,iBAAiB;AACjD,UAAI;AACJ,UAAI;AACJ,UAAI,OAAO,iBAAiB,WAAW;AACrC,oBAAY;AACZ,iBAAS,CAAC;AAAA,MACZ,OAAO;AACL,YAAI,OAAO,aAAa,cAAc,WAAW;AAC/C,sBAAY,aAAa;AAAA,QAC3B,WAAW,aAAa,UAAU;AAChC,sBAAY,OAAO,OAAO,aAAa,QAAQ,EAAE;AAAA,YAC/C,CAAC,UAAU,UAAU;AAAA,UACvB;AAAA,QACF,OAAO;AACL,sBAAY;AAAA,QACd;AAEA,iBAAS;AAAA,UACP,GAAG,aAAa;AAAA,QAClB;AAAA,MACF;AAEA,YAAM,EAAE,MAAM,QAAQ,QAAQ,IAAI,KAAK,QAAQ,IAG5C,CAAC,QAAQ,SAAS,CAAC;AAEtB,YAAM,SAAS,YACX,KAAK,UAAU,IAAI,IACnB,KAAK,UAAU,qBAAqB;AAExC,WAAK,kBAAkB,KAAK;AAAA,QAC1B;AAAA,QACA;AAAA,QACA,MAAM;AAAA,UACJ;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA,GAAG;AAAA,QACL;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAQO,MAAM,mBAAmB,WAAW,CAAC,QAAQ;AAClD,QAAM,SAAS,IAAI,UAAU;AAC7B,QAAM,OAAO,IAAI,iBAAiB;AAAA,IAChC,QAAQ;AAAA,MACN,iBAAiB,IAAI,UAAU,KAAK,GAAG;AAAA,MACvC,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,MAC5C,QAAQ,IAAI,IAAI,QAAQ;AAAA,MACxB,UAAU,IAAI,IAAI,UAAU;AAAA,IAC9B;AAAA,EACF,CAAC;AAED,SAAO,OAAO,IAAI,KAAK,KAAK,WAAW,CAAC;AAC1C,CAAC;","names":[]}

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

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-T2T6Q22Z.js";
+} from "../../chunk-2B2CG5KL.js";
 import * as path from "path";
 import * as mime from "mime";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
@@ -10,9 +10,22 @@ import {
   notUndefined
 } from "../../utils";
 class StaticsController {
+  /**
+   * @param options  The options to construct the controller.
+   */
   constructor({ inject, ...options }) {
+    /**
+     * The service that serves static files.
+     */
     __publicField(this, "_sendFile");
+    /**
+     * The controller customization options.
+     */
     __publicField(this, "_options");
+    /**
+     * A dictionary with the formatted definitions of the files that will be served.
+     * It uses the files' routes as keys, for easy access in the middleware.
+     */
     __publicField(this, "files");
     this._sendFile = inject.sendFile;
     this._options = this._validateOptions(
@@ -33,6 +46,13 @@ class StaticsController {
     );
     this.files = this._createFiles();
   }
+  /**
+   * Mounts the middlewares in the router in order to serve the files.
+   *
+   * @param router       A reference to the application router.
+   * @param middlewares  A list of extra middlewares to execute before the file
+   *                     middleware.
+   */
   addRoutes(router, middlewares = []) {
     const { methods } = this._options;
     const use = methods.all ? ["all"] : Object.keys(methods).reduce((acc, name) => {
@@ -51,9 +71,17 @@ class StaticsController {
     });
     return router;
   }
+  /**
+   * The controller options.
+   */
   get options() {
     return { ...this._options };
   }
+  /**
+   * Generates the middleware that will serve the file.
+   *
+   * @param file  The definition of the file to serve.
+   */
   _getMiddleware(file) {
     return (_, res, next) => {
       const extension = path.parse(file.path).ext.substring(1);
@@ -71,6 +99,11 @@ class StaticsController {
       });
     };
   }
+  /**
+   * Mounts the middleware(s) for a file in the router.
+   *
+   * @param options  The information of the file and how it needs to be added.
+   */
   _addRoute({
     router,
     method,
@@ -81,6 +114,16 @@ class StaticsController {
     const { route } = file;
     router[method](route, [...middlewares, fileMiddleware]);
   }
+  /**
+   * Validates and formats the options sent to the constructor in order to get the final
+   * set that will be stored in the controller.
+   *
+   * @param options  The options to validate.
+   * @throws If no files are specified.
+   * @throws If methods is not defined.
+   * @throws If no methods are enabled.
+   * @throws If there's an invalid HTTP method.
+   */
   _validateOptions(options) {
     if (!options.files || !options.files.length) {
       throw new Error("You need to specify a list of files");
@@ -120,6 +163,10 @@ class StaticsController {
       methods: newMethods
     };
   }
+  /**
+   * Parses the files received from the constructor's options, and formats them into
+   * proper definitions the controller can use.
+   */
   _createFiles() {
     const { files, paths } = this._options;
     const routePath = removeSlashes(paths.route, false, true);

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/controllers/common/statics.ts"],"sourcesContent":["import * as path from 'path';\nimport * as mime from 'mime';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport {\n  controllerCreator,\n  removeSlashes,\n  notUndefined,\n  type MiddlewareLike,\n} from '../../utils';\nimport type { SendFile } from '../../services';\nimport type { Jimpex } from '../../app';\nimport type { DeepPartial, ExpressMiddleware, Router, RouterMethod } from '../../types';\n/**\n * The definition for each file the controller handles.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerFile = {\n  /**\n   * The route, relative to the controller root, to the file.\n   */\n  route: string;\n  /**\n   * The path to the file in the filesystem. Since the file is served using the\n   * {@link SendFile} service, whether the file is relative to the project root or the\n   * application executable depends on how the service is configured (relative to the\n   * executable by default).\n   */\n  path: string;\n  /**\n   * A dictionary of headers for the response.\n   */\n  headers?: Record<string, string>;\n};\n/**\n * These are like \"master paths\" that get prepended to all the file paths and routes the\n * controller use.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerPathsOptions = {\n  /**\n   * A custom route to prefix all the file routes with.\n   */\n  route: string;\n  /**\n   * A custom path to prefix all the file paths with.\n   */\n  source: string;\n};\n/**\n * The options to customize the controller.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerOptions = {\n  /**\n   * A list of filenames, or definitions for the files to handle.\n   */\n  files: Array<string | StaticsControllerFile>;\n  /**\n   * A dictionary with the allowed router (HTTP) methods the controller can use to serve\n   * the files. If `all` is set to `true`, the rest of the values will be ignored.\n   *\n   * @default {get: true, all: false}\n   */\n  methods: Partial<Record<RouterMethod, boolean>>;\n  /**\n   * The \"master paths\" the controller can use to prefix the file paths and routes.\n   *\n   * @default {route: '', source: './',}\n   */\n  paths: StaticsControllerPathsOptions;\n};\n/**\n * The options to construct a {@link StaticsController}.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerConstructorOptions =\n  DeepPartial<StaticsControllerOptions> & {\n    /**\n     * A dictionary with the dependencies to inject.\n     */\n    inject: {\n      sendFile: SendFile;\n    };\n  };\n/**\n * A function to generate a list of middlewares that can be executed before the tontroller\n * main middleware.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[];\n/**\n * The options for the controller creator that mounts {@link StaticsController}.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerCreatorOptions = DeepPartial<StaticsControllerOptions> & {\n  /**\n   * A function to generate a list of middlewares that can be executed before the\n   * tontroller main middleware.\n   */\n  getMiddlewares?: StaticsControllerGetMiddlewaresFn;\n};\n/**\n * The options for {@link StaticsController._addRoute}.\n *\n * @access protected\n * @group Controllers/Statics\n */\nexport type AddStaticRouteOptions = {\n  /**\n   * The reference for the router in which the middlewares will be added.\n   */\n  router: Router;\n  /**\n   * The router method in which the middlewares will be added.\n   */\n  method: RouterMethod;\n  /**\n   * The definition of the file to serve.\n   */\n  file: StaticsControllerFile;\n  /**\n   * The middleware created by {@link StaticsController}, that will serve the file.\n   */\n  fileMiddleware: ExpressMiddleware;\n  /**\n   * A list of extra middlewares to execute before the file middleware.\n   */\n  middlewares: ExpressMiddleware[];\n};\n\n/**\n * The controller class that allows the application to serve specific files from any\n * folder to any route without the need of mounting directories as \"static\".\n *\n * @group Controller Classes\n * @group Controllers/Statics\n * @prettierignore\n */\nexport class StaticsController {\n  /**\n   * The service that serves static files.\n   */\n  protected readonly _sendFile: SendFile;\n  /**\n   * The controller customization options.\n   */\n  protected _options: StaticsControllerOptions;\n  /**\n   * A dictionary with the formatted definitions of the files that will be served.\n   * It uses the files' routes as keys, for easy access in the middleware.\n   */\n  protected files: Record<string, StaticsControllerFile>;\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({ inject, ...options }: StaticsControllerConstructorOptions) {\n    this._sendFile = inject.sendFile;\n    this._options = this._validateOptions(\n      deepAssignWithOverwrite(\n        {\n          files: ['favicon.ico', 'index.html'],\n          methods: options.methods || {\n            all: false,\n            get: true,\n          },\n          paths: {\n            route: '',\n            source: './',\n          },\n        },\n        options,\n      ),\n    );\n    this.files = this._createFiles();\n  }\n  /**\n   * Mounts the middlewares in the router in order to serve the files.\n   *\n   * @param router       A reference to the application router.\n   * @param middlewares  A list of extra middlewares to execute before the file\n   *                     middleware.\n   */\n  addRoutes(router: Router, middlewares: ExpressMiddleware[] = []): Router {\n    const { methods } = this._options;\n    const use: RouterMethod[] = methods.all\n      ? ['all']\n      : Object.keys(methods).reduce<RouterMethod[]>((acc, name) => {\n          const methodName = name as RouterMethod;\n          if (methods[methodName]) {\n            acc.push(methodName);\n          }\n\n          return acc;\n        }, []);\n\n    Object.keys(this.files).forEach((route) => {\n      const file = this.files[route as keyof typeof this.files]!;\n      const fileMiddleware = this._getMiddleware(file);\n      use.forEach((method) =>\n        this._addRoute({ router, method, file, fileMiddleware, middlewares }),\n      );\n    });\n\n    return router;\n  }\n  /**\n   * The controller options.\n   */\n  get options(): Readonly<StaticsControllerOptions> {\n    return { ...this._options };\n  }\n  /**\n   * Generates the middleware that will serve the file.\n   *\n   * @param file  The definition of the file to serve.\n   */\n  protected _getMiddleware(file: StaticsControllerFile): ExpressMiddleware {\n    return (_, res, next) => {\n      const extension = path.parse(file.path).ext.substring(1);\n      const headers = {\n        'Content-Type': mime.getType(extension) || 'text/html',\n        ...file.headers,\n      };\n\n      Object.entries(headers).forEach(([key, value]) => {\n        res.setHeader(key, value);\n      });\n\n      this._sendFile({\n        res,\n        filepath: file.path,\n        next,\n      });\n    };\n  }\n  /**\n   * Mounts the middleware(s) for a file in the router.\n   *\n   * @param options  The information of the file and how it needs to be added.\n   */\n  protected _addRoute({\n    router,\n    method,\n    file,\n    fileMiddleware,\n    middlewares,\n  }: AddStaticRouteOptions): void {\n    const { route } = file;\n    router[method](route, [...middlewares, fileMiddleware]);\n  }\n  /**\n   * Validates and formats the options sent to the constructor in order to get the final\n   * set that will be stored in the controller.\n   *\n   * @param options  The options to validate.\n   * @throws If no files are specified.\n   * @throws If methods is not defined.\n   * @throws If no methods are enabled.\n   * @throws If there's an invalid HTTP method.\n   */\n  protected _validateOptions(\n    options: StaticsControllerOptions,\n  ): StaticsControllerOptions {\n    if (!options.files || !options.files.length) {\n      throw new Error('You need to specify a list of files');\n    }\n\n    if (!options.methods) {\n      throw new Error('You need to specify which HTTP methods are allowed for the files');\n    }\n\n    const methods = Object.keys(options.methods) as RouterMethod[];\n\n    const atLeastOne = methods.some((method) => options.methods[method]);\n    if (!atLeastOne) {\n      throw new Error('You need to enable at least one HTTP method to serve the files');\n    }\n\n    const allowedMethods: RouterMethod[] = [\n      'all',\n      'get',\n      'head',\n      'post',\n      'patch',\n      'put',\n      'delete',\n      'connect',\n      'options',\n      'trace',\n    ];\n\n    const invalid = methods.find(\n      (method) => !allowedMethods.includes(method.toLowerCase() as RouterMethod),\n    );\n\n    if (invalid) {\n      throw new Error(`${invalid} is not a valid HTTP method`);\n    }\n\n    const newMethods = methods.reduce<Record<string, boolean>>((acc, method) => {\n      acc[method.toLowerCase()] = !!options.methods[method];\n      return acc;\n    }, {});\n\n    return {\n      ...options,\n      methods: newMethods,\n    };\n  }\n  /**\n   * Parses the files received from the constructor's options, and formats them into\n   * proper definitions the controller can use.\n   */\n  protected _createFiles(): Record<string, StaticsControllerFile> {\n    const { files, paths } = this._options;\n    const routePath = removeSlashes(paths.route, false, true);\n    return files.reduce<Record<string, StaticsControllerFile>>((acc, file) => {\n      let src;\n      let route;\n      let headers;\n      if (typeof file === 'object') {\n        ({ route, path: src, headers } = file);\n      } else {\n        src = file;\n        route = file;\n      }\n\n      src = path.join(paths.source, src);\n      route = removeSlashes(route, true, false);\n      route = `${routePath}/${route}`;\n      acc[route] = {\n        path: src,\n        route,\n        headers: headers || {},\n      };\n\n      return acc;\n    }, {});\n  }\n}\n/**\n * A controller that allows the application to server specific files from any folder to\n * any route without the need of mounting directories as \"static\" folders.\n *\n * @group Controllers\n * @group Controllers/Statics\n */\nexport const staticsController = controllerCreator(\n  ({ getMiddlewares, ...options }: StaticsControllerCreatorOptions = {}) =>\n    (app) => {\n      const router = app.getRouter();\n      const ctrl = new StaticsController({\n        inject: {\n          sendFile: app.get('sendFile'),\n        },\n        ...options,\n      });\n\n      let useMiddlewares: ExpressMiddleware[] | undefined;\n      if (getMiddlewares) {\n        useMiddlewares = getMiddlewares(app)\n          .map((middleware) => {\n            if ('middleware' in middleware) {\n              return middleware.connect(app) as ExpressMiddleware | undefined;\n            }\n\n            return middleware as ExpressMiddleware;\n          })\n          .filter(notUndefined);\n      }\n\n      return ctrl.addRoutes(router, useMiddlewares);\n    },\n);\n"],"mappings":";;;AAAA,YAAY,UAAU;AACtB,YAAY,UAAU;AACtB,SAAS,+BAA+B;AACxC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAwIA,MAAM,kBAAkB;AAAA,EAiB7B,YAAY,EAAE,WAAW,QAAQ,GAAwC;AAbzE,wBAAmB;AAInB,wBAAU;AAKV,wBAAU;AAKR,SAAK,YAAY,OAAO;AACxB,SAAK,WAAW,KAAK;AAAA,MACnB;AAAA,QACE;AAAA,UACE,OAAO,CAAC,eAAe,YAAY;AAAA,UACnC,SAAS,QAAQ,WAAW;AAAA,YAC1B,KAAK;AAAA,YACL,KAAK;AAAA,UACP;AAAA,UACA,OAAO;AAAA,YACL,OAAO;AAAA,YACP,QAAQ;AAAA,UACV;AAAA,QACF;AAAA,QACA;AAAA,MACF;AAAA,IACF;AACA,SAAK,QAAQ,KAAK,aAAa;AAAA,EACjC;AAAA,EAQA,UAAU,QAAgB,cAAmC,CAAC,GAAW;AACvE,UAAM,EAAE,QAAQ,IAAI,KAAK;AACzB,UAAM,MAAsB,QAAQ,MAChC,CAAC,KAAK,IACN,OAAO,KAAK,OAAO,EAAE,OAAuB,CAAC,KAAK,SAAS;AACzD,YAAM,aAAa;AACnB,UAAI,QAAQ,aAAa;AACvB,YAAI,KAAK,UAAU;AAAA,MACrB;AAEA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAET,WAAO,KAAK,KAAK,KAAK,EAAE,QAAQ,CAAC,UAAU;AACzC,YAAM,OAAO,KAAK,MAAM;AACxB,YAAM,iBAAiB,KAAK,eAAe,IAAI;AAC/C,UAAI;AAAA,QAAQ,CAAC,WACX,KAAK,UAAU,EAAE,QAAQ,QAAQ,MAAM,gBAAgB,YAAY,CAAC;AAAA,MACtE;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA,EAIA,IAAI,UAA8C;AAChD,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA,EAMU,eAAe,MAAgD;AACvE,WAAO,CAAC,GAAG,KAAK,SAAS;AACvB,YAAM,YAAY,KAAK,MAAM,KAAK,IAAI,EAAE,IAAI,UAAU,CAAC;AACvD,YAAM,UAAU;AAAA,QACd,gBAAgB,KAAK,QAAQ,SAAS,KAAK;AAAA,QAC3C,GAAG,KAAK;AAAA,MACV;AAEA,aAAO,QAAQ,OAAO,EAAE,QAAQ,CAAC,CAAC,KAAK,KAAK,MAAM;AAChD,YAAI,UAAU,KAAK,KAAK;AAAA,MAC1B,CAAC;AAED,WAAK,UAAU;AAAA,QACb;AAAA,QACA,UAAU,KAAK;AAAA,QACf;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAMU,UAAU;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAgC;AAC9B,UAAM,EAAE,MAAM,IAAI;AAClB,WAAO,QAAQ,OAAO,CAAC,GAAG,aAAa,cAAc,CAAC;AAAA,EACxD;AAAA,EAWU,iBACR,SAC0B;AAC1B,QAAI,CAAC,QAAQ,SAAS,CAAC,QAAQ,MAAM,QAAQ;AAC3C,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,QAAI,CAAC,QAAQ,SAAS;AACpB,YAAM,IAAI,MAAM,kEAAkE;AAAA,IACpF;AAEA,UAAM,UAAU,OAAO,KAAK,QAAQ,OAAO;AAE3C,UAAM,aAAa,QAAQ,KAAK,CAAC,WAAW,QAAQ,QAAQ,OAAO;AACnE,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,gEAAgE;AAAA,IAClF;AAEA,UAAM,iBAAiC;AAAA,MACrC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,UAAM,UAAU,QAAQ;AAAA,MACtB,CAAC,WAAW,CAAC,eAAe,SAAS,OAAO,YAAY,CAAiB;AAAA,IAC3E;AAEA,QAAI,SAAS;AACX,YAAM,IAAI,MAAM,GAAG,oCAAoC;AAAA,IACzD;AAEA,UAAM,aAAa,QAAQ,OAAgC,CAAC,KAAK,WAAW;AAC1E,UAAI,OAAO,YAAY,KAAK,CAAC,CAAC,QAAQ,QAAQ;AAC9C,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAEL,WAAO;AAAA,MACL,GAAG;AAAA,MACH,SAAS;AAAA,IACX;AAAA,EACF;AAAA,EAKU,eAAsD;AAC9D,UAAM,EAAE,OAAO,MAAM,IAAI,KAAK;AAC9B,UAAM,YAAY,cAAc,MAAM,OAAO,OAAO,IAAI;AACxD,WAAO,MAAM,OAA8C,CAAC,KAAK,SAAS;AACxE,UAAI;AACJ,UAAI;AACJ,UAAI;AACJ,UAAI,OAAO,SAAS,UAAU;AAC5B,SAAC,EAAE,OAAO,MAAM,KAAK,QAAQ,IAAI;AAAA,MACnC,OAAO;AACL,cAAM;AACN,gBAAQ;AAAA,MACV;AAEA,YAAM,KAAK,KAAK,MAAM,QAAQ,GAAG;AACjC,cAAQ,cAAc,OAAO,MAAM,KAAK;AACxC,cAAQ,GAAG,aAAa;AACxB,UAAI,SAAS;AAAA,QACX,MAAM;AAAA,QACN;AAAA,QACA,SAAS,WAAW,CAAC;AAAA,MACvB;AAEA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AACF;AAQO,MAAM,oBAAoB;AAAA,EAC/B,CAAC,EAAE,mBAAmB,QAAQ,IAAqC,CAAC,MAClE,CAAC,QAAQ;AACP,UAAM,SAAS,IAAI,UAAU;AAC7B,UAAM,OAAO,IAAI,kBAAkB;AAAA,MACjC,QAAQ;AAAA,QACN,UAAU,IAAI,IAAI,UAAU;AAAA,MAC9B;AAAA,MACA,GAAG;AAAA,IACL,CAAC;AAED,QAAI;AACJ,QAAI,gBAAgB;AAClB,uBAAiB,eAAe,GAAG,EAChC,IAAI,CAAC,eAAe;AACnB,YAAI,gBAAgB,YAAY;AAC9B,iBAAO,WAAW,QAAQ,GAAG;AAAA,QAC/B;AAEA,eAAO;AAAA,MACT,CAAC,EACA,OAAO,YAAY;AAAA,IACxB;AAEA,WAAO,KAAK,UAAU,QAAQ,cAAc;AAAA,EAC9C;AACJ;","names":[]}
+{"version":3,"sources":["../../../../src/controllers/common/statics.ts"],"sourcesContent":["import * as path from 'path';\nimport * as mime from 'mime';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport {\n  controllerCreator,\n  removeSlashes,\n  notUndefined,\n  type MiddlewareLike,\n} from '../../utils';\nimport type { SendFile } from '../../services';\nimport type { Jimpex } from '../../app';\nimport type { DeepPartial, ExpressMiddleware, Router, RouterMethod } from '../../types';\n/**\n * The definition for each file the controller handles.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerFile = {\n  /**\n   * The route, relative to the controller root, to the file.\n   */\n  route: string;\n  /**\n   * The path to the file in the filesystem. Since the file is served using the\n   * {@link SendFile} service, whether the file is relative to the project root or the\n   * application executable depends on how the service is configured (relative to the\n   * executable by default).\n   */\n  path: string;\n  /**\n   * A dictionary of headers for the response.\n   */\n  headers?: Record<string, string>;\n};\n/**\n * These are like \"master paths\" that get prepended to all the file paths and routes the\n * controller use.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerPathsOptions = {\n  /**\n   * A custom route to prefix all the file routes with.\n   */\n  route: string;\n  /**\n   * A custom path to prefix all the file paths with.\n   */\n  source: string;\n};\n/**\n * The options to customize the controller.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerOptions = {\n  /**\n   * A list of filenames, or definitions for the files to handle.\n   */\n  files: Array<string | StaticsControllerFile>;\n  /**\n   * A dictionary with the allowed router (HTTP) methods the controller can use to serve\n   * the files. If `all` is set to `true`, the rest of the values will be ignored.\n   *\n   * @default {get: true, all: false}\n   */\n  methods: Partial<Record<RouterMethod, boolean>>;\n  /**\n   * The \"master paths\" the controller can use to prefix the file paths and routes.\n   *\n   * @default {route: '', source: './',}\n   */\n  paths: StaticsControllerPathsOptions;\n};\n/**\n * The options to construct a {@link StaticsController}.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerConstructorOptions =\n  DeepPartial<StaticsControllerOptions> & {\n    /**\n     * A dictionary with the dependencies to inject.\n     */\n    inject: {\n      sendFile: SendFile;\n    };\n  };\n/**\n * A function to generate a list of middlewares that can be executed before the tontroller\n * main middleware.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[];\n/**\n * The options for the controller creator that mounts {@link StaticsController}.\n *\n * @group Controllers/Statics\n */\nexport type StaticsControllerCreatorOptions = DeepPartial<StaticsControllerOptions> & {\n  /**\n   * A function to generate a list of middlewares that can be executed before the\n   * tontroller main middleware.\n   */\n  getMiddlewares?: StaticsControllerGetMiddlewaresFn;\n};\n/**\n * The options for {@link StaticsController._addRoute}.\n *\n * @access protected\n * @group Controllers/Statics\n */\nexport type AddStaticRouteOptions = {\n  /**\n   * The reference for the router in which the middlewares will be added.\n   */\n  router: Router;\n  /**\n   * The router method in which the middlewares will be added.\n   */\n  method: RouterMethod;\n  /**\n   * The definition of the file to serve.\n   */\n  file: StaticsControllerFile;\n  /**\n   * The middleware created by {@link StaticsController}, that will serve the file.\n   */\n  fileMiddleware: ExpressMiddleware;\n  /**\n   * A list of extra middlewares to execute before the file middleware.\n   */\n  middlewares: ExpressMiddleware[];\n};\n\n/**\n * The controller class that allows the application to serve specific files from any\n * folder to any route without the need of mounting directories as \"static\".\n *\n * @group Controller Classes\n * @group Controllers/Statics\n * @prettierignore\n */\nexport class StaticsController {\n  /**\n   * The service that serves static files.\n   */\n  protected readonly _sendFile: SendFile;\n  /**\n   * The controller customization options.\n   */\n  protected _options: StaticsControllerOptions;\n  /**\n   * A dictionary with the formatted definitions of the files that will be served.\n   * It uses the files' routes as keys, for easy access in the middleware.\n   */\n  protected files: Record<string, StaticsControllerFile>;\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({ inject, ...options }: StaticsControllerConstructorOptions) {\n    this._sendFile = inject.sendFile;\n    this._options = this._validateOptions(\n      deepAssignWithOverwrite(\n        {\n          files: ['favicon.ico', 'index.html'],\n          methods: options.methods || {\n            all: false,\n            get: true,\n          },\n          paths: {\n            route: '',\n            source: './',\n          },\n        },\n        options,\n      ),\n    );\n    this.files = this._createFiles();\n  }\n  /**\n   * Mounts the middlewares in the router in order to serve the files.\n   *\n   * @param router       A reference to the application router.\n   * @param middlewares  A list of extra middlewares to execute before the file\n   *                     middleware.\n   */\n  addRoutes(router: Router, middlewares: ExpressMiddleware[] = []): Router {\n    const { methods } = this._options;\n    const use: RouterMethod[] = methods.all\n      ? ['all']\n      : Object.keys(methods).reduce<RouterMethod[]>((acc, name) => {\n          const methodName = name as RouterMethod;\n          if (methods[methodName]) {\n            acc.push(methodName);\n          }\n\n          return acc;\n        }, []);\n\n    Object.keys(this.files).forEach((route) => {\n      const file = this.files[route as keyof typeof this.files]!;\n      const fileMiddleware = this._getMiddleware(file);\n      use.forEach((method) =>\n        this._addRoute({ router, method, file, fileMiddleware, middlewares }),\n      );\n    });\n\n    return router;\n  }\n  /**\n   * The controller options.\n   */\n  get options(): Readonly<StaticsControllerOptions> {\n    return { ...this._options };\n  }\n  /**\n   * Generates the middleware that will serve the file.\n   *\n   * @param file  The definition of the file to serve.\n   */\n  protected _getMiddleware(file: StaticsControllerFile): ExpressMiddleware {\n    return (_, res, next) => {\n      const extension = path.parse(file.path).ext.substring(1);\n      const headers = {\n        'Content-Type': mime.getType(extension) || 'text/html',\n        ...file.headers,\n      };\n\n      Object.entries(headers).forEach(([key, value]) => {\n        res.setHeader(key, value);\n      });\n\n      this._sendFile({\n        res,\n        filepath: file.path,\n        next,\n      });\n    };\n  }\n  /**\n   * Mounts the middleware(s) for a file in the router.\n   *\n   * @param options  The information of the file and how it needs to be added.\n   */\n  protected _addRoute({\n    router,\n    method,\n    file,\n    fileMiddleware,\n    middlewares,\n  }: AddStaticRouteOptions): void {\n    const { route } = file;\n    router[method](route, [...middlewares, fileMiddleware]);\n  }\n  /**\n   * Validates and formats the options sent to the constructor in order to get the final\n   * set that will be stored in the controller.\n   *\n   * @param options  The options to validate.\n   * @throws If no files are specified.\n   * @throws If methods is not defined.\n   * @throws If no methods are enabled.\n   * @throws If there's an invalid HTTP method.\n   */\n  protected _validateOptions(\n    options: StaticsControllerOptions,\n  ): StaticsControllerOptions {\n    if (!options.files || !options.files.length) {\n      throw new Error('You need to specify a list of files');\n    }\n\n    if (!options.methods) {\n      throw new Error('You need to specify which HTTP methods are allowed for the files');\n    }\n\n    const methods = Object.keys(options.methods) as RouterMethod[];\n\n    const atLeastOne = methods.some((method) => options.methods[method]);\n    if (!atLeastOne) {\n      throw new Error('You need to enable at least one HTTP method to serve the files');\n    }\n\n    const allowedMethods: RouterMethod[] = [\n      'all',\n      'get',\n      'head',\n      'post',\n      'patch',\n      'put',\n      'delete',\n      'connect',\n      'options',\n      'trace',\n    ];\n\n    const invalid = methods.find(\n      (method) => !allowedMethods.includes(method.toLowerCase() as RouterMethod),\n    );\n\n    if (invalid) {\n      throw new Error(`${invalid} is not a valid HTTP method`);\n    }\n\n    const newMethods = methods.reduce<Record<string, boolean>>((acc, method) => {\n      acc[method.toLowerCase()] = !!options.methods[method];\n      return acc;\n    }, {});\n\n    return {\n      ...options,\n      methods: newMethods,\n    };\n  }\n  /**\n   * Parses the files received from the constructor's options, and formats them into\n   * proper definitions the controller can use.\n   */\n  protected _createFiles(): Record<string, StaticsControllerFile> {\n    const { files, paths } = this._options;\n    const routePath = removeSlashes(paths.route, false, true);\n    return files.reduce<Record<string, StaticsControllerFile>>((acc, file) => {\n      let src;\n      let route;\n      let headers;\n      if (typeof file === 'object') {\n        ({ route, path: src, headers } = file);\n      } else {\n        src = file;\n        route = file;\n      }\n\n      src = path.join(paths.source, src);\n      route = removeSlashes(route, true, false);\n      route = `${routePath}/${route}`;\n      acc[route] = {\n        path: src,\n        route,\n        headers: headers || {},\n      };\n\n      return acc;\n    }, {});\n  }\n}\n/**\n * A controller that allows the application to server specific files from any folder to\n * any route without the need of mounting directories as \"static\" folders.\n *\n * @group Controllers\n * @group Controllers/Statics\n */\nexport const staticsController = controllerCreator(\n  ({ getMiddlewares, ...options }: StaticsControllerCreatorOptions = {}) =>\n    (app) => {\n      const router = app.getRouter();\n      const ctrl = new StaticsController({\n        inject: {\n          sendFile: app.get('sendFile'),\n        },\n        ...options,\n      });\n\n      let useMiddlewares: ExpressMiddleware[] | undefined;\n      if (getMiddlewares) {\n        useMiddlewares = getMiddlewares(app)\n          .map((middleware) => {\n            if ('middleware' in middleware) {\n              return middleware.connect(app) as ExpressMiddleware | undefined;\n            }\n\n            return middleware as ExpressMiddleware;\n          })\n          .filter(notUndefined);\n      }\n\n      return ctrl.addRoutes(router, useMiddlewares);\n    },\n);\n"],"mappings":";;;AAAA,YAAY,UAAU;AACtB,YAAY,UAAU;AACtB,SAAS,+BAA+B;AACxC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAwIA,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA,EAiB7B,YAAY,EAAE,QAAQ,GAAG,QAAQ,GAAwC;AAbzE;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAU;AAKV;AAAA;AAAA;AAAA;AAAA,wBAAU;AAKR,SAAK,YAAY,OAAO;AACxB,SAAK,WAAW,KAAK;AAAA,MACnB;AAAA,QACE;AAAA,UACE,OAAO,CAAC,eAAe,YAAY;AAAA,UACnC,SAAS,QAAQ,WAAW;AAAA,YAC1B,KAAK;AAAA,YACL,KAAK;AAAA,UACP;AAAA,UACA,OAAO;AAAA,YACL,OAAO;AAAA,YACP,QAAQ;AAAA,UACV;AAAA,QACF;AAAA,QACA;AAAA,MACF;AAAA,IACF;AACA,SAAK,QAAQ,KAAK,aAAa;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgB,cAAmC,CAAC,GAAW;AACvE,UAAM,EAAE,QAAQ,IAAI,KAAK;AACzB,UAAM,MAAsB,QAAQ,MAChC,CAAC,KAAK,IACN,OAAO,KAAK,OAAO,EAAE,OAAuB,CAAC,KAAK,SAAS;AACzD,YAAM,aAAa;AACnB,UAAI,QAAQ,UAAU,GAAG;AACvB,YAAI,KAAK,UAAU;AAAA,MACrB;AAEA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAET,WAAO,KAAK,KAAK,KAAK,EAAE,QAAQ,CAAC,UAAU;AACzC,YAAM,OAAO,KAAK,MAAM,KAAgC;AACxD,YAAM,iBAAiB,KAAK,eAAe,IAAI;AAC/C,UAAI;AAAA,QAAQ,CAAC,WACX,KAAK,UAAU,EAAE,QAAQ,QAAQ,MAAM,gBAAgB,YAAY,CAAC;AAAA,MACtE;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA8C;AAChD,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,eAAe,MAAgD;AACvE,WAAO,CAAC,GAAG,KAAK,SAAS;AACvB,YAAM,YAAY,KAAK,MAAM,KAAK,IAAI,EAAE,IAAI,UAAU,CAAC;AACvD,YAAM,UAAU;AAAA,QACd,gBAAgB,KAAK,QAAQ,SAAS,KAAK;AAAA,QAC3C,GAAG,KAAK;AAAA,MACV;AAEA,aAAO,QAAQ,OAAO,EAAE,QAAQ,CAAC,CAAC,KAAK,KAAK,MAAM;AAChD,YAAI,UAAU,KAAK,KAAK;AAAA,MAC1B,CAAC;AAED,WAAK,UAAU;AAAA,QACb;AAAA,QACA,UAAU,KAAK;AAAA,QACf;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,UAAU;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAgC;AAC9B,UAAM,EAAE,MAAM,IAAI;AAClB,WAAO,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,cAAc,CAAC;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWU,iBACR,SAC0B;AAC1B,QAAI,CAAC,QAAQ,SAAS,CAAC,QAAQ,MAAM,QAAQ;AAC3C,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,QAAI,CAAC,QAAQ,SAAS;AACpB,YAAM,IAAI,MAAM,kEAAkE;AAAA,IACpF;AAEA,UAAM,UAAU,OAAO,KAAK,QAAQ,OAAO;AAE3C,UAAM,aAAa,QAAQ,KAAK,CAAC,WAAW,QAAQ,QAAQ,MAAM,CAAC;AACnE,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,gEAAgE;AAAA,IAClF;AAEA,UAAM,iBAAiC;AAAA,MACrC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,UAAM,UAAU,QAAQ;AAAA,MACtB,CAAC,WAAW,CAAC,eAAe,SAAS,OAAO,YAAY,CAAiB;AAAA,IAC3E;AAEA,QAAI,SAAS;AACX,YAAM,IAAI,MAAM,GAAG,OAAO,6BAA6B;AAAA,IACzD;AAEA,UAAM,aAAa,QAAQ,OAAgC,CAAC,KAAK,WAAW;AAC1E,UAAI,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,QAAQ,MAAM;AACpD,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAEL,WAAO;AAAA,MACL,GAAG;AAAA,MACH,SAAS;AAAA,IACX;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAKU,eAAsD;AAC9D,UAAM,EAAE,OAAO,MAAM,IAAI,KAAK;AAC9B,UAAM,YAAY,cAAc,MAAM,OAAO,OAAO,IAAI;AACxD,WAAO,MAAM,OAA8C,CAAC,KAAK,SAAS;AACxE,UAAI;AACJ,UAAI;AACJ,UAAI;AACJ,UAAI,OAAO,SAAS,UAAU;AAC5B,SAAC,EAAE,OAAO,MAAM,KAAK,QAAQ,IAAI;AAAA,MACnC,OAAO;AACL,cAAM;AACN,gBAAQ;AAAA,MACV;AAEA,YAAM,KAAK,KAAK,MAAM,QAAQ,GAAG;AACjC,cAAQ,cAAc,OAAO,MAAM,KAAK;AACxC,cAAQ,GAAG,SAAS,IAAI,KAAK;AAC7B,UAAI,KAAK,IAAI;AAAA,QACX,MAAM;AAAA,QACN;AAAA,QACA,SAAS,WAAW,CAAC;AAAA,MACvB;AAEA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AACF;AAQO,MAAM,oBAAoB;AAAA,EAC/B,CAAC,EAAE,gBAAgB,GAAG,QAAQ,IAAqC,CAAC,MAClE,CAAC,QAAQ;AACP,UAAM,SAAS,IAAI,UAAU;AAC7B,UAAM,OAAO,IAAI,kBAAkB;AAAA,MACjC,QAAQ;AAAA,QACN,UAAU,IAAI,IAAI,UAAU;AAAA,MAC9B;AAAA,MACA,GAAG;AAAA,IACL,CAAC;AAED,QAAI;AACJ,QAAI,gBAAgB;AAClB,uBAAiB,eAAe,GAAG,EAChC,IAAI,CAAC,eAAe;AACnB,YAAI,gBAAgB,YAAY;AAC9B,iBAAO,WAAW,QAAQ,GAAG;AAAA,QAC/B;AAEA,eAAO;AAAA,MACT,CAAC,EACA,OAAO,YAAY;AAAA,IACxB;AAEA,WAAO,KAAK,UAAU,QAAQ,cAAc;AAAA,EAC9C;AACJ;","names":[]}

package/dist/esm/controllers/utils/gateway.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-T2T6Q22Z.js";
+} from "../../chunk-2B2CG5KL.js";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
 import { flat, unflat } from "@homer0/object-utils";
 import {
@@ -11,21 +11,59 @@ import {
   notUndefined
 } from "../../utils";
 class GatewayController {
+  /**
+   * @param options  The options to construct the controller.
+   */
   constructor({
     inject,
     route,
     gatewayConfig,
     ...options
   }) {
+    /**
+     * The service that makes HTTP requests.
+     */
     __publicField(this, "http");
+    /**
+     * A function to get a possible helper service. This is injected as a "getter" to not
+     * interrupt the DIC "lifecycle": controllers are initialized right when the app
+     * starts, and injecting a reference would force the service to be initialized too,
+     * even if a request is not being made.
+     */
     __publicField(this, "_getHelperService");
+    /**
+     * The information, url and endpoints, for the gateway the controller will make requests to.
+     */
     __publicField(this, "_gatewayConfig");
+    /**
+     * The route in which the controller is mounted.
+     */
     __publicField(this, "_route");
+    /**
+     * A regular expression that will be used to remove the controller route from a
+     * request path. This will allow the main middleware to extract the path to where the
+     * request should be made.
+     */
     __publicField(this, "_routeExpression");
+    /**
+     * The controller customization options.
+     */
     __publicField(this, "_options");
+    /**
+     * A flat dictionary with the endpoints information.
+     */
     __publicField(this, "_endpoints");
+    /**
+     * The entry URL for the API client configuration the controller can generate.
+     */
     __publicField(this, "_apiConfigUrl");
+    /**
+     * The generated endpoints for the API client configuration the controller can generate.
+     */
     __publicField(this, "_apiConfigEndpoints");
+    /**
+     * The list of routes the controller can handle.
+     */
     __publicField(this, "_routes");
     this.http = inject.http;
     this._getHelperService = inject.getHelperService || (() => void 0);
@@ -60,6 +98,11 @@ class GatewayController {
     this._apiConfigUrl = url;
     this._apiConfigEndpoints = endpoints;
   }
+  /**
+   * Generates an API client configuration based on the controller routes.
+   *
+   * @param options  The options to customize the generated configuration.
+   */
   getAPIConfig({
     setting,
     placeholders = {}
@@ -82,6 +125,13 @@ class GatewayController {
       }
     };
   }
+  /**
+   * Mounts the middlewares in the router in order to make the requests.
+   *
+   * @param router       A reference to the application router.
+   * @param middlewares  A list of extra middlewares to execute before the gateway
+   *                     middleware.
+   */
   addRoutes(router, middlewares = []) {
     this._routes.forEach((route) => {
       route.methods.forEach((info) => {
@@ -96,12 +146,24 @@ class GatewayController {
     });
     return router;
   }
+  /**
+   * The customization options.
+   */
   get options() {
     return { ...this._options };
   }
+  /**
+   * The configuration for the gateway the controller will make requests to.
+   */
   get gatewayConfig() {
     return { ...this._gatewayConfig };
   }
+  /**
+   * Generates a middleware that will make the request to an endpoint and stream the
+   * response.
+   *
+   * @param endpoint  The information of the endpoint the middleware will handle.
+   */
   _createGatewayMiddleware(endpoint) {
     return async (req, res, next) => {
       const {
@@ -189,6 +251,11 @@ class GatewayController {
       }
     };
   }
+  /**
+   * Mounts the middleware(s) for an endpoint in the router.
+   *
+   * @param options  The information of the endpoint and how it needs to be added.
+   */
   _addRoute({
     router,
     method,
@@ -198,6 +265,9 @@ class GatewayController {
   }) {
     router[method](route, [...middlewares, gatewayMiddleware]);
   }
+  /**
+   * Formats the endpoints for the gateway into a flat dictionary without nesting.
+   */
   _formatEndpoints() {
     return flat({
       target: this._gatewayConfig.gateway,
@@ -207,6 +277,13 @@ class GatewayController {
       }
     });
   }
+  /**
+   * Based on the information from the endpoints, this method will create the routes the
+   * controller will later add on a router.
+   *
+   * @throws If there's more than one endpoint using the same path with the same HTTP
+   *         method.
+   */
   _createRoutes() {
     const routes = {};
     Object.keys(this._endpoints).forEach((name) => {
@@ -256,6 +333,18 @@ class GatewayController {
       };
     });
   }
+  /**
+   * This is a "proxy method" to call the helper service's function that can modify an
+   * endpoint request before it gets made.
+   *
+   * The reason this is a "proxy method" is in case the controller gets subclassed and
+   * "used itself as a helper" instead of relying on a difference one.
+   *
+   * If the helper doesn't implement `reduceEndpointRequest`, it will just return
+   * information for the request.
+   *
+   * @param options  The information of the request and the reference to the helper.
+   */
   _reduceEndpointRequest({
     helper,
     ...options
@@ -265,6 +354,18 @@ class GatewayController {
     }
     return Promise.resolve(options.endpointReq);
   }
+  /**
+   * This is a "proxy method" to call the helper service's function that can modify an
+   * endpoint response before it gets processed.
+   *
+   * The reason this is a "proxy method" is in case the controller gets subclassed and
+   * "used itself as a helper" instead of relying on a difference one.
+   *
+   * If the helper doesn't implement `reduceEndpointResponse`, it will just return
+   * information for the response.
+   *
+   * @param options  The information of the response and the reference to the helper.
+   */
   _reduceEndpointResponse({
     helper,
     ...options
@@ -274,6 +375,18 @@ class GatewayController {
     }
     return Promise.resolve(options.endpointRes);
   }
+  /**
+   * This is a "proxy method" to call the helper service's function that can decide if an
+   * endpoint response should be streamed or not.
+   *
+   * The reason this is a "proxy method" is in case the controller gets subclassed and
+   * "used itself as a helper" instead of relying on a difference one.
+   *
+   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will just return
+   * `true`.
+   *
+   * @param options  The information of the response and the reference to the helper.
+   */
   _shouldStreamEndpointResponse({
     helper,
     ...options
@@ -283,6 +396,19 @@ class GatewayController {
     }
     return Promise.resolve(true);
   }
+  /**
+   * This is a "proxy method" to call the helper service's function that handles a
+   * response in case it already said that a response shouldn't be streamed.
+   *
+   * The reason this is a "proxy method" is in case the controller gets subclassed and
+   * "used itself as a helper" instead of relying on a difference one.
+   *
+   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will throw an
+   * error.
+   *
+   * @param options  The information of the response and the reference to the helper.
+   * @throws If the helper doesn't implement `handleEndpointResponse`.
+   */
   _handleEndpointResponse({
     helper,
     ...options
@@ -292,6 +418,18 @@ class GatewayController {
     }
     return helper.handleEndpointResponse(options);
   }
+  /**
+   * This is a "proxy method" to call the helper service's function that handles an error
+   * on an endpoint request.
+   *
+   * The reason this is a "proxy method" is in case the controller gets subclassed and
+   * "used itself as a helper" instead of relying on a difference one.
+   *
+   * If the helper doesn't implement `handleEndpointError`, it will just send the error to
+   * the next middleware/error handler.
+   *
+   * @param options  The information of the response and the reference to the helper.
+   */
   _handleEndpointError({
     helper,
     ...options
@@ -301,6 +439,11 @@ class GatewayController {
     }
     return options.next(options.error);
   }
+  /**
+   * Validates and formats the customization options sent to the controller.
+   *
+   * @param options  The options sent to the constructor.
+   */
   _formatOptions(options) {
     if (options.root) {
       const root = removeSlashes(options.root).trim();
@@ -308,6 +451,12 @@ class GatewayController {
     }
     return options;
   }
+  /**
+   * Validates a router/HTTP method that the controller intends to use for an endpoint. If
+   * it's not valid, it will return `all`.
+   *
+   * @param method  The HTTP method for the endpoint.
+   */
   _validateHTTPMethod(method) {
     const newMethod = method.toLowerCase();
     return [
@@ -322,6 +471,9 @@ class GatewayController {
       "trace"
     ].includes(newMethod) ? newMethod : "all";
   }
+  /**
+   * Creates the API client configuration based on the controller routes.
+   */
   _createAPIConfig() {
     let endpoints;
     const { root } = this._options;