jimpex 7.0.2 → 9.0.0

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './app';\nexport * from './types';\nexport * from './controllers';\nexport * from './middlewares';\nexport * from './services';\nexport * from './utils';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

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

@@ -0,0 +1,116 @@
+import {
+  __publicField
+} from "../../chunk-2B2CG5KL.js";
+import { deepAssignWithOverwrite } from "@homer0/deep-assign";
+import { middlewareCreator } from "../../utils";
+import { AppError } from "../../services";
+class ErrorHandler {
+  /**
+   * @param options  The options to construct the class.
+   */
+  constructor({
+    inject: { logger, responsesBuilder, statuses, HTTPError },
+    ...options
+  }) {
+    /**
+     * The service that will log the messages in the console.
+     */
+    __publicField(this, "_logger");
+    /**
+     * The service to generate the responses.
+     */
+    __publicField(this, "_responsesBuilder");
+    /**
+     * The uility service to get HTTP status codes.
+     */
+    __publicField(this, "_statuses");
+    /**
+     * The Error class used by the "known errors".
+     */
+    __publicField(this, "_HTTPError");
+    /**
+     * The customization options.
+     */
+    __publicField(this, "_options");
+    this._logger = logger;
+    this._responsesBuilder = responsesBuilder;
+    this._statuses = statuses;
+    this._HTTPError = HTTPError;
+    this._options = deepAssignWithOverwrite(
+      {
+        showErrors: false,
+        response: {
+          message: "Unexpected error",
+          status: this._statuses("internal server error")
+        }
+      },
+      options
+    );
+  }
+  /**
+   * Generates the middleware that handles the errors.
+   */
+  getMiddleware() {
+    return (err, _, res, next) => {
+      if (!err) {
+        next();
+        return;
+      }
+      const { response, showErrors } = this._options;
+      let { status } = response;
+      let data = {
+        error: true,
+        message: response.message
+      };
+      const knownError = err instanceof AppError;
+      if (showErrors || knownError) {
+        data.message = err.message;
+        if (knownError) {
+          data = {
+            ...data,
+            ...err.getResponse()
+          };
+          status = err.status || this._statuses("bad request");
+        }
+        if (showErrors && err instanceof Error && err.stack) {
+          const stack = err.stack.split("\n").map((line) => line.trim());
+          data.stack = stack;
+          stack.splice(0, 1);
+          this._logger.error(`ERROR: ${err.message}`);
+          this._logger.info(stack);
+        }
+      }
+      this._responsesBuilder.json({
+        res,
+        data,
+        status
+      });
+    };
+  }
+  /**
+   * The handler customization options.
+   */
+  get options() {
+    return deepAssignWithOverwrite({}, this._options);
+  }
+}
+const errorHandlerMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const showErrors = app.getConfig("debug.showErrors") === true;
+    return new ErrorHandler({
+      inject: {
+        logger: app.get("logger"),
+        responsesBuilder: app.get("responsesBuilder"),
+        statuses: app.get("statuses"),
+        HTTPError: app.get("HTTPError")
+      },
+      showErrors,
+      ...options
+    }).getMiddleware();
+  }
+);
+export {
+  ErrorHandler,
+  errorHandlerMiddleware
+};
+//# sourceMappingURL=errorHandler.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/errorHandler.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { middlewareCreator, type Statuses } from '../../utils';\nimport type { DeepPartial, Logger, ExpressErrorHandler } from '../../types';\nimport { AppError, type HTTPErrorClass, type ResponsesBuilder } from '../../services';\n/**\n * The options for the responses the middleware will create.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerResponseOptions = {\n  /**\n   * The message to show in case `showErrors` is set to `false`.\n   *\n   * @default 'Oops! Something went wrong, please try again'\n   * @prettierignore\n   */\n  message: string;\n  /**\n   * The default status code for the responses.\n   *\n   * @default 500\n   */\n  status: number;\n};\n/**\n * The customization options for the middleware.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerOptions = {\n  /**\n   * If `false`, unknown errors will show a generic message instead of real message. And\n   * if `true`, it will not only show all kind of errors but it will also show the error\n   * stack.\n   *\n   * By \"uknown errors\", it means that are not `AppError` nor `HTTPError`.\n   */\n  showErrors: boolean;\n  /**\n   * The options for the default response the middleware will create.\n   */\n  response: ErrorHandlerResponseOptions;\n};\n/**\n * A partial version of the {@link ErrorHandlerOptions}, to be used in the constructor and\n * the middleware creator.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerPartialOptions = DeepPartial<ErrorHandlerOptions>;\n/**\n * The options to construct a {@link ErrorHandler}.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerConstructorOptions = ErrorHandlerPartialOptions & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    logger: Logger;\n    responsesBuilder: ResponsesBuilder;\n    statuses: Statuses;\n    HTTPError: HTTPErrorClass;\n  };\n};\n/**\n * Creates a middleware that handles errors and generates the responses.\n *\n * @group Middleware Classes\n * @group Middlewares/ErrorHandler\n * @prettierignore\n */\nexport class ErrorHandler {\n  /**\n   * The service that will log the messages in the console.\n   */\n  protected readonly _logger: Logger;\n  /**\n   * The service to generate the responses.\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 Error class used by the \"known errors\".\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * The customization options.\n   */\n  protected readonly _options: ErrorHandlerOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({\n    inject: { logger, responsesBuilder, statuses, HTTPError },\n    ...options\n  }: ErrorHandlerConstructorOptions) {\n    this._logger = logger;\n    this._responsesBuilder = responsesBuilder;\n    this._statuses = statuses;\n    this._HTTPError = HTTPError;\n    this._options = deepAssignWithOverwrite(\n      {\n        showErrors: false,\n        response: {\n          message: 'Unexpected error',\n          status: this._statuses('internal server error'),\n        },\n      },\n      options,\n    );\n  }\n  /**\n   * Generates the middleware that handles the errors.\n   */\n  getMiddleware(): ExpressErrorHandler {\n    return (err, _, res, next) => {\n      // If there wasn't any error, continue the execution.\n      if (!err) {\n        next();\n        return;\n      }\n\n      const { response, showErrors } = this._options;\n\n      // Define the base status and response.\n      let { status } = response;\n      let data: {\n        error: boolean;\n        message: string;\n        stack?: string[];\n      } & Record<string, unknown> = {\n        error: true,\n        message: response.message,\n      };\n\n      const knownError = err instanceof AppError;\n      // If it's a \"known error\" or the `showErrors` flag is set to `true`...\n      if (showErrors || knownError) {\n        // Get the real message.\n        data.message = err.message;\n        // If it's a \"known error\"...\n        if (knownError) {\n          // Try to extract information for the response.\n          data = {\n            ...data,\n            ...err.getResponse(),\n          };\n          status = err.status || (this._statuses('bad request') as number);\n        }\n        /**\n         * If the flag is set to `true`, and it's a \"valid error\", try to extract the\n         * stack, format it, and include it in the response.\n         */\n        if (showErrors && err instanceof Error && err.stack) {\n          const stack = err.stack.split('\\n').map((line) => line.trim());\n          data.stack = stack;\n          stack.splice(0, 1);\n          this._logger.error(`ERROR: ${err.message}`);\n          this._logger.info(stack);\n        }\n      }\n\n      this._responsesBuilder.json({\n        res,\n        data,\n        status,\n      });\n    };\n  }\n  /**\n   * The handler customization options.\n   */\n  get options(): Readonly<ErrorHandlerOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n}\n/**\n * Creates the middleware that handles errors.\n *\n * @group Middlewares\n * @group Middlewares/ErrorHandler\n */\nexport const errorHandlerMiddleware = middlewareCreator(\n  (options: ErrorHandlerPartialOptions = {}) =>\n    (app) => {\n      const showErrors = app.getConfig<boolean | undefined>('debug.showErrors') === true;\n      return new ErrorHandler({\n        inject: {\n          logger: app.get('logger'),\n          responsesBuilder: app.get('responsesBuilder'),\n          statuses: app.get('statuses'),\n          HTTPError: app.get('HTTPError'),\n        },\n        showErrors,\n        ...options,\n      }).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,+BAA+B;AACxC,SAAS,yBAAwC;AAEjD,SAAS,gBAA4D;AAsE9D,MAAM,aAAa;AAAA;AAAA;AAAA;AAAA,EAwBxB,YAAY;AAAA,IACV,QAAQ,EAAE,QAAQ,kBAAkB,UAAU,UAAU;AAAA,IACxD,GAAG;AAAA,EACL,GAAmC;AAvBnC;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAQjB,SAAK,UAAU;AACf,SAAK,oBAAoB;AACzB,SAAK,YAAY;AACjB,SAAK,aAAa;AAClB,SAAK,WAAW;AAAA,MACd;AAAA,QACE,YAAY;AAAA,QACZ,UAAU;AAAA,UACR,SAAS;AAAA,UACT,QAAQ,KAAK,UAAU,uBAAuB;AAAA,QAChD;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAqC;AACnC,WAAO,CAAC,KAAK,GAAG,KAAK,SAAS;AAE5B,UAAI,CAAC,KAAK;AACR,aAAK;AACL;AAAA,MACF;AAEA,YAAM,EAAE,UAAU,WAAW,IAAI,KAAK;AAGtC,UAAI,EAAE,OAAO,IAAI;AACjB,UAAI,OAI0B;AAAA,QAC5B,OAAO;AAAA,QACP,SAAS,SAAS;AAAA,MACpB;AAEA,YAAM,aAAa,eAAe;AAElC,UAAI,cAAc,YAAY;AAE5B,aAAK,UAAU,IAAI;AAEnB,YAAI,YAAY;AAEd,iBAAO;AAAA,YACL,GAAG;AAAA,YACH,GAAG,IAAI,YAAY;AAAA,UACrB;AACA,mBAAS,IAAI,UAAW,KAAK,UAAU,aAAa;AAAA,QACtD;AAKA,YAAI,cAAc,eAAe,SAAS,IAAI,OAAO;AACnD,gBAAM,QAAQ,IAAI,MAAM,MAAM,IAAI,EAAE,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC;AAC7D,eAAK,QAAQ;AACb,gBAAM,OAAO,GAAG,CAAC;AACjB,eAAK,QAAQ,MAAM,UAAU,IAAI,OAAO,EAAE;AAC1C,eAAK,QAAQ,KAAK,KAAK;AAAA,QACzB;AAAA,MACF;AAEA,WAAK,kBAAkB,KAAK;AAAA,QAC1B;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAyC;AAC3C,WAAO,wBAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AACF;AAOO,MAAM,yBAAyB;AAAA,EACpC,CAAC,UAAsC,CAAC,MACtC,CAAC,QAAQ;AACP,UAAM,aAAa,IAAI,UAA+B,kBAAkB,MAAM;AAC9E,WAAO,IAAI,aAAa;AAAA,MACtB,QAAQ;AAAA,QACN,QAAQ,IAAI,IAAI,QAAQ;AAAA,QACxB,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,QAC5C,UAAU,IAAI,IAAI,UAAU;AAAA,QAC5B,WAAW,IAAI,IAAI,WAAW;AAAA,MAChC;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAAA,EACnB;AACJ;","names":[]}

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

