jimpex 7.0.2 → 8.0.0

package/dist/middlewares/common/errorHandler.d.ts

@@ -0,0 +1,131 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { Statuses } from '../../utils/fns/statuses.js';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../jimpex-7eaee271.js';
+import { ExpressErrorHandler } from '../../types/express.js';
+import { SimpleLogger } from '@homer0/simple-logger';
+import { DeepPartial } from '../../types/utils.js';
+import { HTTPErrorClass } from '../../services/common/httpError.js';
+import { ResponsesBuilder } from '../../services/http/responsesBuilder.js';
+import 'statuses';
+import '@homer0/events-hub';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/simple-config';
+import '../../services/common/appError.js';
+
+/**
+ * The options for the responses the middleware will create.
+ *
+ * @group Middlewares/ErrorHandler
+ */
+type ErrorHandlerResponseOptions = {
+    /**
+     * The message to show in case `showErrors` is set to `false`.
+     *
+     * @default 'Oops! Something went wrong, please try again'
+     * @prettierignore
+     */
+    message: string;
+    /**
+     * The default status code for the responses.
+     *
+     * @default 500
+     */
+    status: number;
+};
+/**
+ * The customization options for the middleware.
+ *
+ * @group Middlewares/ErrorHandler
+ */
+type ErrorHandlerOptions = {
+    /**
+     * If `false`, unknown errors will show a generic message instead of real message. And
+     * if `true`, it will not only show all kind of errors but it will also show the error
+     * stack.
+     *
+     * By "uknown errors", it means that are not `AppError` nor `HTTPError`.
+     */
+    showErrors: boolean;
+    /**
+     * The options for the default response the middleware will create.
+     */
+    response: ErrorHandlerResponseOptions;
+};
+/**
+ * A partial version of the {@link ErrorHandlerOptions}, to be used in the constructor and
+ * the middleware creator.
+ *
+ * @group Middlewares/ErrorHandler
+ */
+type ErrorHandlerPartialOptions = DeepPartial<ErrorHandlerOptions>;
+/**
+ * The options to construct a {@link ErrorHandler}.
+ *
+ * @group Middlewares/ErrorHandler
+ */
+type ErrorHandlerConstructorOptions = ErrorHandlerPartialOptions & {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        logger: SimpleLogger;
+        responsesBuilder: ResponsesBuilder;
+        statuses: Statuses;
+        HTTPError: HTTPErrorClass;
+    };
+};
+/**
+ * Creates a middleware that handles errors and generates the responses.
+ *
+ * @group Middleware Classes
+ * @group Middlewares/ErrorHandler
+ * @prettierignore
+ */
+declare class ErrorHandler {
+    /**
+     * The service that will log the messages in the console.
+     */
+    protected readonly _logger: SimpleLogger;
+    /**
+     * The service to generate the responses.
+     */
+    protected readonly _responsesBuilder: ResponsesBuilder;
+    /**
+     * The uility service to get HTTP status codes.
+     */
+    protected readonly _statuses: Statuses;
+    /**
+     * The Error class used by the "known errors".
+     */
+    protected readonly _HTTPError: HTTPErrorClass;
+    /**
+     * The customization options.
+     */
+    protected readonly _options: ErrorHandlerOptions;
+    /**
+     * @param options  The options to construct the class.
+     */
+    constructor({ inject: { logger, responsesBuilder, statuses, HTTPError }, ...options }: ErrorHandlerConstructorOptions);
+    /**
+     * Generates the middleware that handles the errors.
+     */
+    getMiddleware(): ExpressErrorHandler;
+    /**
+     * The handler customization options.
+     */
+    get options(): Readonly<ErrorHandlerOptions>;
+}
+/**
+ * Creates the middleware that handles errors.
+ *
+ * @group Middlewares
+ * @group Middlewares/ErrorHandler
+ */
+declare const errorHandlerMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: ErrorHandlerPartialOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType) => ExpressErrorHandler, MiddlewareConnectFn>;
+
+export { ErrorHandler, ErrorHandlerConstructorOptions, ErrorHandlerOptions, ErrorHandlerPartialOptions, ErrorHandlerResponseOptions, errorHandlerMiddleware };

package/dist/middlewares/common/errorHandler.js

