jimpex 9.0.0 → 10.0.0

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

@@ -1,8 +1,7 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import * as path from "path";
-import * as mime from "mime";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
 import {
   controllerCreator,
@@ -18,6 +17,11 @@ class StaticsController {
      * The service that serves static files.
      */
     __publicField(this, "_sendFile");
+    /**
+     * The MIME type library. Since it's an ESM only module, Jimpex loads it on boot and makes
+     * it available on the container.
+     */
+    __publicField(this, "_mime");
     /**
      * The controller customization options.
      */
@@ -28,6 +32,7 @@ class StaticsController {
      */
     __publicField(this, "files");
     this._sendFile = inject.sendFile;
+    this._mime = inject.mime;
     this._options = this._validateOptions(
       deepAssignWithOverwrite(
         {
@@ -86,7 +91,7 @@ class StaticsController {
     return (_, res, next) => {
       const extension = path.parse(file.path).ext.substring(1);
       const headers = {
-        "Content-Type": mime.getType(extension) || "text/html",
+        "Content-Type": this._mime.getType(extension) || "text/html",
         ...file.headers
       };
       Object.entries(headers).forEach(([key, value]) => {
@@ -197,7 +202,8 @@ const staticsController = controllerCreator(
     const router = app.getRouter();
     const ctrl = new StaticsController({
       inject: {
-        sendFile: app.get("sendFile")
+        sendFile: app.get("sendFile"),
+        mime: app.get("mime")
       },
       ...options
     });

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;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":[]}
+{"version":3,"sources":["../../../../src/controllers/common/statics.ts"],"sourcesContent":["import * as path from 'path';\nimport type 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\ntype Mime = typeof mime;\n\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      mime: Mime;\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 MIME type library. Since it's an ESM only module, Jimpex loads it on boot and makes\n   * it available on the container.\n   */\n  protected readonly _mime: Mime;\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._mime = inject.mime;\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': this._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          mime: app.get('mime'),\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;AAEtB,SAAS,+BAA+B;AACxC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AA4IA,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA,EAsB7B,YAAY,EAAE,QAAQ,GAAG,QAAQ,GAAwC;AAlBzE;AAAA;AAAA;AAAA,wBAAmB;AAKnB;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAU;AAKV;AAAA;AAAA;AAAA;AAAA,wBAAU;AAKR,SAAK,YAAY,OAAO;AACxB,SAAK,QAAQ,OAAO;AACpB,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,MAAM,QAAQ,SAAS,KAAK;AAAA,QACjD,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,QAC5B,MAAM,IAAI,IAAI,MAAM;AAAA,MACtB;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-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
 import { flat, unflat } from "@homer0/object-utils";
 import {
@@ -228,6 +228,9 @@ class GatewayController {
           ...helperBasePayload
         });
         if (shouldStream) {
+          if (response.body === null) {
+            throw new Error("The response body is null");
+          }
           res.status(response.status);
           response.headers.forEach((value, name) => {
             if (!headersOptions.remove.includes(name)) {

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/controllers/utils/gateway.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { flat, unflat } from '@homer0/object-utils';\nimport type { APIClientOptions } from '@homer0/api-utils';\nimport {\n  controllerProviderCreator,\n  controller,\n  createRouteExpression,\n  removeSlashes,\n  notUndefined,\n  type MiddlewareLike,\n} from '../../utils';\nimport type { HTTP, HTTPFetchOptions } from '../../services';\nimport type { Jimpex } from '../../app';\nimport {\n  RouterMethod,\n  DeepPartial,\n  Request,\n  Response,\n  NextFunction,\n  HTTPResponse,\n  Router,\n  ExpressMiddleware,\n  AsyncExpressMiddleware,\n} from '../../types';\n/**\n * The extended definition for endpoints.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpointProps = {\n  /**\n   * The path to the endpoint relative to the entry point. It can include placeholders for\n   * parameters like `/:parameter/`.\n   */\n  path: string;\n  /**\n   * The router (HTTP) method for the endpoint.\n   *\n   * @default 'all'\n   */\n  method?: RouterMethod;\n};\n/**\n * The definition of an endpoint: it can be just the path, relative to the entry point, or\n * an object in which you can also specify things like the method.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpointDefinition = string | GatewayConfigEndpointProps;\n/**\n * The dictionary of endpoints the controller uses. The reason for this type is that this\n * could be a flat dictionary, or a nested one.\n *\n * @example\n *\n * <caption>A flat dictionary</caption>\n *\n * {\n *   random: '/random',\n *   users: '/users',\n *   userById: {\n *     path: '/users/:id',\n *     method: 'get',\n *   },\n * }\n *\n * @example\n *\n * <caption>A nested dictionary</caption>\n *\n * {\n *   random: '/random',\n *   users: {\n *     list: '/users',\n *     byId: {\n *       path: '/users/:id',\n *       method: 'get',\n *     },\n *   },\n * }\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpoints = {\n  [key: string]: GatewayConfigEndpointDefinition | GatewayConfigEndpoints;\n};\n/**\n * The configuration for the gateway the controller uses.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfig = {\n  /**\n   * The entry point to the API the controller will make the requests to.\n   */\n  url: string;\n  /**\n   * The dictionary of enpoints the gateway will make available.\n   */\n  gateway: GatewayConfigEndpoints;\n};\n/**\n * The options for how the gateway will handle the headers from the requests and the\n * responses.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerHeaderOptions = {\n  /**\n   * Whether or not to include the header with the request's IP address.\n   *\n   * @default true\n   */\n  useXForwardedFor: boolean;\n  /**\n   * Whether or not to copy all custom headers from the request. By custom header, it\n   * means all the headers which names start with `x-`.\n   *\n   * @default true\n   */\n  copyCustomHeaders: boolean;\n  /**\n   * A list of \"known\" headers the gateway will try to copy from the incoming request.\n   *\n   * @default ['authorization','content-type', 'referer', 'user-agent']\n   */\n  copy: string[];\n  /**\n   * A list of \"known\" headers the gateway will try to remove the response.\n   *\n   * @default ['server', 'x-powered-by']\n   */\n  remove: string[];\n};\n/**\n * The extra options for the gateway controller. They are \"extra\" because they are mostly\n * helpers for when used with an API client, or for optional features.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerExtraOptions = {\n  /**\n   * This is really a helper for when the gateway is used with an API client. The idea is\n   * that, by default, the routes are mounted on the controller route, but with this\n   * option, you can specify another sub path. For example: The controller is mounted on\n   * `/routes`, and if you set `root` to `gateway`, all the routes will be on\n   * `/routes/gateway`.\n   *\n   * This become important (and useful) when you get the API client configuration (with\n   * `getAPIConfig`): The `url` will be the controller route, but all the endpoints will\n   * be modified and prefixed with the `root`, that way, you can have multiple gateways in\n   * the same \"base route\".\n   *\n   * It can also includes placeholders for parameters like `/:parameter/`, that will be\n   * replaced with the `placeholders` option when `getAPIConfig` gets called.\n   *\n   * @default ''\n   */\n  root: string;\n  /**\n   * This is another option for when the gateway is used with an API client. When calling\n   * `getAPIConfig`, all the endpoints will be wrapped inside an object named after this\n   * option. For example: `{ url: '...', endpoints: { api: { ... } } }`.\n   *\n   * @default 'api'\n   */\n  apiConfigSetting: string;\n  /**\n   * The options for how the gateway will handle the headers from the requests and the\n   * responses.\n   */\n  headers: GatewayControllerHeaderOptions;\n};\n/**\n * The required options for the gateway controller.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerOptions = {\n  /**\n   * The configuration for the API the gateway will make the requests to.\n   */\n  gatewayConfig: GatewayConfig;\n  /**\n   * The route where the controller is mounted.\n   */\n  route: string;\n} & DeepPartial<GatewayControllerExtraOptions>;\n/**\n * The information for a request the controller will make.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRequest = {\n  /**\n   * The URL for the request.\n   */\n  url: string;\n  /**\n   * The options for the fetch client that will make the requests.\n   */\n  options: HTTPFetchOptions;\n};\n/**\n * The information for an endpoint the gateway is calling.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerEndpointInfo = {\n  /**\n   * The name of the endpoint in the configuration.\n   */\n  name: string;\n  /**\n   * The properties (path and method) of the endpoint.\n   */\n  definition: GatewayConfigEndpointDefinition;\n};\n/**\n * These are the base options sent to all the helper service functions.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceBaseFnOptions = {\n  /**\n   * The information of the endpoint the gateway is calling.\n   */\n  endpoint: GatewayControllerEndpointInfo;\n  /**\n   * The request recived by the application.\n   */\n  req: Request;\n  /**\n   * The response object created by the application.\n   */\n  res: Response;\n  /**\n   * The function to call the next middleware in the chain.\n   */\n  next: NextFunction;\n};\n/**\n * The information sent to the helper service in order to modify, or not, a request before\n * it is sent.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceRequestReducerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The options the controller created for the fetch client.\n     */\n    endpointReq: GatewayControllerRequest;\n  };\n/**\n * A function that can be used to modify the information of an endpoint before making a\n * request.\n *\n * @param options  The information of the request.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceRequestReducer = (\n  options: GatewayHelperServiceRequestReducerOptions,\n) => Promise<GatewayControllerRequest>;\n/**\n * The information sent to the helper service in order to modify a response before\n * processing it, decide if it should be streamed or not, and even handle it.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseReducerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The response from the endpoint request.\n     */\n    endpointRes: HTTPResponse;\n  };\n/**\n * A function that can be used to modify the response of an endpoint before the controller\n * processes it.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseReducer = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<HTTPResponse>;\n/**\n * A function that can be used to tell the controller to stream the response of an\n * endpoint or not.\n * If it returns `false`, the function to handle responses should be defined, otherwise,\n * an error will be generated.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceStreamVerification = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<boolean>;\n/**\n * A function to handle the response of an endpoint. This is called when the helper\n * service tells the controller that the endpoint shouldn't be streamed, so this method\n * should handle the response.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseHandler = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<void>;\n/**\n * The information sent to the helper service in order to handle a failed request for an\n * endpoint.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceErrorHandlerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The error generated during the request.\n     */\n    error: Error;\n  };\n/**\n * A function to handle the error of an endpoint request.\n *\n * @param options  The information of the error.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceErrorHandler = (\n  options: GatewayHelperServiceErrorHandlerOptions,\n) => void;\n/**\n * The interface of a helper service that can intercept/modify the requests and responses\n * the gateway makes.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperService = Partial<{\n  /**\n   * A function that is called before an endpoint request is made.\n   */\n  reduceEndpointRequest: GatewayHelperServiceRequestReducer;\n  /**\n   * A function that is called with the response of an endpoint request.\n   */\n  reduceEndpointResponse: GatewayHelperServiceResponseReducer;\n  /**\n   * A function called in order to validate if an endpoint response should be streamed or\n   * not. If the function returns `false`, `handleEndpointResponse` will be called.\n   */\n  shouldStreamEndpointResponse: GatewayHelperServiceStreamVerification;\n  /**\n   * A function called when `shouldStreamEndpointResponse` returns `false`. The function\n   * should handle the response for the application.\n   */\n  handleEndpointResponse: GatewayHelperServiceResponseHandler;\n  /**\n   * A function called when an error is generated during an endpoint request/processing.\n   */\n  handleEndpointError: GatewayHelperServiceErrorHandler;\n}>;\n/**\n * Utility type for the options object sent to the \"proxy methods\" the controller has for\n * the helper service.\n *\n * @template T  The type of the options for a specific helper service function.\n * @access protected\n * @group Controllers/Gateway\n */\nexport type GatewayControllerHelperOptions<T> = T & {\n  /**\n   * The reference for the helper service.\n   */\n  helper: GatewayHelperService;\n};\n/**\n * The information for a single HTTP method an endpoint can handle.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRouteMethod = {\n  /**\n   * The method for the route.\n   */\n  method: RouterMethod;\n  /**\n   * The information of the endpoint.\n   */\n  endpoint: GatewayControllerEndpointInfo;\n};\n/**\n * The information for all the HTTP methods that can be handled for an endpoint.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRoute = {\n  /**\n   * The path to the endpoint, relative to the entry point.\n   */\n  path: string;\n  /**\n   * The path for the route in the controller. This is different from `path` as it's possible for\n   * the gateway to be implemented using the `root` option.\n   */\n  route: string;\n  /**\n   * A list with all the methods the controller uses on the route.\n   */\n  methods: GatewayControllerRouteMethod[];\n};\n/**\n * The API client configuration the gateway can generate for its endpoints.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerAPIConfig = {\n  /**\n   * The base URL for the API.\n   */\n  url: string;\n  /**\n   * The dictionary of endpoints the controller handles.\n   */\n  endpoints: APIClientOptions['endpoints'];\n};\n/**\n * The options sent to {@link GatewayController.getAPIConfig}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerAPIConfigOptions = {\n  /**\n   * This can be used to overwrite the gateway's `apiConfigSetting` option, and set a new\n   * setting as a wrapper for the endpoints.\n   */\n  setting?: string;\n  /**\n   * A dictionary of values for possible placeholders that were sent using the `root`\n   * option.\n   */\n  placeholders?: Record<string, string>;\n};\n/**\n * The options to construct a {@link GatewayController}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerConstructorOptions = GatewayControllerOptions & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    http: HTTP;\n    /**\n     * A function to get a possible helper service. This is injected as a \"getter\" to not\n     * interrupt the DIC \"lifecycle\": controllers are initialized right when the app\n     * starts, and injecting a reference would force the service to be initialized too,\n     * even if a request is not being made.\n     */\n    getHelperService?: () => GatewayHelperService | undefined;\n  };\n};\n/**\n * The options for {@link GatewayController._addRoute}.\n *\n * @access protected\n * @group Controllers/Gateway\n */\nexport type AddGatewayRouteOptions = {\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 route in which the middlewares will be added.\n   */\n  route: string;\n  /**\n   * The middleware created by {@link GatewayController}, that makes the request.\n   */\n  gatewayMiddleware: AsyncExpressMiddleware;\n  /**\n   * A list of extra middlewares to prepend to the gateway middleware.\n   */\n  middlewares: ExpressMiddleware[];\n};\n/**\n * A utility controller that generates routes that act as a gateway for a specific API.\n *\n * @group Controller Classes\n * @group Controllers/Gateway\n * @prettierignore\n */\nexport class GatewayController {\n  /**\n   * The service that makes HTTP requests.\n   */\n  protected readonly http: HTTP;\n  /**\n   * A function to get a possible helper service. This is injected as a \"getter\" to not\n   * interrupt the DIC \"lifecycle\": controllers are initialized right when the app\n   * starts, and injecting a reference would force the service to be initialized too,\n   * even if a request is not being made.\n   */\n  protected readonly _getHelperService: () => GatewayHelperService | undefined;\n  /**\n   * The information, url and endpoints, for the gateway the controller will make requests to.\n   */\n  protected readonly _gatewayConfig: GatewayConfig;\n  /**\n   * The route in which the controller is mounted.\n   */\n  protected readonly _route: string;\n  /**\n   * A regular expression that will be used to remove the controller route from a\n   * request path. This will allow the main middleware to extract the path to where the\n   * request should be made.\n   */\n  protected readonly _routeExpression: RegExp;\n  /**\n   * The controller customization options.\n   */\n  protected readonly _options: GatewayControllerExtraOptions;\n  /**\n   * A flat dictionary with the endpoints information.\n   */\n  protected readonly _endpoints: Record<string, GatewayConfigEndpointDefinition>;\n  /**\n   * The entry URL for the API client configuration the controller can generate.\n   */\n  protected readonly _apiConfigUrl: string;\n  /**\n   * The generated endpoints for the API client configuration the controller can generate.\n   */\n  protected readonly _apiConfigEndpoints: APIClientOptions['endpoints'];\n  /**\n   * The list of routes the controller can handle.\n   */\n  protected readonly _routes: GatewayControllerRoute[];\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({\n    inject,\n    route,\n    gatewayConfig,\n    ...options\n  }: GatewayControllerConstructorOptions) {\n    this.http = inject.http;\n    this._getHelperService = inject.getHelperService || (() => undefined);\n    this._route = removeSlashes(route);\n    this._options = this._formatOptions(\n      deepAssignWithOverwrite(\n        {\n          root: '',\n          apiConfigSetting: 'api',\n          headers: {\n            useXForwardedFor: true,\n            copyCustomHeaders: true,\n            copy: ['authorization', 'content-type', 'referer', 'user-agent'],\n            remove: ['server', 'x-powered-by', 'content-encoding'],\n          },\n        },\n        options,\n      ),\n    );\n    this._gatewayConfig = {\n      ...gatewayConfig,\n      url: removeSlashes(gatewayConfig.url, false, true),\n    };\n    this._routeExpression = createRouteExpression(\n      this._options.root ? `${this._route}/${this._options.root}` : this._route,\n      true,\n      true,\n    );\n    this._endpoints = this._formatEndpoints();\n    this._routes = this._createRoutes();\n    const { url, endpoints } = this._createAPIConfig();\n    this._apiConfigUrl = url;\n    this._apiConfigEndpoints = endpoints;\n  }\n  /**\n   * Generates an API client configuration based on the controller routes.\n   *\n   * @param options  The options to customize the generated configuration.\n   */\n  getAPIConfig({\n    setting,\n    placeholders = {},\n  }: GatewayControllerAPIConfigOptions = {}): Readonly<GatewayControllerAPIConfig> {\n    const useSetting = setting || this._options.apiConfigSetting;\n    let url: string;\n    const placeholdersEntries = Object.entries(placeholders);\n    if (placeholdersEntries.length) {\n      url = placeholdersEntries.reduce<string>(\n        (acc, [key, value]) => acc.replace(`:${key}`, value),\n        this._apiConfigUrl,\n      );\n    } else {\n      url = this._apiConfigUrl;\n    }\n\n    return {\n      url,\n      endpoints: {\n        [useSetting]: this._apiConfigEndpoints,\n      },\n    };\n  }\n  /**\n   * Mounts the middlewares in the router in order to make the requests.\n   *\n   * @param router       A reference to the application router.\n   * @param middlewares  A list of extra middlewares to execute before the gateway\n   *                     middleware.\n   */\n  addRoutes(router: Router, middlewares: ExpressMiddleware[] = []): Router {\n    this._routes.forEach((route) => {\n      route.methods.forEach((info) => {\n        this._addRoute({\n          router,\n          method: info.method,\n          route: route.route,\n          gatewayMiddleware: this._createGatewayMiddleware(info.endpoint),\n          middlewares,\n        });\n      });\n    });\n\n    return router;\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<GatewayControllerExtraOptions> {\n    return { ...this._options };\n  }\n  /**\n   * The configuration for the gateway the controller will make requests to.\n   */\n  get gatewayConfig(): Readonly<GatewayConfig> {\n    return { ...this._gatewayConfig };\n  }\n  /**\n   * Generates a middleware that will make the request to an endpoint and stream the\n   * response.\n   *\n   * @param endpoint  The information of the endpoint the middleware will handle.\n   */\n  protected _createGatewayMiddleware(\n    endpoint: GatewayControllerEndpointInfo,\n  ): AsyncExpressMiddleware {\n    return async (req, res, next) => {\n      const {\n        _options: { headers: headersOptions },\n        _gatewayConfig: { url: gatewayUrl },\n        _routeExpression: routeExpression,\n      } = this;\n      // Remove the controller route from the requested URL.\n      const reqPath = req.originalUrl.replace(routeExpression, '');\n      // Process the headers for the request.\n      let headers: Record<string, string> = {};\n      // - Copy the headers from the incoming request.\n      headersOptions.copy.forEach((name) => {\n        if (req.headers[name]) {\n          headers[name] = req.headers[name] as string;\n        }\n      });\n      // - Copy the custom headers.\n      if (headersOptions.copyCustomHeaders) {\n        headers = deepAssignWithOverwrite<Record<string, string>>(\n          headers,\n          this.http.getCustomHeadersFromRequest(req),\n        );\n      }\n      // - Include the IP on the X-Forwarded-For header, if enabled.\n      if (headersOptions.useXForwardedFor) {\n        const ip = this.http.getIPFromRequest(req);\n        if (ip) {\n          headers['x-forwarded-for'] = ip;\n        }\n      }\n\n      const method = req.method.toUpperCase();\n      // If the request has a body and the method is not `GET`, stringify it.\n      let body: string | undefined;\n      if (method !== 'GET' && typeof req.body === 'object') {\n        body = JSON.stringify(req.body);\n        // If there's no `content-type`, let's assume it's JSON.\n        if (!headers['content-type']) {\n          headers['content-type'] = 'application/json';\n        }\n      }\n\n      /**\n       * Get the helper service, if there's one, and define the base options for its\n       * methods.\n       */\n      const helper = this._getHelperService() || {};\n      const helperBasePayload = {\n        endpoint,\n        req,\n        res,\n        next,\n        helper,\n      };\n\n      try {\n        // Reduce the request information before using it.\n        const request = await this._reduceEndpointRequest({\n          endpointReq: {\n            url: `${gatewayUrl}/${reqPath}`,\n            options: {\n              method,\n              headers,\n              body,\n            },\n          },\n          ...helperBasePayload,\n        });\n        // Make the actual request.\n        const responseRaw = await this.http.fetch(request.url, request.options);\n        // Reduce the response information before using it.\n        const response = await this._reduceEndpointResponse({\n          endpointRes: responseRaw,\n          ...helperBasePayload,\n        });\n        // Validate if the response should be streamed.\n        const shouldStream = await this._shouldStreamEndpointResponse({\n          endpointRes: responseRaw,\n          ...helperBasePayload,\n        });\n\n        if (shouldStream) {\n          /**\n           * If the response should be streamed, set the status, remove unwanted headers,\n           * and pipe it to the application response object.\n           */\n          res.status(response.status);\n          response.headers.forEach((value, name) => {\n            if (!headersOptions.remove.includes(name)) {\n              res.setHeader(name, value);\n            }\n          });\n\n          response.body.pipe(res).on('error', (error) => {\n            next(error);\n          });\n        } else {\n          /**\n           * If the response should not be streamed, send it to the helper method to\n           * handle it.\n           */\n          await this._handleEndpointResponse({\n            endpointRes: response,\n            ...helperBasePayload,\n          });\n        }\n      } catch (error) {\n        // Something failed, so let's pass the error to the helper service.\n        this._handleEndpointError({\n          error: error as Error,\n          ...helperBasePayload,\n        });\n      }\n    };\n  }\n  /**\n   * Mounts the middleware(s) for an endpoint in the router.\n   *\n   * @param options  The information of the endpoint and how it needs to be added.\n   */\n  protected _addRoute({\n    router,\n    method,\n    route,\n    gatewayMiddleware,\n    middlewares,\n  }: AddGatewayRouteOptions): void {\n    router[method](route, [...middlewares, gatewayMiddleware]);\n  }\n  /**\n   * Formats the endpoints for the gateway into a flat dictionary without nesting.\n   */\n  protected _formatEndpoints(): Record<string, GatewayConfigEndpointDefinition> {\n    return flat({\n      target: this._gatewayConfig.gateway,\n      shouldFlatten: (_, value) => {\n        const useValue = value as { path?: string };\n        return typeof useValue.path === 'undefined';\n      },\n    });\n  }\n  /**\n   * Based on the information from the endpoints, this method will create the routes the\n   * controller will later add on a router.\n   *\n   * @throws If there's more than one endpoint using the same path with the same HTTP\n   *         method.\n   */\n  protected _createRoutes(): GatewayControllerRoute[] {\n    const routes: Record<\n      string,\n      {\n        path: string;\n        methods: Partial<Record<RouterMethod, string>>;\n      }\n    > = {};\n    Object.keys(this._endpoints).forEach((name) => {\n      const endpoint = this._endpoints[name]!;\n      let endpointPath: string;\n      let endpointMethod: RouterMethod;\n      if (typeof endpoint === 'string') {\n        endpointPath = endpoint;\n        endpointMethod = 'all';\n      } else {\n        endpointPath = endpoint.path;\n        endpointMethod = endpoint.method\n          ? this._validateHTTPMethod(endpoint.method)\n          : 'all';\n      }\n\n      endpointPath = removeSlashes(endpointPath);\n      if (!routes[endpointPath]) {\n        routes[endpointPath] = {\n          path: endpointPath,\n          methods: {},\n        };\n      }\n\n      if (routes[endpointPath]!.methods[endpointMethod]) {\n        const repeatedEndpoint = routes[endpointPath]!.methods[endpointMethod];\n        throw new Error(\n          \"You can't have two gateway endpoints to the same path and with the same \" +\n            `HTTP method: '${repeatedEndpoint}' and '${name}'`,\n        );\n      }\n\n      routes[endpointPath]!.methods[endpointMethod] = name;\n    });\n\n    const routePrefixes = this._options.root ? `/${this._options.root}/` : '/';\n    return Object.keys(routes).map((endpointPath) => {\n      const info = routes[endpointPath]!;\n      return {\n        path: info.path,\n        route: `${routePrefixes}${info.path}`,\n        methods: Object.keys(info.methods).map((methodNameRaw) => {\n          const methodName = methodNameRaw as RouterMethod;\n          const endpointName = info.methods[methodName]!;\n          const endpointDefinition = this._endpoints[endpointName]!;\n          return {\n            method: methodName,\n            endpoint: {\n              name: endpointName,\n              definition: endpointDefinition,\n            },\n          };\n        }),\n      };\n    });\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can modify an\n   * endpoint request before it gets made.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `reduceEndpointRequest`, it will just return\n   * information for the request.\n   *\n   * @param options  The information of the request and the reference to the helper.\n   */\n  protected _reduceEndpointRequest({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceRequestReducerOptions>): Promise<GatewayControllerRequest> {\n    if (helper.reduceEndpointRequest) {\n      return helper.reduceEndpointRequest(options);\n    }\n\n    return Promise.resolve(options.endpointReq);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can modify an\n   * endpoint response before it gets processed.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `reduceEndpointResponse`, it will just return\n   * information for the response.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _reduceEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<HTTPResponse> {\n    if (helper.reduceEndpointResponse) {\n      return helper.reduceEndpointResponse(options);\n    }\n\n    return Promise.resolve(options.endpointRes);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can decide if an\n   * endpoint response should be streamed or not.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will just return\n   * `true`.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _shouldStreamEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<boolean> {\n    if (helper.shouldStreamEndpointResponse) {\n      return helper.shouldStreamEndpointResponse(options);\n    }\n\n    return Promise.resolve(true);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that handles a\n   * response in case it already said that a response shouldn't be streamed.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will throw an\n   * error.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   * @throws If the helper doesn't implement `handleEndpointResponse`.\n   */\n  protected _handleEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<void> {\n    if (!helper.handleEndpointResponse) {\n      throw new Error('You must implement handleEndpointResponse');\n    }\n\n    return helper.handleEndpointResponse(options);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that handles an error\n   * on an endpoint request.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `handleEndpointError`, it will just send the error to\n   * the next middleware/error handler.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _handleEndpointError({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceErrorHandlerOptions>): void {\n    if (helper.handleEndpointError) {\n      return helper.handleEndpointError(options);\n    }\n\n    return options.next(options.error);\n  }\n  /**\n   * Validates and formats the customization options sent to the controller.\n   *\n   * @param options  The options sent to the constructor.\n   */\n  protected _formatOptions(\n    options: GatewayControllerExtraOptions,\n  ): GatewayControllerExtraOptions {\n    if (options.root) {\n      const root = removeSlashes(options.root).trim();\n      return { ...options, root };\n    }\n\n    return options;\n  }\n  /**\n   * Validates a router/HTTP method that the controller intends to use for an endpoint. If\n   * it's not valid, it will return `all`.\n   *\n   * @param method  The HTTP method for the endpoint.\n   */\n  protected _validateHTTPMethod(method: string): RouterMethod {\n    const newMethod = method.toLowerCase();\n    return [\n      'get',\n      'head',\n      'post',\n      'patch',\n      'put',\n      'delete',\n      'connect',\n      'options',\n      'trace',\n    ].includes(newMethod)\n      ? (newMethod as RouterMethod)\n      : 'all';\n  }\n  /**\n   * Creates the API client configuration based on the controller routes.\n   */\n  protected _createAPIConfig(): GatewayControllerAPIConfig {\n    let endpoints: APIClientOptions['endpoints'];\n    const { root } = this._options;\n    if (root) {\n      endpoints = Object.keys(this._endpoints).reduce<\n        Record<string, GatewayConfigEndpointDefinition>\n      >((acc, name) => {\n        const endpoint = this._endpoints[name]!;\n        let newEndpoint;\n        if (typeof endpoint === 'string') {\n          newEndpoint = removeSlashes(endpoint);\n          newEndpoint = `${root}/${newEndpoint}`;\n        } else {\n          const endpointPath = removeSlashes(endpoint.path);\n          newEndpoint = {\n            ...endpoint,\n            path: `${root}/${endpointPath}`,\n          };\n        }\n\n        acc[name] = newEndpoint;\n        return acc;\n      }, {});\n    } else {\n      endpoints = this._endpoints;\n    }\n\n    return {\n      url: `/${this._route}`,\n      endpoints: unflat({ target: endpoints }),\n    };\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/Gateway\n */\nexport type GatewayControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[];\n/**\n * The options for the controller creator that mounts the {@link GatewayController}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerCreatorOptions =\n  DeepPartial<GatewayControllerExtraOptions> & {\n    /**\n     * The name the creator will use to register the controller in the container. No,\n     * this is not a typo. The creator will register the controller so other services can\n     * access the `getAPIConfig` method. The service will be available after the app\n     * routes are mounted.\n     * If this is overwritten, the creator will ensure that the name ends with `Gateway`;\n     * and if overwritten, but it doesn't include `Gateway` at the end, and no\n     * `gatewaySettingName` was defined, the creator will use the custom name (without\n     * `Gatway`) for `gatewaySettingName`.\n     *\n     * @default 'apiGateway'\n     */\n    serviceName?: string;\n    /**\n     * The name of the helper service the creator will try to obtain from the container.\n     * If `serviceName` is overwritten, the default for this will be\n     * `${serviceName}Helper`.\n     *\n     * @default 'apiGatewayHelper'\n     */\n    helperServiceName?: string;\n    /**\n     * The name of the configuration setting where the gateway configuration is stored. If\n     * not overwritten, check the description of `serviceName` to understand which will be\n     * its default value.\n     *\n     * @default 'api'\n     */\n    gatewaySettingName?: string;\n    /**\n     * The class the creator will instantiate. Similar to the API Client, this allows for\n     * extra customization as you can send a custom subclass of the\n     * {@link GatewayController}.\n     *\n     * @default GatewayController\n     */\n    gatewayClass?: typeof GatewayController;\n    /**\n     * A function to generate a list of middlewares that can be executed before the\n     * controller main middleware.\n     */\n    getMiddlewares?: GatewayControllerGetMiddlewaresFn;\n  };\n/**\n * Creates a controller that allows the application to mount routes that will work like\n * gateway to a specific API.\n *\n * @group Controllers\n * @group Controllers/Gateway\n */\nexport const gatewayController = controllerProviderCreator(\n  (options: GatewayControllerCreatorOptions = {}) =>\n    (app, route) => {\n      /**\n       * Formats the name in order to keep consistency with the helper service and the\n       * configuration setting: If the `serviceName` is different from the default, make\n       * sure it ends with `Gateway`, set the default helper service name to\n       * `${serviceName}Helper`, and the default configuration setting to the same as the\n       * service name (without the `Gateway`).\n       * This way, if you just use `myApi`, the service name will be `myApiGateway`, the\n       * helper name will be `myApiGatewayHelper` and the configuration setting `myApi`.\n       */\n      const defaultServiceName = 'apiGateway';\n      let defaultHelperServiceName = 'apiGatewayHelper';\n      let defaultConfigSetting = 'api';\n      let { serviceName = defaultServiceName } = options;\n      if (serviceName !== defaultServiceName) {\n        defaultConfigSetting = serviceName;\n        if (!serviceName.match(/gateway$/i)) {\n          serviceName = `${serviceName}Gateway`;\n        }\n        defaultHelperServiceName = `${serviceName}Helper`;\n      }\n      // Register the service.\n      app.set(serviceName, () => {\n        const {\n          helperServiceName = defaultHelperServiceName,\n          gatewaySettingName = defaultConfigSetting,\n          gatewayClass: GatewayClass = GatewayController,\n        } = options;\n\n        const gtConfig = app.getConfig<GatewayConfig>(gatewaySettingName);\n\n        return new GatewayClass({\n          ...options,\n          apiConfigSetting: gatewaySettingName,\n          gatewayConfig: gtConfig,\n          route,\n          inject: {\n            http: app.get('http'),\n            getHelperService: () => app.try(helperServiceName),\n          },\n        });\n      });\n\n      return controller(() => {\n        // Get the controller.\n        const ctrl = app.get<GatewayController>(serviceName);\n        /**\n         * Check if there are actual middlewares to be included, and in case there are\n         * Jimpex middlewares, connect them.\n         */\n        let useMiddlewares: ExpressMiddleware[] | undefined;\n        if (options.getMiddlewares) {\n          useMiddlewares = options\n            .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        // Add the routes to the router and return it.\n        return ctrl.addRoutes(app.get('router'), useMiddlewares);\n      });\n    },\n);\n"],"mappings":";;;AAAA,SAAS,+BAA+B;AACxC,SAAS,MAAM,cAAc;AAE7B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAweA,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA,EAiD7B,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACL,GAAwC;AAlDxC;AAAA;AAAA;AAAA,wBAAmB;AAOnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAMnB;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAUjB,SAAK,OAAO,OAAO;AACnB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,SAAS,cAAc,KAAK;AACjC,SAAK,WAAW,KAAK;AAAA,MACnB;AAAA,QACE;AAAA,UACE,MAAM;AAAA,UACN,kBAAkB;AAAA,UAClB,SAAS;AAAA,YACP,kBAAkB;AAAA,YAClB,mBAAmB;AAAA,YACnB,MAAM,CAAC,iBAAiB,gBAAgB,WAAW,YAAY;AAAA,YAC/D,QAAQ,CAAC,UAAU,gBAAgB,kBAAkB;AAAA,UACvD;AAAA,QACF;AAAA,QACA;AAAA,MACF;AAAA,IACF;AACA,SAAK,iBAAiB;AAAA,MACpB,GAAG;AAAA,MACH,KAAK,cAAc,cAAc,KAAK,OAAO,IAAI;AAAA,IACnD;AACA,SAAK,mBAAmB;AAAA,MACtB,KAAK,SAAS,OAAO,GAAG,KAAK,MAAM,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK;AAAA,MACnE;AAAA,MACA;AAAA,IACF;AACA,SAAK,aAAa,KAAK,iBAAiB;AACxC,SAAK,UAAU,KAAK,cAAc;AAClC,UAAM,EAAE,KAAK,UAAU,IAAI,KAAK,iBAAiB;AACjD,SAAK,gBAAgB;AACrB,SAAK,sBAAsB;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa;AAAA,IACX;AAAA,IACA,eAAe,CAAC;AAAA,EAClB,IAAuC,CAAC,GAAyC;AAC/E,UAAM,aAAa,WAAW,KAAK,SAAS;AAC5C,QAAI;AACJ,UAAM,sBAAsB,OAAO,QAAQ,YAAY;AACvD,QAAI,oBAAoB,QAAQ;AAC9B,YAAM,oBAAoB;AAAA,QACxB,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,QAAQ,IAAI,GAAG,IAAI,KAAK;AAAA,QACnD,KAAK;AAAA,MACP;AAAA,IACF,OAAO;AACL,YAAM,KAAK;AAAA,IACb;AAEA,WAAO;AAAA,MACL;AAAA,MACA,WAAW;AAAA,QACT,CAAC,UAAU,GAAG,KAAK;AAAA,MACrB;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgB,cAAmC,CAAC,GAAW;AACvE,SAAK,QAAQ,QAAQ,CAAC,UAAU;AAC9B,YAAM,QAAQ,QAAQ,CAAC,SAAS;AAC9B,aAAK,UAAU;AAAA,UACb;AAAA,UACA,QAAQ,KAAK;AAAA,UACb,OAAO,MAAM;AAAA,UACb,mBAAmB,KAAK,yBAAyB,KAAK,QAAQ;AAAA,UAC9D;AAAA,QACF,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAmD;AACrD,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,gBAAyC;AAC3C,WAAO,EAAE,GAAG,KAAK,eAAe;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,yBACR,UACwB;AACxB,WAAO,OAAO,KAAK,KAAK,SAAS;AAC/B,YAAM;AAAA,QACJ,UAAU,EAAE,SAAS,eAAe;AAAA,QACpC,gBAAgB,EAAE,KAAK,WAAW;AAAA,QAClC,kBAAkB;AAAA,MACpB,IAAI;AAEJ,YAAM,UAAU,IAAI,YAAY,QAAQ,iBAAiB,EAAE;AAE3D,UAAI,UAAkC,CAAC;AAEvC,qBAAe,KAAK,QAAQ,CAAC,SAAS;AACpC,YAAI,IAAI,QAAQ,IAAI,GAAG;AACrB,kBAAQ,IAAI,IAAI,IAAI,QAAQ,IAAI;AAAA,QAClC;AAAA,MACF,CAAC;AAED,UAAI,eAAe,mBAAmB;AACpC,kBAAU;AAAA,UACR;AAAA,UACA,KAAK,KAAK,4BAA4B,GAAG;AAAA,QAC3C;AAAA,MACF;AAEA,UAAI,eAAe,kBAAkB;AACnC,cAAM,KAAK,KAAK,KAAK,iBAAiB,GAAG;AACzC,YAAI,IAAI;AACN,kBAAQ,iBAAiB,IAAI;AAAA,QAC/B;AAAA,MACF;AAEA,YAAM,SAAS,IAAI,OAAO,YAAY;AAEtC,UAAI;AACJ,UAAI,WAAW,SAAS,OAAO,IAAI,SAAS,UAAU;AACpD,eAAO,KAAK,UAAU,IAAI,IAAI;AAE9B,YAAI,CAAC,QAAQ,cAAc,GAAG;AAC5B,kBAAQ,cAAc,IAAI;AAAA,QAC5B;AAAA,MACF;AAMA,YAAM,SAAS,KAAK,kBAAkB,KAAK,CAAC;AAC5C,YAAM,oBAAoB;AAAA,QACxB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,UAAI;AAEF,cAAM,UAAU,MAAM,KAAK,uBAAuB;AAAA,UAChD,aAAa;AAAA,YACX,KAAK,GAAG,UAAU,IAAI,OAAO;AAAA,YAC7B,SAAS;AAAA,cACP;AAAA,cACA;AAAA,cACA;AAAA,YACF;AAAA,UACF;AAAA,UACA,GAAG;AAAA,QACL,CAAC;AAED,cAAM,cAAc,MAAM,KAAK,KAAK,MAAM,QAAQ,KAAK,QAAQ,OAAO;AAEtE,cAAM,WAAW,MAAM,KAAK,wBAAwB;AAAA,UAClD,aAAa;AAAA,UACb,GAAG;AAAA,QACL,CAAC;AAED,cAAM,eAAe,MAAM,KAAK,8BAA8B;AAAA,UAC5D,aAAa;AAAA,UACb,GAAG;AAAA,QACL,CAAC;AAED,YAAI,cAAc;AAKhB,cAAI,OAAO,SAAS,MAAM;AAC1B,mBAAS,QAAQ,QAAQ,CAAC,OAAO,SAAS;AACxC,gBAAI,CAAC,eAAe,OAAO,SAAS,IAAI,GAAG;AACzC,kBAAI,UAAU,MAAM,KAAK;AAAA,YAC3B;AAAA,UACF,CAAC;AAED,mBAAS,KAAK,KAAK,GAAG,EAAE,GAAG,SAAS,CAAC,UAAU;AAC7C,iBAAK,KAAK;AAAA,UACZ,CAAC;AAAA,QACH,OAAO;AAKL,gBAAM,KAAK,wBAAwB;AAAA,YACjC,aAAa;AAAA,YACb,GAAG;AAAA,UACL,CAAC;AAAA,QACH;AAAA,MACF,SAAS,OAAO;AAEd,aAAK,qBAAqB;AAAA,UACxB;AAAA,UACA,GAAG;AAAA,QACL,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,UAAU;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAiC;AAC/B,WAAO,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,iBAAiB,CAAC;AAAA,EAC3D;AAAA;AAAA;AAAA;AAAA,EAIU,mBAAoE;AAC5E,WAAO,KAAK;AAAA,MACV,QAAQ,KAAK,eAAe;AAAA,MAC5B,eAAe,CAAC,GAAG,UAAU;AAC3B,cAAM,WAAW;AACjB,eAAO,OAAO,SAAS,SAAS;AAAA,MAClC;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,gBAA0C;AAClD,UAAM,SAMF,CAAC;AACL,WAAO,KAAK,KAAK,UAAU,EAAE,QAAQ,CAAC,SAAS;AAC7C,YAAM,WAAW,KAAK,WAAW,IAAI;AACrC,UAAI;AACJ,UAAI;AACJ,UAAI,OAAO,aAAa,UAAU;AAChC,uBAAe;AACf,yBAAiB;AAAA,MACnB,OAAO;AACL,uBAAe,SAAS;AACxB,yBAAiB,SAAS,SACtB,KAAK,oBAAoB,SAAS,MAAM,IACxC;AAAA,MACN;AAEA,qBAAe,cAAc,YAAY;AACzC,UAAI,CAAC,OAAO,YAAY,GAAG;AACzB,eAAO,YAAY,IAAI;AAAA,UACrB,MAAM;AAAA,UACN,SAAS,CAAC;AAAA,QACZ;AAAA,MACF;AAEA,UAAI,OAAO,YAAY,EAAG,QAAQ,cAAc,GAAG;AACjD,cAAM,mBAAmB,OAAO,YAAY,EAAG,QAAQ,cAAc;AACrE,cAAM,IAAI;AAAA,UACR,yFACmB,gBAAgB,UAAU,IAAI;AAAA,QACnD;AAAA,MACF;AAEA,aAAO,YAAY,EAAG,QAAQ,cAAc,IAAI;AAAA,IAClD,CAAC;AAED,UAAM,gBAAgB,KAAK,SAAS,OAAO,IAAI,KAAK,SAAS,IAAI,MAAM;AACvE,WAAO,OAAO,KAAK,MAAM,EAAE,IAAI,CAAC,iBAAiB;AAC/C,YAAM,OAAO,OAAO,YAAY;AAChC,aAAO;AAAA,QACL,MAAM,KAAK;AAAA,QACX,OAAO,GAAG,aAAa,GAAG,KAAK,IAAI;AAAA,QACnC,SAAS,OAAO,KAAK,KAAK,OAAO,EAAE,IAAI,CAAC,kBAAkB;AACxD,gBAAM,aAAa;AACnB,gBAAM,eAAe,KAAK,QAAQ,UAAU;AAC5C,gBAAM,qBAAqB,KAAK,WAAW,YAAY;AACvD,iBAAO;AAAA,YACL,QAAQ;AAAA,YACR,UAAU;AAAA,cACR,MAAM;AAAA,cACN,YAAY;AAAA,YACd;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,uBAAuB;AAAA,IAC/B;AAAA,IACA,GAAG;AAAA,EACL,GAAiH;AAC/G,QAAI,OAAO,uBAAuB;AAChC,aAAO,OAAO,sBAAsB,OAAO;AAAA,IAC7C;AAEA,WAAO,QAAQ,QAAQ,QAAQ,WAAW;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,wBAAwB;AAAA,IAChC;AAAA,IACA,GAAG;AAAA,EACL,GAAsG;AACpG,QAAI,OAAO,wBAAwB;AACjC,aAAO,OAAO,uBAAuB,OAAO;AAAA,IAC9C;AAEA,WAAO,QAAQ,QAAQ,QAAQ,WAAW;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,8BAA8B;AAAA,IACtC;AAAA,IACA,GAAG;AAAA,EACL,GAAiG;AAC/F,QAAI,OAAO,8BAA8B;AACvC,aAAO,OAAO,6BAA6B,OAAO;AAAA,IACpD;AAEA,WAAO,QAAQ,QAAQ,IAAI;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcU,wBAAwB;AAAA,IAChC;AAAA,IACA,GAAG;AAAA,EACL,GAA8F;AAC5F,QAAI,CAAC,OAAO,wBAAwB;AAClC,YAAM,IAAI,MAAM,2CAA2C;AAAA,IAC7D;AAEA,WAAO,OAAO,uBAAuB,OAAO;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,qBAAqB;AAAA,IAC7B;AAAA,IACA,GAAG;AAAA,EACL,GAAkF;AAChF,QAAI,OAAO,qBAAqB;AAC9B,aAAO,OAAO,oBAAoB,OAAO;AAAA,IAC3C;AAEA,WAAO,QAAQ,KAAK,QAAQ,KAAK;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,eACR,SAC+B;AAC/B,QAAI,QAAQ,MAAM;AAChB,YAAM,OAAO,cAAc,QAAQ,IAAI,EAAE,KAAK;AAC9C,aAAO,EAAE,GAAG,SAAS,KAAK;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,oBAAoB,QAA8B;AAC1D,UAAM,YAAY,OAAO,YAAY;AACrC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,EAAE,SAAS,SAAS,IACf,YACD;AAAA,EACN;AAAA;AAAA;AAAA;AAAA,EAIU,mBAA+C;AACvD,QAAI;AACJ,UAAM,EAAE,KAAK,IAAI,KAAK;AACtB,QAAI,MAAM;AACR,kBAAY,OAAO,KAAK,KAAK,UAAU,EAAE,OAEvC,CAAC,KAAK,SAAS;AACf,cAAM,WAAW,KAAK,WAAW,IAAI;AACrC,YAAI;AACJ,YAAI,OAAO,aAAa,UAAU;AAChC,wBAAc,cAAc,QAAQ;AACpC,wBAAc,GAAG,IAAI,IAAI,WAAW;AAAA,QACtC,OAAO;AACL,gBAAM,eAAe,cAAc,SAAS,IAAI;AAChD,wBAAc;AAAA,YACZ,GAAG;AAAA,YACH,MAAM,GAAG,IAAI,IAAI,YAAY;AAAA,UAC/B;AAAA,QACF;AAEA,YAAI,IAAI,IAAI;AACZ,eAAO;AAAA,MACT,GAAG,CAAC,CAAC;AAAA,IACP,OAAO;AACL,kBAAY,KAAK;AAAA,IACnB;AAEA,WAAO;AAAA,MACL,KAAK,IAAI,KAAK,MAAM;AAAA,MACpB,WAAW,OAAO,EAAE,QAAQ,UAAU,CAAC;AAAA,IACzC;AAAA,EACF;AACF;AAiEO,MAAM,oBAAoB;AAAA,EAC/B,CAAC,UAA2C,CAAC,MAC3C,CAAC,KAAK,UAAU;AAUd,UAAM,qBAAqB;AAC3B,QAAI,2BAA2B;AAC/B,QAAI,uBAAuB;AAC3B,QAAI,EAAE,cAAc,mBAAmB,IAAI;AAC3C,QAAI,gBAAgB,oBAAoB;AACtC,6BAAuB;AACvB,UAAI,CAAC,YAAY,MAAM,WAAW,GAAG;AACnC,sBAAc,GAAG,WAAW;AAAA,MAC9B;AACA,iCAA2B,GAAG,WAAW;AAAA,IAC3C;AAEA,QAAI,IAAI,aAAa,MAAM;AACzB,YAAM;AAAA,QACJ,oBAAoB;AAAA,QACpB,qBAAqB;AAAA,QACrB,cAAc,eAAe;AAAA,MAC/B,IAAI;AAEJ,YAAM,WAAW,IAAI,UAAyB,kBAAkB;AAEhE,aAAO,IAAI,aAAa;AAAA,QACtB,GAAG;AAAA,QACH,kBAAkB;AAAA,QAClB,eAAe;AAAA,QACf;AAAA,QACA,QAAQ;AAAA,UACN,MAAM,IAAI,IAAI,MAAM;AAAA,UACpB,kBAAkB,MAAM,IAAI,IAAI,iBAAiB;AAAA,QACnD;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAED,WAAO,WAAW,MAAM;AAEtB,YAAM,OAAO,IAAI,IAAuB,WAAW;AAKnD,UAAI;AACJ,UAAI,QAAQ,gBAAgB;AAC1B,yBAAiB,QACd,eAAe,GAAG,EAClB,IAAI,CAAC,eAAe;AACnB,cAAI,gBAAgB,YAAY;AAC9B,mBAAO,WAAW,QAAQ,GAAG;AAAA,UAC/B;AAEA,iBAAO;AAAA,QACT,CAAC,EACA,OAAO,YAAY;AAAA,MACxB;AAGA,aAAO,KAAK,UAAU,IAAI,IAAI,QAAQ,GAAG,cAAc;AAAA,IACzD,CAAC;AAAA,EACH;AACJ;","names":[]}
+{"version":3,"sources":["../../../../src/controllers/utils/gateway.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { flat, unflat } from '@homer0/object-utils';\nimport type { APIClientOptions } from '@homer0/api-utils';\nimport {\n  controllerProviderCreator,\n  controller,\n  createRouteExpression,\n  removeSlashes,\n  notUndefined,\n  type MiddlewareLike,\n} from '../../utils';\nimport type { HTTP, HTTPFetchOptions } from '../../services';\nimport type { Jimpex } from '../../app';\nimport {\n  RouterMethod,\n  DeepPartial,\n  Request,\n  Response,\n  NextFunction,\n  HTTPResponse,\n  Router,\n  ExpressMiddleware,\n  AsyncExpressMiddleware,\n} from '../../types';\n/**\n * The extended definition for endpoints.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpointProps = {\n  /**\n   * The path to the endpoint relative to the entry point. It can include placeholders for\n   * parameters like `/:parameter/`.\n   */\n  path: string;\n  /**\n   * The router (HTTP) method for the endpoint.\n   *\n   * @default 'all'\n   */\n  method?: RouterMethod;\n};\n/**\n * The definition of an endpoint: it can be just the path, relative to the entry point, or\n * an object in which you can also specify things like the method.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpointDefinition = string | GatewayConfigEndpointProps;\n/**\n * The dictionary of endpoints the controller uses. The reason for this type is that this\n * could be a flat dictionary, or a nested one.\n *\n * @example\n *\n * <caption>A flat dictionary</caption>\n *\n * {\n *   random: '/random',\n *   users: '/users',\n *   userById: {\n *     path: '/users/:id',\n *     method: 'get',\n *   },\n * }\n *\n * @example\n *\n * <caption>A nested dictionary</caption>\n *\n * {\n *   random: '/random',\n *   users: {\n *     list: '/users',\n *     byId: {\n *       path: '/users/:id',\n *       method: 'get',\n *     },\n *   },\n * }\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpoints = {\n  [key: string]: GatewayConfigEndpointDefinition | GatewayConfigEndpoints;\n};\n/**\n * The configuration for the gateway the controller uses.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfig = {\n  /**\n   * The entry point to the API the controller will make the requests to.\n   */\n  url: string;\n  /**\n   * The dictionary of enpoints the gateway will make available.\n   */\n  gateway: GatewayConfigEndpoints;\n};\n/**\n * The options for how the gateway will handle the headers from the requests and the\n * responses.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerHeaderOptions = {\n  /**\n   * Whether or not to include the header with the request's IP address.\n   *\n   * @default true\n   */\n  useXForwardedFor: boolean;\n  /**\n   * Whether or not to copy all custom headers from the request. By custom header, it\n   * means all the headers which names start with `x-`.\n   *\n   * @default true\n   */\n  copyCustomHeaders: boolean;\n  /**\n   * A list of \"known\" headers the gateway will try to copy from the incoming request.\n   *\n   * @default ['authorization','content-type', 'referer', 'user-agent']\n   */\n  copy: string[];\n  /**\n   * A list of \"known\" headers the gateway will try to remove the response.\n   *\n   * @default ['server', 'x-powered-by']\n   */\n  remove: string[];\n};\n/**\n * The extra options for the gateway controller. They are \"extra\" because they are mostly\n * helpers for when used with an API client, or for optional features.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerExtraOptions = {\n  /**\n   * This is really a helper for when the gateway is used with an API client. The idea is\n   * that, by default, the routes are mounted on the controller route, but with this\n   * option, you can specify another sub path. For example: The controller is mounted on\n   * `/routes`, and if you set `root` to `gateway`, all the routes will be on\n   * `/routes/gateway`.\n   *\n   * This become important (and useful) when you get the API client configuration (with\n   * `getAPIConfig`): The `url` will be the controller route, but all the endpoints will\n   * be modified and prefixed with the `root`, that way, you can have multiple gateways in\n   * the same \"base route\".\n   *\n   * It can also includes placeholders for parameters like `/:parameter/`, that will be\n   * replaced with the `placeholders` option when `getAPIConfig` gets called.\n   *\n   * @default ''\n   */\n  root: string;\n  /**\n   * This is another option for when the gateway is used with an API client. When calling\n   * `getAPIConfig`, all the endpoints will be wrapped inside an object named after this\n   * option. For example: `{ url: '...', endpoints: { api: { ... } } }`.\n   *\n   * @default 'api'\n   */\n  apiConfigSetting: string;\n  /**\n   * The options for how the gateway will handle the headers from the requests and the\n   * responses.\n   */\n  headers: GatewayControllerHeaderOptions;\n};\n/**\n * The required options for the gateway controller.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerOptions = {\n  /**\n   * The configuration for the API the gateway will make the requests to.\n   */\n  gatewayConfig: GatewayConfig;\n  /**\n   * The route where the controller is mounted.\n   */\n  route: string;\n} & DeepPartial<GatewayControllerExtraOptions>;\n/**\n * The information for a request the controller will make.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRequest = {\n  /**\n   * The URL for the request.\n   */\n  url: string;\n  /**\n   * The options for the fetch client that will make the requests.\n   */\n  options: HTTPFetchOptions;\n};\n/**\n * The information for an endpoint the gateway is calling.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerEndpointInfo = {\n  /**\n   * The name of the endpoint in the configuration.\n   */\n  name: string;\n  /**\n   * The properties (path and method) of the endpoint.\n   */\n  definition: GatewayConfigEndpointDefinition;\n};\n/**\n * These are the base options sent to all the helper service functions.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceBaseFnOptions = {\n  /**\n   * The information of the endpoint the gateway is calling.\n   */\n  endpoint: GatewayControllerEndpointInfo;\n  /**\n   * The request recived by the application.\n   */\n  req: Request;\n  /**\n   * The response object created by the application.\n   */\n  res: Response;\n  /**\n   * The function to call the next middleware in the chain.\n   */\n  next: NextFunction;\n};\n/**\n * The information sent to the helper service in order to modify, or not, a request before\n * it is sent.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceRequestReducerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The options the controller created for the fetch client.\n     */\n    endpointReq: GatewayControllerRequest;\n  };\n/**\n * A function that can be used to modify the information of an endpoint before making a\n * request.\n *\n * @param options  The information of the request.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceRequestReducer = (\n  options: GatewayHelperServiceRequestReducerOptions,\n) => Promise<GatewayControllerRequest>;\n/**\n * The information sent to the helper service in order to modify a response before\n * processing it, decide if it should be streamed or not, and even handle it.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseReducerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The response from the endpoint request.\n     */\n    endpointRes: HTTPResponse;\n  };\n/**\n * A function that can be used to modify the response of an endpoint before the controller\n * processes it.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseReducer = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<HTTPResponse>;\n/**\n * A function that can be used to tell the controller to stream the response of an\n * endpoint or not.\n * If it returns `false`, the function to handle responses should be defined, otherwise,\n * an error will be generated.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceStreamVerification = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<boolean>;\n/**\n * A function to handle the response of an endpoint. This is called when the helper\n * service tells the controller that the endpoint shouldn't be streamed, so this method\n * should handle the response.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseHandler = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<void>;\n/**\n * The information sent to the helper service in order to handle a failed request for an\n * endpoint.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceErrorHandlerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The error generated during the request.\n     */\n    error: Error;\n  };\n/**\n * A function to handle the error of an endpoint request.\n *\n * @param options  The information of the error.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceErrorHandler = (\n  options: GatewayHelperServiceErrorHandlerOptions,\n) => void;\n/**\n * The interface of a helper service that can intercept/modify the requests and responses\n * the gateway makes.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperService = Partial<{\n  /**\n   * A function that is called before an endpoint request is made.\n   */\n  reduceEndpointRequest: GatewayHelperServiceRequestReducer;\n  /**\n   * A function that is called with the response of an endpoint request.\n   */\n  reduceEndpointResponse: GatewayHelperServiceResponseReducer;\n  /**\n   * A function called in order to validate if an endpoint response should be streamed or\n   * not. If the function returns `false`, `handleEndpointResponse` will be called.\n   */\n  shouldStreamEndpointResponse: GatewayHelperServiceStreamVerification;\n  /**\n   * A function called when `shouldStreamEndpointResponse` returns `false`. The function\n   * should handle the response for the application.\n   */\n  handleEndpointResponse: GatewayHelperServiceResponseHandler;\n  /**\n   * A function called when an error is generated during an endpoint request/processing.\n   */\n  handleEndpointError: GatewayHelperServiceErrorHandler;\n}>;\n/**\n * Utility type for the options object sent to the \"proxy methods\" the controller has for\n * the helper service.\n *\n * @template T  The type of the options for a specific helper service function.\n * @access protected\n * @group Controllers/Gateway\n */\nexport type GatewayControllerHelperOptions<T> = T & {\n  /**\n   * The reference for the helper service.\n   */\n  helper: GatewayHelperService;\n};\n/**\n * The information for a single HTTP method an endpoint can handle.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRouteMethod = {\n  /**\n   * The method for the route.\n   */\n  method: RouterMethod;\n  /**\n   * The information of the endpoint.\n   */\n  endpoint: GatewayControllerEndpointInfo;\n};\n/**\n * The information for all the HTTP methods that can be handled for an endpoint.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRoute = {\n  /**\n   * The path to the endpoint, relative to the entry point.\n   */\n  path: string;\n  /**\n   * The path for the route in the controller. This is different from `path` as it's possible for\n   * the gateway to be implemented using the `root` option.\n   */\n  route: string;\n  /**\n   * A list with all the methods the controller uses on the route.\n   */\n  methods: GatewayControllerRouteMethod[];\n};\n/**\n * The API client configuration the gateway can generate for its endpoints.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerAPIConfig = {\n  /**\n   * The base URL for the API.\n   */\n  url: string;\n  /**\n   * The dictionary of endpoints the controller handles.\n   */\n  endpoints: APIClientOptions['endpoints'];\n};\n/**\n * The options sent to {@link GatewayController.getAPIConfig}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerAPIConfigOptions = {\n  /**\n   * This can be used to overwrite the gateway's `apiConfigSetting` option, and set a new\n   * setting as a wrapper for the endpoints.\n   */\n  setting?: string;\n  /**\n   * A dictionary of values for possible placeholders that were sent using the `root`\n   * option.\n   */\n  placeholders?: Record<string, string>;\n};\n/**\n * The options to construct a {@link GatewayController}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerConstructorOptions = GatewayControllerOptions & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    http: HTTP;\n    /**\n     * A function to get a possible helper service. This is injected as a \"getter\" to not\n     * interrupt the DIC \"lifecycle\": controllers are initialized right when the app\n     * starts, and injecting a reference would force the service to be initialized too,\n     * even if a request is not being made.\n     */\n    getHelperService?: () => GatewayHelperService | undefined;\n  };\n};\n/**\n * The options for {@link GatewayController._addRoute}.\n *\n * @access protected\n * @group Controllers/Gateway\n */\nexport type AddGatewayRouteOptions = {\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 route in which the middlewares will be added.\n   */\n  route: string;\n  /**\n   * The middleware created by {@link GatewayController}, that makes the request.\n   */\n  gatewayMiddleware: AsyncExpressMiddleware;\n  /**\n   * A list of extra middlewares to prepend to the gateway middleware.\n   */\n  middlewares: ExpressMiddleware[];\n};\n/**\n * A utility controller that generates routes that act as a gateway for a specific API.\n *\n * @group Controller Classes\n * @group Controllers/Gateway\n * @prettierignore\n */\nexport class GatewayController {\n  /**\n   * The service that makes HTTP requests.\n   */\n  protected readonly http: HTTP;\n  /**\n   * A function to get a possible helper service. This is injected as a \"getter\" to not\n   * interrupt the DIC \"lifecycle\": controllers are initialized right when the app\n   * starts, and injecting a reference would force the service to be initialized too,\n   * even if a request is not being made.\n   */\n  protected readonly _getHelperService: () => GatewayHelperService | undefined;\n  /**\n   * The information, url and endpoints, for the gateway the controller will make requests to.\n   */\n  protected readonly _gatewayConfig: GatewayConfig;\n  /**\n   * The route in which the controller is mounted.\n   */\n  protected readonly _route: string;\n  /**\n   * A regular expression that will be used to remove the controller route from a\n   * request path. This will allow the main middleware to extract the path to where the\n   * request should be made.\n   */\n  protected readonly _routeExpression: RegExp;\n  /**\n   * The controller customization options.\n   */\n  protected readonly _options: GatewayControllerExtraOptions;\n  /**\n   * A flat dictionary with the endpoints information.\n   */\n  protected readonly _endpoints: Record<string, GatewayConfigEndpointDefinition>;\n  /**\n   * The entry URL for the API client configuration the controller can generate.\n   */\n  protected readonly _apiConfigUrl: string;\n  /**\n   * The generated endpoints for the API client configuration the controller can generate.\n   */\n  protected readonly _apiConfigEndpoints: APIClientOptions['endpoints'];\n  /**\n   * The list of routes the controller can handle.\n   */\n  protected readonly _routes: GatewayControllerRoute[];\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({\n    inject,\n    route,\n    gatewayConfig,\n    ...options\n  }: GatewayControllerConstructorOptions) {\n    this.http = inject.http;\n    this._getHelperService = inject.getHelperService || (() => undefined);\n    this._route = removeSlashes(route);\n    this._options = this._formatOptions(\n      deepAssignWithOverwrite(\n        {\n          root: '',\n          apiConfigSetting: 'api',\n          headers: {\n            useXForwardedFor: true,\n            copyCustomHeaders: true,\n            copy: ['authorization', 'content-type', 'referer', 'user-agent'],\n            remove: ['server', 'x-powered-by', 'content-encoding'],\n          },\n        },\n        options,\n      ),\n    );\n    this._gatewayConfig = {\n      ...gatewayConfig,\n      url: removeSlashes(gatewayConfig.url, false, true),\n    };\n    this._routeExpression = createRouteExpression(\n      this._options.root ? `${this._route}/${this._options.root}` : this._route,\n      true,\n      true,\n    );\n    this._endpoints = this._formatEndpoints();\n    this._routes = this._createRoutes();\n    const { url, endpoints } = this._createAPIConfig();\n    this._apiConfigUrl = url;\n    this._apiConfigEndpoints = endpoints;\n  }\n  /**\n   * Generates an API client configuration based on the controller routes.\n   *\n   * @param options  The options to customize the generated configuration.\n   */\n  getAPIConfig({\n    setting,\n    placeholders = {},\n  }: GatewayControllerAPIConfigOptions = {}): Readonly<GatewayControllerAPIConfig> {\n    const useSetting = setting || this._options.apiConfigSetting;\n    let url: string;\n    const placeholdersEntries = Object.entries(placeholders);\n    if (placeholdersEntries.length) {\n      url = placeholdersEntries.reduce<string>(\n        (acc, [key, value]) => acc.replace(`:${key}`, value),\n        this._apiConfigUrl,\n      );\n    } else {\n      url = this._apiConfigUrl;\n    }\n\n    return {\n      url,\n      endpoints: {\n        [useSetting]: this._apiConfigEndpoints,\n      },\n    };\n  }\n  /**\n   * Mounts the middlewares in the router in order to make the requests.\n   *\n   * @param router       A reference to the application router.\n   * @param middlewares  A list of extra middlewares to execute before the gateway\n   *                     middleware.\n   */\n  addRoutes(router: Router, middlewares: ExpressMiddleware[] = []): Router {\n    this._routes.forEach((route) => {\n      route.methods.forEach((info) => {\n        this._addRoute({\n          router,\n          method: info.method,\n          route: route.route,\n          gatewayMiddleware: this._createGatewayMiddleware(info.endpoint),\n          middlewares,\n        });\n      });\n    });\n\n    return router;\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<GatewayControllerExtraOptions> {\n    return { ...this._options };\n  }\n  /**\n   * The configuration for the gateway the controller will make requests to.\n   */\n  get gatewayConfig(): Readonly<GatewayConfig> {\n    return { ...this._gatewayConfig };\n  }\n  /**\n   * Generates a middleware that will make the request to an endpoint and stream the\n   * response.\n   *\n   * @param endpoint  The information of the endpoint the middleware will handle.\n   */\n  protected _createGatewayMiddleware(\n    endpoint: GatewayControllerEndpointInfo,\n  ): AsyncExpressMiddleware {\n    return async (req, res, next) => {\n      const {\n        _options: { headers: headersOptions },\n        _gatewayConfig: { url: gatewayUrl },\n        _routeExpression: routeExpression,\n      } = this;\n      // Remove the controller route from the requested URL.\n      const reqPath = req.originalUrl.replace(routeExpression, '');\n      // Process the headers for the request.\n      let headers: Record<string, string> = {};\n      // - Copy the headers from the incoming request.\n      headersOptions.copy.forEach((name) => {\n        if (req.headers[name]) {\n          headers[name] = req.headers[name] as string;\n        }\n      });\n      // - Copy the custom headers.\n      if (headersOptions.copyCustomHeaders) {\n        headers = deepAssignWithOverwrite<Record<string, string>>(\n          headers,\n          this.http.getCustomHeadersFromRequest(req),\n        );\n      }\n      // - Include the IP on the X-Forwarded-For header, if enabled.\n      if (headersOptions.useXForwardedFor) {\n        const ip = this.http.getIPFromRequest(req);\n        if (ip) {\n          headers['x-forwarded-for'] = ip;\n        }\n      }\n\n      const method = req.method.toUpperCase();\n      // If the request has a body and the method is not `GET`, stringify it.\n      let body: string | undefined;\n      if (method !== 'GET' && typeof req.body === 'object') {\n        body = JSON.stringify(req.body);\n        // If there's no `content-type`, let's assume it's JSON.\n        if (!headers['content-type']) {\n          headers['content-type'] = 'application/json';\n        }\n      }\n\n      /**\n       * Get the helper service, if there's one, and define the base options for its\n       * methods.\n       */\n      const helper = this._getHelperService() || {};\n      const helperBasePayload = {\n        endpoint,\n        req,\n        res,\n        next,\n        helper,\n      };\n\n      try {\n        // Reduce the request information before using it.\n        const request = await this._reduceEndpointRequest({\n          endpointReq: {\n            url: `${gatewayUrl}/${reqPath}`,\n            options: {\n              method,\n              headers,\n              body,\n            },\n          },\n          ...helperBasePayload,\n        });\n        // Make the actual request.\n        const responseRaw = await this.http.fetch(request.url, request.options);\n        // Reduce the response information before using it.\n        const response = await this._reduceEndpointResponse({\n          endpointRes: responseRaw,\n          ...helperBasePayload,\n        });\n        // Validate if the response should be streamed.\n        const shouldStream = await this._shouldStreamEndpointResponse({\n          endpointRes: responseRaw,\n          ...helperBasePayload,\n        });\n\n        if (shouldStream) {\n          if (response.body === null) {\n            throw new Error('The response body is null');\n          }\n\n          /**\n           * If the response should be streamed, set the status, remove unwanted headers,\n           * and pipe it to the application response object.\n           */\n          res.status(response.status);\n          response.headers.forEach((value, name) => {\n            if (!headersOptions.remove.includes(name)) {\n              res.setHeader(name, value);\n            }\n          });\n\n          response.body.pipe(res).on('error', (error) => {\n            next(error);\n          });\n        } else {\n          /**\n           * If the response should not be streamed, send it to the helper method to\n           * handle it.\n           */\n          await this._handleEndpointResponse({\n            endpointRes: response,\n            ...helperBasePayload,\n          });\n        }\n      } catch (error) {\n        // Something failed, so let's pass the error to the helper service.\n        this._handleEndpointError({\n          error: error as Error,\n          ...helperBasePayload,\n        });\n      }\n    };\n  }\n  /**\n   * Mounts the middleware(s) for an endpoint in the router.\n   *\n   * @param options  The information of the endpoint and how it needs to be added.\n   */\n  protected _addRoute({\n    router,\n    method,\n    route,\n    gatewayMiddleware,\n    middlewares,\n  }: AddGatewayRouteOptions): void {\n    router[method](route, [...middlewares, gatewayMiddleware]);\n  }\n  /**\n   * Formats the endpoints for the gateway into a flat dictionary without nesting.\n   */\n  protected _formatEndpoints(): Record<string, GatewayConfigEndpointDefinition> {\n    return flat({\n      target: this._gatewayConfig.gateway,\n      shouldFlatten: (_, value) => {\n        const useValue = value as { path?: string };\n        return typeof useValue.path === 'undefined';\n      },\n    });\n  }\n  /**\n   * Based on the information from the endpoints, this method will create the routes the\n   * controller will later add on a router.\n   *\n   * @throws If there's more than one endpoint using the same path with the same HTTP\n   *         method.\n   */\n  protected _createRoutes(): GatewayControllerRoute[] {\n    const routes: Record<\n      string,\n      {\n        path: string;\n        methods: Partial<Record<RouterMethod, string>>;\n      }\n    > = {};\n    Object.keys(this._endpoints).forEach((name) => {\n      const endpoint = this._endpoints[name]!;\n      let endpointPath: string;\n      let endpointMethod: RouterMethod;\n      if (typeof endpoint === 'string') {\n        endpointPath = endpoint;\n        endpointMethod = 'all';\n      } else {\n        endpointPath = endpoint.path;\n        endpointMethod = endpoint.method\n          ? this._validateHTTPMethod(endpoint.method)\n          : 'all';\n      }\n\n      endpointPath = removeSlashes(endpointPath);\n      if (!routes[endpointPath]) {\n        routes[endpointPath] = {\n          path: endpointPath,\n          methods: {},\n        };\n      }\n\n      if (routes[endpointPath]!.methods[endpointMethod]) {\n        const repeatedEndpoint = routes[endpointPath]!.methods[endpointMethod];\n        throw new Error(\n          \"You can't have two gateway endpoints to the same path and with the same \" +\n            `HTTP method: '${repeatedEndpoint}' and '${name}'`,\n        );\n      }\n\n      routes[endpointPath]!.methods[endpointMethod] = name;\n    });\n\n    const routePrefixes = this._options.root ? `/${this._options.root}/` : '/';\n    return Object.keys(routes).map((endpointPath) => {\n      const info = routes[endpointPath]!;\n      return {\n        path: info.path,\n        route: `${routePrefixes}${info.path}`,\n        methods: Object.keys(info.methods).map((methodNameRaw) => {\n          const methodName = methodNameRaw as RouterMethod;\n          const endpointName = info.methods[methodName]!;\n          const endpointDefinition = this._endpoints[endpointName]!;\n          return {\n            method: methodName,\n            endpoint: {\n              name: endpointName,\n              definition: endpointDefinition,\n            },\n          };\n        }),\n      };\n    });\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can modify an\n   * endpoint request before it gets made.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `reduceEndpointRequest`, it will just return\n   * information for the request.\n   *\n   * @param options  The information of the request and the reference to the helper.\n   */\n  protected _reduceEndpointRequest({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceRequestReducerOptions>): Promise<GatewayControllerRequest> {\n    if (helper.reduceEndpointRequest) {\n      return helper.reduceEndpointRequest(options);\n    }\n\n    return Promise.resolve(options.endpointReq);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can modify an\n   * endpoint response before it gets processed.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `reduceEndpointResponse`, it will just return\n   * information for the response.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _reduceEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<HTTPResponse> {\n    if (helper.reduceEndpointResponse) {\n      return helper.reduceEndpointResponse(options);\n    }\n\n    return Promise.resolve(options.endpointRes);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can decide if an\n   * endpoint response should be streamed or not.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will just return\n   * `true`.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _shouldStreamEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<boolean> {\n    if (helper.shouldStreamEndpointResponse) {\n      return helper.shouldStreamEndpointResponse(options);\n    }\n\n    return Promise.resolve(true);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that handles a\n   * response in case it already said that a response shouldn't be streamed.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will throw an\n   * error.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   * @throws If the helper doesn't implement `handleEndpointResponse`.\n   */\n  protected _handleEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<void> {\n    if (!helper.handleEndpointResponse) {\n      throw new Error('You must implement handleEndpointResponse');\n    }\n\n    return helper.handleEndpointResponse(options);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that handles an error\n   * on an endpoint request.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `handleEndpointError`, it will just send the error to\n   * the next middleware/error handler.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _handleEndpointError({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceErrorHandlerOptions>): void {\n    if (helper.handleEndpointError) {\n      return helper.handleEndpointError(options);\n    }\n\n    return options.next(options.error);\n  }\n  /**\n   * Validates and formats the customization options sent to the controller.\n   *\n   * @param options  The options sent to the constructor.\n   */\n  protected _formatOptions(\n    options: GatewayControllerExtraOptions,\n  ): GatewayControllerExtraOptions {\n    if (options.root) {\n      const root = removeSlashes(options.root).trim();\n      return { ...options, root };\n    }\n\n    return options;\n  }\n  /**\n   * Validates a router/HTTP method that the controller intends to use for an endpoint. If\n   * it's not valid, it will return `all`.\n   *\n   * @param method  The HTTP method for the endpoint.\n   */\n  protected _validateHTTPMethod(method: string): RouterMethod {\n    const newMethod = method.toLowerCase();\n    return [\n      'get',\n      'head',\n      'post',\n      'patch',\n      'put',\n      'delete',\n      'connect',\n      'options',\n      'trace',\n    ].includes(newMethod)\n      ? (newMethod as RouterMethod)\n      : 'all';\n  }\n  /**\n   * Creates the API client configuration based on the controller routes.\n   */\n  protected _createAPIConfig(): GatewayControllerAPIConfig {\n    let endpoints: APIClientOptions['endpoints'];\n    const { root } = this._options;\n    if (root) {\n      endpoints = Object.keys(this._endpoints).reduce<\n        Record<string, GatewayConfigEndpointDefinition>\n      >((acc, name) => {\n        const endpoint = this._endpoints[name]!;\n        let newEndpoint;\n        if (typeof endpoint === 'string') {\n          newEndpoint = removeSlashes(endpoint);\n          newEndpoint = `${root}/${newEndpoint}`;\n        } else {\n          const endpointPath = removeSlashes(endpoint.path);\n          newEndpoint = {\n            ...endpoint,\n            path: `${root}/${endpointPath}`,\n          };\n        }\n\n        acc[name] = newEndpoint;\n        return acc;\n      }, {});\n    } else {\n      endpoints = this._endpoints;\n    }\n\n    return {\n      url: `/${this._route}`,\n      endpoints: unflat({ target: endpoints }),\n    };\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/Gateway\n */\nexport type GatewayControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[];\n/**\n * The options for the controller creator that mounts the {@link GatewayController}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerCreatorOptions =\n  DeepPartial<GatewayControllerExtraOptions> & {\n    /**\n     * The name the creator will use to register the controller in the container. No,\n     * this is not a typo. The creator will register the controller so other services can\n     * access the `getAPIConfig` method. The service will be available after the app\n     * routes are mounted.\n     * If this is overwritten, the creator will ensure that the name ends with `Gateway`;\n     * and if overwritten, but it doesn't include `Gateway` at the end, and no\n     * `gatewaySettingName` was defined, the creator will use the custom name (without\n     * `Gatway`) for `gatewaySettingName`.\n     *\n     * @default 'apiGateway'\n     */\n    serviceName?: string;\n    /**\n     * The name of the helper service the creator will try to obtain from the container.\n     * If `serviceName` is overwritten, the default for this will be\n     * `${serviceName}Helper`.\n     *\n     * @default 'apiGatewayHelper'\n     */\n    helperServiceName?: string;\n    /**\n     * The name of the configuration setting where the gateway configuration is stored. If\n     * not overwritten, check the description of `serviceName` to understand which will be\n     * its default value.\n     *\n     * @default 'api'\n     */\n    gatewaySettingName?: string;\n    /**\n     * The class the creator will instantiate. Similar to the API Client, this allows for\n     * extra customization as you can send a custom subclass of the\n     * {@link GatewayController}.\n     *\n     * @default GatewayController\n     */\n    gatewayClass?: typeof GatewayController;\n    /**\n     * A function to generate a list of middlewares that can be executed before the\n     * controller main middleware.\n     */\n    getMiddlewares?: GatewayControllerGetMiddlewaresFn;\n  };\n/**\n * Creates a controller that allows the application to mount routes that will work like\n * gateway to a specific API.\n *\n * @group Controllers\n * @group Controllers/Gateway\n */\nexport const gatewayController = controllerProviderCreator(\n  (options: GatewayControllerCreatorOptions = {}) =>\n    (app, route) => {\n      /**\n       * Formats the name in order to keep consistency with the helper service and the\n       * configuration setting: If the `serviceName` is different from the default, make\n       * sure it ends with `Gateway`, set the default helper service name to\n       * `${serviceName}Helper`, and the default configuration setting to the same as the\n       * service name (without the `Gateway`).\n       * This way, if you just use `myApi`, the service name will be `myApiGateway`, the\n       * helper name will be `myApiGatewayHelper` and the configuration setting `myApi`.\n       */\n      const defaultServiceName = 'apiGateway';\n      let defaultHelperServiceName = 'apiGatewayHelper';\n      let defaultConfigSetting = 'api';\n      let { serviceName = defaultServiceName } = options;\n      if (serviceName !== defaultServiceName) {\n        defaultConfigSetting = serviceName;\n        if (!serviceName.match(/gateway$/i)) {\n          serviceName = `${serviceName}Gateway`;\n        }\n        defaultHelperServiceName = `${serviceName}Helper`;\n      }\n      // Register the service.\n      app.set(serviceName, () => {\n        const {\n          helperServiceName = defaultHelperServiceName,\n          gatewaySettingName = defaultConfigSetting,\n          gatewayClass: GatewayClass = GatewayController,\n        } = options;\n\n        const gtConfig = app.getConfig<GatewayConfig>(gatewaySettingName);\n\n        return new GatewayClass({\n          ...options,\n          apiConfigSetting: gatewaySettingName,\n          gatewayConfig: gtConfig,\n          route,\n          inject: {\n            http: app.get('http'),\n            getHelperService: () => app.try(helperServiceName),\n          },\n        });\n      });\n\n      return controller(() => {\n        // Get the controller.\n        const ctrl = app.get<GatewayController>(serviceName);\n        /**\n         * Check if there are actual middlewares to be included, and in case there are\n         * Jimpex middlewares, connect them.\n         */\n        let useMiddlewares: ExpressMiddleware[] | undefined;\n        if (options.getMiddlewares) {\n          useMiddlewares = options\n            .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        // Add the routes to the router and return it.\n        return ctrl.addRoutes(app.get('router'), useMiddlewares);\n      });\n    },\n);\n"],"mappings":";;;AAAA,SAAS,+BAA+B;AACxC,SAAS,MAAM,cAAc;AAE7B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAweA,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA,EAiD7B,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACL,GAAwC;AAlDxC;AAAA;AAAA;AAAA,wBAAmB;AAOnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAMnB;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAUjB,SAAK,OAAO,OAAO;AACnB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,SAAS,cAAc,KAAK;AACjC,SAAK,WAAW,KAAK;AAAA,MACnB;AAAA,QACE;AAAA,UACE,MAAM;AAAA,UACN,kBAAkB;AAAA,UAClB,SAAS;AAAA,YACP,kBAAkB;AAAA,YAClB,mBAAmB;AAAA,YACnB,MAAM,CAAC,iBAAiB,gBAAgB,WAAW,YAAY;AAAA,YAC/D,QAAQ,CAAC,UAAU,gBAAgB,kBAAkB;AAAA,UACvD;AAAA,QACF;AAAA,QACA;AAAA,MACF;AAAA,IACF;AACA,SAAK,iBAAiB;AAAA,MACpB,GAAG;AAAA,MACH,KAAK,cAAc,cAAc,KAAK,OAAO,IAAI;AAAA,IACnD;AACA,SAAK,mBAAmB;AAAA,MACtB,KAAK,SAAS,OAAO,GAAG,KAAK,MAAM,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK;AAAA,MACnE;AAAA,MACA;AAAA,IACF;AACA,SAAK,aAAa,KAAK,iBAAiB;AACxC,SAAK,UAAU,KAAK,cAAc;AAClC,UAAM,EAAE,KAAK,UAAU,IAAI,KAAK,iBAAiB;AACjD,SAAK,gBAAgB;AACrB,SAAK,sBAAsB;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa;AAAA,IACX;AAAA,IACA,eAAe,CAAC;AAAA,EAClB,IAAuC,CAAC,GAAyC;AAC/E,UAAM,aAAa,WAAW,KAAK,SAAS;AAC5C,QAAI;AACJ,UAAM,sBAAsB,OAAO,QAAQ,YAAY;AACvD,QAAI,oBAAoB,QAAQ;AAC9B,YAAM,oBAAoB;AAAA,QACxB,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,QAAQ,IAAI,GAAG,IAAI,KAAK;AAAA,QACnD,KAAK;AAAA,MACP;AAAA,IACF,OAAO;AACL,YAAM,KAAK;AAAA,IACb;AAEA,WAAO;AAAA,MACL;AAAA,MACA,WAAW;AAAA,QACT,CAAC,UAAU,GAAG,KAAK;AAAA,MACrB;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgB,cAAmC,CAAC,GAAW;AACvE,SAAK,QAAQ,QAAQ,CAAC,UAAU;AAC9B,YAAM,QAAQ,QAAQ,CAAC,SAAS;AAC9B,aAAK,UAAU;AAAA,UACb;AAAA,UACA,QAAQ,KAAK;AAAA,UACb,OAAO,MAAM;AAAA,UACb,mBAAmB,KAAK,yBAAyB,KAAK,QAAQ;AAAA,UAC9D;AAAA,QACF,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAmD;AACrD,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,gBAAyC;AAC3C,WAAO,EAAE,GAAG,KAAK,eAAe;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,yBACR,UACwB;AACxB,WAAO,OAAO,KAAK,KAAK,SAAS;AAC/B,YAAM;AAAA,QACJ,UAAU,EAAE,SAAS,eAAe;AAAA,QACpC,gBAAgB,EAAE,KAAK,WAAW;AAAA,QAClC,kBAAkB;AAAA,MACpB,IAAI;AAEJ,YAAM,UAAU,IAAI,YAAY,QAAQ,iBAAiB,EAAE;AAE3D,UAAI,UAAkC,CAAC;AAEvC,qBAAe,KAAK,QAAQ,CAAC,SAAS;AACpC,YAAI,IAAI,QAAQ,IAAI,GAAG;AACrB,kBAAQ,IAAI,IAAI,IAAI,QAAQ,IAAI;AAAA,QAClC;AAAA,MACF,CAAC;AAED,UAAI,eAAe,mBAAmB;AACpC,kBAAU;AAAA,UACR;AAAA,UACA,KAAK,KAAK,4BAA4B,GAAG;AAAA,QAC3C;AAAA,MACF;AAEA,UAAI,eAAe,kBAAkB;AACnC,cAAM,KAAK,KAAK,KAAK,iBAAiB,GAAG;AACzC,YAAI,IAAI;AACN,kBAAQ,iBAAiB,IAAI;AAAA,QAC/B;AAAA,MACF;AAEA,YAAM,SAAS,IAAI,OAAO,YAAY;AAEtC,UAAI;AACJ,UAAI,WAAW,SAAS,OAAO,IAAI,SAAS,UAAU;AACpD,eAAO,KAAK,UAAU,IAAI,IAAI;AAE9B,YAAI,CAAC,QAAQ,cAAc,GAAG;AAC5B,kBAAQ,cAAc,IAAI;AAAA,QAC5B;AAAA,MACF;AAMA,YAAM,SAAS,KAAK,kBAAkB,KAAK,CAAC;AAC5C,YAAM,oBAAoB;AAAA,QACxB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,UAAI;AAEF,cAAM,UAAU,MAAM,KAAK,uBAAuB;AAAA,UAChD,aAAa;AAAA,YACX,KAAK,GAAG,UAAU,IAAI,OAAO;AAAA,YAC7B,SAAS;AAAA,cACP;AAAA,cACA;AAAA,cACA;AAAA,YACF;AAAA,UACF;AAAA,UACA,GAAG;AAAA,QACL,CAAC;AAED,cAAM,cAAc,MAAM,KAAK,KAAK,MAAM,QAAQ,KAAK,QAAQ,OAAO;AAEtE,cAAM,WAAW,MAAM,KAAK,wBAAwB;AAAA,UAClD,aAAa;AAAA,UACb,GAAG;AAAA,QACL,CAAC;AAED,cAAM,eAAe,MAAM,KAAK,8BAA8B;AAAA,UAC5D,aAAa;AAAA,UACb,GAAG;AAAA,QACL,CAAC;AAED,YAAI,cAAc;AAChB,cAAI,SAAS,SAAS,MAAM;AAC1B,kBAAM,IAAI,MAAM,2BAA2B;AAAA,UAC7C;AAMA,cAAI,OAAO,SAAS,MAAM;AAC1B,mBAAS,QAAQ,QAAQ,CAAC,OAAO,SAAS;AACxC,gBAAI,CAAC,eAAe,OAAO,SAAS,IAAI,GAAG;AACzC,kBAAI,UAAU,MAAM,KAAK;AAAA,YAC3B;AAAA,UACF,CAAC;AAED,mBAAS,KAAK,KAAK,GAAG,EAAE,GAAG,SAAS,CAAC,UAAU;AAC7C,iBAAK,KAAK;AAAA,UACZ,CAAC;AAAA,QACH,OAAO;AAKL,gBAAM,KAAK,wBAAwB;AAAA,YACjC,aAAa;AAAA,YACb,GAAG;AAAA,UACL,CAAC;AAAA,QACH;AAAA,MACF,SAAS,OAAO;AAEd,aAAK,qBAAqB;AAAA,UACxB;AAAA,UACA,GAAG;AAAA,QACL,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,UAAU;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAiC;AAC/B,WAAO,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,iBAAiB,CAAC;AAAA,EAC3D;AAAA;AAAA;AAAA;AAAA,EAIU,mBAAoE;AAC5E,WAAO,KAAK;AAAA,MACV,QAAQ,KAAK,eAAe;AAAA,MAC5B,eAAe,CAAC,GAAG,UAAU;AAC3B,cAAM,WAAW;AACjB,eAAO,OAAO,SAAS,SAAS;AAAA,MAClC;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,gBAA0C;AAClD,UAAM,SAMF,CAAC;AACL,WAAO,KAAK,KAAK,UAAU,EAAE,QAAQ,CAAC,SAAS;AAC7C,YAAM,WAAW,KAAK,WAAW,IAAI;AACrC,UAAI;AACJ,UAAI;AACJ,UAAI,OAAO,aAAa,UAAU;AAChC,uBAAe;AACf,yBAAiB;AAAA,MACnB,OAAO;AACL,uBAAe,SAAS;AACxB,yBAAiB,SAAS,SACtB,KAAK,oBAAoB,SAAS,MAAM,IACxC;AAAA,MACN;AAEA,qBAAe,cAAc,YAAY;AACzC,UAAI,CAAC,OAAO,YAAY,GAAG;AACzB,eAAO,YAAY,IAAI;AAAA,UACrB,MAAM;AAAA,UACN,SAAS,CAAC;AAAA,QACZ;AAAA,MACF;AAEA,UAAI,OAAO,YAAY,EAAG,QAAQ,cAAc,GAAG;AACjD,cAAM,mBAAmB,OAAO,YAAY,EAAG,QAAQ,cAAc;AACrE,cAAM,IAAI;AAAA,UACR,yFACmB,gBAAgB,UAAU,IAAI;AAAA,QACnD;AAAA,MACF;AAEA,aAAO,YAAY,EAAG,QAAQ,cAAc,IAAI;AAAA,IAClD,CAAC;AAED,UAAM,gBAAgB,KAAK,SAAS,OAAO,IAAI,KAAK,SAAS,IAAI,MAAM;AACvE,WAAO,OAAO,KAAK,MAAM,EAAE,IAAI,CAAC,iBAAiB;AAC/C,YAAM,OAAO,OAAO,YAAY;AAChC,aAAO;AAAA,QACL,MAAM,KAAK;AAAA,QACX,OAAO,GAAG,aAAa,GAAG,KAAK,IAAI;AAAA,QACnC,SAAS,OAAO,KAAK,KAAK,OAAO,EAAE,IAAI,CAAC,kBAAkB;AACxD,gBAAM,aAAa;AACnB,gBAAM,eAAe,KAAK,QAAQ,UAAU;AAC5C,gBAAM,qBAAqB,KAAK,WAAW,YAAY;AACvD,iBAAO;AAAA,YACL,QAAQ;AAAA,YACR,UAAU;AAAA,cACR,MAAM;AAAA,cACN,YAAY;AAAA,YACd;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,uBAAuB;AAAA,IAC/B;AAAA,IACA,GAAG;AAAA,EACL,GAAiH;AAC/G,QAAI,OAAO,uBAAuB;AAChC,aAAO,OAAO,sBAAsB,OAAO;AAAA,IAC7C;AAEA,WAAO,QAAQ,QAAQ,QAAQ,WAAW;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,wBAAwB;AAAA,IAChC;AAAA,IACA,GAAG;AAAA,EACL,GAAsG;AACpG,QAAI,OAAO,wBAAwB;AACjC,aAAO,OAAO,uBAAuB,OAAO;AAAA,IAC9C;AAEA,WAAO,QAAQ,QAAQ,QAAQ,WAAW;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,8BAA8B;AAAA,IACtC;AAAA,IACA,GAAG;AAAA,EACL,GAAiG;AAC/F,QAAI,OAAO,8BAA8B;AACvC,aAAO,OAAO,6BAA6B,OAAO;AAAA,IACpD;AAEA,WAAO,QAAQ,QAAQ,IAAI;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcU,wBAAwB;AAAA,IAChC;AAAA,IACA,GAAG;AAAA,EACL,GAA8F;AAC5F,QAAI,CAAC,OAAO,wBAAwB;AAClC,YAAM,IAAI,MAAM,2CAA2C;AAAA,IAC7D;AAEA,WAAO,OAAO,uBAAuB,OAAO;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,qBAAqB;AAAA,IAC7B;AAAA,IACA,GAAG;AAAA,EACL,GAAkF;AAChF,QAAI,OAAO,qBAAqB;AAC9B,aAAO,OAAO,oBAAoB,OAAO;AAAA,IAC3C;AAEA,WAAO,QAAQ,KAAK,QAAQ,KAAK;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,eACR,SAC+B;AAC/B,QAAI,QAAQ,MAAM;AAChB,YAAM,OAAO,cAAc,QAAQ,IAAI,EAAE,KAAK;AAC9C,aAAO,EAAE,GAAG,SAAS,KAAK;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,oBAAoB,QAA8B;AAC1D,UAAM,YAAY,OAAO,YAAY;AACrC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,EAAE,SAAS,SAAS,IACf,YACD;AAAA,EACN;AAAA;AAAA;AAAA;AAAA,EAIU,mBAA+C;AACvD,QAAI;AACJ,UAAM,EAAE,KAAK,IAAI,KAAK;AACtB,QAAI,MAAM;AACR,kBAAY,OAAO,KAAK,KAAK,UAAU,EAAE,OAEvC,CAAC,KAAK,SAAS;AACf,cAAM,WAAW,KAAK,WAAW,IAAI;AACrC,YAAI;AACJ,YAAI,OAAO,aAAa,UAAU;AAChC,wBAAc,cAAc,QAAQ;AACpC,wBAAc,GAAG,IAAI,IAAI,WAAW;AAAA,QACtC,OAAO;AACL,gBAAM,eAAe,cAAc,SAAS,IAAI;AAChD,wBAAc;AAAA,YACZ,GAAG;AAAA,YACH,MAAM,GAAG,IAAI,IAAI,YAAY;AAAA,UAC/B;AAAA,QACF;AAEA,YAAI,IAAI,IAAI;AACZ,eAAO;AAAA,MACT,GAAG,CAAC,CAAC;AAAA,IACP,OAAO;AACL,kBAAY,KAAK;AAAA,IACnB;AAEA,WAAO;AAAA,MACL,KAAK,IAAI,KAAK,MAAM;AAAA,MACpB,WAAW,OAAO,EAAE,QAAQ,UAAU,CAAC;AAAA,IACzC;AAAA,EACF;AACF;AAiEO,MAAM,oBAAoB;AAAA,EAC/B,CAAC,UAA2C,CAAC,MAC3C,CAAC,KAAK,UAAU;AAUd,UAAM,qBAAqB;AAC3B,QAAI,2BAA2B;AAC/B,QAAI,uBAAuB;AAC3B,QAAI,EAAE,cAAc,mBAAmB,IAAI;AAC3C,QAAI,gBAAgB,oBAAoB;AACtC,6BAAuB;AACvB,UAAI,CAAC,YAAY,MAAM,WAAW,GAAG;AACnC,sBAAc,GAAG,WAAW;AAAA,MAC9B;AACA,iCAA2B,GAAG,WAAW;AAAA,IAC3C;AAEA,QAAI,IAAI,aAAa,MAAM;AACzB,YAAM;AAAA,QACJ,oBAAoB;AAAA,QACpB,qBAAqB;AAAA,QACrB,cAAc,eAAe;AAAA,MAC/B,IAAI;AAEJ,YAAM,WAAW,IAAI,UAAyB,kBAAkB;AAEhE,aAAO,IAAI,aAAa;AAAA,QACtB,GAAG;AAAA,QACH,kBAAkB;AAAA,QAClB,eAAe;AAAA,QACf;AAAA,QACA,QAAQ;AAAA,UACN,MAAM,IAAI,IAAI,MAAM;AAAA,UACpB,kBAAkB,MAAM,IAAI,IAAI,iBAAiB;AAAA,QACnD;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAED,WAAO,WAAW,MAAM;AAEtB,YAAM,OAAO,IAAI,IAAuB,WAAW;AAKnD,UAAI;AACJ,UAAI,QAAQ,gBAAgB;AAC1B,yBAAiB,QACd,eAAe,GAAG,EAClB,IAAI,CAAC,eAAe;AACnB,cAAI,gBAAgB,YAAY;AAC9B,mBAAO,WAAW,QAAQ,GAAG;AAAA,UAC/B;AAEA,iBAAO;AAAA,QACT,CAAC,EACA,OAAO,YAAY;AAAA,MACxB;AAGA,aAAO,KAAK,UAAU,IAAI,IAAI,QAAQ,GAAG,cAAc;AAAA,IACzD,CAAC;AAAA,EACH;AACJ;","names":[]}

package/dist/esm/middlewares/common/errorHandler.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
 import { middlewareCreator } from "../../utils";
 import { AppError } from "../../services";

package/dist/esm/middlewares/common/forceHTTPS.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { middlewareCreator } from "../../utils";
 class ForceHTTPS {
   /**

package/dist/esm/middlewares/common/hsts.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { middlewareCreator } from "../../utils";
 class HSTS {
   /**

package/dist/esm/middlewares/html/fastHTML.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { createRouteExpression, middlewareCreator, removeSlashes } from "../../utils";
 class FastHTML {
   /**

package/dist/esm/middlewares/html/showHTML.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { middlewareCreator } from "../../utils";
 class ShowHTML {
   /**

package/dist/esm/middlewares/utils/versionValidator.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
 import { middlewareCreator } from "../../utils";
 class VersionValidator {

package/dist/esm/services/common/appError.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { provider, statuses as statusesFn } from "../../utils";
 class AppError extends Error {
   /**

package/dist/esm/services/common/httpError.js

@@ -1,4 +1,4 @@
-import "../../chunk-2B2CG5KL.js";
+import "../../chunk-F3FYYIAV.js";
 import { provider, statuses as statusesFn } from "../../utils";
 import { AppError } from "./appError";
 class HTTPError extends AppError {

package/dist/esm/services/common/index.js

@@ -1,4 +1,4 @@
-import "../../chunk-2B2CG5KL.js";
+import "../../chunk-F3FYYIAV.js";
 import { providers } from "../../utils";
 import { appErrorProvider } from "./appError";
 import { httpErrorProvider } from "./httpError";

package/dist/esm/services/common/sendFile.js

@@ -1,4 +1,4 @@
-import "../../chunk-2B2CG5KL.js";
+import "../../chunk-F3FYYIAV.js";
 import { provider } from "../../utils";
 const sendFile = ({ inject: { pathUtils } }) => ({ res, filepath, from = "app", next = () => {
 } }) => {

package/dist/esm/services/frontend/frontendFs.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import fs from "fs/promises";
 import { provider } from "../../utils";
 class FrontendFs {

package/dist/esm/services/frontend/index.js

@@ -1,4 +1,4 @@
-import "../../chunk-2B2CG5KL.js";
+import "../../chunk-F3FYYIAV.js";
 import { providers } from "../../utils";
 import { frontendFsProvider } from "./frontendFs";
 const frontendServicesProvider = providers({

package/dist/esm/services/html/htmlGenerator.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import { get } from "@homer0/object-utils";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
 import { deferred } from "@homer0/deferred";

package/dist/esm/services/html/index.js

@@ -1,4 +1,4 @@
-import "../../chunk-2B2CG5KL.js";
+import "../../chunk-F3FYYIAV.js";
 import { providers } from "../../utils";
 import { htmlGeneratorProvider } from "./htmlGenerator";
 const htmlServicesProvider = providers({

package/dist/esm/services/http/apiClient.js

@@ -1,6 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
+} from "../../chunk-F3FYYIAV.js";
 import {
   APIClient as APIClientBase
 } from "@homer0/api-utils";

package/dist/esm/services/http/http.js

@@ -1,7 +1,6 @@
 import {
   __publicField
-} from "../../chunk-2B2CG5KL.js";
-import fetch from "node-fetch";
+} from "../../chunk-F3FYYIAV.js";
 import urijs from "urijs";
 import { deepAssignWithOverwrite } from "@homer0/deep-assign";
 import { provider } from "../../utils";
@@ -9,16 +8,22 @@ class HTTP {
   /**
    * @param options  The options to construct the class.
    */
-  constructor({ inject: { logger }, ...options }) {
+  constructor({ inject: { logger, nodeFetch }, ...options }) {
     /**
      * The service used to log information in the terminal.
      */
     __publicField(this, "_logger");
+    /**
+     * The node-fetch library. Since it's an ESM only module, Jimpex loads it on boot and makes
+     * it available on the container.
+     */
+    __publicField(this, "_nodeFetch");
     /**
      * The service customization options.
      */
     __publicField(this, "_options");
     this._logger = logger;
+    this._nodeFetch = nodeFetch;
     this._options = deepAssignWithOverwrite(
       {
         logRequests: false
@@ -61,7 +66,7 @@ class HTTP {
     if (logRequests) {
       this._logRequest(useURL, fetchOptions);
     }
-    const response = await fetch(useURL, fetchOptions);
+    const response = await this._nodeFetch(useURL, fetchOptions);
     if (logRequests) {
       this._logResponse(response);
     }
@@ -161,7 +166,8 @@ const httpProvider = provider((app) => {
     const logRequests = config.get("debug.logRequests") === true;
     return new HTTP({
       inject: {
-        logger: app.get("logger")
+        logger: app.get("logger"),
+        nodeFetch: app.get("node-fetch")
       },
       logRequests
     });