@@ -0,0 +1,53 @@
+import {
+  __publicField
+} from "../../chunk-2B2CG5KL.js";
+import { middlewareCreator } from "../../utils";
+class ForceHTTPS {
+  /**
+   * @param options  The options to construct the class.
+   */
+  constructor(options = {}) {
+    /**
+     * The customization options.
+     */
+    __publicField(this, "_options");
+    this._options = {
+      ignoredRoutes: [/^\/service\//],
+      ...options
+    };
+  }
+  /**
+   * Generates the middleware that redirects the traffic.
+   */
+  getMiddleware() {
+    return (req, res, next) => {
+      if (!req.secure && req.get("X-Forwarded-Proto") !== "https" && !this._options.ignoredRoutes.some(
+        (expression) => expression.test(req.originalUrl)
+      )) {
+        const host = req.get("Host");
+        res.redirect(`https://${host}${req.url}`);
+      } else {
+        next();
+      }
+    };
+  }
+  /**
+   * The customization options.
+   */
+  get options() {
+    return { ...this._options };
+  }
+}
+const forceHTTPSMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const enabled = app.getConfig("forceHTTPS");
+    if (!enabled)
+      return void 0;
+    return new ForceHTTPS(options).getMiddleware();
+  }
+);
+export {
+  ForceHTTPS,
+  forceHTTPSMiddleware
+};
+//# sourceMappingURL=forceHTTPS.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/forceHTTPS.ts"],"sourcesContent":["import { middlewareCreator } from '../../utils';\nimport { ExpressMiddleware } from '../../types';\n/**\n * The customization options for the middleware.\n *\n * @group Middlewares/ForceHTTPS\n */\nexport type ForceHTTPSOptions = {\n  /**\n   * A list of regular expressions to match routes that should be ignored.\n   *\n   * @default [/^\\/service\\//]\n   */\n  ignoredRoutes: RegExp[];\n};\n/**\n * A partial version of the {@link ForceHTTPSOptions}, to be used in the constructor and\n * the middleware creator.\n *\n * @group Middlewares/ForceHTTPS\n */\nexport type ForceHTTPSPartialOptions = Partial<ForceHTTPSOptions>;\n/**\n * Creates a middleware that forces all the traffic to be through HTTPS.\n *\n * @group Middleware Classes\n * @group Middlewares/ForceHTTPS\n * @prettierignore\n */\nexport class ForceHTTPS {\n  /**\n   * The customization options.\n   */\n  protected readonly _options: ForceHTTPSOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor(options: ForceHTTPSPartialOptions = {}) {\n    this._options = {\n      ignoredRoutes: [/^\\/service\\//],\n      ...options,\n    };\n  }\n  /**\n   * Generates the middleware that redirects the traffic.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      if (\n        !req.secure &&\n        req.get('X-Forwarded-Proto') !== 'https' &&\n        !this._options.ignoredRoutes.some((expression) =>\n          expression.test(req.originalUrl),\n        )\n      ) {\n        const host = req.get('Host');\n        res.redirect(`https://${host}${req.url}`);\n      } else {\n        next();\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<ForceHTTPSOptions> {\n    return { ...this._options };\n  }\n}\n/**\n * Creates the middleware that redirects the traffic to HTTPS.\n *\n * @group Middlewares\n * @group Middlewares/ForceHTTPS\n */\nexport const forceHTTPSMiddleware = middlewareCreator(\n  (options: ForceHTTPSPartialOptions = {}) =>\n    (app) => {\n      const enabled = app.getConfig<boolean | undefined>('forceHTTPS');\n      if (!enabled) return undefined;\n      return new ForceHTTPS(options).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,yBAAyB;AA6B3B,MAAM,WAAW;AAAA;AAAA;AAAA;AAAA,EAQtB,YAAY,UAAoC,CAAC,GAAG;AAJpD;AAAA;AAAA;AAAA,wBAAmB;AAKjB,SAAK,WAAW;AAAA,MACd,eAAe,CAAC,cAAc;AAAA,MAC9B,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AACzB,UACE,CAAC,IAAI,UACL,IAAI,IAAI,mBAAmB,MAAM,WACjC,CAAC,KAAK,SAAS,cAAc;AAAA,QAAK,CAAC,eACjC,WAAW,KAAK,IAAI,WAAW;AAAA,MACjC,GACA;AACA,cAAM,OAAO,IAAI,IAAI,MAAM;AAC3B,YAAI,SAAS,WAAW,IAAI,GAAG,IAAI,GAAG,EAAE;AAAA,MAC1C,OAAO;AACL,aAAK;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAuC;AACzC,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AACF;AAOO,MAAM,uBAAuB;AAAA,EAClC,CAAC,UAAoC,CAAC,MACpC,CAAC,QAAQ;AACP,UAAM,UAAU,IAAI,UAA+B,YAAY;AAC/D,QAAI,CAAC;AAAS,aAAO;AACrB,WAAO,IAAI,WAAW,OAAO,EAAE,cAAc;AAAA,EAC/C;AACJ;","names":[]}

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