@@ -0,0 +1,119 @@
+"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);
+  return value;
+};
+var errorHandler_exports = {};
+__export(errorHandler_exports, {
+  ErrorHandler: () => ErrorHandler,
+  errorHandlerMiddleware: () => errorHandlerMiddleware
+});
+module.exports = __toCommonJS(errorHandler_exports);
+var import_deep_assign = require("@homer0/deep-assign");
+var import_utils = require("../../utils");
+var import_services = require("../../services");
+class ErrorHandler {
+  constructor({
+    inject: { logger, responsesBuilder, statuses, HTTPError },
+    ...options
+  }) {
+    __publicField(this, "_logger");
+    __publicField(this, "_responsesBuilder");
+    __publicField(this, "_statuses");
+    __publicField(this, "_HTTPError");
+    __publicField(this, "_options");
+    this._logger = logger;
+    this._responsesBuilder = responsesBuilder;
+    this._statuses = statuses;
+    this._HTTPError = HTTPError;
+    this._options = (0, import_deep_assign.deepAssignWithOverwrite)(
+      {
+        showErrors: false,
+        response: {
+          message: "Unexpected error",
+          status: this._statuses("internal server error")
+        }
+      },
+      options
+    );
+  }
+  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 import_services.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
+      });
+    };
+  }
+  get options() {
+    return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
+  }
+}
+const errorHandlerMiddleware = (0, import_utils.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();
+  }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ErrorHandler,
+  errorHandlerMiddleware
+});
+//# sourceMappingURL=errorHandler.js.map

package/dist/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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAwC;AACxC,mBAAiD;AAEjD,sBAAqE;AAsE9D,MAAM,aAAa;AAAA,EAwBxB,YAAY;AAAA,IACV,QAAQ,EAAE,QAAQ,kBAAkB,UAAU,UAAU;AAAA,OACrD;AAAA,EACL,GAAmC;AAvBnC,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAQjB,SAAK,UAAU;AACf,SAAK,oBAAoB;AACzB,SAAK,YAAY;AACjB,SAAK,aAAa;AAClB,SAAK,eAAW;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,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,SAAS;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,EAIA,IAAI,UAAyC;AAC3C,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AACF;AAOO,MAAM,6BAAyB;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/middlewares/common/forceHTTPS.d.ts

@@ -0,0 +1,68 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../jimpex-7eaee271.js';
+import { ExpressMiddleware } from '../../types/express.js';
+import '@homer0/events-hub';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/simple-config';
+import '../../types/utils.js';
+import '@homer0/simple-logger';
+
+/**
+ * The customization options for the middleware.
+ *
+ * @group Middlewares/ForceHTTPS
+ */
+type ForceHTTPSOptions = {
+    /**
+     * A list of regular expressions to match routes that should be ignored.
+     *
+     * @default [/^\/service\//]
+     */
+    ignoredRoutes: RegExp[];
+};
+/**
+ * A partial version of the {@link ForceHTTPSOptions}, to be used in the constructor and
+ * the middleware creator.
+ *
+ * @group Middlewares/ForceHTTPS
+ */
+type ForceHTTPSPartialOptions = Partial<ForceHTTPSOptions>;
+/**
+ * Creates a middleware that forces all the traffic to be through HTTPS.
+ *
+ * @group Middleware Classes
+ * @group Middlewares/ForceHTTPS
+ * @prettierignore
+ */
+declare class ForceHTTPS {
+    /**
+     * The customization options.
+     */
+    protected readonly _options: ForceHTTPSOptions;
+    /**
+     * @param options  The options to construct the class.
+     */
+    constructor(options?: ForceHTTPSPartialOptions);
+    /**
+     * Generates the middleware that redirects the traffic.
+     */
+    getMiddleware(): ExpressMiddleware;
+    /**
+     * The customization options.
+     */
+    get options(): Readonly<ForceHTTPSOptions>;
+}
+/**
+ * Creates the middleware that redirects the traffic to HTTPS.
+ *
+ * @group Middlewares
+ * @group Middlewares/ForceHTTPS
+ */
+declare const forceHTTPSMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: ForceHTTPSPartialOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType) => ExpressMiddleware | undefined, MiddlewareConnectFn>;
+
+export { ForceHTTPS, ForceHTTPSOptions, ForceHTTPSPartialOptions, forceHTTPSMiddleware };

package/dist/middlewares/common/forceHTTPS.js

