jimpex 10.0.2 → 11.0.0

package/dist/middlewares/html/showHTML.js

@@ -1,56 +1,30 @@
-"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 showHTML_exports = {};
-__export(showHTML_exports, {
-  ShowHTML: () => ShowHTML,
-  showHTMLMiddleware: () => showHTMLMiddleware
-});
-module.exports = __toCommonJS(showHTML_exports);
-var import_utils = require("../../utils");
+import { middlewareCreator } from "../../utils/index.js";
 class ShowHTML {
+  /**
+   * The service that serves a file.
+   */
+  _sendFile;
+  /**
+   * A function to get a possible {@link HTMLGenerator}. This is injected as a "getter"
+   * to not interrupt the DIC "lifecycle": middlewares 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.
+   */
+  _getHTMLGenerator;
+  /**
+   * The customization options for the middleware.
+   */
+  _options;
+  /**
+   * Whether or not the file is ready to be served. In case the middleware uses an
+   * {@link HTMLGenerator} service, the file needs to be generated before being available,
+   * and that's why this flag exists.
+   */
+  _fileReady = false;
   /**
    * @param options  The options to construct the class.
    */
   constructor({ inject, ...options }) {
-    /**
-     * The service that serves a file.
-     */
-    __publicField(this, "_sendFile");
-    /**
-     * A function to get a possible {@link HTMLGenerator}. This is injected as a "getter"
-     * to not interrupt the DIC "lifecycle": middlewares 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, "_getHTMLGenerator");
-    /**
-     * The customization options for the middleware.
-     */
-    __publicField(this, "_options");
-    /**
-     * Whether or not the file is ready to be served. In case the middleware uses an
-     * {@link HTMLGenerator} service, the file needs to be generated before being available,
-     * and that's why this flag exists.
-     */
-    __publicField(this, "_fileReady", false);
     this._sendFile = inject.sendFile;
     this._getHTMLGenerator = inject.getHTMLGenerator || (() => void 0);
     this._options = {
@@ -104,7 +78,7 @@ class ShowHTML {
     });
   }
 }