@@ -0,0 +1,74 @@
+import {
+  __publicField
+} from "../../chunk-2B2CG5KL.js";
+import { middlewareCreator } from "../../utils";
+class HSTS {
+  /**
+   * @param options  The options to construct the class.
+   */
+  constructor(options = {}) {
+    /**
+     * The customization options for the header.
+     */
+    __publicField(this, "_options");
+    /**
+     * The value of the header that will be included in the responses.
+     */
+    __publicField(this, "_header");
+    this._options = {
+      maxAge: 31536e3,
+      includeSubDomains: true,
+      preload: false,
+      ...options
+    };
+    this._header = this._buildHeader();
+  }
+  /**
+   * Generates the middleware that includes the HSTS header on the responses.
+   */
+  getMiddleware() {
+    return (_, res, next) => {
+      res.setHeader("Strict-Transport-Security", this._header);
+      next();
+    };
+  }
+  /**
+   * The customization options.
+   */
+  get options() {
+    return { ...this._options };
+  }
+  /**
+   * The value of the header that will be included in the responses.
+   */
+  get header() {
+    return this._header;
+  }
+  /**
+   * Creates the header value based on the customization options.
+   */
+  _buildHeader() {
+    const { maxAge, includeSubDomains, preload } = this._options;
+    const directives = [`max-age=${maxAge}`];
+    if (includeSubDomains) {
+      directives.push("includeSubDomains");
+    }
+    if (preload) {
+      directives.push("preload");
+    }
+    return directives.join("; ");
+  }
+}
+const hstsMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const setting = app.getConfig("hsts");
+    if (!setting?.enabled || typeof options.enabled !== "undefined" && !options.enabled)
+      return void 0;
+    return new HSTS(options).getMiddleware();
+  }
+);
+export {
+  HSTS,
+  hstsMiddleware
+};
+//# sourceMappingURL=hsts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/hsts.ts"],"sourcesContent":["import { middlewareCreator } from '../../utils';\nimport { ExpressMiddleware } from '../../types';\n/**\n * The options to customize the HSTS header value.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security}\n * @group Middlewares/HSTS\n */\nexport type HSTSMiddlewareOptions = {\n  /**\n   * The time, in seconds, that the browser should remember that a site is only to be\n   * accessed using HTTPS.\n   *\n   * @default 31536000\n   */\n  maxAge: number;\n  /**\n   * Whether or not the rule should apply to all sub domains.\n   *\n   * @default true\n   */\n  includeSubDomains: boolean;\n  /**\n   * Whether or not to include on the major browsers'\n   * preload list. This directive is not part of the specification, for more information\n   * about it, you should check the MDN documentation for the header.\n   *\n   * @default false\n   */\n  preload: boolean;\n};\n/**\n * A partial version of the {@link HSTSMiddlewareOptions}, to be used in the constructor\n * and the middleware creator.\n *\n * @group Middlewares/HSTS\n */\nexport type HSTSMiddlewarePartialOptions = Partial<HSTSMiddlewareOptions>;\n/**\n * The options for the middleware creator that will create the middleware, or not,\n * depending on the `enabled` option.\n *\n * @group Middlewares/HSTS\n */\nexport type HSTSMiddlewareSettings = HSTSMiddlewarePartialOptions & {\n  /**\n   * If it's not `true`, it won't return the middleware.\n   */\n  enabled?: boolean;\n};\n/**\n * Generates a middleware that includes the HSTS header on the responses.\n *\n * @see {@link https://tools.ietf.org/html/rfc6797}\n * @group Middleware Classes\n * @group Middlewares/HSTS\n * @prettierignore\n */\nexport class HSTS {\n  /**\n   * The customization options for the header.\n   */\n  protected readonly _options: HSTSMiddlewareOptions;\n  /**\n   * The value of the header that will be included in the responses.\n   */\n  protected readonly _header: string;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor(options: HSTSMiddlewarePartialOptions = {}) {\n    this._options = {\n      maxAge: 31536000,\n      includeSubDomains: true,\n      preload: false,\n      ...options,\n    };\n    this._header = this._buildHeader();\n  }\n  /**\n   * Generates the middleware that includes the HSTS header on the responses.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (_, res, next) => {\n      res.setHeader('Strict-Transport-Security', this._header);\n      next();\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<HSTSMiddlewareOptions> {\n    return { ...this._options };\n  }\n  /**\n   * The value of the header that will be included in the responses.\n   */\n  get header(): string {\n    return this._header;\n  }\n  /**\n   * Creates the header value based on the customization options.\n   */\n  protected _buildHeader(): string {\n    const { maxAge, includeSubDomains, preload } = this._options;\n    const directives = [`max-age=${maxAge}`];\n    if (includeSubDomains) {\n      directives.push('includeSubDomains');\n    }\n\n    if (preload) {\n      directives.push('preload');\n    }\n\n    return directives.join('; ');\n  }\n}\n/**\n * Creates the middleware that includes the HSTS header on the responses.\n *\n * @group Middlewares\n * @group Middlewares/HSTS\n */\nexport const hstsMiddleware = middlewareCreator(\n  (options: HSTSMiddlewareSettings = {}) =>\n    (app) => {\n      const setting = app.getConfig<HSTSMiddlewareSettings | undefined>('hsts');\n      if (\n        !setting?.enabled ||\n        (typeof options.enabled !== 'undefined' && !options.enabled)\n      )\n        return undefined;\n      return new HSTS(options).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,yBAAyB;AA0D3B,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA,EAYhB,YAAY,UAAwC,CAAC,GAAG;AARxD;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAKjB,SAAK,WAAW;AAAA,MACd,QAAQ;AAAA,MACR,mBAAmB;AAAA,MACnB,SAAS;AAAA,MACT,GAAG;AAAA,IACL;AACA,SAAK,UAAU,KAAK,aAAa;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAmC;AACjC,WAAO,CAAC,GAAG,KAAK,SAAS;AACvB,UAAI,UAAU,6BAA6B,KAAK,OAAO;AACvD,WAAK;AAAA,IACP;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA2C;AAC7C,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,SAAiB;AACnB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAIU,eAAuB;AAC/B,UAAM,EAAE,QAAQ,mBAAmB,QAAQ,IAAI,KAAK;AACpD,UAAM,aAAa,CAAC,WAAW,MAAM,EAAE;AACvC,QAAI,mBAAmB;AACrB,iBAAW,KAAK,mBAAmB;AAAA,IACrC;AAEA,QAAI,SAAS;AACX,iBAAW,KAAK,SAAS;AAAA,IAC3B;AAEA,WAAO,WAAW,KAAK,IAAI;AAAA,EAC7B;AACF;AAOO,MAAM,iBAAiB;AAAA,EAC5B,CAAC,UAAkC,CAAC,MAClC,CAAC,QAAQ;AACP,UAAM,UAAU,IAAI,UAA8C,MAAM;AACxE,QACE,CAAC,SAAS,WACT,OAAO,QAAQ,YAAY,eAAe,CAAC,QAAQ;AAEpD,aAAO;AACT,WAAO,IAAI,KAAK,OAAO,EAAE,cAAc;AAAA,EACzC;AACJ;","names":[]}

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

