jimpex 8.0.0 → 10.0.0

package/dist/{jimpex-7eaee271.d.ts → index-C6I3NCC-.d.ts}

@@ -1,12 +1,16 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { ProviderRegisterFn as ProviderRegisterFn$1, GenericCurriedFn, Jimple } from '@homer0/jimple';
-import { EventsHub } from '@homer0/events-hub';
 import { ExpressMiddlewareLike } from './types/express.js';
-import { Router, Express } from 'express';
 import { JimpexServer, JimpexServerInstance, JimpexHTTPSCredentials } from './types/http.js';
-import { SimpleConfig } from '@homer0/simple-config';
 import { NoStringIndex, DeepPartial, DeepReadonly } from './types/utils.js';
+import '@homer0/path-utils';
 import { SimpleLogger } from '@homer0/simple-logger';
+import { SimpleConfig } from '@homer0/simple-config';
+import { EventsHub } from '@homer0/events-hub';
+import { Router, Express } from 'express';
+import 'node-fetch';
+import 'https';
+import 'http';
+import * as _homer0_jimple from '@homer0/jimple';
+import { ProviderRegisterFn as ProviderRegisterFn$1, GenericCurriedFn, Jimple } from '@homer0/jimple';
 
 /**
  * The base payload the events emitted by the application send.
@@ -1218,6 +1222,11 @@ declare class Jimpex extends Jimple {
      * This method is called just before starting the application.
      */
     protected _setupConfig(): Promise<void>;
+    /**
+     * Loads the ESM modules that are needed by Jimpex. This is called just before the starting
+     * the application so they'll be available for all the services.
+     */
+    protected _loadESMModules(): Promise<void>;
     /**
      * Processes the resources from the mount queue (added with {@link Jimpex.mount} and
      * {@link Jimpex.use}), and adds them to the Express application.
@@ -1275,4 +1284,4 @@ declare class Jimpex extends Jimple {
  */
 declare const jimpex: (options?: DeepPartial<JimpexOptions> | undefined, config?: unknown) => Jimpex;
 
-export { MiddlewareProvider as $, Providers as A, ProviderLike as B, ControllerConnectFn as C, controller as D, EventPayload as E, ControllerCreatorFn as F, controllerCreator as G, Controller as H, ControllerCreator as I, Jimpex as J, ControllerProviderRegisterFn as K, controllerProvider as L, ControllerProviderCreatorFn as M, controllerProviderCreator as N, ControllerProvider as O, ProviderRegisterFn as P, ControllerProviderCreator as Q, MiddlewareConnectFn as R, middleware as S, MiddlewareCreatorFn as T, middlewareCreator as U, Middleware as V, MiddlewareCreator as W, MiddlewareProviderRegisterFn as X, middlewareProvider as Y, MiddlewareProviderCreatorFn as Z, middlewareProviderCreator as _, JimpexEvents as a, MiddlewareProviderCreator as a0, MiddlewareLike as a1, ControllerLike as a2, JimpexEventName as b, JimpexEventPayload as c, JimpexReducerEventTargets as d, JimpexReducerEventPayloads as e, JimpexReducerEventName as f, JimpexReducerEventTarget as g, JimpexReducerEventPayload as h, JimpexEventNameLike as i, jimpex as j, JimpexEventListener as k, Events as l, JimpexConfigOptions as m, JimpexStaticsOptions as n, JimpexExpressOptions as o, JimpexPathOptions as p, JimpexServicesOptions as q, JimpexHealthStatus as r, JimpexHealthCheckFn as s, JimpexOptions as t, JimpexStartCallback as u, provider as v, providerCreator as w, providers as x, Provider as y, ProviderCreator as z };
+export { type MiddlewareProvider as $, type Providers as A, type ProviderLike as B, type ControllerConnectFn as C, controller as D, type EventPayload as E, type ControllerCreatorFn as F, controllerCreator as G, type Controller as H, type ControllerCreator as I, Jimpex as J, type ControllerProviderRegisterFn as K, controllerProvider as L, type ControllerProviderCreatorFn as M, controllerProviderCreator as N, type ControllerProvider as O, type ProviderRegisterFn as P, type ControllerProviderCreator as Q, type MiddlewareConnectFn as R, middleware as S, type MiddlewareCreatorFn as T, middlewareCreator as U, type Middleware as V, type MiddlewareCreator as W, type MiddlewareProviderRegisterFn as X, middlewareProvider as Y, type MiddlewareProviderCreatorFn as Z, middlewareProviderCreator as _, type JimpexEvents as a, type MiddlewareProviderCreator as a0, type MiddlewareLike as a1, type ControllerLike as a2, type JimpexEventName as b, type JimpexEventPayload as c, type JimpexReducerEventTargets as d, type JimpexReducerEventPayloads as e, type JimpexReducerEventName as f, type JimpexReducerEventTarget as g, type JimpexReducerEventPayload as h, type JimpexEventNameLike as i, jimpex as j, type JimpexEventListener as k, type Events as l, type JimpexConfigOptions as m, type JimpexStaticsOptions as n, type JimpexExpressOptions as o, type JimpexPathOptions as p, type JimpexServicesOptions as q, type JimpexHealthStatus as r, type JimpexHealthCheckFn as s, type JimpexOptions as t, type JimpexStartCallback as u, provider as v, providerCreator as w, providers as x, type Provider as y, type ProviderCreator as z };