@@ -0,0 +1,68 @@
+"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);
+  return value;
+};
+var forceHTTPS_exports = {};
+__export(forceHTTPS_exports, {
+  ForceHTTPS: () => ForceHTTPS,
+  forceHTTPSMiddleware: () => forceHTTPSMiddleware
+});
+module.exports = __toCommonJS(forceHTTPS_exports);
+var import_utils = require("../../utils");
+class ForceHTTPS {
+  constructor(options = {}) {
+    __publicField(this, "_options");
+    this._options = {
+      ignoredRoutes: [/^\/service\//],
+      ...options
+    };
+  }
+  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();
+      }
+    };
+  }
+  get options() {
+    return { ...this._options };
+  }
+}
+const forceHTTPSMiddleware = (0, import_utils.middlewareCreator)(
+  (options = {}) => (app) => {
+    const enabled = app.getConfig("forceHTTPS");
+    if (!enabled)
+      return void 0;
+    return new ForceHTTPS(options).getMiddleware();
+  }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ForceHTTPS,
+  forceHTTPSMiddleware
+});
+//# sourceMappingURL=forceHTTPS.js.map

package/dist/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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkC;AA6B3B,MAAM,WAAW;AAAA,EAQtB,YAAY,UAAoC,CAAC,GAAG;AAJpD,wBAAmB;AAKjB,SAAK,WAAW;AAAA,MACd,eAAe,CAAC,cAAc;AAAA,MAC9B,GAAG;AAAA,IACL;AAAA,EACF;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,OAAO,IAAI,KAAK;AAAA,MAC1C,OAAO;AACL,aAAK;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA,EAIA,IAAI,UAAuC;AACzC,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AACF;AAOO,MAAM,2BAAuB;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/middlewares/common/hsts.d.ts

@@ -0,0 +1,109 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../jimpex-7eaee271.js';
+import { ExpressMiddleware } from '../../types/express.js';
+import '@homer0/events-hub';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/simple-config';
+import '../../types/utils.js';
+import '@homer0/simple-logger';
+
+/**
+ * The options to customize the HSTS header value.
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security}
+ * @group Middlewares/HSTS
+ */
+type HSTSMiddlewareOptions = {
+    /**
+     * The time, in seconds, that the browser should remember that a site is only to be
+     * accessed using HTTPS.
+     *
+     * @default 31536000
+     */
+    maxAge: number;
+    /**
+     * Whether or not the rule should apply to all sub domains.
+     *
+     * @default true
+     */
+    includeSubDomains: boolean;
+    /**
+     * Whether or not to include on the major browsers'
+     * preload list. This directive is not part of the specification, for more information
+     * about it, you should check the MDN documentation for the header.
+     *
+     * @default false
+     */
+    preload: boolean;
+};
+/**
+ * A partial version of the {@link HSTSMiddlewareOptions}, to be used in the constructor
+ * and the middleware creator.
+ *
+ * @group Middlewares/HSTS
+ */
+type HSTSMiddlewarePartialOptions = Partial<HSTSMiddlewareOptions>;
+/**
+ * The options for the middleware creator that will create the middleware, or not,
+ * depending on the `enabled` option.
+ *
+ * @group Middlewares/HSTS
+ */
+type HSTSMiddlewareSettings = HSTSMiddlewarePartialOptions & {
+    /**
+     * If it's not `true`, it won't return the middleware.
+     */
+    enabled?: boolean;
+};
+/**
+ * Generates a middleware that includes the HSTS header on the responses.
+ *
+ * @see {@link https://tools.ietf.org/html/rfc6797}
+ * @group Middleware Classes
+ * @group Middlewares/HSTS
+ * @prettierignore
+ */
+declare class HSTS {
+    /**
+     * The customization options for the header.
+     */
+    protected readonly _options: HSTSMiddlewareOptions;
+    /**
+     * The value of the header that will be included in the responses.
+     */
+    protected readonly _header: string;
+    /**
+     * @param options  The options to construct the class.
+     */
+    constructor(options?: HSTSMiddlewarePartialOptions);
+    /**
+     * Generates the middleware that includes the HSTS header on the responses.
+     */
+    getMiddleware(): ExpressMiddleware;
+    /**
+     * The customization options.
+     */
+    get options(): Readonly<HSTSMiddlewareOptions>;
+    /**
+     * The value of the header that will be included in the responses.
+     */
+    get header(): string;
+    /**
+     * Creates the header value based on the customization options.
+     */
+    protected _buildHeader(): string;
+}
+/**
+ * Creates the middleware that includes the HSTS header on the responses.
+ *
+ * @group Middlewares
+ * @group Middlewares/HSTS
+ */
+declare const hstsMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: HSTSMiddlewareSettings) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType) => ExpressMiddleware | undefined, MiddlewareConnectFn>;
+
+export { HSTS, HSTSMiddlewareOptions, HSTSMiddlewarePartialOptions, HSTSMiddlewareSettings, hstsMiddleware };