@@ -0,0 +1,4 @@
+export * from "./errorHandler";
+export * from "./forceHTTPS";
+export * from "./hsts";
+//# sourceMappingURL=index.js.map

package/dist/esm/middlewares/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/index.ts"],"sourcesContent":["export * from './errorHandler';\nexport * from './forceHTTPS';\nexport * from './hsts';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

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

@@ -0,0 +1,158 @@
+import {
+  __publicField
+} from "../../chunk-2B2CG5KL.js";
+import { createRouteExpression, middlewareCreator, removeSlashes } from "../../utils";
+class FastHTML {
+  /**
+   * @param options  The options to construct the class.
+   * @throws If `ignoredRoutes` is empty and `useAppRoutes` is set to `false`.
+   */
+  constructor({ inject, ...options }) {
+    /**
+     * The service that serves a file.
+     */
+    __publicField(this, "_sendFile");
+    /**
+     * The application envent bus, to listen and get the list of "controlled routes" after
+     * the application is started.
+     */
+    __publicField(this, "_events");
+    /**
+     * 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);
+    /**
+     * A list of regular expression that match the routes controlled by the application.
+     * This is in case the `useAppRoutes` option is set to `true`; when the application gets
+     * started, an event listener will obtain all the top controlled routes, create regular
+     * expressions, and save them on this property.
+     */
+    __publicField(this, "_routeExpressions", []);
+    this._sendFile = inject.sendFile;
+    this._events = inject.events;
+    this._getHTMLGenerator = inject.getHTMLGenerator || (() => void 0);
+    this._options = {
+      file: "index.html",
+      ignoredRoutes: [/\.ico$/i],
+      useAppRoutes: true,
+      ...options
+    };
+    if (!this._options.ignoredRoutes.length && !this._options.useAppRoutes) {
+      throw new Error("You must provide either `ignoredRoutes` or `useAppRoutes`");
+    }
+    if (this._options.useAppRoutes) {
+      this._setupEvents();
+    }
+  }
+  /**
+   * Generates the middleware that serves the HTML file.
+   */
+  getMiddleware() {
+    return async (req, res, next) => {
+      if (this._shouldIgnoreRoute(req.originalUrl)) {
+        next();
+        return;
+      }
+      if (this._fileReady) {
+        this._sendResponse(res, next);
+        return;
+      }
+      const htmlGenerator = this._getHTMLGenerator();
+      if (!htmlGenerator) {
+        this._fileReady = true;
+        this._sendResponse(res, next);
+        return;
+      }
+      try {
+        await htmlGenerator.whenReady();
+        this._options.file = htmlGenerator.options.file;
+        this._fileReady = true;
+        this._sendResponse(res, next);
+      } catch (error) {
+        next(error);
+      }
+    };
+  }
+  /**
+   * The customization options.
+   */
+  get options() {
+    return { ...this._options };
+  }
+  /**
+   * Serves the HTML file to the response.
+   *
+   * @param res   The response object generated by the application.
+   * @param next  The function to call the next middleware.
+   */
+  _sendResponse(res, next) {
+    res.setHeader("Content-Type", "text/html");
+    this._sendFile({
+      res,
+      next,
+      filepath: this._options.file
+    });
+  }
+  /**
+   * Adds the event listener that obtains the list of "controlled routes" when
+   * `useAppRoutes` is set to `true`.
+   */
+  _setupEvents() {
+    this._events.once("afterStart", ({ app }) => {
+      const [routeExpressions] = app.routes.reduce(
+        (acc, route) => {
+          const [expressions, processed] = acc;
+          const clean = removeSlashes(route).trim();
+          if (!clean || processed.includes(clean))
+            return acc;
+          expressions.push(createRouteExpression(clean));
+          processed.push(clean);
+          return acc;
+        },
+        [[], []]
+      );
+      this._routeExpressions.push(...routeExpressions);
+    });
+  }
+  /**
+   * Validates whether a route should be ignored or not. The method checks first against
+   * the `ignore` option, and then against the list of "controlled routes" if
+   * `useAppRoutes` is set to `true`.
+   *
+   * @param route  The route to validate.
+   */
+  _shouldIgnoreRoute(route) {
+    return this._options.ignoredRoutes.some((expression) => route.match(expression)) || this._routeExpressions.some((expression) => route.match(expression));
+  }
+}
+const fastHTMLMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const { htmlGeneratorServiceName = "htmlGenerator", ...rest } = options;
+    return new FastHTML({
+      inject: {
+        events: app.get("events"),
+        sendFile: app.get("sendFile"),
+        getHTMLGenerator: () => app.try(htmlGeneratorServiceName)
+      },
+      ...rest
+    }).getMiddleware();
+  }
+);
+export {
+  FastHTML,
+  fastHTMLMiddleware
+};
+//# sourceMappingURL=fastHTML.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/html/fastHTML.ts"],"sourcesContent":["import { createRouteExpression, middlewareCreator, removeSlashes } from '../../utils';\nimport type { HTMLGenerator, SendFile } from '../../services';\nimport type { AsyncExpressMiddleware, Response, NextFunction, Events } from '../../types';\n/**\n * The options to customize the behavior of the middleware.\n *\n * @group Middlewares/FastHTML\n */\nexport type FastHTMLOptions = {\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   * A list of regular expressions to match request paths that should be ignored by the\n   * middleware.\n   *\n   * @default [/\\.ico$/i]\n   */\n  ignoredRoutes: RegExp[];\n  /**\n   * If `true`, {@link FastHTML} will get the list of all the routes controlled by the\n   * application, and will use them to validate the incoming requests (in addition to the\n   * `ignore` list): If a request URL doesn't match with any of the \"controlled routes\",\n   * it will serve the HTML file.\n   *\n   * @default true\n   */\n  useAppRoutes: boolean;\n};\n/**\n * The options to construct a {@link FastHTML}.\n *\n * @group Middlewares/FastHTML\n */\nexport type FastHTMLConstructorOptions = Partial<FastHTMLOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    sendFile: SendFile;\n    events: Events;\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 FastHTML}.\n *\n * @group Middlewares/FastHTML\n */\nexport type FastHTMLMiddlewareOptions = Partial<FastHTMLOptions> & {\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 * It's common for an app to show an HTML view when no route was able to handle a request,\n * so the idea behind this middleware is to avoid going to every middleware and controller\n * and just specify that if the request is not for a route handled by a controller, just\n * serve the HTML and avoid processing unnecessary data.\n *\n * A simple example: The app has a route `/backend` that a frontend uses to get\n * information.\n * This middleware can be used to only allow the execution of middlewares and controllers\n * when the request route is for `/backend`.\n *\n * **Disclaimer**: Managing statics files with Express is not a best practice, but there\n * are scenarios where there is not other choice.\n *\n * @group Middleware Classes\n * @group Middlewares/FastHTML\n * @prettierignore\n */\nexport class FastHTML {\n  /**\n   * The service that serves a file.\n   */\n  protected readonly _sendFile: SendFile;\n  /**\n   * The application envent bus, to listen and get the list of \"controlled routes\" after\n   * the application is started.\n   */\n  protected readonly _events: Events;\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: FastHTMLOptions;\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   * A list of regular expression that match the routes controlled by the application.\n   * This is in case the `useAppRoutes` option is set to `true`; when the application gets\n   * started, an event listener will obtain all the top controlled routes, create regular\n   * expressions, and save them on this property.\n   */\n  protected _routeExpressions: RegExp[] = [];\n  /**\n   * @param options  The options to construct the class.\n   * @throws If `ignoredRoutes` is empty and `useAppRoutes` is set to `false`.\n   */\n  constructor({ inject, ...options }: FastHTMLConstructorOptions) {\n    this._sendFile = inject.sendFile;\n    this._events = inject.events;\n    this._getHTMLGenerator = inject.getHTMLGenerator || (() => undefined);\n    this._options = {\n      file: 'index.html',\n      ignoredRoutes: [/\\.ico$/i],\n      useAppRoutes: true,\n      ...options,\n    };\n\n    if (!this._options.ignoredRoutes.length && !this._options.useAppRoutes) {\n      throw new Error('You must provide either `ignoredRoutes` or `useAppRoutes`');\n    }\n\n    if (this._options.useAppRoutes) {\n      this._setupEvents();\n    }\n  }\n  /**\n   * Generates the middleware that serves the HTML file.\n   */\n  getMiddleware(): AsyncExpressMiddleware {\n    return async (req, res, next) => {\n      // If the route should be ignored, move to the next middleware.\n      if (this._shouldIgnoreRoute(req.originalUrl)) {\n        next();\n        return;\n      }\n\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<FastHTMLOptions> {\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   * Adds the event listener that obtains the list of \"controlled routes\" when\n   * `useAppRoutes` is set to `true`.\n   */\n  protected _setupEvents() {\n    this._events.once('afterStart', ({ app }) => {\n      const [routeExpressions] = app.routes.reduce<[RegExp[], string[]]>(\n        (acc, route) => {\n          const [expressions, processed] = acc;\n          const clean = removeSlashes(route).trim();\n          if (!clean || processed.includes(clean)) return acc;\n          expressions.push(createRouteExpression(clean));\n          processed.push(clean);\n          return acc;\n        },\n        [[], []],\n      );\n      this._routeExpressions.push(...routeExpressions);\n    });\n  }\n  /**\n   * Validates whether a route should be ignored or not. The method checks first against\n   * the `ignore` option, and then against the list of \"controlled routes\" if\n   * `useAppRoutes` is set to `true`.\n   *\n   * @param route  The route to validate.\n   */\n  protected _shouldIgnoreRoute(route: string): boolean {\n    return (\n      this._options.ignoredRoutes.some((expression) => route.match(expression)) ||\n      this._routeExpressions.some((expression) => route.match(expression))\n    );\n  }\n}\n/**\n * Creates the middleware that filters the routes and serves an HTML before the\n * application gets to evaluate whether there's a controller for the request or not.\n *\n * @group Middlewares\n * @group Middlewares/FastHTML\n */\nexport const fastHTMLMiddleware = middlewareCreator(\n  (options: FastHTMLMiddlewareOptions = {}) =>\n    (app) => {\n      const { htmlGeneratorServiceName = 'htmlGenerator', ...rest } = options;\n      return new FastHTML({\n        inject: {\n          events: app.get('events'),\n          sendFile: app.get('sendFile'),\n          getHTMLGenerator: () => app.try(htmlGeneratorServiceName),\n        },\n        ...rest,\n      }).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,uBAAuB,mBAAmB,qBAAqB;AAqFjE,MAAM,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAsCpB,YAAY,EAAE,QAAQ,GAAG,QAAQ,GAA+B;AAlChE;AAAA;AAAA;AAAA,wBAAmB;AAKnB;AAAA;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;AAOhC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAU,qBAA8B,CAAC;AAMvC,SAAK,YAAY,OAAO;AACxB,SAAK,UAAU,OAAO;AACtB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,WAAW;AAAA,MACd,MAAM;AAAA,MACN,eAAe,CAAC,SAAS;AAAA,MACzB,cAAc;AAAA,MACd,GAAG;AAAA,IACL;AAEA,QAAI,CAAC,KAAK,SAAS,cAAc,UAAU,CAAC,KAAK,SAAS,cAAc;AACtE,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,QAAI,KAAK,SAAS,cAAc;AAC9B,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,gBAAwC;AACtC,WAAO,OAAO,KAAK,KAAK,SAAS;AAE/B,UAAI,KAAK,mBAAmB,IAAI,WAAW,GAAG;AAC5C,aAAK;AACL;AAAA,MACF;AAGA,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;AAAA;AAAA;AAAA;AAAA;AAAA,EAKU,eAAe;AACvB,SAAK,QAAQ,KAAK,cAAc,CAAC,EAAE,IAAI,MAAM;AAC3C,YAAM,CAAC,gBAAgB,IAAI,IAAI,OAAO;AAAA,QACpC,CAAC,KAAK,UAAU;AACd,gBAAM,CAAC,aAAa,SAAS,IAAI;AACjC,gBAAM,QAAQ,cAAc,KAAK,EAAE,KAAK;AACxC,cAAI,CAAC,SAAS,UAAU,SAAS,KAAK;AAAG,mBAAO;AAChD,sBAAY,KAAK,sBAAsB,KAAK,CAAC;AAC7C,oBAAU,KAAK,KAAK;AACpB,iBAAO;AAAA,QACT;AAAA,QACA,CAAC,CAAC,GAAG,CAAC,CAAC;AAAA,MACT;AACA,WAAK,kBAAkB,KAAK,GAAG,gBAAgB;AAAA,IACjD,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,mBAAmB,OAAwB;AACnD,WACE,KAAK,SAAS,cAAc,KAAK,CAAC,eAAe,MAAM,MAAM,UAAU,CAAC,KACxE,KAAK,kBAAkB,KAAK,CAAC,eAAe,MAAM,MAAM,UAAU,CAAC;AAAA,EAEvE;AACF;AAQO,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,QAAQ,IAAI,IAAI,QAAQ;AAAA,QACxB,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/esm/middlewares/html/index.js