package/dist/index.d.mts

@@ -0,0 +1,47 @@
+export { H as Controller, C as ControllerConnectFn, I as ControllerCreator, F as ControllerCreatorFn, a2 as ControllerLike, O as ControllerProvider, Q as ControllerProviderCreator, M as ControllerProviderCreatorFn, K as ControllerProviderRegisterFn, E as EventPayload, l as Events, J as Jimpex, m as JimpexConfigOptions, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions, V as Middleware, R as MiddlewareConnectFn, W as MiddlewareCreator, T as MiddlewareCreatorFn, a1 as MiddlewareLike, $ as MiddlewareProvider, a0 as MiddlewareProviderCreator, Z as MiddlewareProviderCreatorFn, X as MiddlewareProviderRegisterFn, y as Provider, z as ProviderCreator, B as ProviderLike, P as ProviderRegisterFn, A as Providers, D as controller, G as controllerCreator, L as controllerProvider, N as controllerProviderCreator, j as jimpex, S as middleware, U as middlewareCreator, Y as middlewareProvider, _ as middlewareProviderCreator, v as provider, w as providerCreator, x as providers } from './index-Bwf7JHu9.mjs';
+export { AsyncExpressMiddleware, ExpressErrorHandler, ExpressMiddleware, ExpressMiddlewareLike, RouterMethod } from './types/express.mjs';
+export { JimpexHTTP2Options, JimpexHTTPSCredentials, JimpexHTTPSOptions, JimpexServer, JimpexServerInstance, NodeFetch } from './types/http.mjs';
+export { DeepPartial, DeepReadonly, Dict, NoStringIndex } from './types/utils.mjs';
+export { PathUtils } from '@homer0/path-utils';
+export { SimpleLogger as Logger } from '@homer0/simple-logger';
+export { SimpleConfig as Config } from '@homer0/simple-config';
+export { EventsHub } from '@homer0/events-hub';
+export { ConfigController, ConfigControllerOptions, configController } from './controllers/common/config.mjs';
+export { GetHealthStatus, HealthController, HealthControllerOptions, healthController } from './controllers/common/health.mjs';
+export { AddStaticRouteOptions, StaticsController, StaticsControllerConstructorOptions, StaticsControllerCreatorOptions, StaticsControllerFile, StaticsControllerGetMiddlewaresFn, StaticsControllerOptions, StaticsControllerPathsOptions, staticsController } from './controllers/common/statics.mjs';
+export { AddGatewayRouteOptions, GatewayConfig, GatewayConfigEndpointDefinition, GatewayConfigEndpointProps, GatewayConfigEndpoints, GatewayController, GatewayControllerAPIConfig, GatewayControllerAPIConfigOptions, GatewayControllerConstructorOptions, GatewayControllerCreatorOptions, GatewayControllerEndpointInfo, GatewayControllerExtraOptions, GatewayControllerGetMiddlewaresFn, GatewayControllerHeaderOptions, GatewayControllerHelperOptions, GatewayControllerOptions, GatewayControllerRequest, GatewayControllerRoute, GatewayControllerRouteMethod, GatewayHelperService, GatewayHelperServiceBaseFnOptions, GatewayHelperServiceErrorHandler, GatewayHelperServiceErrorHandlerOptions, GatewayHelperServiceRequestReducer, GatewayHelperServiceRequestReducerOptions, GatewayHelperServiceResponseHandler, GatewayHelperServiceResponseReducer, GatewayHelperServiceResponseReducerOptions, GatewayHelperServiceStreamVerification, gatewayController } from './controllers/utils/gateway.mjs';
+export { ErrorHandler, ErrorHandlerConstructorOptions, ErrorHandlerOptions, ErrorHandlerPartialOptions, ErrorHandlerResponseOptions, errorHandlerMiddleware } from './middlewares/common/errorHandler.mjs';
+export { ForceHTTPS, ForceHTTPSOptions, ForceHTTPSPartialOptions, forceHTTPSMiddleware } from './middlewares/common/forceHTTPS.mjs';
+export { HSTS, HSTSMiddlewareOptions, HSTSMiddlewarePartialOptions, HSTSMiddlewareSettings, hstsMiddleware } from './middlewares/common/hsts.mjs';
+export { FastHTML, FastHTMLConstructorOptions, FastHTMLMiddlewareOptions, FastHTMLOptions, fastHTMLMiddleware } from './middlewares/html/fastHTML.mjs';
+export { ShowHTML, ShowHTMLConstructorOptions, ShowHTMLMiddlewareOptions, ShowHTMLOptions, showHTMLMiddleware } from './middlewares/html/showHTML.mjs';
+export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware } from './middlewares/utils/versionValidator.mjs';
+export { commonServicesProvider } from './services/common/index.mjs';
+export { frontendServicesProvider } from './services/frontend/index.mjs';
+export { htmlServicesProvider } from './services/html/index.mjs';
+export { httpServicesProvider } from './services/http/index.mjs';
+export { utilsServicesProvider } from './services/utils/index.mjs';
+export { notUndefined } from './utils/fns/others.mjs';
+export { createRouteExpression, removeLeadingSlash, removeSlashes, removeTrailingSlash } from './utils/fns/routes.mjs';
+export { Statuses } from './utils/fns/statuses.mjs';
+export { escapeForRegExp } from './utils/fns/text.mjs';
+export { Express, NextFunction, Request, Response, Router } from 'express';
+export { Response as HTTPResponse } from 'node-fetch';
+export { Server as HTTPSServer } from 'https';
+export { Server as HTTPServer } from 'http';
+export { AppError, AppErrorClass, AppErrorContext, CreateAppErrorFn, appErrorProvider, createAppError } from './services/common/appError.mjs';
+export { CreateHTTPErrorFn, HTTPError, HTTPErrorClass, createHTTPError, httpErrorProvider } from './services/common/httpError.mjs';
+export { SendFile, SendFileGeneratorOptions, SendFileOptions, sendFile, sendFileProvider } from './services/common/sendFile.mjs';
+export { FrontendFs, FrontendFsOptions, frontendFsProvider } from './services/frontend/frontendFs.mjs';
+export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorProviderOptions, HTMLGeneratorValuesService, htmlGeneratorProvider } from './services/html/htmlGenerator.mjs';
+export { ErrorResponse } from '@homer0/api-utils';
+export { APIClient, APIClientConfig, APIClientConstructorOptions, APIClientProviderOptions, APIClientSettings, EndpointsType, apiClientProvider } from './services/http/apiClient.mjs';
+export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFetchBody, HTTPFetchOptions, HTTPOptions, httpProvider } from './services/http/http.mjs';
+export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider } from './services/http/responsesBuilder.mjs';
+export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, EnsureBearerTokenProviderOptions, ensureBearerTokenProvider } from './services/utils/ensureBearerToken.mjs';
+export { default as statuses } from 'statuses';
+import '@homer0/jimple';
+import 'spdy';
+import 'mime';
+import 'fs/promises';
+import '@homer0/deferred';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-export { H as Controller, C as ControllerConnectFn, I as ControllerCreator, F as ControllerCreatorFn, a2 as ControllerLike, O as ControllerProvider, Q as ControllerProviderCreator, M as ControllerProviderCreatorFn, K as ControllerProviderRegisterFn, E as EventPayload, l as Events, J as Jimpex, m as JimpexConfigOptions, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions, V as Middleware, R as MiddlewareConnectFn, W as MiddlewareCreator, T as MiddlewareCreatorFn, a1 as MiddlewareLike, $ as MiddlewareProvider, a0 as MiddlewareProviderCreator, Z as MiddlewareProviderCreatorFn, X as MiddlewareProviderRegisterFn, y as Provider, z as ProviderCreator, B as ProviderLike, P as ProviderRegisterFn, A as Providers, D as controller, G as controllerCreator, L as controllerProvider, N as controllerProviderCreator, j as jimpex, S as middleware, U as middlewareCreator, Y as middlewareProvider, _ as middlewareProviderCreator, v as provider, w as providerCreator, x as providers } from './jimpex-7eaee271.js';
+export { H as Controller, C as ControllerConnectFn, I as ControllerCreator, F as ControllerCreatorFn, a2 as ControllerLike, O as ControllerProvider, Q as ControllerProviderCreator, M as ControllerProviderCreatorFn, K as ControllerProviderRegisterFn, E as EventPayload, l as Events, J as Jimpex, m as JimpexConfigOptions, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions, V as Middleware, R as MiddlewareConnectFn, W as MiddlewareCreator, T as MiddlewareCreatorFn, a1 as MiddlewareLike, $ as MiddlewareProvider, a0 as MiddlewareProviderCreator, Z as MiddlewareProviderCreatorFn, X as MiddlewareProviderRegisterFn, y as Provider, z as ProviderCreator, B as ProviderLike, P as ProviderRegisterFn, A as Providers, D as controller, G as controllerCreator, L as controllerProvider, N as controllerProviderCreator, j as jimpex, S as middleware, U as middlewareCreator, Y as middlewareProvider, _ as middlewareProviderCreator, v as provider, w as providerCreator, x as providers } from './index-C6I3NCC-.js';
 export { AsyncExpressMiddleware, ExpressErrorHandler, ExpressMiddleware, ExpressMiddlewareLike, RouterMethod } from './types/express.js';