package/dist/middlewares/common/hsts.js

@@ -0,0 +1,80 @@
+"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);
+  return value;
+};
+var hsts_exports = {};
+__export(hsts_exports, {
+  HSTS: () => HSTS,
+  hstsMiddleware: () => hstsMiddleware
+});
+module.exports = __toCommonJS(hsts_exports);
+var import_utils = require("../../utils");
+class HSTS {
+  constructor(options = {}) {
+    __publicField(this, "_options");
+    __publicField(this, "_header");
+    this._options = {
+      maxAge: 31536e3,
+      includeSubDomains: true,
+      preload: false,
+      ...options
+    };
+    this._header = this._buildHeader();
+  }
+  getMiddleware() {
+    return (_, res, next) => {
+      res.setHeader("Strict-Transport-Security", this._header);
+      next();
+    };
+  }
+  get options() {
+    return { ...this._options };
+  }
+  get header() {
+    return this._header;
+  }
+  _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 = (0, import_utils.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();
+  }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HSTS,
+  hstsMiddleware
+});
+//# sourceMappingURL=hsts.js.map

package/dist/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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkC;AA0D3B,MAAM,KAAK;AAAA,EAYhB,YAAY,UAAwC,CAAC,GAAG;AARxD,wBAAmB;AAInB,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,EAIA,gBAAmC;AACjC,WAAO,CAAC,GAAG,KAAK,SAAS;AACvB,UAAI,UAAU,6BAA6B,KAAK,OAAO;AACvD,WAAK;AAAA,IACP;AAAA,EACF;AAAA,EAIA,IAAI,UAA2C;AAC7C,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA,EAIA,IAAI,SAAiB;AACnB,WAAO,KAAK;AAAA,EACd;AAAA,EAIU,eAAuB;AAC/B,UAAM,EAAE,QAAQ,mBAAmB,QAAQ,IAAI,KAAK;AACpD,UAAM,aAAa,CAAC,WAAW,QAAQ;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,qBAAiB;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/middlewares/common/index.d.ts

@@ -0,0 +1,21 @@
+export { ErrorHandler, ErrorHandlerConstructorOptions, ErrorHandlerOptions, ErrorHandlerPartialOptions, ErrorHandlerResponseOptions, errorHandlerMiddleware } from './errorHandler.js';
+export { ForceHTTPS, ForceHTTPSOptions, ForceHTTPSPartialOptions, forceHTTPSMiddleware } from './forceHTTPS.js';
+export { HSTS, HSTSMiddlewareOptions, HSTSMiddlewarePartialOptions, HSTSMiddlewareSettings, hstsMiddleware } from './hsts.js';
+import '@homer0/jimple';
+import '../../utils/fns/statuses.js';
+import 'statuses';
+import '../../jimpex-7eaee271.js';
+import '@homer0/events-hub';
+import '../../types/express.js';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/simple-config';
+import '../../types/utils.js';
+import '@homer0/simple-logger';
+import '../../services/common/httpError.js';
+import '../../services/common/appError.js';
+import '../../services/http/responsesBuilder.js';

package/dist/middlewares/common/index.js

@@ -0,0 +1,21 @@
+"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 common_exports = {};
+module.exports = __toCommonJS(common_exports);
+__reExport(common_exports, require("./errorHandler"), module.exports);
+__reExport(common_exports, require("./forceHTTPS"), module.exports);
+__reExport(common_exports, require("./hsts"), module.exports);
+//# sourceMappingURL=index.js.map

package/dist/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;AAAA;AAAA,2BAAc,2BAAd;AACA,2BAAc,yBADd;AAEA,2BAAc,mBAFd;","names":[]}