@@ -0,0 +1,3 @@
+export * from "./fastHTML";
+export * from "./showHTML";
+//# sourceMappingURL=index.js.map

package/dist/esm/middlewares/html/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/html/index.ts"],"sourcesContent":["export * from './fastHTML';\nexport * from './showHTML';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}

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

@@ -0,0 +1,100 @@
+import {
+  __publicField
+} from "../../chunk-2B2CG5KL.js";
+import { middlewareCreator } from "../../utils";
+class ShowHTML {
+  /**
+   * @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 = {
+      file: "index.html",
+      ...options
+    };
+  }
+  /**
+   * Generates the middleware that serves the HTML file.
+   */
+  getMiddleware() {
+    return async (_, res, next) => {
+      if (this._fileReady) {
+        this._sendResponse(res, next);
+        return;
+      }
+      const htmlGenerator = this._getHTMLGenerator();
+      if (!htmlGenerator) {
+        this._fileReady = true;
+        this._sendResponse(res, next);
+        return;
+      }
+      try {
+        await htmlGenerator.whenReady();
+        this._options.file = htmlGenerator.options.file;
+        this._fileReady = true;
+        this._sendResponse(res, next);
+      } catch (error) {
+        next(error);
+      }
+    };
+  }
+  /**
+   * The customization options.
+   */
+  get options() {
+    return { ...this._options };
+  }
+  /**
+   * Serves the HTML file to the response.
+   *
+   * @param res   The response object generated by the application.
+   * @param next  The function to call the next middleware.
+   */
+  _sendResponse(res, next) {
+    res.setHeader("Content-Type", "text/html");
+    this._sendFile({
+      res,
+      next,
+      filepath: this._options.file
+    });
+  }
+}
+const showHTMLMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const { htmlGeneratorServiceName = "htmlGenerator", ...rest } = options;
+    return new ShowHTML({
+      inject: {
+        sendFile: app.get("sendFile"),
+        getHTMLGenerator: () => app.try(htmlGeneratorServiceName)
+      },
+      ...rest
+    }).getMiddleware();
+  }
+);
+export {
+  ShowHTML,
+  showHTMLMiddleware
+};
+//# sourceMappingURL=showHTML.js.map

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

@@ -0,0 +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,SAAS,yBAAyB;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,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/esm/middlewares/index.js

@@ -0,0 +1,4 @@
+export * from "./common";
+export * from "./html";
+export * from "./utils";
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,2 @@
+export * from "./versionValidator";
+//# sourceMappingURL=index.js.map

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

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