-export { JimpexHTTP2Options, JimpexHTTPSCredentials, JimpexHTTPSOptions, JimpexServer, JimpexServerInstance } from './types/http.js';
+export { JimpexHTTP2Options, JimpexHTTPSCredentials, JimpexHTTPSOptions, JimpexServer, JimpexServerInstance, NodeFetch } from './types/http.js';
 export { DeepPartial, DeepReadonly, Dict, NoStringIndex } from './types/utils.js';
 export { PathUtils } from '@homer0/path-utils';
 export { SimpleLogger as Logger } from '@homer0/simple-logger';
@@ -42,5 +42,6 @@ export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErr
 export { default as statuses } from 'statuses';
 import '@homer0/jimple';
 import 'spdy';
+import 'mime';
 import 'fs/promises';
 import '@homer0/deferred';

package/dist/index.js

@@ -21,4 +21,13 @@ __reExport(src_exports, require("./controllers"), module.exports);
 __reExport(src_exports, require("./middlewares"), module.exports);
 __reExport(src_exports, require("./services"), module.exports);
 __reExport(src_exports, require("./utils"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./app"),
+  ...require("./types"),
+  ...require("./controllers"),
+  ...require("./middlewares"),
+  ...require("./services"),
+  ...require("./utils")
+});
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,132 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { Statuses } from '../../utils/fns/statuses.mjs';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../index-Bwf7JHu9.mjs';
+import { ExpressErrorHandler } from '../../types/express.mjs';
+import { SimpleLogger } from '@homer0/simple-logger';
+import { DeepPartial } from '../../types/utils.mjs';
+import { HTTPErrorClass } from '../../services/common/httpError.mjs';
+import { ResponsesBuilder } from '../../services/http/responsesBuilder.mjs';
+import 'statuses';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import 'express';
+import '@homer0/path-utils';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../../services/common/appError.mjs';
+
+/**
+ * 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, type ErrorHandlerConstructorOptions, type ErrorHandlerOptions, type ErrorHandlerPartialOptions, type ErrorHandlerResponseOptions, errorHandlerMiddleware };

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

@@ -1,20 +1,21 @@
 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 { J as Jimpex, R as MiddlewareConnectFn } from '../../index-C6I3NCC-.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 'express';
+import '@homer0/path-utils';
 import '@homer0/simple-config';
+import '@homer0/events-hub';
 import '../../services/common/appError.js';
 
 /**
@@ -128,4 +129,4 @@ declare class 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 };
+export { ErrorHandler, type ErrorHandlerConstructorOptions, type ErrorHandlerOptions, type ErrorHandlerPartialOptions, type ErrorHandlerResponseOptions, errorHandlerMiddleware };

package/dist/middlewares/common/errorHandler.js

@@ -31,14 +31,32 @@ var import_deep_assign = require("@homer0/deep-assign");
 var import_utils = require("../../utils");
 var import_services = require("../../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;
@@ -55,6 +73,9 @@ class ErrorHandler {
       options
     );
   }
+  /**
+   * Generates the middleware that handles the errors.
+   */
   getMiddleware() {
     return (err, _, res, next) => {
       if (!err) {
@@ -92,6 +113,9 @@ class ErrorHandler {
       });
     };
   }
