jimpex 8.0.0 → 10.0.0

package/dist/middlewares/html/showHTML.d.mts

@@ -0,0 +1,127 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../index-Bwf7JHu9.mjs';
+import { AsyncExpressMiddleware } from '../../types/express.mjs';
+import { SendFile } from '../../services/common/sendFile.mjs';
+import { HTMLGenerator } from '../../services/html/htmlGenerator.mjs';
+import { Response, NextFunction } from 'express';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '../../types/utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../../services/frontend/frontendFs.mjs';
+import 'fs/promises';
+import '@homer0/deferred';
+
+/**
+ * The options to customize the behavior of the middleware.
+ *
+ * @group Middlewares/ShowHTML
+ */
+type ShowHTMLOptions = {
+    /**
+     * The name of the file the middleware will serve. If the {@link HTMLGenerator} service
+     * is available, it will be overriden by the service.
+     *
+     * @default 'index.html'
+     */
+    file: string;
+};
+/**
+ * The options to construct a {@link ShowHTML}.
+ *
+ * @group Middlewares/ShowHTML
+ */
+type ShowHTMLConstructorOptions = Partial<ShowHTMLOptions> & {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        sendFile: SendFile;
+        /**
+         * A function to get a possible {@link HTMLGenerator}. This is injected as a "getter"
+         * to not interrupt the DIC "lifecycle": middlewares are initialized right when the
+         * app starts, and injecting a reference would force the service to be initialized
+         * too, even if a request is not being made.
+         */
+        getHTMLGenerator?: () => HTMLGenerator | undefined;
+    };
+};
+/**
+ * The options for the middleware creator that will mount an instance of {@link ShowHTML}.
+ *
+ * @group Middlewares/ShowHTML
+ */
+type ShowHTMLMiddlewareOptions = Partial<ShowHTMLOptions> & {
+    /**
+     * The name of an {@link HTMLGenerator} service already available in the application.
+     *
+     * @default 'htmlGenerator'
+     */
+    htmlGeneratorServiceName?: string;
+};
+/**
+ * A very simple middleware service to send an HTML on a server response. The special
+ * _'feature'_ of this service is that it can be hooked up to an {@link HTMLGenerator}
+ * service and it will automatically server the file generated by it.
+ *
+ * @group Middleware Classes
+ * @group Middlewares/ShowHTML
+ * @prettierignore
+ */
+declare class ShowHTML {
+    /**
+     * The service that serves a file.
+     */
+    protected readonly _sendFile: 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.
+     */
+    protected readonly _getHTMLGenerator: () => HTMLGenerator | undefined;
+    /**
+     * The customization options for the middleware.
+     */
+    protected _options: ShowHTMLOptions;
+    /**
+     * 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.
+     */
+    protected _fileReady: boolean;
+    /**
+     * @param options  The options to construct the class.
+     */
+    constructor({ inject, ...options }: ShowHTMLConstructorOptions);
+    /**
+     * Generates the middleware that serves the HTML file.
+     */
+    getMiddleware(): AsyncExpressMiddleware;
+    /**
+     * The customization options.
+     */
+    get options(): Readonly<ShowHTMLOptions>;
+    /**
+     * 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.
+     */
+    protected _sendResponse(res: Response, next: NextFunction): void;
+}
+/**
+ * Creates the middleware that serves an HTML file in the response.
+ *
+ * @group Middlewares
+ * @group Middlewares/ShowHTML
+ */
+declare const showHTMLMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: ShowHTMLMiddlewareOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType) => AsyncExpressMiddleware, MiddlewareConnectFn>;
+
+export { ShowHTML, type ShowHTMLConstructorOptions, type ShowHTMLMiddlewareOptions, type ShowHTMLOptions, showHTMLMiddleware };

package/dist/middlewares/html/showHTML.d.ts

@@ -1,19 +1,19 @@
 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 { AsyncExpressMiddleware } from '../../types/express.js';
 import { SendFile } from '../../services/common/sendFile.js';
 import { HTMLGenerator } from '../../services/html/htmlGenerator.js';
 import { Response, NextFunction } from 'express';
-import '@homer0/events-hub';
 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 '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import '../../services/frontend/frontendFs.js';
 import 'fs/promises';
 import '@homer0/deferred';