-const showHTMLMiddleware = (0, import_utils.middlewareCreator)(
+const showHTMLMiddleware = middlewareCreator(
   (options = {}) => (app) => {
     const { htmlGeneratorServiceName = "htmlGenerator", ...rest } = options;
     return new ShowHTML({
@@ -116,9 +90,8 @@ const showHTMLMiddleware = (0, import_utils.middlewareCreator)(
     }).getMiddleware();
   }
 );
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   ShowHTML,
   showHTMLMiddleware
-});
+};
 //# sourceMappingURL=showHTML.js.map

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/middlewares/html/showHTML.ts"],"sourcesContent":["import { middlewareCreator } from '../../utils';\nimport type { HTMLGenerator, SendFile } from '../../services';\nimport type { AsyncExpressMiddleware, Response, NextFunction } from '../../types';\n/**\n * The options to customize the behavior of the middleware.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLOptions = {\n  /**\n   * The name of the file the middleware will serve. If the {@link HTMLGenerator} service\n   * is available, it will be overriden by the service.\n   *\n   * @default 'index.html'\n   */\n  file: string;\n};\n/**\n * The options to construct a {@link ShowHTML}.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLConstructorOptions = Partial<ShowHTMLOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    sendFile: SendFile;\n    /**\n     * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n     * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n     * app starts, and injecting a reference would force the service to be initialized\n     * too, even if a request is not being made.\n     */\n    getHTMLGenerator?: () => HTMLGenerator | undefined;\n  };\n};\n/**\n * The options for the middleware creator that will mount an instance of {@link ShowHTML}.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLMiddlewareOptions = Partial<ShowHTMLOptions> & {\n  /**\n   * The name of an {@link HTMLGenerator} service already available in the application.\n   *\n   * @default 'htmlGenerator'\n   */\n  htmlGeneratorServiceName?: string;\n};\n\n/**\n * A very simple middleware service to send an HTML on a server response. The special\n * _'feature'_ of this service is that it can be hooked up to an {@link HTMLGenerator}\n * service and it will automatically server the file generated by it.\n *\n * @group Middleware Classes\n * @group Middlewares/ShowHTML\n * @prettierignore\n */\nexport class ShowHTML {\n  /**\n   * The service that serves a file.\n   */\n  protected readonly _sendFile: SendFile;\n  /**\n   * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n   * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n   * app starts, and injecting a reference would force the service to be initialized\n   * too, even if a request is not being made.\n   */\n  protected readonly _getHTMLGenerator: () => HTMLGenerator | undefined;\n  /**\n   * The customization options for the middleware.\n   */\n  protected _options: ShowHTMLOptions;\n  /**\n   * Whether or not the file is ready to be served. In case the middleware uses an\n   * {@link HTMLGenerator} service, the file needs to be generated before being available,\n   * and that's why this flag exists.\n   */\n  protected _fileReady: boolean = false;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({ inject, ...options }: ShowHTMLConstructorOptions) {\n    this._sendFile = inject.sendFile;\n    this._getHTMLGenerator = inject.getHTMLGenerator || (() => undefined);\n    this._options = {\n      file: 'index.html',\n      ...options,\n    };\n  }\n  /**\n   * Generates the middleware that serves the HTML file.\n   */\n  getMiddleware(): AsyncExpressMiddleware {\n    return async (_, res, next) => {\n      // If the file is ready to be served, serve it.\n      if (this._fileReady) {\n        this._sendResponse(res, next);\n        return;\n      }\n\n      const htmlGenerator = this._getHTMLGenerator();\n      // If there's no generator, switch the flag and just serve the file.\n      if (!htmlGenerator) {\n        this._fileReady = true;\n        this._sendResponse(res, next);\n        return;\n      }\n\n      try {\n        // Wait for the HTML to be generated.\n        await htmlGenerator.whenReady();\n        // Update the local option.\n        this._options.file = htmlGenerator.options.file;\n        // Switch the flag and serve the file.\n        this._fileReady = true;\n        this._sendResponse(res, next);\n      } catch (error) {\n        next(error);\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<ShowHTMLOptions> {\n    return { ...this._options };\n  }\n  /**\n   * Serves the HTML file to the response.\n   *\n   * @param res   The response object generated by the application.\n   * @param next  The function to call the next middleware.\n   */\n  protected _sendResponse(res: Response, next: NextFunction): void {\n    res.setHeader('Content-Type', 'text/html');\n    this._sendFile({\n      res,\n      next,\n      filepath: this._options.file,\n    });\n  }\n}\n/**\n * Creates the middleware that serves an HTML file in the response.\n *\n * @group Middlewares\n * @group Middlewares/ShowHTML\n */\nexport const showHTMLMiddleware = middlewareCreator(\n  (options: ShowHTMLMiddlewareOptions = {}) =>\n    (app) => {\n      const { htmlGeneratorServiceName = 'htmlGenerator', ...rest } = options;\n      return new ShowHTML({\n        inject: {\n          sendFile: app.get('sendFile'),\n          getHTMLGenerator: () => app.try(htmlGeneratorServiceName),\n        },\n        ...rest,\n      }).getMiddleware();\n    },\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkC;AA4D3B,MAAM,SAAS;AAAA;AAAA;AAAA;AAAA,EAyBpB,YAAY,EAAE,QAAQ,GAAG,QAAQ,GAA+B;AArBhE;AAAA;AAAA;AAAA,wBAAmB;AAOnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAU;AAMV;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAU,cAAsB;AAK9B,SAAK,YAAY,OAAO;AACxB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,WAAW;AAAA,MACd,MAAM;AAAA,MACN,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAwC;AACtC,WAAO,OAAO,GAAG,KAAK,SAAS;AAE7B,UAAI,KAAK,YAAY;AACnB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,YAAM,gBAAgB,KAAK,kBAAkB;AAE7C,UAAI,CAAC,eAAe;AAClB,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,UAAI;AAEF,cAAM,cAAc,UAAU;AAE9B,aAAK,SAAS,OAAO,cAAc,QAAQ;AAE3C,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAAA,MAC9B,SAAS,OAAO;AACd,aAAK,KAAK;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAqC;AACvC,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,cAAc,KAAe,MAA0B;AAC/D,QAAI,UAAU,gBAAgB,WAAW;AACzC,SAAK,UAAU;AAAA,MACb;AAAA,MACA;AAAA,MACA,UAAU,KAAK,SAAS;AAAA,IAC1B,CAAC;AAAA,EACH;AACF;AAOO,MAAM,yBAAqB;AAAA,EAChC,CAAC,UAAqC,CAAC,MACrC,CAAC,QAAQ;AACP,UAAM,EAAE,2BAA2B,iBAAiB,GAAG,KAAK,IAAI;AAChE,WAAO,IAAI,SAAS;AAAA,MAClB,QAAQ;AAAA,QACN,UAAU,IAAI,IAAI,UAAU;AAAA,QAC5B,kBAAkB,MAAM,IAAI,IAAI,wBAAwB;AAAA,MAC1D;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAAA,EACnB;AACJ;","names":[]}
+{"version":3,"sources":["../../../src/middlewares/html/showHTML.ts"],"sourcesContent":["import { middlewareCreator } from '../../utils/index.js';\nimport type { HTMLGenerator, SendFile } from '../../services/index.js';\nimport type {\n  AsyncExpressMiddleware,\n  Response,\n  NextFunction,\n} from '../../types/index.js';\n/**\n * The options to customize the behavior of the middleware.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLOptions = {\n  /**\n   * The name of the file the middleware will serve. If the {@link HTMLGenerator} service\n   * is available, it will be overridden by the service.\n   *\n   * @default 'index.html'\n   */\n  file: string;\n};\n/**\n * The options to construct a {@link ShowHTML}.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLConstructorOptions = Partial<ShowHTMLOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    sendFile: SendFile;\n    /**\n     * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n     * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n     * app starts, and injecting a reference would force the service to be initialized\n     * too, even if a request is not being made.\n     */\n    getHTMLGenerator?: () => HTMLGenerator | undefined;\n  };\n};\n/**\n * The options for the middleware creator that will mount an instance of {@link ShowHTML}.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLMiddlewareOptions = Partial<ShowHTMLOptions> & {\n  /**\n   * The name of an {@link HTMLGenerator} service already available in the application.\n   *\n   * @default 'htmlGenerator'\n   */\n  htmlGeneratorServiceName?: string;\n};\n\n/**\n * A very simple middleware service to send an HTML on a server response. The special\n * _'feature'_ of this service is that it can be hooked up to an {@link HTMLGenerator}\n * service and it will automatically server the file generated by it.\n *\n * @group Middleware Classes\n * @group Middlewares/ShowHTML\n * @prettierignore\n */\nexport class ShowHTML {\n  /**\n   * The service that serves a file.\n   */\n  protected readonly _sendFile: SendFile;\n  /**\n   * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n   * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n   * app starts, and injecting a reference would force the service to be initialized\n   * too, even if a request is not being made.\n   */\n  protected readonly _getHTMLGenerator: () => HTMLGenerator | undefined;\n  /**\n   * The customization options for the middleware.\n   */\n  protected _options: ShowHTMLOptions;\n  /**\n   * Whether or not the file is ready to be served. In case the middleware uses an\n   * {@link HTMLGenerator} service, the file needs to be generated before being available,\n   * and that's why this flag exists.\n   */\n  protected _fileReady: boolean = false;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({ inject, ...options }: ShowHTMLConstructorOptions) {\n    this._sendFile = inject.sendFile;\n    this._getHTMLGenerator = inject.getHTMLGenerator || (() => undefined);\n    this._options = {\n      file: 'index.html',\n      ...options,\n    };\n  }\n  /**\n   * Generates the middleware that serves the HTML file.\n   */\n  getMiddleware(): AsyncExpressMiddleware {\n    return async (_, res, next) => {\n      // If the file is ready to be served, serve it.\n      if (this._fileReady) {\n        this._sendResponse(res, next);\n        return;\n      }\n\n      const htmlGenerator = this._getHTMLGenerator();\n      // If there's no generator, switch the flag and just serve the file.\n      if (!htmlGenerator) {\n        this._fileReady = true;\n        this._sendResponse(res, next);\n        return;\n      }\n\n      try {\n        // Wait for the HTML to be generated.\n        await htmlGenerator.whenReady();\n        // Update the local option.\n        this._options.file = htmlGenerator.options.file;\n        // Switch the flag and serve the file.\n        this._fileReady = true;\n        this._sendResponse(res, next);\n      } catch (error) {\n        next(error);\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<ShowHTMLOptions> {\n    return { ...this._options };\n  }\n  /**\n   * Serves the HTML file to the response.\n   *\n   * @param res   The response object generated by the application.\n   * @param next  The function to call the next middleware.\n   */\n  protected _sendResponse(res: Response, next: NextFunction): void {\n    res.setHeader('Content-Type', 'text/html');\n    this._sendFile({\n      res,\n      next,\n      filepath: this._options.file,\n    });\n  }\n}\n/**\n * Creates the middleware that serves an HTML file in the response.\n *\n * @group Middlewares\n * @group Middlewares/ShowHTML\n */\nexport const showHTMLMiddleware = middlewareCreator(\n  (options: ShowHTMLMiddlewareOptions = {}) =>\n    (app) => {\n      const { htmlGeneratorServiceName = 'htmlGenerator', ...rest } = options;\n      return new ShowHTML({\n        inject: {\n          sendFile: app.get('sendFile'),\n          getHTMLGenerator: () => app.try(htmlGeneratorServiceName),\n        },\n        ...rest,\n      }).getMiddleware();\n    },\n);\n"],"mappings":"AAAA,SAAS,yBAAyB;AAgE3B,MAAM,SAAS;AAAA;AAAA;AAAA;AAAA,EAID;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA;AAAA;AAAA;AAAA;AAAA,EAIT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAsB;AAAA;AAAA;AAAA;AAAA,EAIhC,YAAY,EAAE,QAAQ,GAAG,QAAQ,GAA+B;AAC9D,SAAK,YAAY,OAAO;AACxB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,WAAW;AAAA,MACd,MAAM;AAAA,MACN,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAwC;AACtC,WAAO,OAAO,GAAG,KAAK,SAAS;AAE7B,UAAI,KAAK,YAAY;AACnB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,YAAM,gBAAgB,KAAK,kBAAkB;AAE7C,UAAI,CAAC,eAAe;AAClB,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,UAAI;AAEF,cAAM,cAAc,UAAU;AAE9B,aAAK,SAAS,OAAO,cAAc,QAAQ;AAE3C,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAAA,MAC9B,SAAS,OAAO;AACd,aAAK,KAAK;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAqC;AACvC,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,cAAc,KAAe,MAA0B;AAC/D,QAAI,UAAU,gBAAgB,WAAW;AACzC,SAAK,UAAU;AAAA,MACb;AAAA,MACA;AAAA,MACA,UAAU,KAAK,SAAS;AAAA,IAC1B,CAAC;AAAA,EACH;AACF;AAOO,MAAM,qBAAqB;AAAA,EAChC,CAAC,UAAqC,CAAC,MACrC,CAAC,QAAQ;AACP,UAAM,EAAE,2BAA2B,iBAAiB,GAAG,KAAK,IAAI;AAChE,WAAO,IAAI,SAAS;AAAA,MAClB,QAAQ;AAAA,QACN,UAAU,IAAI,IAAI,UAAU;AAAA,QAC5B,kBAAkB,MAAM,IAAI,IAAI,wBAAwB;AAAA,MAC1D;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAAA,EACnB;AACJ;","names":[]}

package/dist/middlewares/index.d.ts

@@ -5,9 +5,7 @@ export { FastHTML, FastHTMLConstructorOptions, FastHTMLMiddlewareOptions, FastHT
 export { ShowHTML, ShowHTMLConstructorOptions, ShowHTMLMiddlewareOptions, ShowHTMLOptions, showHTMLMiddleware } from './html/showHTML.js';
 export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware } from './utils/versionValidator.js';
 import '@homer0/jimple';
-import '../utils/fns/statuses.js';
-import 'statuses';
-import '../index-C6I3NCC-.js';
+import '../index-BlSpNHox.js';
 import '../types/express.js';
 import 'express';
 import '../types/http.js';
@@ -20,11 +18,13 @@ import '@homer0/path-utils';
 import '@homer0/simple-logger';
 import '@homer0/simple-config';
 import '@homer0/events-hub';
+import '../utils/fns/statuses.js';
+import 'statuses';
 import '../services/common/httpError.js';
 import '../services/common/appError.js';
 import '../services/http/responsesBuilder.js';
 import '../services/common/sendFile.js';
 import '../services/html/htmlGenerator.js';
 import '../services/frontend/frontendFs.js';
-import 'fs/promises';
+import 'node:fs/promises';
 import '@homer0/deferred';

package/dist/middlewares/index.js

@@ -1,27 +1,4 @@
-"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 middlewares_exports = {};
-module.exports = __toCommonJS(middlewares_exports);
-__reExport(middlewares_exports, require("./common"), module.exports);
-__reExport(middlewares_exports, require("./html"), module.exports);
-__reExport(middlewares_exports, require("./utils"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("./common"),
-  ...require("./html"),
-  ...require("./utils")
-});
+export * from "./common/index.js";
+export * from "./html/index.js";
+export * from "./utils/index.js";
 //# sourceMappingURL=index.js.map

package/dist/middlewares/index.js.map

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

package/dist/middlewares/utils/index.d.ts

@@ -1,8 +1,6 @@
 export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware } from './versionValidator.js';
 import '@homer0/jimple';
-import '../../utils/fns/statuses.js';
-import 'statuses';
-import '../../index-C6I3NCC-.js';
+import '../../index-BlSpNHox.js';
 import '../../types/express.js';
 import 'express';
 import '../../types/http.js';
@@ -15,6 +13,8 @@ import '@homer0/path-utils';
 import '@homer0/simple-logger';
 import '@homer0/simple-config';
 import '@homer0/events-hub';
+import '../../utils/fns/statuses.js';
+import 'statuses';
 import '../../services/common/httpError.js';
 import '../../services/common/appError.js';
 import '../../services/http/responsesBuilder.js';

package/dist/middlewares/utils/index.js

@@ -1,23 +1,2 @@
-"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 utils_exports = {};
-module.exports = __toCommonJS(utils_exports);
-__reExport(utils_exports, require("./versionValidator"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("./versionValidator")
-});
+export * from "./versionValidator.js";
 //# sourceMappingURL=index.js.map

package/dist/middlewares/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/middlewares/utils/index.ts"],"sourcesContent":["export * from './versionValidator';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,0BAAc,+BAAd;","names":[]}
+{"version":3,"sources":["../../../src/middlewares/utils/index.ts"],"sourcesContent":["export * from './versionValidator.js';\n"],"mappings":"AAAA,cAAc;","names":[]}

package/dist/middlewares/utils/versionValidator.d.ts

@@ -1,12 +1,11 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { Statuses } from '../../utils/fns/statuses.js';
-import { J as Jimpex, R as MiddlewareConnectFn } from '../../index-C6I3NCC-.js';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../index-BlSpNHox.js';
 import { ExpressMiddleware } from '../../types/express.js';
+import { Statuses } from '../../utils/fns/statuses.js';
 import { DeepPartial } from '../../types/utils.js';
 import { HTTPErrorClass } from '../../services/common/httpError.js';
 import { ResponsesBuilder } from '../../services/http/responsesBuilder.js';
 import { Request } from 'express';
-import 'statuses';
 import '../../types/http.js';
 import 'https';
 import 'http';
@@ -16,6 +15,7 @@ import '@homer0/path-utils';
 import '@homer0/simple-logger';
 import '@homer0/simple-config';
 import '@homer0/events-hub';
+import 'statuses';
 import '../../services/common/appError.js';
 
 /**
@@ -46,7 +46,7 @@ type VersionValidatorLatestOptions = {
  */
 type VersionValidatorPopupOptions = {
     /**
-     * The name of the query string variable the middleware will check in order to indentify
+     * The name of the query string variable the middleware will check in order to identify
      * whether the request comes from a popup or not. The variable must have `'true'` as its
      * value.
      *
@@ -160,7 +160,7 @@ declare class VersionValidator {
      */
     protected readonly _responsesBuilder: ResponsesBuilder;
     /**
-     * The uility service to get HTTP status codes.
+     * The utility service to get HTTP status codes.
      */
     protected readonly _statuses: Statuses;
     /**

package/dist/middlewares/utils/versionValidator.js

@@ -1,57 +1,31 @@
-"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 versionValidator_exports = {};
-__export(versionValidator_exports, {
-  VersionValidator: () => VersionValidator,
-  versionValidatorMiddleware: () => versionValidatorMiddleware
-});
-module.exports = __toCommonJS(versionValidator_exports);
-var import_deep_assign = require("@homer0/deep-assign");
-var import_utils = require("../../utils");
+import { deepAssignWithOverwrite } from "@homer0/deep-assign";
+import { middlewareCreator } from "../../utils/index.js";
 class VersionValidator {
+  /**
+   * To generate the errors in case the validation fails.
+   */
+  _HTTPError;
+  /**
+   * To generate responses for popups.
+   */
+  _responsesBuilder;
+  /**
+   * The utility service to get HTTP status codes.
+   */
+  _statuses;
+  /**
+   * The customization options.
+   */
+  _options;
   /**
    * @param options  The options to construct the class.
    * @throws If no `version` is specified in the options.
    */
   constructor({ inject, version, ...options }) {
-    /**
-     * To generate the errors in case the validation fails.
-     */
-    __publicField(this, "_HTTPError");
-    /**
-     * To generate responses for popups.
-     */
-    __publicField(this, "_responsesBuilder");
-    /**
-     * The uility service to get HTTP status codes.
-     */
-    __publicField(this, "_statuses");
-    /**
-     * The customization options.
-     */
-    __publicField(this, "_options");
     this._HTTPError = inject.HTTPError;
     this._responsesBuilder = inject.responsesBuilder;
     this._statuses = inject.statuses;
-    this._options = (0, import_deep_assign.deepAssignWithOverwrite)(
+    this._options = deepAssignWithOverwrite(
       {
         error: "The application version doesn't match",
         latest: {
@@ -61,7 +35,7 @@ class VersionValidator {
         popup: {
           variable: "popup",
           title: "Conflict",
-          message: "vesion:conflict"
+          message: "version:conflict"
         },
         version
       },
@@ -109,7 +83,7 @@ class VersionValidator {
    * The customization options.
    */
   get options() {
-    return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
+    return deepAssignWithOverwrite({}, this._options);
   }
   /**
    * Helper method that checks if the incoming request is from a popup. It will look for
@@ -132,7 +106,7 @@ class VersionValidator {
     return allow && version === name;
   }
 }
-const versionValidatorMiddleware = (0, import_utils.middlewareCreator)(
+const versionValidatorMiddleware = middlewareCreator(
   (options = {}) => (app, route) => {
     const version = app.getConfig("version");
     const middleware = new VersionValidator({
@@ -151,9 +125,8 @@ const versionValidatorMiddleware = (0, import_utils.middlewareCreator)(
     return middleware;
   }
 );
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   VersionValidator,
   versionValidatorMiddleware
-});
+};
 //# sourceMappingURL=versionValidator.js.map

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/middlewares/utils/versionValidator.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { middlewareCreator, type Statuses } from '../../utils';\nimport { DeepPartial, Request, ExpressMiddleware } from '../../types';\nimport type { HTTPErrorClass, ResponsesBuilder } from '../../services';\n/**\n * The options for how the middleware should behave if the requested version is `latest`.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorLatestOptions = {\n  /**\n   * Whether or not the middleware should validate the _\"latest version\"_.\n   *\n   * @default true\n   */\n  allow: boolean;\n  /**\n   * The name of the _\"latest version\"_. Basically, `req.params.version` must match with\n   * this property in order to be consider \"latest\".\n   *\n   * @default 'latest'\n   */\n  name: string;\n};\n/**\n * The options for how to detect if the request comes from a popup and how to compose the\n * post message the middleware will use to respond.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorPopupOptions = {\n  /**\n   * The name of the query string variable the middleware will check in order to indentify\n   * whether the request comes from a popup or not. The variable must have `'true'` as its\n   * value.\n   *\n   * @default 'popup'\n   */\n  variable: string;\n  /**\n   * The title of the page that will be generated to respond in case the versions don't\n   * match.\n   *\n   * @default 'Conflict'\n   */\n  title: string;\n  /**\n   * The contents of the post message the generated page will send if the versions don't\n   * match.\n   *\n   * @default 'version:conflict'\n   */\n  message: string;\n};\n/**\n * The options used to customize a {@link VersionValidator} instance.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorOptions = {\n  /**\n   * The version used to validate the requests.\n   */\n  version: string;\n  /**\n   * The options for how the middleware should behave if the requested version is\n   * `latest`.\n   */\n  latest: VersionValidatorLatestOptions;\n  /**\n   * The options for how to detect if the request comes from a popup and how to compose\n   * the post message the middleware will use to respond.\n   */\n  popup: VersionValidatorPopupOptions;\n  /**\n   * The error message to show when the version is invalid.\n   *\n   * @default \"The application version doesn't match\"\n   * @prettierignore\n   */\n  error: string;\n};\n/**\n * A partial version of the {@link VersionValidatorOptions}, to be used in the constructor\n * and the middleware creator. The reason it omits `version` it's because for the\n * constructor it's required, but for the middleware creator it's not.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorPartialOptions = DeepPartial<\n  Omit<VersionValidatorOptions, 'version'>\n>;\n/**\n * The options to construct a {@link VersionValidator}.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorConstructorOptions = VersionValidatorPartialOptions & {\n  /**\n   * The version used to validate the requests.\n   */\n  version: string;\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    HTTPError: HTTPErrorClass;\n    responsesBuilder: ResponsesBuilder;\n    statuses: Statuses;\n  };\n};\n/**\n * The options for the middleware creator that will mount an instance of\n * {@link VersionValidator}.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorMiddlewareOptions = VersionValidatorPartialOptions & {\n  /**\n   * The version used to validate the requests. This is optional in here because if it's\n   * not specified, it will be obtained from the configuration service.\n   */\n  version?: string;\n};\n/**\n * This is the handler for the middleware/controller that validates the application\n * version.\n * This is useful in cases where you want to restrict the access to specific versions; for\n * example: you have a frontend which needs to be aligned with the \"current\" version of\n * the application, since the frontend won't realize a new version was released, the\n * validator can be used to let the frontend know.\n * Also, it can be configured to handle requests from popups, in which case, instead of\n * generating an error message, it will send a post message.\n *\n * @group Middleware Classes\n * @group Middlewares/VersionValidator\n * @prettierignore\n */\nexport class VersionValidator {\n  /**\n   * To generate the errors in case the validation fails.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * To generate responses for popups.\n   */\n  protected readonly _responsesBuilder: ResponsesBuilder;\n  /**\n   * The uility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * The customization options.\n   */\n  protected readonly _options: VersionValidatorOptions;\n  /**\n   * @param options  The options to construct the class.\n   * @throws If no `version` is specified in the options.\n   */\n  constructor({ inject, version, ...options }: VersionValidatorConstructorOptions) {\n    this._HTTPError = inject.HTTPError;\n    this._responsesBuilder = inject.responsesBuilder;\n    this._statuses = inject.statuses;\n    this._options = deepAssignWithOverwrite(\n      {\n        error: \"The application version doesn't match\",\n        latest: {\n          allow: true,\n          name: 'latest',\n        },\n        popup: {\n          variable: 'popup',\n          title: 'Conflict',\n          message: 'vesion:conflict',\n        },\n        version,\n      },\n      options,\n    );\n\n    if (!this._options.version) {\n      throw new Error('You need to supply a version');\n    }\n  }\n  /**\n   * Generates the middleware that validates the version.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      // Get the `version` parameter from the request.\n      const { version } = req.params;\n      // If no version is present, move on to the next middleware.\n      if (!version) {\n        next();\n        return;\n      }\n      // If the version matches, or it's a \"latest\" version, move on to the next middleware.\n      if (version === this._options.version || this._isTheAllowedLatest(version)) {\n        next();\n        return;\n      }\n\n      const status = this._statuses('conflict');\n      // If the request comes from a popup, send the post message.\n      if (this._isPopup(req)) {\n        const { title, message } = this._options.popup;\n        this._responsesBuilder.htmlPostMessage({\n          res,\n          title,\n          message,\n          status,\n        });\n        return;\n      }\n\n      // Every other validation failed, and it's not a popup, so generate an error.\n      next(\n        new this._HTTPError(this._options.error, status, {\n          response: {\n            validation: true,\n          },\n        }),\n      );\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<VersionValidatorOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Helper method that checks if the incoming request is from a popup. It will look for\n   * the query string variable defined in the constructor options.\n   *\n   * @param req  The request object sent by the application.\n   */\n  protected _isPopup(req: Request): boolean {\n    const popup = req.query[this._options.popup.variable];\n    return !!(popup && String(popup).toLowerCase() === 'true');\n  }\n  /**\n   * Helper method that checks if the \"latest version\" is enabled and if the given version\n   * is \"the latest\" (comparing it with the option name).\n   *\n   * @param version  The version received in the request.\n   */\n  protected _isTheAllowedLatest(version: string): boolean {\n    const { allow, name } = this._options.latest;\n    return allow && version === name;\n  }\n}\n/**\n * A middleware that will validate a `version` request parameter against the application\n * version, and generate an error if they don't match.\n * This is a \"middleware/controller\" because the wrappers for both are the same, the\n * difference is that, for controllers, Jimpex sends a second parameter with the route\n * where they are mounted.\n * By validating the route parameter, the function can know whether the implementation is\n * going to use the middleware by itself or as a route middleware.\n * If used as middleware, it will just return the result of\n * {@link VersionValidator.getMiddleware}; but if used as controller, it will mount it on\n * `[route]/:version/*`.\n *\n * @group Middlewares\n * @group Middlewares/VersionValidator\n */\nexport const versionValidatorMiddleware = middlewareCreator(\n  (options: VersionValidatorMiddlewareOptions = {}) =>\n    (app, route) => {\n      const version = app.getConfig<string>('version');\n      const middleware = new VersionValidator({\n        inject: {\n          HTTPError: app.get('HTTPError'),\n          responsesBuilder: app.get('responsesBuilder'),\n          statuses: app.get('statuses'),\n        },\n        version,\n        ...options,\n      }).getMiddleware();\n\n      if (route) {\n        const router = app.getRouter();\n        return router.all('/:version/*', middleware);\n      }\n\n      return middleware;\n    },\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAwC;AACxC,mBAAiD;AAyI1C,MAAM,iBAAiB;AAAA;AAAA;AAAA;AAAA;AAAA,EAqB5B,YAAY,EAAE,QAAQ,SAAS,GAAG,QAAQ,GAAuC;AAjBjF;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAMjB,SAAK,aAAa,OAAO;AACzB,SAAK,oBAAoB,OAAO;AAChC,SAAK,YAAY,OAAO;AACxB,SAAK,eAAW;AAAA,MACd;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,UACN,OAAO;AAAA,UACP,MAAM;AAAA,QACR;AAAA,QACA,OAAO;AAAA,UACL,UAAU;AAAA,UACV,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,SAAS,SAAS;AAC1B,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AAEzB,YAAM,EAAE,QAAQ,IAAI,IAAI;AAExB,UAAI,CAAC,SAAS;AACZ,aAAK;AACL;AAAA,MACF;AAEA,UAAI,YAAY,KAAK,SAAS,WAAW,KAAK,oBAAoB,OAAO,GAAG;AAC1E,aAAK;AACL;AAAA,MACF;AAEA,YAAM,SAAS,KAAK,UAAU,UAAU;AAExC,UAAI,KAAK,SAAS,GAAG,GAAG;AACtB,cAAM,EAAE,OAAO,QAAQ,IAAI,KAAK,SAAS;AACzC,aAAK,kBAAkB,gBAAgB;AAAA,UACrC;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF,CAAC;AACD;AAAA,MACF;AAGA;AAAA,QACE,IAAI,KAAK,WAAW,KAAK,SAAS,OAAO,QAAQ;AAAA,UAC/C,UAAU;AAAA,YACR,YAAY;AAAA,UACd;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA6C;AAC/C,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,SAAS,KAAuB;AACxC,UAAM,QAAQ,IAAI,MAAM,KAAK,SAAS,MAAM,QAAQ;AACpD,WAAO,CAAC,EAAE,SAAS,OAAO,KAAK,EAAE,YAAY,MAAM;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,oBAAoB,SAA0B;AACtD,UAAM,EAAE,OAAO,KAAK,IAAI,KAAK,SAAS;AACtC,WAAO,SAAS,YAAY;AAAA,EAC9B;AACF;AAgBO,MAAM,iCAA6B;AAAA,EACxC,CAAC,UAA6C,CAAC,MAC7C,CAAC,KAAK,UAAU;AACd,UAAM,UAAU,IAAI,UAAkB,SAAS;AAC/C,UAAM,aAAa,IAAI,iBAAiB;AAAA,MACtC,QAAQ;AAAA,QACN,WAAW,IAAI,IAAI,WAAW;AAAA,QAC9B,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,QAC5C,UAAU,IAAI,IAAI,UAAU;AAAA,MAC9B;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAEjB,QAAI,OAAO;AACT,YAAM,SAAS,IAAI,UAAU;AAC7B,aAAO,OAAO,IAAI,eAAe,UAAU;AAAA,IAC7C;AAEA,WAAO;AAAA,EACT;AACJ;","names":[]}
+{"version":3,"sources":["../../../src/middlewares/utils/versionValidator.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { middlewareCreator, type Statuses } from '../../utils/index.js';\nimport { DeepPartial, Request, ExpressMiddleware } from '../../types/index.js';\nimport type { HTTPErrorClass, ResponsesBuilder } from '../../services/index.js';\n/**\n * The options for how the middleware should behave if the requested version is `latest`.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorLatestOptions = {\n  /**\n   * Whether or not the middleware should validate the _\"latest version\"_.\n   *\n   * @default true\n   */\n  allow: boolean;\n  /**\n   * The name of the _\"latest version\"_. Basically, `req.params.version` must match with\n   * this property in order to be consider \"latest\".\n   *\n   * @default 'latest'\n   */\n  name: string;\n};\n/**\n * The options for how to detect if the request comes from a popup and how to compose the\n * post message the middleware will use to respond.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorPopupOptions = {\n  /**\n   * The name of the query string variable the middleware will check in order to identify\n   * whether the request comes from a popup or not. The variable must have `'true'` as its\n   * value.\n   *\n   * @default 'popup'\n   */\n  variable: string;\n  /**\n   * The title of the page that will be generated to respond in case the versions don't\n   * match.\n   *\n   * @default 'Conflict'\n   */\n  title: string;\n  /**\n   * The contents of the post message the generated page will send if the versions don't\n   * match.\n   *\n   * @default 'version:conflict'\n   */\n  message: string;\n};\n/**\n * The options used to customize a {@link VersionValidator} instance.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorOptions = {\n  /**\n   * The version used to validate the requests.\n   */\n  version: string;\n  /**\n   * The options for how the middleware should behave if the requested version is\n   * `latest`.\n   */\n  latest: VersionValidatorLatestOptions;\n  /**\n   * The options for how to detect if the request comes from a popup and how to compose\n   * the post message the middleware will use to respond.\n   */\n  popup: VersionValidatorPopupOptions;\n  /**\n   * The error message to show when the version is invalid.\n   *\n   * @default \"The application version doesn't match\"\n   * @prettierignore\n   */\n  error: string;\n};\n/**\n * A partial version of the {@link VersionValidatorOptions}, to be used in the constructor\n * and the middleware creator. The reason it omits `version` it's because for the\n * constructor it's required, but for the middleware creator it's not.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorPartialOptions = DeepPartial<\n  Omit<VersionValidatorOptions, 'version'>\n>;\n/**\n * The options to construct a {@link VersionValidator}.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorConstructorOptions = VersionValidatorPartialOptions & {\n  /**\n   * The version used to validate the requests.\n   */\n  version: string;\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    HTTPError: HTTPErrorClass;\n    responsesBuilder: ResponsesBuilder;\n    statuses: Statuses;\n  };\n};\n/**\n * The options for the middleware creator that will mount an instance of\n * {@link VersionValidator}.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorMiddlewareOptions = VersionValidatorPartialOptions & {\n  /**\n   * The version used to validate the requests. This is optional in here because if it's\n   * not specified, it will be obtained from the configuration service.\n   */\n  version?: string;\n};\n/**\n * This is the handler for the middleware/controller that validates the application\n * version.\n * This is useful in cases where you want to restrict the access to specific versions; for\n * example: you have a frontend which needs to be aligned with the \"current\" version of\n * the application, since the frontend won't realize a new version was released, the\n * validator can be used to let the frontend know.\n * Also, it can be configured to handle requests from popups, in which case, instead of\n * generating an error message, it will send a post message.\n *\n * @group Middleware Classes\n * @group Middlewares/VersionValidator\n * @prettierignore\n */\nexport class VersionValidator {\n  /**\n   * To generate the errors in case the validation fails.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * To generate responses for popups.\n   */\n  protected readonly _responsesBuilder: ResponsesBuilder;\n  /**\n   * The utility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * The customization options.\n   */\n  protected readonly _options: VersionValidatorOptions;\n  /**\n   * @param options  The options to construct the class.\n   * @throws If no `version` is specified in the options.\n   */\n  constructor({ inject, version, ...options }: VersionValidatorConstructorOptions) {\n    this._HTTPError = inject.HTTPError;\n    this._responsesBuilder = inject.responsesBuilder;\n    this._statuses = inject.statuses;\n    this._options = deepAssignWithOverwrite(\n      {\n        error: \"The application version doesn't match\",\n        latest: {\n          allow: true,\n          name: 'latest',\n        },\n        popup: {\n          variable: 'popup',\n          title: 'Conflict',\n          message: 'version:conflict',\n        },\n        version,\n      },\n      options,\n    );\n\n    if (!this._options.version) {\n      throw new Error('You need to supply a version');\n    }\n  }\n  /**\n   * Generates the middleware that validates the version.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      // Get the `version` parameter from the request.\n      const { version } = req.params;\n      // If no version is present, move on to the next middleware.\n      if (!version) {\n        next();\n        return;\n      }\n      // If the version matches, or it's a \"latest\" version, move on to the next middleware.\n      if (version === this._options.version || this._isTheAllowedLatest(version)) {\n        next();\n        return;\n      }\n\n      const status = this._statuses('conflict');\n      // If the request comes from a popup, send the post message.\n      if (this._isPopup(req)) {\n        const { title, message } = this._options.popup;\n        this._responsesBuilder.htmlPostMessage({\n          res,\n          title,\n          message,\n          status,\n        });\n        return;\n      }\n\n      // Every other validation failed, and it's not a popup, so generate an error.\n      next(\n        new this._HTTPError(this._options.error, status, {\n          response: {\n            validation: true,\n          },\n        }),\n      );\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<VersionValidatorOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Helper method that checks if the incoming request is from a popup. It will look for\n   * the query string variable defined in the constructor options.\n   *\n   * @param req  The request object sent by the application.\n   */\n  protected _isPopup(req: Request): boolean {\n    const popup = req.query[this._options.popup.variable];\n    return !!(popup && String(popup).toLowerCase() === 'true');\n  }\n  /**\n   * Helper method that checks if the \"latest version\" is enabled and if the given version\n   * is \"the latest\" (comparing it with the option name).\n   *\n   * @param version  The version received in the request.\n   */\n  protected _isTheAllowedLatest(version: string): boolean {\n    const { allow, name } = this._options.latest;\n    return allow && version === name;\n  }\n}\n/**\n * A middleware that will validate a `version` request parameter against the application\n * version, and generate an error if they don't match.\n * This is a \"middleware/controller\" because the wrappers for both are the same, the\n * difference is that, for controllers, Jimpex sends a second parameter with the route\n * where they are mounted.\n * By validating the route parameter, the function can know whether the implementation is\n * going to use the middleware by itself or as a route middleware.\n * If used as middleware, it will just return the result of\n * {@link VersionValidator.getMiddleware}; but if used as controller, it will mount it on\n * `[route]/:version/*`.\n *\n * @group Middlewares\n * @group Middlewares/VersionValidator\n */\nexport const versionValidatorMiddleware = middlewareCreator(\n  (options: VersionValidatorMiddlewareOptions = {}) =>\n    (app, route) => {\n      const version = app.getConfig<string>('version');\n      const middleware = new VersionValidator({\n        inject: {\n          HTTPError: app.get('HTTPError'),\n          responsesBuilder: app.get('responsesBuilder'),\n          statuses: app.get('statuses'),\n        },\n        version,\n        ...options,\n      }).getMiddleware();\n\n      if (route) {\n        const router = app.getRouter();\n        return router.all('/:version/*', middleware);\n      }\n\n      return middleware;\n    },\n);\n"],"mappings":"AAAA,SAAS,+BAA+B;AACxC,SAAS,yBAAwC;AAyI1C,MAAM,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAIT;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnB,YAAY,EAAE,QAAQ,SAAS,GAAG,QAAQ,GAAuC;AAC/E,SAAK,aAAa,OAAO;AACzB,SAAK,oBAAoB,OAAO;AAChC,SAAK,YAAY,OAAO;AACxB,SAAK,WAAW;AAAA,MACd;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,UACN,OAAO;AAAA,UACP,MAAM;AAAA,QACR;AAAA,QACA,OAAO;AAAA,UACL,UAAU;AAAA,UACV,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,SAAS,SAAS;AAC1B,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AAEzB,YAAM,EAAE,QAAQ,IAAI,IAAI;AAExB,UAAI,CAAC,SAAS;AACZ,aAAK;AACL;AAAA,MACF;AAEA,UAAI,YAAY,KAAK,SAAS,WAAW,KAAK,oBAAoB,OAAO,GAAG;AAC1E,aAAK;AACL;AAAA,MACF;AAEA,YAAM,SAAS,KAAK,UAAU,UAAU;AAExC,UAAI,KAAK,SAAS,GAAG,GAAG;AACtB,cAAM,EAAE,OAAO,QAAQ,IAAI,KAAK,SAAS;AACzC,aAAK,kBAAkB,gBAAgB;AAAA,UACrC;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF,CAAC;AACD;AAAA,MACF;AAGA;AAAA,QACE,IAAI,KAAK,WAAW,KAAK,SAAS,OAAO,QAAQ;AAAA,UAC/C,UAAU;AAAA,YACR,YAAY;AAAA,UACd;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA6C;AAC/C,WAAO,wBAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,SAAS,KAAuB;AACxC,UAAM,QAAQ,IAAI,MAAM,KAAK,SAAS,MAAM,QAAQ;AACpD,WAAO,CAAC,EAAE,SAAS,OAAO,KAAK,EAAE,YAAY,MAAM;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,oBAAoB,SAA0B;AACtD,UAAM,EAAE,OAAO,KAAK,IAAI,KAAK,SAAS;AACtC,WAAO,SAAS,YAAY;AAAA,EAC9B;AACF;AAgBO,MAAM,6BAA6B;AAAA,EACxC,CAAC,UAA6C,CAAC,MAC7C,CAAC,KAAK,UAAU;AACd,UAAM,UAAU,IAAI,UAAkB,SAAS;AAC/C,UAAM,aAAa,IAAI,iBAAiB;AAAA,MACtC,QAAQ;AAAA,QACN,WAAW,IAAI,IAAI,WAAW;AAAA,QAC9B,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,QAC5C,UAAU,IAAI,IAAI,UAAU;AAAA,MAC9B;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAEjB,QAAI,OAAO;AACT,YAAM,SAAS,IAAI,UAAU;AAC7B,aAAO,OAAO,IAAI,eAAe,UAAU;AAAA,IAC7C;AAEA,WAAO;AAAA,EACT;AACJ;","names":[]}

package/dist/services/common/appError.d.ts

@@ -1,5 +1,5 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-C6I3NCC-.js';
+import { J as Jimpex } from '../../index-BlSpNHox.js';
 import { Statuses } from '../../utils/fns/statuses.js';
 import '../../types/express.js';
 import 'express';
@@ -102,7 +102,7 @@ declare class AppError extends Error {
  * @group Services
  * @group Services/AppError
  */
-declare const createAppError: (message: string, context?: AppErrorContext | undefined, statuses?: Statuses | undefined) => AppError;
+declare const createAppError: (...args: ConstructorParameters<typeof AppError>) => AppError;
 /**
  * The type of the function that generates a new instance of {@link AppError}.
  * This is exported to make it easy to type the dependency injection.

package/dist/services/common/appError.js

@@ -1,32 +1,18 @@
-"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 appError_exports = {};
-__export(appError_exports, {
-  AppError: () => AppError,
-  appErrorProvider: () => appErrorProvider,
-  createAppError: () => createAppError
-});
-module.exports = __toCommonJS(appError_exports);
-var import_utils = require("../../utils");
+import { provider, statuses as statusesFn } from "../../utils/index.js";
 class AppError extends Error {
+  /**
+   * The date of when the error was generated.
+   */
+  _date;
+  /**
+   * The context information that can be provided to the error, and picked by the error
+   * handler.
+   */
+  _context;
+  /**
+   * The service that generates HTTP status codes.
+   */
+  _statuses;
   /**
    * @param message   The message of the error.
    * @param context   The context information, for the error handler.
@@ -35,21 +21,8 @@ class AppError extends Error {
    *                  the container; otherwise, it will use the `statuses` library
    *                  directly.
    */
-  constructor(message, context = {}, statuses = import_utils.statuses) {
+  constructor(message, context = {}, statuses = statusesFn) {
     super(message);
-    /**
-     * The date of when the error was generated.
-     */
-    __publicField(this, "_date");
-    /**
-     * The context information that can be provided to the error, and picked by the error
-     * handler.
-     */
-    __publicField(this, "_context");
-    /**
-     * The service that generates HTTP status codes.
-     */
-    __publicField(this, "_statuses");
     this.name = this.constructor.name;
     this._date = /* @__PURE__ */ new Date();
     this._statuses = statuses;
@@ -110,14 +83,13 @@ class AppError extends Error {
   }
 }
 const createAppError = (...args) => new AppError(...args);
-const appErrorProvider = (0, import_utils.provider)((app) => {
+const appErrorProvider = provider((app) => {
   app.set("AppError", () => AppError);
   app.set("appError", () => createAppError);
 });
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   AppError,
   appErrorProvider,
   createAppError
-});
+};
 //# sourceMappingURL=appError.js.map

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/common/appError.ts"],"sourcesContent":["import { provider, statuses as statusesFn, type Statuses } from '../../utils';\n/**\n * A dictionary with some context information that can be provided to {@link AppError}.\n *\n * @group Services/AppError\n */\nexport type AppErrorContext = {\n  /**\n   * Extra information that the error handler can pick and include the response.\n   */\n  response?: unknown;\n  /**\n   * A status code or name for the error handler to set in the response.\n   */\n  status?: string | number;\n} & Record<string, unknown>;\n/**\n * A simple subclass of `Error` but with support for context information.\n *\n * @group Services\n * @group Services/AppError\n */\nexport class AppError extends Error {\n  /**\n   * The date of when the error was generated.\n   */\n  readonly _date: Date;\n  /**\n   * The context information that can be provided to the error, and picked by the error\n   * handler.\n   */\n  readonly _context: AppErrorContext;\n  /**\n   * The service that generates HTTP status codes.\n   */\n  protected _statuses: Statuses;\n  /**\n   * @param message   The message of the error.\n   * @param context   The context information, for the error handler.\n   * @param statuses  A reference to the service that generates HTTP status codes. This\n   *                  is in case the implementation wants to use a special version from\n   *                  the container; otherwise, it will use the `statuses` library\n   *                  directly.\n   */\n  constructor(\n    message: string,\n    context: AppErrorContext = {},\n    statuses: Statuses = statusesFn,\n  ) {\n    super(message);\n    this.name = this.constructor.name;\n    this._date = new Date();\n    this._statuses = statuses;\n    this._context = this._parseContext(context);\n\n    // Limit the stack trace if possible.\n    if (Error.captureStackTrace) {\n      Error.captureStackTrace(this, this.constructor);\n    }\n  }\n  /**\n   * Gets an object that can be included in a response from the application. This method\n   * is a helper for the `response` getter, as it allows for the assertion of the response\n   * type.\n   *\n   * @template T  The type of the response.\n   */\n  getResponse<T>(): T {\n    return this.response as T;\n  }\n  /**\n   * Information about the error that can be included in a response. This is set using the\n   * `response` key in the `context` option.\n   */\n  get response(): unknown {\n    return this._context.response || {};\n  }\n  /**\n   * An HTTP status code related to the error. This is set using the `status` key on the\n   * `context`.\n   */\n  get status(): number | undefined {\n    return this._context.status as number | undefined;\n  }\n  /**\n   * Context information related to the error.\n   */\n  get context(): unknown {\n    return this._context;\n  }\n  /**\n   * The date of when the error was generated.\n   */\n  get date(): Date {\n    return this._date;\n  }\n  /**\n   * Utility method that formats the context before saving it in the instance:\n   * - If the context includes a `status` as a `string`, it will try to replace it with\n   * its actual status code from the `statuses `service.\n   *\n   * @param context  The original context sent to the constructor.\n   */\n  protected _parseContext(context: AppErrorContext): AppErrorContext {\n    const result = { ...context };\n    if (result.status && typeof result.status === 'string') {\n      result.status = this._statuses.code[result.status.toLowerCase()] || result.status;\n    }\n\n    return result;\n  }\n}\n/**\n * Shorthand for `new AppError()`.\n *\n * @param args  The same parameters as the {@link AppError} constructor.\n * @returns A new instance of {@link AppError}.\n * @group Services\n * @group Services/AppError\n */\nexport const createAppError = (\n  ...args: ConstructorParameters<typeof AppError>\n): AppError => new AppError(...args);\n/**\n * The type of the function that generates a new instance of {@link AppError}.\n * This is exported to make it easy to type the dependency injection.\n *\n * @group Services/AppError\n */\nexport type CreateAppErrorFn = typeof createAppError;\n/**\n * THe type of the {@link AppError} class.\n * This is exported to make it easy to type the dependency injection.\n *\n * @group Services/AppError\n */\nexport type AppErrorClass = typeof AppError;\n/**\n * A service provider that will register both, {@link AppError} and\n * {@link createAppError}, on the container. `AppError` will be the key for class, and\n * `appError` will be for the generator function.\n *\n * @example\n *\n *   // Register it on the container\n *   container.register(appErrorProvider);\n *   // Getting access to the class.\n *   const AppError = container.get<AppErrorClass>('AppError');\n *   // Getting access to the function.\n *   const appError = container.get<CreateAppErrorFn>('appError');\n *\n * @group Providers\n * @group Services/AppError\n */\nexport const appErrorProvider = provider((app) => {\n  app.set('AppError', () => AppError);\n  app.set('appError', () => createAppError);\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAgE;AAsBzD,MAAM,iBAAiB,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBlC,YACE,SACA,UAA2B,CAAC,GAC5B,WAAqB,aAAAA,UACrB;AACA,UAAM,OAAO;AAvBf;AAAA;AAAA;AAAA,wBAAS;AAKT;AAAA;AAAA;AAAA;AAAA,wBAAS;AAIT;AAAA;AAAA;AAAA,wBAAU;AAeR,SAAK,OAAO,KAAK,YAAY;AAC7B,SAAK,QAAQ,oBAAI,KAAK;AACtB,SAAK,YAAY;AACjB,SAAK,WAAW,KAAK,cAAc,OAAO;AAG1C,QAAI,MAAM,mBAAmB;AAC3B,YAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,IAChD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAoB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,WAAoB;AACtB,WAAO,KAAK,SAAS,YAAY,CAAC;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,SAA6B;AAC/B,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,OAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,cAAc,SAA2C;AACjE,UAAM,SAAS,EAAE,GAAG,QAAQ;AAC5B,QAAI,OAAO,UAAU,OAAO,OAAO,WAAW,UAAU;AACtD,aAAO,SAAS,KAAK,UAAU,KAAK,OAAO,OAAO,YAAY,CAAC,KAAK,OAAO;AAAA,IAC7E;AAEA,WAAO;AAAA,EACT;AACF;AASO,MAAM,iBAAiB,IACzB,SACU,IAAI,SAAS,GAAG,IAAI;AAgC5B,MAAM,uBAAmB,uBAAS,CAAC,QAAQ;AAChD,MAAI,IAAI,YAAY,MAAM,QAAQ;AAClC,MAAI,IAAI,YAAY,MAAM,cAAc;AAC1C,CAAC;","names":["statusesFn"]}
+{"version":3,"sources":["../../../src/services/common/appError.ts"],"sourcesContent":["import { provider, statuses as statusesFn, type Statuses } from '../../utils/index.js';\n/**\n * A dictionary with some context information that can be provided to {@link AppError}.\n *\n * @group Services/AppError\n */\nexport type AppErrorContext = {\n  /**\n   * Extra information that the error handler can pick and include the response.\n   */\n  response?: unknown;\n  /**\n   * A status code or name for the error handler to set in the response.\n   */\n  status?: string | number;\n} & Record<string, unknown>;\n/**\n * A simple subclass of `Error` but with support for context information.\n *\n * @group Services\n * @group Services/AppError\n */\nexport class AppError extends Error {\n  /**\n   * The date of when the error was generated.\n   */\n  readonly _date: Date;\n  /**\n   * The context information that can be provided to the error, and picked by the error\n   * handler.\n   */\n  readonly _context: AppErrorContext;\n  /**\n   * The service that generates HTTP status codes.\n   */\n  protected _statuses: Statuses;\n  /**\n   * @param message   The message of the error.\n   * @param context   The context information, for the error handler.\n   * @param statuses  A reference to the service that generates HTTP status codes. This\n   *                  is in case the implementation wants to use a special version from\n   *                  the container; otherwise, it will use the `statuses` library\n   *                  directly.\n   */\n  constructor(\n    message: string,\n    context: AppErrorContext = {},\n    statuses: Statuses = statusesFn,\n  ) {\n    super(message);\n    this.name = this.constructor.name;\n    this._date = new Date();\n    this._statuses = statuses;\n    this._context = this._parseContext(context);\n\n    // Limit the stack trace if possible.\n    if (Error.captureStackTrace) {\n      Error.captureStackTrace(this, this.constructor);\n    }\n  }\n  /**\n   * Gets an object that can be included in a response from the application. This method\n   * is a helper for the `response` getter, as it allows for the assertion of the response\n   * type.\n   *\n   * @template T  The type of the response.\n   */\n  getResponse<T>(): T {\n    return this.response as T;\n  }\n  /**\n   * Information about the error that can be included in a response. This is set using the\n   * `response` key in the `context` option.\n   */\n  get response(): unknown {\n    return this._context.response || {};\n  }\n  /**\n   * An HTTP status code related to the error. This is set using the `status` key on the\n   * `context`.\n   */\n  get status(): number | undefined {\n    return this._context.status as number | undefined;\n  }\n  /**\n   * Context information related to the error.\n   */\n  get context(): unknown {\n    return this._context;\n  }\n  /**\n   * The date of when the error was generated.\n   */\n  get date(): Date {\n    return this._date;\n  }\n  /**\n   * Utility method that formats the context before saving it in the instance:\n   * - If the context includes a `status` as a `string`, it will try to replace it with\n   * its actual status code from the `statuses `service.\n   *\n   * @param context  The original context sent to the constructor.\n   */\n  protected _parseContext(context: AppErrorContext): AppErrorContext {\n    const result = { ...context };\n    if (result.status && typeof result.status === 'string') {\n      result.status = this._statuses.code[result.status.toLowerCase()] || result.status;\n    }\n\n    return result;\n  }\n}\n/**\n * Shorthand for `new AppError()`.\n *\n * @param args  The same parameters as the {@link AppError} constructor.\n * @returns A new instance of {@link AppError}.\n * @group Services\n * @group Services/AppError\n */\nexport const createAppError = (\n  ...args: ConstructorParameters<typeof AppError>\n): AppError => new AppError(...args);\n/**\n * The type of the function that generates a new instance of {@link AppError}.\n * This is exported to make it easy to type the dependency injection.\n *\n * @group Services/AppError\n */\nexport type CreateAppErrorFn = typeof createAppError;\n/**\n * THe type of the {@link AppError} class.\n * This is exported to make it easy to type the dependency injection.\n *\n * @group Services/AppError\n */\nexport type AppErrorClass = typeof AppError;\n/**\n * A service provider that will register both, {@link AppError} and\n * {@link createAppError}, on the container. `AppError` will be the key for class, and\n * `appError` will be for the generator function.\n *\n * @example\n *\n *   // Register it on the container\n *   container.register(appErrorProvider);\n *   // Getting access to the class.\n *   const AppError = container.get<AppErrorClass>('AppError');\n *   // Getting access to the function.\n *   const appError = container.get<CreateAppErrorFn>('appError');\n *\n * @group Providers\n * @group Services/AppError\n */\nexport const appErrorProvider = provider((app) => {\n  app.set('AppError', () => AppError);\n  app.set('appError', () => createAppError);\n});\n"],"mappings":"AAAA,SAAS,UAAU,YAAY,kBAAiC;AAsBzD,MAAM,iBAAiB,MAAM;AAAA;AAAA;AAAA;AAAA,EAIzB;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA;AAAA;AAAA;AAAA,EAIC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASV,YACE,SACA,UAA2B,CAAC,GAC5B,WAAqB,YACrB;AACA,UAAM,OAAO;AACb,SAAK,OAAO,KAAK,YAAY;AAC7B,SAAK,QAAQ,oBAAI,KAAK;AACtB,SAAK,YAAY;AACjB,SAAK,WAAW,KAAK,cAAc,OAAO;AAG1C,QAAI,MAAM,mBAAmB;AAC3B,YAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,IAChD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAoB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,WAAoB;AACtB,WAAO,KAAK,SAAS,YAAY,CAAC;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,SAA6B;AAC/B,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,OAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,cAAc,SAA2C;AACjE,UAAM,SAAS,EAAE,GAAG,QAAQ;AAC5B,QAAI,OAAO,UAAU,OAAO,OAAO,WAAW,UAAU;AACtD,aAAO,SAAS,KAAK,UAAU,KAAK,OAAO,OAAO,YAAY,CAAC,KAAK,OAAO;AAAA,IAC7E;AAEA,WAAO;AAAA,EACT;AACF;AASO,MAAM,iBAAiB,IACzB,SACU,IAAI,SAAS,GAAG,IAAI;AAgC5B,MAAM,mBAAmB,SAAS,CAAC,QAAQ;AAChD,MAAI,IAAI,YAAY,MAAM,QAAQ;AAClC,MAAI,IAAI,YAAY,MAAM,cAAc;AAC1C,CAAC;","names":[]}

package/dist/services/common/httpError.d.ts

@@ -1,5 +1,5 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-C6I3NCC-.js';
+import { J as Jimpex } from '../../index-BlSpNHox.js';
 import { Statuses } from '../../utils/fns/statuses.js';
 import { AppError, AppErrorContext } from './appError.js';
 import '../../types/express.js';
@@ -43,7 +43,7 @@ declare class HTTPError extends AppError {
  * @group Services
  * @group Services/HTTPError
  */
-declare const createHTTPError: (message: string, status?: string | number | undefined, context?: AppErrorContext | undefined, statuses?: Statuses | undefined) => HTTPError;
+declare const createHTTPError: (...args: ConstructorParameters<typeof HTTPError>) => HTTPError;
 /**
  * The type of the function that generates a new instance of {@link HTTPError}.
  * This is exported to make it easy to type the dependency injection.