+  /**
+   * The handler customization options.
+   */
   get options() {
     return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
   }

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

@@ -1 +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":[]}
+{"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;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,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;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,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.mts

@@ -0,0 +1,69 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../index-Bwf7JHu9.mjs';
+import { ExpressMiddleware } from '../../types/express.mjs';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import 'express';
+import '../../types/utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+
+/**
+ * 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, type ForceHTTPSOptions, type ForceHTTPSPartialOptions, forceHTTPSMiddleware };

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

@@ -1,16 +1,17 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex, R as MiddlewareConnectFn } from '../../jimpex-7eaee271.js';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../index-C6I3NCC-.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 'express';
 import '../../types/utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 
 /**
  * The customization options for the middleware.
@@ -65,4 +66,4 @@ declare class 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 };
+export { ForceHTTPS, type ForceHTTPSOptions, type ForceHTTPSPartialOptions, forceHTTPSMiddleware };

package/dist/middlewares/common/forceHTTPS.js

@@ -29,13 +29,22 @@ __export(forceHTTPS_exports, {
 module.exports = __toCommonJS(forceHTTPS_exports);
 var import_utils = require("../../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(
@@ -48,6 +57,9 @@ class ForceHTTPS {
       }
     };
   }
+  /**
+   * The customization options.
+   */
   get options() {
     return { ...this._options };
   }

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

@@ -1 +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":[]}
+{"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;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,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.mts

@@ -0,0 +1,110 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../index-Bwf7JHu9.mjs';
+import { ExpressMiddleware } from '../../types/express.mjs';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import 'express';
+import '../../types/utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+
+/**
+ * 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, type HSTSMiddlewareOptions, type HSTSMiddlewarePartialOptions, type HSTSMiddlewareSettings, hstsMiddleware };