@@ -124,4 +124,4 @@ declare class ShowHTML {
  */
 declare const showHTMLMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: ShowHTMLMiddlewareOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType) => AsyncExpressMiddleware, MiddlewareConnectFn>;
 
-export { ShowHTML, ShowHTMLConstructorOptions, ShowHTMLMiddlewareOptions, ShowHTMLOptions, showHTMLMiddleware };
+export { ShowHTML, type ShowHTMLConstructorOptions, type ShowHTMLMiddlewareOptions, type ShowHTMLOptions, showHTMLMiddleware };

package/dist/middlewares/html/showHTML.js

@@ -29,10 +29,30 @@ __export(showHTML_exports, {
 module.exports = __toCommonJS(showHTML_exports);
 var import_utils = require("../../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);
@@ -41,6 +61,9 @@ class ShowHTML {
       ...options
     };
   }
+  /**
+   * Generates the middleware that serves the HTML file.
+   */
   getMiddleware() {
     return async (_, res, next) => {
       if (this._fileReady) {
@@ -63,9 +86,18 @@ class ShowHTML {
       }
     };
   }
+  /**
+   * 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({

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

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

package/dist/middlewares/index.d.mts

@@ -0,0 +1,30 @@
+export { ErrorHandler, ErrorHandlerConstructorOptions, ErrorHandlerOptions, ErrorHandlerPartialOptions, ErrorHandlerResponseOptions, errorHandlerMiddleware } from './common/errorHandler.mjs';
+export { ForceHTTPS, ForceHTTPSOptions, ForceHTTPSPartialOptions, forceHTTPSMiddleware } from './common/forceHTTPS.mjs';
+export { HSTS, HSTSMiddlewareOptions, HSTSMiddlewarePartialOptions, HSTSMiddlewareSettings, hstsMiddleware } from './common/hsts.mjs';
+export { FastHTML, FastHTMLConstructorOptions, FastHTMLMiddlewareOptions, FastHTMLOptions, fastHTMLMiddleware } from './html/fastHTML.mjs';
+export { ShowHTML, ShowHTMLConstructorOptions, ShowHTMLMiddlewareOptions, ShowHTMLOptions, showHTMLMiddleware } from './html/showHTML.mjs';
+export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware } from './utils/versionValidator.mjs';
+import '@homer0/jimple';
+import '../utils/fns/statuses.mjs';
+import 'statuses';
+import '../index-Bwf7JHu9.mjs';
+import '../types/express.mjs';
+import 'express';
+import '../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '../types/utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../services/common/httpError.mjs';
+import '../services/common/appError.mjs';
+import '../services/http/responsesBuilder.mjs';
+import '../services/common/sendFile.mjs';
+import '../services/html/htmlGenerator.mjs';
+import '../services/frontend/frontendFs.mjs';
+import 'fs/promises';
+import '@homer0/deferred';

package/dist/middlewares/index.d.ts

@@ -7,8 +7,7 @@ export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorL
 import '@homer0/jimple';
 import '../utils/fns/statuses.js';
 import 'statuses';
-import '../jimpex-7eaee271.js';
-import '@homer0/events-hub';
+import '../index-C6I3NCC-.js';
 import '../types/express.js';
 import 'express';
 import '../types/http.js';
@@ -16,14 +15,15 @@ import 'https';
 import 'http';
 import 'spdy';
 import 'node-fetch';
-import '@homer0/simple-config';
 import '../types/utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import '../services/common/httpError.js';
 import '../services/common/appError.js';
 import '../services/http/responsesBuilder.js';
 import '../services/common/sendFile.js';
-import '@homer0/path-utils';
 import '../services/html/htmlGenerator.js';
 import '../services/frontend/frontendFs.js';
 import 'fs/promises';

package/dist/middlewares/index.js

@@ -18,4 +18,10 @@ module.exports = __toCommonJS(middlewares_exports);
 __reExport(middlewares_exports, require("./common"), module.exports);
 __reExport(middlewares_exports, require("./html"), module.exports);
 __reExport(middlewares_exports, require("./utils"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./common"),
+  ...require("./html"),
+  ...require("./utils")
+});
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,20 @@
+export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware } from './versionValidator.mjs';
+import '@homer0/jimple';
+import '../../utils/fns/statuses.mjs';
+import 'statuses';
+import '../../index-Bwf7JHu9.mjs';
+import '../../types/express.mjs';
+import 'express';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '../../types/utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../../services/common/httpError.mjs';
+import '../../services/common/appError.mjs';
+import '../../services/http/responsesBuilder.mjs';

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

@@ -2,8 +2,7 @@ export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorL
 import '@homer0/jimple';
 import '../../utils/fns/statuses.js';
 import 'statuses';
-import '../../jimpex-7eaee271.js';
-import '@homer0/events-hub';
+import '../../index-C6I3NCC-.js';
 import '../../types/express.js';
 import 'express';
 import '../../types/http.js';
@@ -11,9 +10,11 @@ import 'https';
 import 'http';
 import 'spdy';
 import 'node-fetch';
-import '@homer0/simple-config';
 import '../../types/utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import '../../services/common/httpError.js';
 import '../../services/common/appError.js';
 import '../../services/http/responsesBuilder.js';

package/dist/middlewares/utils/index.js

@@ -16,4 +16,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var utils_exports = {};
 module.exports = __toCommonJS(utils_exports);
 __reExport(utils_exports, require("./versionValidator"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./versionValidator")
+});
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,215 @@
+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 { ExpressMiddleware } from '../../types/express.mjs';
+import { DeepPartial } from '../../types/utils.mjs';
+import { HTTPErrorClass } from '../../services/common/httpError.mjs';
+import { ResponsesBuilder } from '../../services/http/responsesBuilder.mjs';
+import { Request } from 'express';
+import 'statuses';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../../services/common/appError.mjs';
+
+/**
+ * The options for how the middleware should behave if the requested version is `latest`.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorLatestOptions = {
+    /**
+     * Whether or not the middleware should validate the _"latest version"_.
+     *
+     * @default true
+     */
+    allow: boolean;
+    /**
+     * The name of the _"latest version"_. Basically, `req.params.version` must match with
+     * this property in order to be consider "latest".
+     *
+     * @default 'latest'
+     */
+    name: string;
+};
+/**
+ * The options for how to detect if the request comes from a popup and how to compose the
+ * post message the middleware will use to respond.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorPopupOptions = {
+    /**
+     * The name of the query string variable the middleware will check in order to indentify
+     * whether the request comes from a popup or not. The variable must have `'true'` as its
+     * value.
+     *
+     * @default 'popup'
+     */
+    variable: string;
+    /**
+     * The title of the page that will be generated to respond in case the versions don't
+     * match.
+     *
+     * @default 'Conflict'
+     */
+    title: string;
+    /**
+     * The contents of the post message the generated page will send if the versions don't
+     * match.
+     *
+     * @default 'version:conflict'
+     */
+    message: string;
+};
+/**
+ * The options used to customize a {@link VersionValidator} instance.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorOptions = {
+    /**
+     * The version used to validate the requests.
+     */
+    version: string;
+    /**
+     * The options for how the middleware should behave if the requested version is
+     * `latest`.
+     */
+    latest: VersionValidatorLatestOptions;
+    /**
+     * The options for how to detect if the request comes from a popup and how to compose
+     * the post message the middleware will use to respond.
+     */
+    popup: VersionValidatorPopupOptions;
+    /**
+     * The error message to show when the version is invalid.
+     *
+     * @default "The application version doesn't match"
+     * @prettierignore
+     */
+    error: string;
+};
+/**
+ * A partial version of the {@link VersionValidatorOptions}, to be used in the constructor
+ * and the middleware creator. The reason it omits `version` it's because for the
+ * constructor it's required, but for the middleware creator it's not.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorPartialOptions = DeepPartial<Omit<VersionValidatorOptions, 'version'>>;
+/**
+ * The options to construct a {@link VersionValidator}.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorConstructorOptions = VersionValidatorPartialOptions & {
+    /**
+     * The version used to validate the requests.
+     */
+    version: string;
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        HTTPError: HTTPErrorClass;
+        responsesBuilder: ResponsesBuilder;
+        statuses: Statuses;
+    };
+};
+/**
+ * The options for the middleware creator that will mount an instance of
+ * {@link VersionValidator}.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorMiddlewareOptions = VersionValidatorPartialOptions & {
+    /**
+     * The version used to validate the requests. This is optional in here because if it's
+     * not specified, it will be obtained from the configuration service.
+     */
+    version?: string;
+};
+/**
+ * This is the handler for the middleware/controller that validates the application
+ * version.
+ * This is useful in cases where you want to restrict the access to specific versions; for
+ * example: you have a frontend which needs to be aligned with the "current" version of
+ * the application, since the frontend won't realize a new version was released, the
+ * validator can be used to let the frontend know.
+ * Also, it can be configured to handle requests from popups, in which case, instead of
+ * generating an error message, it will send a post message.
+ *
+ * @group Middleware Classes
+ * @group Middlewares/VersionValidator
+ * @prettierignore
+ */
+declare class VersionValidator {
+    /**
+     * To generate the errors in case the validation fails.
+     */
+    protected readonly _HTTPError: HTTPErrorClass;
+    /**
+     * To generate responses for popups.
+     */
+    protected readonly _responsesBuilder: ResponsesBuilder;
+    /**
+     * The uility service to get HTTP status codes.
+     */
+    protected readonly _statuses: Statuses;
+    /**
+     * The customization options.
+     */
+    protected readonly _options: VersionValidatorOptions;
+    /**
+     * @param options  The options to construct the class.
+     * @throws If no `version` is specified in the options.
+     */
+    constructor({ inject, version, ...options }: VersionValidatorConstructorOptions);
+    /**
+     * Generates the middleware that validates the version.
+     */
+    getMiddleware(): ExpressMiddleware;
+    /**
+     * The customization options.
+     */
+    get options(): Readonly<VersionValidatorOptions>;
+    /**
+     * Helper method that checks if the incoming request is from a popup. It will look for
+     * the query string variable defined in the constructor options.
+     *
+     * @param req  The request object sent by the application.
+     */
+    protected _isPopup(req: Request): boolean;
+    /**
+     * Helper method that checks if the "latest version" is enabled and if the given version
+     * is "the latest" (comparing it with the option name).
+     *
+     * @param version  The version received in the request.
+     */
+    protected _isTheAllowedLatest(version: string): boolean;
+}
+/**
+ * A middleware that will validate a `version` request parameter against the application
+ * version, and generate an error if they don't match.
+ * This is a "middleware/controller" because the wrappers for both are the same, the
+ * difference is that, for controllers, Jimpex sends a second parameter with the route
+ * where they are mounted.
+ * By validating the route parameter, the function can know whether the implementation is
+ * going to use the middleware by itself or as a route middleware.
+ * If used as middleware, it will just return the result of
+ * {@link VersionValidator.getMiddleware}; but if used as controller, it will mount it on
+ * `[route]/:version/*`.
+ *
+ * @group Middlewares
+ * @group Middlewares/VersionValidator
+ */
+declare const versionValidatorMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: VersionValidatorMiddlewareOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType, route: string | undefined) => ExpressMiddleware, MiddlewareConnectFn>;
+
+export { VersionValidator, type VersionValidatorConstructorOptions, type VersionValidatorLatestOptions, type VersionValidatorMiddlewareOptions, type VersionValidatorOptions, type VersionValidatorPartialOptions, type VersionValidatorPopupOptions, versionValidatorMiddleware };

package/dist/middlewares/utils/versionValidator.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 { ExpressMiddleware } from '../../types/express.js';
 import { DeepPartial } from '../../types/utils.js';
 import { HTTPErrorClass } from '../../services/common/httpError.js';
 import { ResponsesBuilder } from '../../services/http/responsesBuilder.js';
 import { Request } from 'express';
 import 'statuses';
-import '@homer0/events-hub';
 import '../../types/http.js';
 import 'https';
 import 'http';
 import 'spdy';
 import 'node-fetch';
-import '@homer0/simple-config';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import '../../services/common/appError.js';
 
 /**
@@ -211,4 +212,4 @@ declare class VersionValidator {
  */
 declare const versionValidatorMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: VersionValidatorMiddlewareOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType, route: string | undefined) => ExpressMiddleware, MiddlewareConnectFn>;
 
-export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware };
+export { VersionValidator, type VersionValidatorConstructorOptions, type VersionValidatorLatestOptions, type VersionValidatorMiddlewareOptions, type VersionValidatorOptions, type VersionValidatorPartialOptions, type VersionValidatorPopupOptions, versionValidatorMiddleware };