jimpex 10.0.2 → 11.0.0

package/dist/controllers/common/statics.js

@@ -1,69 +1,37 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-var statics_exports = {};
-__export(statics_exports, {
-  StaticsController: () => StaticsController,
-  staticsController: () => staticsController
-});
-module.exports = __toCommonJS(statics_exports);
-var path = __toESM(require("path"));
-var import_deep_assign = require("@homer0/deep-assign");
-var import_utils = require("../../utils");
+import * as path from "node:path";
+import { deepAssignWithOverwrite } from "@homer0/deep-assign";
+import {
+  controllerCreator,
+  removeSlashes,
+  notUndefined
+} from "../../utils/index.js";
 class StaticsController {
+  /**
+   * The service that serves static files.
+   */
+  _sendFile;
+  /**
+   * The MIME type library. Since it's an ESM only module, Jimpex loads it on boot and makes
+   * it available on the container.
+   */
+  _mime;
+  /**
+   * The controller customization options.
+   */
+  _options;
+  /**
+   * A dictionary with the formatted definitions of the files that will be served.
+   * It uses the files' routes as keys, for easy access in the middleware.
+   */
+  files;
   /**
    * @param options  The options to construct the controller.
    */
   constructor({ inject, ...options }) {
-    /**
-     * 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.
-     */
-    __publicField(this, "_options");
-    /**
-     * A dictionary with the formatted definitions of the files that will be served.
-     * It uses the files' routes as keys, for easy access in the middleware.
-     */
-    __publicField(this, "files");
     this._sendFile = inject.sendFile;
     this._mime = inject.mime;
     this._options = this._validateOptions(
-      (0, import_deep_assign.deepAssignWithOverwrite)(
+      deepAssignWithOverwrite(
         {
           files: ["favicon.ico", "index.html"],
           methods: options.methods || {
@@ -203,7 +171,7 @@ class StaticsController {
    */
   _createFiles() {
     const { files, paths } = this._options;
-    const routePath = (0, import_utils.removeSlashes)(paths.route, false, true);
+    const routePath = removeSlashes(paths.route, false, true);
     return files.reduce((acc, file) => {
       let src;
       let route;
@@ -215,7 +183,7 @@ class StaticsController {
         route = file;
       }
       src = path.join(paths.source, src);
-      route = (0, import_utils.removeSlashes)(route, true, false);
+      route = removeSlashes(route, true, false);
       route = `${routePath}/${route}`;
       acc[route] = {
         path: src,
@@ -226,7 +194,7 @@ class StaticsController {
     }, {});
   }
 }
-const staticsController = (0, import_utils.controllerCreator)(
+const staticsController = controllerCreator(
   ({ getMiddlewares, ...options } = {}) => (app) => {
     const router = app.getRouter();
     const ctrl = new StaticsController({
@@ -243,14 +211,13 @@ const staticsController = (0, import_utils.controllerCreator)(
           return middleware.connect(app);
         }
         return middleware;
-      }).filter(import_utils.notUndefined);
+      }).filter(notUndefined);
     }
     return ctrl.addRoutes(router, useMiddlewares);
   }
 );
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   StaticsController,
   staticsController
-});
+};
 //# sourceMappingURL=statics.js.map

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

@@ -1 +1 @@
-{"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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,WAAsB;AAEtB,yBAAwC;AACxC,mBAKO;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,UACnB;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,gBAAY,4BAAc,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,kBAAQ,4BAAc,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,wBAAoB;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,yBAAY;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 'node: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/index.js';\nimport type { SendFile } from '../../services/index.js';\nimport type { Jimpex } from '../../app/index.js';\nimport type {\n  DeepPartial,\n  ExpressMiddleware,\n  Router,\n  RouterMethod,\n} from '../../types/index.js';\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 controller\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   * controller 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;AAiJA,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA,EAIV;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA;AAAA;AAAA;AAAA,EAIT;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA;AAAA;AAAA;AAAA,EAIV,YAAY,EAAE,QAAQ,GAAG,QAAQ,GAAwC;AACvE,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/controllers/index.d.ts

@@ -3,7 +3,7 @@ export { GetHealthStatus, HealthController, HealthControllerOptions, healthContr
 export { AddStaticRouteOptions, StaticsController, StaticsControllerConstructorOptions, StaticsControllerCreatorOptions, StaticsControllerFile, StaticsControllerGetMiddlewaresFn, StaticsControllerOptions, StaticsControllerPathsOptions, staticsController } from './common/statics.js';
 export { AddGatewayRouteOptions, GatewayConfig, GatewayConfigEndpointDefinition, GatewayConfigEndpointProps, GatewayConfigEndpoints, GatewayController, GatewayControllerAPIConfig, GatewayControllerAPIConfigOptions, GatewayControllerConstructorOptions, GatewayControllerCreatorOptions, GatewayControllerEndpointInfo, GatewayControllerExtraOptions, GatewayControllerGetMiddlewaresFn, GatewayControllerHeaderOptions, GatewayControllerHelperOptions, GatewayControllerOptions, GatewayControllerRequest, GatewayControllerRoute, GatewayControllerRouteMethod, GatewayHelperService, GatewayHelperServiceBaseFnOptions, GatewayHelperServiceErrorHandler, GatewayHelperServiceErrorHandlerOptions, GatewayHelperServiceRequestReducer, GatewayHelperServiceRequestReducerOptions, GatewayHelperServiceResponseHandler, GatewayHelperServiceResponseReducer, GatewayHelperServiceResponseReducerOptions, GatewayHelperServiceStreamVerification, gatewayController } from './utils/gateway.js';
 import '@homer0/jimple';
-import '../index-C6I3NCC-.js';
+import '../index-BlSpNHox.js';
 import '../types/express.js';
 import 'express';
 import '../types/http.js';

package/dist/controllers/index.js

@@ -1,25 +1,3 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var controllers_exports = {};
-module.exports = __toCommonJS(controllers_exports);
-__reExport(controllers_exports, require("./common"), module.exports);
-__reExport(controllers_exports, require("./utils"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("./common"),
-  ...require("./utils")
-});
+export * from "./common/index.js";
+export * from "./utils/index.js";
 //# sourceMappingURL=index.js.map

package/dist/controllers/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/controllers/index.ts"],"sourcesContent":["export * from './common';\nexport * from './utils';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,gCAAc,qBAAd;AACA,gCAAc,oBADd;","names":[]}
+{"version":3,"sources":["../../src/controllers/index.ts"],"sourcesContent":["export * from './common/index.js';\nexport * from './utils/index.js';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}

package/dist/controllers/utils/gateway.d.ts

@@ -1,5 +1,5 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex, a1 as MiddlewareLike, C as ControllerConnectFn, K as ControllerProviderRegisterFn } from '../../index-C6I3NCC-.js';
+import { J as Jimpex, a1 as MiddlewareLike, C as ControllerConnectFn, K as ControllerProviderRegisterFn } from '../../index-BlSpNHox.js';
 import { APIClientOptions } from '@homer0/api-utils';
 import { RouterMethod, AsyncExpressMiddleware, ExpressMiddleware } from '../../types/express.js';
 import { Response as Response$1 } from 'node-fetch';
@@ -88,7 +88,7 @@ type GatewayConfig = {
      */
     url: string;
     /**
-     * The dictionary of enpoints the gateway will make available.
+     * The dictionary of endpoints the gateway will make available.
      */
     gateway: GatewayConfigEndpoints;
 };
@@ -220,7 +220,7 @@ type GatewayHelperServiceBaseFnOptions = {
      */
     endpoint: GatewayControllerEndpointInfo;
     /**
-     * The request recived by the application.
+     * The request received by the application.
      */
     req: Request;
     /**
@@ -658,7 +658,7 @@ declare class GatewayController {
     protected _createAPIConfig(): GatewayControllerAPIConfig;
 }
 /**
- * A function to generate a list of middlewares that can be executed before the tontroller
+ * A function to generate a list of middlewares that can be executed before the controller
  * main middleware.
  *
  * @group Controllers/Gateway
@@ -678,7 +678,7 @@ type GatewayControllerCreatorOptions = DeepPartial<GatewayControllerExtraOptions
      * If this is overwritten, the creator will ensure that the name ends with `Gateway`;
      * and if overwritten, but it doesn't include `Gateway` at the end, and no
      * `gatewaySettingName` was defined, the creator will use the custom name (without
-     * `Gatway`) for `gatewaySettingName`.
+     * `Gateway`) for `gatewaySettingName`.
      *
      * @default 'apiGateway'
      */

package/dist/controllers/utils/gateway.js

@@ -1,33 +1,58 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-var gateway_exports = {};
-__export(gateway_exports, {
-  GatewayController: () => GatewayController,
-  gatewayController: () => gatewayController
-});
-module.exports = __toCommonJS(gateway_exports);
-var import_deep_assign = require("@homer0/deep-assign");
-var import_object_utils = require("@homer0/object-utils");
-var import_utils = require("../../utils");
+import { deepAssignWithOverwrite } from "@homer0/deep-assign";
+import { flat, unflat } from "@homer0/object-utils";
+import {
+  controllerProviderCreator,
+  controller,
+  createRouteExpression,
+  removeSlashes,
+  notUndefined
+} from "../../utils/index.js";
 class GatewayController {
+  /**
+   * The service that makes HTTP requests.
+   */
+  http;
+  /**
+   * A function to get a possible helper service. This is injected as a "getter" to not
+   * interrupt the DIC "lifecycle": controllers are initialized right when the app
+   * starts, and injecting a reference would force the service to be initialized too,
+   * even if a request is not being made.
+   */
+  _getHelperService;
+  /**
+   * The information, url and endpoints, for the gateway the controller will make requests to.
+   */
+  _gatewayConfig;
+  /**
+   * The route in which the controller is mounted.
+   */
+  _route;
+  /**
+   * A regular expression that will be used to remove the controller route from a
+   * request path. This will allow the main middleware to extract the path to where the
+   * request should be made.
+   */
+  _routeExpression;
+  /**
+   * The controller customization options.
+   */
+  _options;
+  /**
+   * A flat dictionary with the endpoints information.
+   */
+  _endpoints;
+  /**
+   * The entry URL for the API client configuration the controller can generate.
+   */
+  _apiConfigUrl;
+  /**
+   * The generated endpoints for the API client configuration the controller can generate.
+   */
+  _apiConfigEndpoints;
+  /**
+   * The list of routes the controller can handle.
+   */
+  _routes;
   /**
    * @param options  The options to construct the controller.
    */
@@ -37,56 +62,11 @@ class GatewayController {
     gatewayConfig,
     ...options
   }) {
-    /**
-     * The service that makes HTTP requests.
-     */
-    __publicField(this, "http");
-    /**
-     * A function to get a possible helper service. This is injected as a "getter" to not
-     * interrupt the DIC "lifecycle": controllers are initialized right when the app
-     * starts, and injecting a reference would force the service to be initialized too,
-     * even if a request is not being made.
-     */
-    __publicField(this, "_getHelperService");
-    /**
-     * The information, url and endpoints, for the gateway the controller will make requests to.
-     */
-    __publicField(this, "_gatewayConfig");
-    /**
-     * The route in which the controller is mounted.
-     */
-    __publicField(this, "_route");
-    /**
-     * A regular expression that will be used to remove the controller route from a
-     * request path. This will allow the main middleware to extract the path to where the
-     * request should be made.
-     */
-    __publicField(this, "_routeExpression");
-    /**
-     * The controller customization options.
-     */
-    __publicField(this, "_options");
-    /**
-     * A flat dictionary with the endpoints information.
-     */
-    __publicField(this, "_endpoints");
-    /**
-     * The entry URL for the API client configuration the controller can generate.
-     */
-    __publicField(this, "_apiConfigUrl");
-    /**
-     * The generated endpoints for the API client configuration the controller can generate.
-     */
-    __publicField(this, "_apiConfigEndpoints");
-    /**
-     * The list of routes the controller can handle.
-     */
-    __publicField(this, "_routes");
     this.http = inject.http;
     this._getHelperService = inject.getHelperService || (() => void 0);
-    this._route = (0, import_utils.removeSlashes)(route);
+    this._route = removeSlashes(route);
     this._options = this._formatOptions(
-      (0, import_deep_assign.deepAssignWithOverwrite)(
+      deepAssignWithOverwrite(
         {
           root: "",
           apiConfigSetting: "api",
@@ -102,9 +82,9 @@ class GatewayController {
     );
     this._gatewayConfig = {
       ...gatewayConfig,
-      url: (0, import_utils.removeSlashes)(gatewayConfig.url, false, true)
+      url: removeSlashes(gatewayConfig.url, false, true)
     };
-    this._routeExpression = (0, import_utils.createRouteExpression)(
+    this._routeExpression = createRouteExpression(
       this._options.root ? `${this._route}/${this._options.root}` : this._route,
       true,
       true
@@ -196,7 +176,7 @@ class GatewayController {
         }
       });
       if (headersOptions.copyCustomHeaders) {
-        headers = (0, import_deep_assign.deepAssignWithOverwrite)(
+        headers = deepAssignWithOverwrite(
           headers,
           this.http.getCustomHeadersFromRequest(req)
         );
@@ -289,7 +269,7 @@ class GatewayController {
    * Formats the endpoints for the gateway into a flat dictionary without nesting.
    */
   _formatEndpoints() {
-    return (0, import_object_utils.flat)({
+    return flat({
       target: this._gatewayConfig.gateway,
       shouldFlatten: (_, value) => {
         const useValue = value;
@@ -317,7 +297,7 @@ class GatewayController {
         endpointPath = endpoint.path;
         endpointMethod = endpoint.method ? this._validateHTTPMethod(endpoint.method) : "all";
       }
-      endpointPath = (0, import_utils.removeSlashes)(endpointPath);
+      endpointPath = removeSlashes(endpointPath);
       if (!routes[endpointPath]) {
         routes[endpointPath] = {
           path: endpointPath,
@@ -466,7 +446,7 @@ class GatewayController {
    */
   _formatOptions(options) {
     if (options.root) {
-      const root = (0, import_utils.removeSlashes)(options.root).trim();
+      const root = removeSlashes(options.root).trim();
       return { ...options, root };
     }
     return options;
@@ -502,10 +482,10 @@ class GatewayController {
         const endpoint = this._endpoints[name];
         let newEndpoint;
         if (typeof endpoint === "string") {
-          newEndpoint = (0, import_utils.removeSlashes)(endpoint);
+          newEndpoint = removeSlashes(endpoint);
           newEndpoint = `${root}/${newEndpoint}`;
         } else {
-          const endpointPath = (0, import_utils.removeSlashes)(endpoint.path);
+          const endpointPath = removeSlashes(endpoint.path);
           newEndpoint = {
             ...endpoint,
             path: `${root}/${endpointPath}`
@@ -519,11 +499,11 @@ class GatewayController {
     }
     return {
       url: `/${this._route}`,
-      endpoints: (0, import_object_utils.unflat)({ target: endpoints })
+      endpoints: unflat({ target: endpoints })
     };
   }
 }
-const gatewayController = (0, import_utils.controllerProviderCreator)(
+const gatewayController = controllerProviderCreator(
   (options = {}) => (app, route) => {
     const defaultServiceName = "apiGateway";
     let defaultHelperServiceName = "apiGatewayHelper";
@@ -554,7 +534,7 @@ const gatewayController = (0, import_utils.controllerProviderCreator)(
         }
       });
     });
-    return (0, import_utils.controller)(() => {
+    return controller(() => {
       const ctrl = app.get(serviceName);
       let useMiddlewares;
       if (options.getMiddlewares) {
@@ -563,15 +543,14 @@ const gatewayController = (0, import_utils.controllerProviderCreator)(
             return middleware.connect(app);
           }
           return middleware;
-        }).filter(import_utils.notUndefined);
+        }).filter(notUndefined);
       }
       return ctrl.addRoutes(app.get("router"), useMiddlewares);
     });
   }
 );
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   GatewayController,
   gatewayController
-});
+};
 //# sourceMappingURL=gateway.js.map