jimpex 10.0.1 → 11.0.0

package/dist/services/html/htmlGenerator.js

@@ -1,37 +1,39 @@
-"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 htmlGenerator_exports = {};
-__export(htmlGenerator_exports, {
-  HTMLGenerator: () => HTMLGenerator,
-  htmlGeneratorProvider: () => htmlGeneratorProvider
-});
-module.exports = __toCommonJS(htmlGenerator_exports);
-var import_object_utils = require("@homer0/object-utils");
-var import_deep_assign = require("@homer0/deep-assign");
-var import_deferred = require("@homer0/deferred");
-var import_utils = require("../../utils");
+import { get } from "@homer0/object-utils";
+import { deepAssignWithOverwrite } from "@homer0/deep-assign";
+import { deferred } from "@homer0/deferred";
+import { providerCreator } from "../../utils/index.js";
 class HTMLGenerator {
+  /**
+   * The service customization options.
+   */
+  _options;
+  /**
+   * The application configuration service, to get the settings specified by the
+   * `configKeys` option.
+   */
+  _config;
+  /**
+   * The service that logs messages on the terminal, in case the `silent` option is `false`.
+   */
+  _logger;
+  /**
+   * The service that interacts with the filesystem.
+   */
+  _frontendFs;
+  /**
+   * A service that can provide values to be replaced in the template.
+   */
+  _valuesService;
+  /**
+   * Whether or not the file was already generated.
+   */
+  _fileReady = false;
+  /**
+   * A deferred promise to return when another service asks if the file has been
+   * generated. Once this service finishes generating the file, the promise will be
+   * resolved for all implementations that hold a reference to this deferred.
+   */
+  _fileDeferred;
   /**
    * @param options  The options to construct the class.
    * @throws If `valuesService` is specified but it doesn't have a `getValues`
@@ -41,42 +43,11 @@ class HTMLGenerator {
     inject: { config, logger, frontendFs, valuesService },
     ...options
   }) {
-    /**
-     * The service customization options.
-     */
-    __publicField(this, "_options");
-    /**
-     * The application configuration service, to get the settings specified by the
-     * `configKeys` option.
-     */
-    __publicField(this, "_config");
-    /**
-     * The service that logs messages on the terminal, in case the `silent` option is `false`.
-     */
-    __publicField(this, "_logger");
-    /**
-     * The service that interacts with the filesystem.
-     */
-    __publicField(this, "_frontendFs");
-    /**
-     * A service that can provide values to be replaced in the template.
-     */
-    __publicField(this, "_valuesService");
-    /**
-     * Whether or not the file was already generated.
-     */
-    __publicField(this, "_fileReady", false);
-    /**
-     * A deferred promise to return when another service asks if the file has been
-     * generated. Once this sevice finishes generating the file, the promise will be
-     * resolved for all implementations that hold a reference to this deferred.
-     */
-    __publicField(this, "_fileDeferred");
     this._config = config;
     this._logger = logger;
     this._frontendFs = frontendFs;
     this._valuesService = valuesService;
-    this._options = (0, import_deep_assign.deepAssignWithOverwrite)(
+    this._options = deepAssignWithOverwrite(
       {
         template: "index.tpl.html",
         file: "index.html",
@@ -103,11 +74,9 @@ class HTMLGenerator {
    * Generates the HTML file.
    */
   async generateHTML() {
-    if (this._fileReady)
-      return void 0;
-    if (this._fileDeferred)
-      return this._fileDeferred.promise;
-    this._fileDeferred = (0, import_deferred.deferred)();
+    if (this._fileReady) return void 0;
+    if (this._fileDeferred) return this._fileDeferred.promise;
+    this._fileDeferred = deferred();
     const { template, deleteTemplateAfter, file, silent } = this._options;
     try {
       const templateContents = await this._frontendFs.read(template);
@@ -140,7 +109,7 @@ class HTMLGenerator {
    * Gets the customization options.
    */
   get options() {
-    return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
+    return deepAssignWithOverwrite({}, this._options);
   }
   /**
    * Helper method to get the values that will be replaced in the template. If a "values
@@ -175,21 +144,19 @@ class HTMLGenerator {
     let match = placeholderExpression.exec(code);
     while (match) {
       const [string, value] = match;
-      if (string && value) {
-        matches.push({
-          string,
-          value
-        });
-      }
+      matches.push({
+        string,
+        value
+      });
       match = placeholderExpression.exec(code);
     }
     matches.forEach((info) => {
-      code = code.replace(info.string, String((0, import_object_utils.get)(values, info.value)));
+      code = code.replace(info.string, String(get(values, info.value)));
     });
     return code;
   }
 }
-const htmlGeneratorProvider = (0, import_utils.providerCreator)(
+const htmlGeneratorProvider = providerCreator(
   (options = {}) => (app) => {
     const {
       serviceName = "htmlGenerator",
@@ -213,9 +180,8 @@ const htmlGeneratorProvider = (0, import_utils.providerCreator)(
     });
   }
 );
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   HTMLGenerator,
   htmlGeneratorProvider
-});
+};
 //# sourceMappingURL=htmlGenerator.js.map

package/dist/services/html/htmlGenerator.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/html/htmlGenerator.ts"],"sourcesContent":["import { get } from '@homer0/object-utils';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { deferred, type DeferredPromise } from '@homer0/deferred';\nimport { providerCreator } from '../../utils';\nimport type { Config, Logger } from '../../types';\nimport type { FrontendFs } from '../frontend';\n/**\n * The options to customize a {@link HTMLGenerator} instance.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorOptions = {\n  /**\n   * The name of the file it should use as template.\n   *\n   * @default 'index.tpl.html'\n   */\n  template: string;\n  /**\n   * The name of the generated file.\n   *\n   * @default 'index.html'\n   */\n  file: string;\n  /**\n   * If `true`, it won't log messages on the terminal when generating the file.\n   *\n   * @default false\n   */\n  silent: boolean;\n  /**\n   * Whether or not to delete the tempalte after generating the file.\n   *\n   * @default true\n   */\n  deleteTemplateAfter: boolean;\n  /**\n   * The placeholder string where the information will be written.\n   *\n   * @default /\\{\\{appConfi(?:guration)?\\}\\}/\n   */\n  replacePlaceholder: string | RegExp;\n  /**\n   * A regular expression for dynamic placeholders that will be replaced by values when\n   * the file is generated.\n   *\n   * @default /\\{\\{(.*?)\\}\\}/gi\n   */\n  placeholderExpression: RegExp;\n  /**\n   * The name of the variable that will have the information on the file.\n   *\n   * @default 'appConfig'\n   */\n  variableName: string;\n  /**\n   * A list of settings from the app configuration that will be used as the information to\n   * inject on the file.\n   *\n   * @default ['features', 'version', 'postMessagesPrefix']\n   */\n  configKeys: string[];\n};\n/**\n * An external service that can be used to provide the values the generator will replace\n * in the template.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorValuesService = {\n  /**\n   * A function that will be called to get the values to replace in the template.\n   *\n   * @param options  The service customization options.\n   */\n  getValues: (options: HTMLGeneratorOptions) => Promise<Record<string, unknown>>;\n};\n/**\n * The options to construct a {@link HTMLGenerator}.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorConstructorOptions = Partial<HTMLGeneratorOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    config: Config;\n    logger: Logger;\n    frontendFs: FrontendFs;\n    /**\n     * A service that can provide the values to replace in the template. If specified, the\n     * values from `configKeys` will be ignored.\n     */\n    valuesService?: HTMLGeneratorValuesService;\n  };\n};\n/**\n * Custom options for the provider that will register an instance of {@link HTMLGenerator}\n * as a service.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorProviderOptions = Partial<HTMLGeneratorOptions> & {\n  /**\n   * The name that will be used to register the service on the container. This is to allow\n   * multiple \"instances\" of the service to be created.\n   *\n   * @default 'htmlGenerator'\n   */\n  serviceName?: string;\n  /**\n   * The name of a service that the generator will use in order to read the values that\n   * will be replaced on the template. If the service is available, the values from\n   * `configKeys` will be ignored.\n   *\n   * @default 'htmlGeneratorValues'\n   */\n  valuesServiceName?: string;\n};\n/**\n * This is a utility service that generates an HTML file with custom information when the\n * application is started.\n *\n * @group Services\n * @group Services/HTMLGenerator\n */\nexport class HTMLGenerator {\n  /**\n   * The service customization options.\n   */\n  protected readonly _options: HTMLGeneratorOptions;\n  /**\n   * The application configuration service, to get the settings specified by the\n   * `configKeys` option.\n   */\n  protected readonly _config: Config;\n  /**\n   * The service that logs messages on the terminal, in case the `silent` option is `false`.\n   */\n  protected readonly _logger: Logger;\n  /**\n   * The service that interacts with the filesystem.\n   */\n  protected readonly _frontendFs: FrontendFs;\n  /**\n   * A service that can provide values to be replaced in the template.\n   */\n  protected readonly _valuesService?: HTMLGeneratorValuesService;\n  /**\n   * Whether or not the file was already generated.\n   */\n  protected _fileReady: boolean = false;\n  /**\n   * A deferred promise to return when another service asks if the file has been\n   * generated. Once this sevice finishes generating the file, the promise will be\n   * resolved for all implementations that hold a reference to this deferred.\n   */\n  protected _fileDeferred?: DeferredPromise<void>;\n  /**\n   * @param options  The options to construct the class.\n   * @throws If `valuesService` is specified but it doesn't have a `getValues`\n   *         method.\n   */\n  constructor({\n    inject: { config, logger, frontendFs, valuesService },\n    ...options\n  }: HTMLGeneratorConstructorOptions) {\n    this._config = config;\n    this._logger = logger;\n    this._frontendFs = frontendFs;\n    this._valuesService = valuesService;\n    this._options = deepAssignWithOverwrite(\n      {\n        template: 'index.tpl.html',\n        file: 'index.html',\n        silent: false,\n        deleteTemplateAfter: true,\n        replacePlaceholder: /\\{\\{appConfig(?:uration)?\\}\\}/,\n        placeholderExpression: /\\{\\{(.*?)\\}\\}/gi,\n        variableName: 'appConfig',\n        configKeys: ['features', 'version', 'postMessagesPrefix'],\n      },\n      options,\n    );\n\n    if (this._valuesService && typeof this._valuesService.getValues !== 'function') {\n      throw new Error('The HTMLGenerator values service must have a `getValues` method');\n    }\n  }\n  /**\n   * Gets a promise that will be resolved when the file has been generated.\n   */\n  whenReady(): Promise<void> {\n    return this._fileDeferred ? this._fileDeferred.promise : Promise.resolve();\n  }\n  /**\n   * Generates the HTML file.\n   */\n  async generateHTML(): Promise<void> {\n    // The file is already generated, and since this is async, return the promise.\n    if (this._fileReady) return undefined;\n    // If the file is not ready, but the deferred exists, return the reference to the promise.\n    if (this._fileDeferred) return this._fileDeferred.promise;\n    // Create the deferred promise.\n    this._fileDeferred = deferred<void>();\n    const { template, deleteTemplateAfter, file, silent } = this._options;\n    try {\n      // Get the template.\n      const templateContents = await this._frontendFs.read(template);\n      // Get the values to replace.\n      const values = await this._getValues();\n      // Replace/process the template.\n      const html = this._processHTML(templateContents, values);\n      // Write it in the filesystem.\n      await this._frontendFs.write(file, html);\n      if (!silent) {\n        this._logger.success(`The HTML file was successfully generated (${file})`);\n      }\n      // Delete the template, if specified by the options.\n      if (deleteTemplateAfter) {\n        await this._frontendFs.delete(template);\n        if (!silent) {\n          this._logger.info(`The HTML template was successfully removed (${template})`);\n        }\n      }\n\n      // Switch the flag, resolve the deferred promise, and delete it.\n      this._fileReady = true;\n      this._fileDeferred!.resolve();\n      this._fileDeferred = undefined;\n      return undefined;\n    } catch (error) {\n      this._fileDeferred!.reject(error);\n      this._fileDeferred = undefined;\n      if (!silent) {\n        this._logger.error('There was an error while generating the HTML');\n      }\n      throw error;\n    }\n  }\n  /**\n   * Gets the customization options.\n   */\n  get options(): Readonly<HTMLGeneratorOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Helper method to get the values that will be replaced in the template. If a \"values\n   * service\" was specified in the constructor, it will get the values from there,\n   * otherwise, it will use the `configKeys` option to get the values from the\n   * application configuration.\n   */\n  protected _getValues(): Promise<Record<string, unknown>> {\n    if (this._valuesService) {\n      return this._valuesService.getValues(this._options);\n    }\n\n    const { configKeys } = this._options;\n    if (configKeys && configKeys.length) {\n      return Promise.resolve(this._config.get(configKeys));\n    }\n\n    return Promise.resolve({});\n  }\n  /**\n   * Processes the HTML template by replacing the placeholders with the actual values.\n   *\n   * @param template  The template for the HTML file.\n   * @param values    The values dictionary that should be replaced in the template.\n   */\n  protected _processHTML(template: string, values: Record<string, unknown>) {\n    const { replacePlaceholder, placeholderExpression, variableName } = this._options;\n    const htmlObject = JSON.stringify(values);\n    let code = template.replace(\n      replacePlaceholder,\n      `window.${variableName} = ${htmlObject}`,\n    );\n    const matches: Array<{ string: string; value: string }> = [];\n    let match = placeholderExpression.exec(code);\n    while (match) {\n      const [string, value] = match;\n      if (string && value) {\n        matches.push({\n          string,\n          value,\n        });\n      }\n\n      match = placeholderExpression.exec(code);\n    }\n\n    matches.forEach((info) => {\n      code = code.replace(info.string, String(get(values, info.value)));\n    });\n\n    return code;\n  }\n}\n/**\n * The service provider that once registered on the container will set an instance of\n * {@link HTMLGenerator} as the `htmlGenerator` service. it will also hook itself to the\n * `after-start` event of the application in order to trigger the generator of the HTML\n * file.\n *\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   // Register it on the container\n *   container.register(htmlGeneratorProvider);\n *   // Getting access to the service instance\n *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');\n *\n * @example\n *\n * <caption>Using with custom options</caption>\n *\n *   container.register(\n *     htmlGeneratorProvider({\n *       serviceName: 'myHtmlGenerator',\n *       valuesServiceName: 'myValuesService',\n *       template: 'my-template.tpl.html',\n *     }),\n *   );\n *\n * @group Providers\n * @group Services/HTMLGenerator\n */\nexport const htmlGeneratorProvider = providerCreator(\n  (options: HTMLGeneratorProviderOptions = {}) =>\n    (app) => {\n      const {\n        serviceName = 'htmlGenerator',\n        valuesServiceName = 'htmlGeneratorValues',\n        ...rest\n      } = options;\n      app.set(\n        serviceName,\n        () =>\n          new HTMLGenerator({\n            inject: {\n              config: app.get('config'),\n              logger: app.get('logger'),\n              frontendFs: app.get('frontendFs'),\n              valuesService: app.try(valuesServiceName),\n            },\n            ...rest,\n          }),\n      );\n\n      app.once('afterStart', () => {\n        app.get<HTMLGenerator>(serviceName).generateHTML();\n      });\n    },\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,0BAAoB;AACpB,yBAAwC;AACxC,sBAA+C;AAC/C,mBAAgC;AA4HzB,MAAM,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqCzB,YAAY;AAAA,IACV,QAAQ,EAAE,QAAQ,QAAQ,YAAY,cAAc;AAAA,IACpD,GAAG;AAAA,EACL,GAAoC;AApCpC;AAAA;AAAA;AAAA,wBAAmB;AAKnB;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAU,cAAsB;AAMhC;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAU;AAUR,SAAK,UAAU;AACf,SAAK,UAAU;AACf,SAAK,cAAc;AACnB,SAAK,iBAAiB;AACtB,SAAK,eAAW;AAAA,MACd;AAAA,QACE,UAAU;AAAA,QACV,MAAM;AAAA,QACN,QAAQ;AAAA,QACR,qBAAqB;AAAA,QACrB,oBAAoB;AAAA,QACpB,uBAAuB;AAAA,QACvB,cAAc;AAAA,QACd,YAAY,CAAC,YAAY,WAAW,oBAAoB;AAAA,MAC1D;AAAA,MACA;AAAA,IACF;AAEA,QAAI,KAAK,kBAAkB,OAAO,KAAK,eAAe,cAAc,YAAY;AAC9E,YAAM,IAAI,MAAM,iEAAiE;AAAA,IACnF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,YAA2B;AACzB,WAAO,KAAK,gBAAgB,KAAK,cAAc,UAAU,QAAQ,QAAQ;AAAA,EAC3E;AAAA;AAAA;AAAA;AAAA,EAIA,MAAM,eAA8B;AAElC,QAAI,KAAK;AAAY,aAAO;AAE5B,QAAI,KAAK;AAAe,aAAO,KAAK,cAAc;AAElD,SAAK,oBAAgB,0BAAe;AACpC,UAAM,EAAE,UAAU,qBAAqB,MAAM,OAAO,IAAI,KAAK;AAC7D,QAAI;AAEF,YAAM,mBAAmB,MAAM,KAAK,YAAY,KAAK,QAAQ;AAE7D,YAAM,SAAS,MAAM,KAAK,WAAW;AAErC,YAAM,OAAO,KAAK,aAAa,kBAAkB,MAAM;AAEvD,YAAM,KAAK,YAAY,MAAM,MAAM,IAAI;AACvC,UAAI,CAAC,QAAQ;AACX,aAAK,QAAQ,QAAQ,6CAA6C,IAAI,GAAG;AAAA,MAC3E;AAEA,UAAI,qBAAqB;AACvB,cAAM,KAAK,YAAY,OAAO,QAAQ;AACtC,YAAI,CAAC,QAAQ;AACX,eAAK,QAAQ,KAAK,+CAA+C,QAAQ,GAAG;AAAA,QAC9E;AAAA,MACF;AAGA,WAAK,aAAa;AAClB,WAAK,cAAe,QAAQ;AAC5B,WAAK,gBAAgB;AACrB,aAAO;AAAA,IACT,SAAS,OAAO;AACd,WAAK,cAAe,OAAO,KAAK;AAChC,WAAK,gBAAgB;AACrB,UAAI,CAAC,QAAQ;AACX,aAAK,QAAQ,MAAM,8CAA8C;AAAA,MACnE;AACA,YAAM;AAAA,IACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA0C;AAC5C,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,aAA+C;AACvD,QAAI,KAAK,gBAAgB;AACvB,aAAO,KAAK,eAAe,UAAU,KAAK,QAAQ;AAAA,IACpD;AAEA,UAAM,EAAE,WAAW,IAAI,KAAK;AAC5B,QAAI,cAAc,WAAW,QAAQ;AACnC,aAAO,QAAQ,QAAQ,KAAK,QAAQ,IAAI,UAAU,CAAC;AAAA,IACrD;AAEA,WAAO,QAAQ,QAAQ,CAAC,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,aAAa,UAAkB,QAAiC;AACxE,UAAM,EAAE,oBAAoB,uBAAuB,aAAa,IAAI,KAAK;AACzE,UAAM,aAAa,KAAK,UAAU,MAAM;AACxC,QAAI,OAAO,SAAS;AAAA,MAClB;AAAA,MACA,UAAU,YAAY,MAAM,UAAU;AAAA,IACxC;AACA,UAAM,UAAoD,CAAC;AAC3D,QAAI,QAAQ,sBAAsB,KAAK,IAAI;AAC3C,WAAO,OAAO;AACZ,YAAM,CAAC,QAAQ,KAAK,IAAI;AACxB,UAAI,UAAU,OAAO;AACnB,gBAAQ,KAAK;AAAA,UACX;AAAA,UACA;AAAA,QACF,CAAC;AAAA,MACH;AAEA,cAAQ,sBAAsB,KAAK,IAAI;AAAA,IACzC;AAEA,YAAQ,QAAQ,CAAC,SAAS;AACxB,aAAO,KAAK,QAAQ,KAAK,QAAQ,WAAO,yBAAI,QAAQ,KAAK,KAAK,CAAC,CAAC;AAAA,IAClE,CAAC;AAED,WAAO;AAAA,EACT;AACF;AA+BO,MAAM,4BAAwB;AAAA,EACnC,CAAC,UAAwC,CAAC,MACxC,CAAC,QAAQ;AACP,UAAM;AAAA,MACJ,cAAc;AAAA,MACd,oBAAoB;AAAA,MACpB,GAAG;AAAA,IACL,IAAI;AACJ,QAAI;AAAA,MACF;AAAA,MACA,MACE,IAAI,cAAc;AAAA,QAChB,QAAQ;AAAA,UACN,QAAQ,IAAI,IAAI,QAAQ;AAAA,UACxB,QAAQ,IAAI,IAAI,QAAQ;AAAA,UACxB,YAAY,IAAI,IAAI,YAAY;AAAA,UAChC,eAAe,IAAI,IAAI,iBAAiB;AAAA,QAC1C;AAAA,QACA,GAAG;AAAA,MACL,CAAC;AAAA,IACL;AAEA,QAAI,KAAK,cAAc,MAAM;AAC3B,UAAI,IAAmB,WAAW,EAAE,aAAa;AAAA,IACnD,CAAC;AAAA,EACH;AACJ;","names":[]}
+{"version":3,"sources":["../../../src/services/html/htmlGenerator.ts"],"sourcesContent":["import { get } from '@homer0/object-utils';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { deferred, type DeferredPromise } from '@homer0/deferred';\nimport { providerCreator } from '../../utils/index.js';\nimport type { Config, Logger } from '../../types/index.js';\nimport type { FrontendFs } from '../frontend/index.js';\n/**\n * The options to customize a {@link HTMLGenerator} instance.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorOptions = {\n  /**\n   * The name of the file it should use as template.\n   *\n   * @default 'index.tpl.html'\n   */\n  template: string;\n  /**\n   * The name of the generated file.\n   *\n   * @default 'index.html'\n   */\n  file: string;\n  /**\n   * If `true`, it won't log messages on the terminal when generating the file.\n   *\n   * @default false\n   */\n  silent: boolean;\n  /**\n   * Whether or not to delete the template after generating the file.\n   *\n   * @default true\n   */\n  deleteTemplateAfter: boolean;\n  /**\n   * The placeholder string where the information will be written.\n   *\n   * @default /\\{\\{appConfig(?:uration)?\\}\\}/\n   */\n  replacePlaceholder: string | RegExp;\n  /**\n   * A regular expression for dynamic placeholders that will be replaced by values when\n   * the file is generated.\n   *\n   * @default /\\{\\{(.*?)\\}\\}/gi\n   */\n  placeholderExpression: RegExp;\n  /**\n   * The name of the variable that will have the information on the file.\n   *\n   * @default 'appConfig'\n   */\n  variableName: string;\n  /**\n   * A list of settings from the app configuration that will be used as the information to\n   * inject on the file.\n   *\n   * @default ['features', 'version', 'postMessagesPrefix']\n   */\n  configKeys: string[];\n};\n/**\n * An external service that can be used to provide the values the generator will replace\n * in the template.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorValuesService = {\n  /**\n   * A function that will be called to get the values to replace in the template.\n   *\n   * @param options  The service customization options.\n   */\n  getValues: (options: HTMLGeneratorOptions) => Promise<Record<string, unknown>>;\n};\n/**\n * The options to construct a {@link HTMLGenerator}.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorConstructorOptions = Partial<HTMLGeneratorOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    config: Config;\n    logger: Logger;\n    frontendFs: FrontendFs;\n    /**\n     * A service that can provide the values to replace in the template. If specified, the\n     * values from `configKeys` will be ignored.\n     */\n    valuesService?: HTMLGeneratorValuesService;\n  };\n};\n/**\n * Custom options for the provider that will register an instance of {@link HTMLGenerator}\n * as a service.\n *\n * @group Services/HTMLGenerator\n */\nexport type HTMLGeneratorProviderOptions = Partial<HTMLGeneratorOptions> & {\n  /**\n   * The name that will be used to register the service on the container. This is to allow\n   * multiple \"instances\" of the service to be created.\n   *\n   * @default 'htmlGenerator'\n   */\n  serviceName?: string;\n  /**\n   * The name of a service that the generator will use in order to read the values that\n   * will be replaced on the template. If the service is available, the values from\n   * `configKeys` will be ignored.\n   *\n   * @default 'htmlGeneratorValues'\n   */\n  valuesServiceName?: string;\n};\n/**\n * This is a utility service that generates an HTML file with custom information when the\n * application is started.\n *\n * @group Services\n * @group Services/HTMLGenerator\n */\nexport class HTMLGenerator {\n  /**\n   * The service customization options.\n   */\n  protected readonly _options: HTMLGeneratorOptions;\n  /**\n   * The application configuration service, to get the settings specified by the\n   * `configKeys` option.\n   */\n  protected readonly _config: Config;\n  /**\n   * The service that logs messages on the terminal, in case the `silent` option is `false`.\n   */\n  protected readonly _logger: Logger;\n  /**\n   * The service that interacts with the filesystem.\n   */\n  protected readonly _frontendFs: FrontendFs;\n  /**\n   * A service that can provide values to be replaced in the template.\n   */\n  protected readonly _valuesService?: HTMLGeneratorValuesService;\n  /**\n   * Whether or not the file was already generated.\n   */\n  protected _fileReady: boolean = false;\n  /**\n   * A deferred promise to return when another service asks if the file has been\n   * generated. Once this service finishes generating the file, the promise will be\n   * resolved for all implementations that hold a reference to this deferred.\n   */\n  protected _fileDeferred?: DeferredPromise<void>;\n  /**\n   * @param options  The options to construct the class.\n   * @throws If `valuesService` is specified but it doesn't have a `getValues`\n   *         method.\n   */\n  constructor({\n    inject: { config, logger, frontendFs, valuesService },\n    ...options\n  }: HTMLGeneratorConstructorOptions) {\n    this._config = config;\n    this._logger = logger;\n    this._frontendFs = frontendFs;\n    this._valuesService = valuesService;\n    this._options = deepAssignWithOverwrite(\n      {\n        template: 'index.tpl.html',\n        file: 'index.html',\n        silent: false,\n        deleteTemplateAfter: true,\n        replacePlaceholder: /\\{\\{appConfig(?:uration)?\\}\\}/,\n        placeholderExpression: /\\{\\{(.*?)\\}\\}/gi,\n        variableName: 'appConfig',\n        configKeys: ['features', 'version', 'postMessagesPrefix'],\n      },\n      options,\n    );\n\n    if (this._valuesService && typeof this._valuesService.getValues !== 'function') {\n      throw new Error('The HTMLGenerator values service must have a `getValues` method');\n    }\n  }\n  /**\n   * Gets a promise that will be resolved when the file has been generated.\n   */\n  whenReady(): Promise<void> {\n    return this._fileDeferred ? this._fileDeferred.promise : Promise.resolve();\n  }\n  /**\n   * Generates the HTML file.\n   */\n  async generateHTML(): Promise<void> {\n    // The file is already generated, and since this is async, return the promise.\n    if (this._fileReady) return undefined;\n    // If the file is not ready, but the deferred exists, return the reference to the promise.\n    if (this._fileDeferred) return this._fileDeferred.promise;\n    // Create the deferred promise.\n    this._fileDeferred = deferred<void>();\n    const { template, deleteTemplateAfter, file, silent } = this._options;\n    try {\n      // Get the template.\n      const templateContents = await this._frontendFs.read(template);\n      // Get the values to replace.\n      const values = await this._getValues();\n      // Replace/process the template.\n      const html = this._processHTML(templateContents, values);\n      // Write it in the filesystem.\n      await this._frontendFs.write(file, html);\n      if (!silent) {\n        this._logger.success(`The HTML file was successfully generated (${file})`);\n      }\n      // Delete the template, if specified by the options.\n      if (deleteTemplateAfter) {\n        await this._frontendFs.delete(template);\n        if (!silent) {\n          this._logger.info(`The HTML template was successfully removed (${template})`);\n        }\n      }\n\n      // Switch the flag, resolve the deferred promise, and delete it.\n      this._fileReady = true;\n      this._fileDeferred!.resolve();\n      this._fileDeferred = undefined;\n      return undefined;\n    } catch (error) {\n      this._fileDeferred!.reject(error);\n      this._fileDeferred = undefined;\n      if (!silent) {\n        this._logger.error('There was an error while generating the HTML');\n      }\n      throw error;\n    }\n  }\n  /**\n   * Gets the customization options.\n   */\n  get options(): Readonly<HTMLGeneratorOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Helper method to get the values that will be replaced in the template. If a \"values\n   * service\" was specified in the constructor, it will get the values from there,\n   * otherwise, it will use the `configKeys` option to get the values from the\n   * application configuration.\n   */\n  protected _getValues(): Promise<Record<string, unknown>> {\n    if (this._valuesService) {\n      return this._valuesService.getValues(this._options);\n    }\n\n    const { configKeys } = this._options;\n    if (configKeys && configKeys.length) {\n      return Promise.resolve(this._config.get(configKeys));\n    }\n\n    return Promise.resolve({});\n  }\n  /**\n   * Processes the HTML template by replacing the placeholders with the actual values.\n   *\n   * @param template  The template for the HTML file.\n   * @param values    The values dictionary that should be replaced in the template.\n   */\n  protected _processHTML(template: string, values: Record<string, unknown>) {\n    const { replacePlaceholder, placeholderExpression, variableName } = this._options;\n    const htmlObject = JSON.stringify(values);\n    let code = template.replace(\n      replacePlaceholder,\n      `window.${variableName} = ${htmlObject}`,\n    );\n    const matches: Array<{ string: string; value: string }> = [];\n    let match = placeholderExpression.exec(code);\n    while (match) {\n      const [string, value] = match as RegExpExecArray;\n      matches.push({\n        string,\n        value: value!,\n      });\n\n      match = placeholderExpression.exec(code);\n    }\n\n    matches.forEach((info) => {\n      code = code.replace(info.string, String(get(values, info.value)));\n    });\n\n    return code;\n  }\n}\n/**\n * The service provider that once registered on the container will set an instance of\n * {@link HTMLGenerator} as the `htmlGenerator` service. it will also hook itself to the\n * `after-start` event of the application in order to trigger the generator of the HTML\n * file.\n *\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   // Register it on the container\n *   container.register(htmlGeneratorProvider);\n *   // Getting access to the service instance\n *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');\n *\n * @example\n *\n * <caption>Using with custom options</caption>\n *\n *   container.register(\n *     htmlGeneratorProvider({\n *       serviceName: 'myHtmlGenerator',\n *       valuesServiceName: 'myValuesService',\n *       template: 'my-template.tpl.html',\n *     }),\n *   );\n *\n * @group Providers\n * @group Services/HTMLGenerator\n */\nexport const htmlGeneratorProvider = providerCreator(\n  (options: HTMLGeneratorProviderOptions = {}) =>\n    (app) => {\n      const {\n        serviceName = 'htmlGenerator',\n        valuesServiceName = 'htmlGeneratorValues',\n        ...rest\n      } = options;\n      app.set(\n        serviceName,\n        () =>\n          new HTMLGenerator({\n            inject: {\n              config: app.get('config'),\n              logger: app.get('logger'),\n              frontendFs: app.get('frontendFs'),\n              valuesService: app.try(valuesServiceName),\n            },\n            ...rest,\n          }),\n      );\n\n      app.once('afterStart', () => {\n        app.get<HTMLGenerator>(serviceName).generateHTML();\n      });\n    },\n);\n"],"mappings":"AAAA,SAAS,WAAW;AACpB,SAAS,+BAA+B;AACxC,SAAS,gBAAsC;AAC/C,SAAS,uBAAuB;AA4HzB,MAAM,cAAc;AAAA;AAAA;AAAA;AAAA,EAIN;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA,EAIT,aAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMV,YAAY;AAAA,IACV,QAAQ,EAAE,QAAQ,QAAQ,YAAY,cAAc;AAAA,IACpD,GAAG;AAAA,EACL,GAAoC;AAClC,SAAK,UAAU;AACf,SAAK,UAAU;AACf,SAAK,cAAc;AACnB,SAAK,iBAAiB;AACtB,SAAK,WAAW;AAAA,MACd;AAAA,QACE,UAAU;AAAA,QACV,MAAM;AAAA,QACN,QAAQ;AAAA,QACR,qBAAqB;AAAA,QACrB,oBAAoB;AAAA,QACpB,uBAAuB;AAAA,QACvB,cAAc;AAAA,QACd,YAAY,CAAC,YAAY,WAAW,oBAAoB;AAAA,MAC1D;AAAA,MACA;AAAA,IACF;AAEA,QAAI,KAAK,kBAAkB,OAAO,KAAK,eAAe,cAAc,YAAY;AAC9E,YAAM,IAAI,MAAM,iEAAiE;AAAA,IACnF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,YAA2B;AACzB,WAAO,KAAK,gBAAgB,KAAK,cAAc,UAAU,QAAQ,QAAQ;AAAA,EAC3E;AAAA;AAAA;AAAA;AAAA,EAIA,MAAM,eAA8B;AAElC,QAAI,KAAK,WAAY,QAAO;AAE5B,QAAI,KAAK,cAAe,QAAO,KAAK,cAAc;AAElD,SAAK,gBAAgB,SAAe;AACpC,UAAM,EAAE,UAAU,qBAAqB,MAAM,OAAO,IAAI,KAAK;AAC7D,QAAI;AAEF,YAAM,mBAAmB,MAAM,KAAK,YAAY,KAAK,QAAQ;AAE7D,YAAM,SAAS,MAAM,KAAK,WAAW;AAErC,YAAM,OAAO,KAAK,aAAa,kBAAkB,MAAM;AAEvD,YAAM,KAAK,YAAY,MAAM,MAAM,IAAI;AACvC,UAAI,CAAC,QAAQ;AACX,aAAK,QAAQ,QAAQ,6CAA6C,IAAI,GAAG;AAAA,MAC3E;AAEA,UAAI,qBAAqB;AACvB,cAAM,KAAK,YAAY,OAAO,QAAQ;AACtC,YAAI,CAAC,QAAQ;AACX,eAAK,QAAQ,KAAK,+CAA+C,QAAQ,GAAG;AAAA,QAC9E;AAAA,MACF;AAGA,WAAK,aAAa;AAClB,WAAK,cAAe,QAAQ;AAC5B,WAAK,gBAAgB;AACrB,aAAO;AAAA,IACT,SAAS,OAAO;AACd,WAAK,cAAe,OAAO,KAAK;AAChC,WAAK,gBAAgB;AACrB,UAAI,CAAC,QAAQ;AACX,aAAK,QAAQ,MAAM,8CAA8C;AAAA,MACnE;AACA,YAAM;AAAA,IACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA0C;AAC5C,WAAO,wBAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,aAA+C;AACvD,QAAI,KAAK,gBAAgB;AACvB,aAAO,KAAK,eAAe,UAAU,KAAK,QAAQ;AAAA,IACpD;AAEA,UAAM,EAAE,WAAW,IAAI,KAAK;AAC5B,QAAI,cAAc,WAAW,QAAQ;AACnC,aAAO,QAAQ,QAAQ,KAAK,QAAQ,IAAI,UAAU,CAAC;AAAA,IACrD;AAEA,WAAO,QAAQ,QAAQ,CAAC,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,aAAa,UAAkB,QAAiC;AACxE,UAAM,EAAE,oBAAoB,uBAAuB,aAAa,IAAI,KAAK;AACzE,UAAM,aAAa,KAAK,UAAU,MAAM;AACxC,QAAI,OAAO,SAAS;AAAA,MAClB;AAAA,MACA,UAAU,YAAY,MAAM,UAAU;AAAA,IACxC;AACA,UAAM,UAAoD,CAAC;AAC3D,QAAI,QAAQ,sBAAsB,KAAK,IAAI;AAC3C,WAAO,OAAO;AACZ,YAAM,CAAC,QAAQ,KAAK,IAAI;AACxB,cAAQ,KAAK;AAAA,QACX;AAAA,QACA;AAAA,MACF,CAAC;AAED,cAAQ,sBAAsB,KAAK,IAAI;AAAA,IACzC;AAEA,YAAQ,QAAQ,CAAC,SAAS;AACxB,aAAO,KAAK,QAAQ,KAAK,QAAQ,OAAO,IAAI,QAAQ,KAAK,KAAK,CAAC,CAAC;AAAA,IAClE,CAAC;AAED,WAAO;AAAA,EACT;AACF;AA+BO,MAAM,wBAAwB;AAAA,EACnC,CAAC,UAAwC,CAAC,MACxC,CAAC,QAAQ;AACP,UAAM;AAAA,MACJ,cAAc;AAAA,MACd,oBAAoB;AAAA,MACpB,GAAG;AAAA,IACL,IAAI;AACJ,QAAI;AAAA,MACF;AAAA,MACA,MACE,IAAI,cAAc;AAAA,QAChB,QAAQ;AAAA,UACN,QAAQ,IAAI,IAAI,QAAQ;AAAA,UACxB,QAAQ,IAAI,IAAI,QAAQ;AAAA,UACxB,YAAY,IAAI,IAAI,YAAY;AAAA,UAChC,eAAe,IAAI,IAAI,iBAAiB;AAAA,QAC1C;AAAA,QACA,GAAG;AAAA,MACL,CAAC;AAAA,IACL;AAEA,QAAI,KAAK,cAAc,MAAM;AAC3B,UAAI,IAAmB,WAAW,EAAE,aAAa;AAAA,IACnD,CAAC;AAAA,EACH;AACJ;","names":[]}

package/dist/services/html/index.d.ts

@@ -1,5 +1,5 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-C6I3NCC-.js';
+import { J as Jimpex } from '../../index-BlSpNHox.js';
 import { HTMLGeneratorProviderOptions } from './htmlGenerator.js';
 export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorValuesService, htmlGeneratorProvider } from './htmlGenerator.js';
 import '../../types/express.js';
@@ -15,7 +15,7 @@ import '@homer0/simple-logger';
 import '@homer0/simple-config';
 import '@homer0/events-hub';
 import '../frontend/frontendFs.js';
-import 'fs/promises';
+import 'node:fs/promises';
 import '@homer0/deferred';
 
 /**

package/dist/services/html/index.js

@@ -1,36 +1,10 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var html_exports = {};
-__export(html_exports, {
-  htmlServicesProvider: () => htmlServicesProvider
-});
-module.exports = __toCommonJS(html_exports);
-var import_utils = require("../../utils");
-var import_htmlGenerator = require("./htmlGenerator");
-__reExport(html_exports, require("./htmlGenerator"), module.exports);
-const htmlServicesProvider = (0, import_utils.providers)({
-  htmlGeneratorProvider: import_htmlGenerator.htmlGeneratorProvider
-});
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  htmlServicesProvider,
-  ...require("./htmlGenerator")
+import { providers } from "../../utils/index.js";
+import { htmlGeneratorProvider } from "./htmlGenerator.js";
+const htmlServicesProvider = providers({
+  htmlGeneratorProvider
 });
+export * from "./htmlGenerator.js";
+export {
+  htmlServicesProvider
+};
 //# sourceMappingURL=index.js.map

package/dist/services/html/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/html/index.ts"],"sourcesContent":["import { providers } from '../../utils';\nimport { htmlGeneratorProvider } from './htmlGenerator';\n/**\n * Registers all the HTML services on the container.\n *\n * - {@link HTMLGenerator | htmlGenerator}\n *\n * @example\n *\n *   // Register the collection on the container\n *   container.register(htmlServicesProvider);\n *   // Getting access to one the services instance\n *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');\n *\n * @group Providers\n */\nexport const htmlServicesProvider = providers({\n  htmlGeneratorProvider,\n});\n\nexport * from './htmlGenerator';\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAA0B;AAC1B,2BAAsC;AAmBtC,yBAAc,4BApBd;AAgBO,MAAM,2BAAuB,wBAAU;AAAA,EAC5C;AACF,CAAC;","names":[]}
+{"version":3,"sources":["../../../src/services/html/index.ts"],"sourcesContent":["import { providers } from '../../utils/index.js';\nimport { htmlGeneratorProvider } from './htmlGenerator.js';\n/**\n * Registers all the HTML services on the container.\n *\n * - {@link HTMLGenerator | htmlGenerator}\n *\n * @example\n *\n *   // Register the collection on the container\n *   container.register(htmlServicesProvider);\n *   // Getting access to one the services instance\n *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');\n *\n * @group Providers\n */\nexport const htmlServicesProvider = providers({\n  htmlGeneratorProvider,\n});\n\nexport * from './htmlGenerator.js';\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,6BAA6B;AAe/B,MAAM,uBAAuB,UAAU;AAAA,EAC5C;AACF,CAAC;AAED,cAAc;","names":[]}

package/dist/services/http/apiClient.d.ts

@@ -1,5 +1,5 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-C6I3NCC-.js';
+import { J as Jimpex } from '../../index-BlSpNHox.js';
 import { HTTPErrorClass } from '../common/httpError.js';
 import { HTTP } from './http.js';
 import { APIClientOptions, APIClient as APIClient$1, ErrorResponse } from '@homer0/api-utils';

package/dist/services/http/apiClient.js

@@ -1,36 +1,21 @@
-"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 apiClient_exports = {};
-__export(apiClient_exports, {
-  APIClient: () => APIClient,
-  apiClientProvider: () => apiClientProvider
-});
-module.exports = __toCommonJS(apiClient_exports);
-var import_api_utils = require("@homer0/api-utils");
-var import_deep_assign = require("@homer0/deep-assign");
-var import_utils = require("../../utils");
-class APIClient extends import_api_utils.APIClient {
+import {
+  APIClient as APIClientBase
+} from "@homer0/api-utils";
+import { deepAssignWithOverwrite } from "@homer0/deep-assign";
+import { providerCreator } from "../../utils/index.js";
+class APIClient extends APIClientBase {
+  /**
+   * The service that makes the requests to the API.
+   */
+  _http;
+  /**
+   * The class to generate possible errors in the requests.
+   */
+  _HTTPError;
+  /**
+   * The configuration of the API it uses.
+   */
+  _apiConfig;
   /**
    * @param options  The options to construct the class.
    */
@@ -45,27 +30,15 @@ class APIClient extends import_api_utils.APIClient {
       ...apiConfig,
       fetchClient: http.fetch
     });
-    /**
-     * The service that makes the requests to the API.
-     */
-    __publicField(this, "_http");
-    /**
-     * The class to generate possible errors in the requests.
-     */
-    __publicField(this, "_HTTPError");
-    /**
-     * The configuration of the API it uses.
-     */
-    __publicField(this, "_apiConfig");
     this._http = http;
     this._HTTPError = HTTPError;
-    this._apiConfig = (0, import_deep_assign.deepAssignWithOverwrite)({}, apiConfig);
+    this._apiConfig = deepAssignWithOverwrite({}, apiConfig);
   }
   /**
    * The configuration for the API.
    */
   get apiConfig() {
-    return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._apiConfig);
+    return deepAssignWithOverwrite({}, this._apiConfig);
   }
   /**
    * Tries to obtain a message from an error caused on a failed request.
@@ -74,13 +47,10 @@ class APIClient extends import_api_utils.APIClient {
    */
   _getErrorMessageFromResponse(response) {
     const res = response;
-    if (res.error)
-      return res.error;
+    if (res.error) return res.error;
     if (res.data) {
-      if (res.data.message)
-        return res.data.message;
-      if (res.data.error)
-        return res.data.error;
+      if (res.data.message) return res.data.message;
+      if (res.data.error) return res.data.error;
     }
     return "Unexpected error";
   }
@@ -94,7 +64,7 @@ class APIClient extends import_api_utils.APIClient {
     return new this._HTTPError(this._getErrorMessageFromResponse(response), status);
   }
 }
-const apiClientProvider = (0, import_utils.providerCreator)(
+const apiClientProvider = providerCreator(
   (options = {}) => (app) => {
     const defaultName = "apiClient";
     const { serviceName = defaultName, clientClass: ClientClass = APIClient } = options;
@@ -114,9 +84,8 @@ const apiClientProvider = (0, import_utils.providerCreator)(
     );
   }
 );
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   APIClient,
   apiClientProvider
-});
+};
 //# sourceMappingURL=apiClient.js.map

package/dist/services/http/apiClient.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/http/apiClient.ts"],"sourcesContent":["import {\n  APIClient as APIClientBase,\n  type ErrorResponse,\n  type APIClientOptions,\n  type FetchClient,\n} from '@homer0/api-utils';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { providerCreator } from '../../utils';\nimport type { HTTP } from './http';\nimport type { HTTPErrorClass } from '../common';\n\nexport type { ErrorResponse };\n/**\n * The required settings needed to create the an API client.\n *\n * @group Services/APIClient\n */\nexport type APIClientConfig = Pick<APIClientOptions, 'url' | 'endpoints'>;\n/**\n * A dictionary of endpoints for the API client.\n * This is declared as standalone because it needs to reference them multiple times.\n *\n * @group Services/APIClient\n */\nexport type EndpointsType = APIClientOptions['endpoints'];\n/**\n * The format the settings needs to have in the application configuration in order to\n * create a valid API client.\n * The settings may include the endpoints dictionary in the `endpoints` property, or the\n * gateway `property`, with `endpoints` always having priority if both exists.\n * The reason for the `gateway` property to be valid, is in case the application also\n * implements a {@link GatewayController}, using the same property for both things will\n * help reduce the amount of duplicated definitions.\n *\n * @group Services/APIClient\n */\nexport type APIClientSettings = Omit<APIClientConfig, 'endpoints'> &\n  (\n    | {\n        endpoints: EndpointsType;\n        gateway?: EndpointsType;\n      }\n    | {\n        endpoints?: EndpointsType;\n        gateway: EndpointsType;\n      }\n  );\n/**\n * The options to construct a {@link APIClient}.\n *\n * @group Services/APIClient\n */\nexport type APIClientConstructorOptions = APIClientSettings & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    http: HTTP;\n    HTTPError: HTTPErrorClass;\n  };\n};\n/**\n * An API client for the application to use. What makes this service special is that it\n * formats received errors using the {@link _HTTPError} class, and as fetch client, it\n * uses the {@link HTTP} service, allowing the application to to internally handle all the\n * requests and responses.\n *\n * The only reason to use the class directly is if you want to subclass it, as you would\n * normally just register the {@link apiClientProvider}.\n *\n * @group Services\n * @group Services/APIClient\n */\nexport class APIClient extends APIClientBase {\n  /**\n   * The service that makes the requests to the API.\n   */\n  protected readonly _http: HTTP;\n  /**\n   * The class to generate possible errors in the requests.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * The configuration of the API it uses.\n   */\n  protected readonly _apiConfig: APIClientConfig;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({ inject: { http, HTTPError }, ...rest }: APIClientConstructorOptions) {\n    const { endpoints, gateway, url } = rest;\n    const useEndpoints = (endpoints || gateway)!;\n    const apiConfig = {\n      url,\n      endpoints: useEndpoints,\n    };\n    super({\n      ...apiConfig,\n      fetchClient: http.fetch as unknown as FetchClient,\n    });\n\n    this._http = http;\n    this._HTTPError = HTTPError;\n    this._apiConfig = deepAssignWithOverwrite({}, apiConfig);\n  }\n  /**\n   * The configuration for the API.\n   */\n  get apiConfig(): Readonly<APIClientConfig> {\n    return deepAssignWithOverwrite({}, this._apiConfig);\n  }\n  /**\n   * Tries to obtain a message from an error caused on a failed request.\n   *\n   * @param response  The response from the failed request.\n   */\n  protected _getErrorMessageFromResponse(response: unknown) {\n    const res = response as {\n      error?: string;\n      data?: {\n        message?: string;\n        error?: string;\n      };\n    };\n    if (res.error) return res.error;\n    if (res.data) {\n      if (res.data.message) return res.data.message;\n      if (res.data.error) return res.data.error;\n    }\n\n    return 'Unexpected error';\n  }\n  /**\n   * Generates an {@link _HTTPError} from the response of a failed request.\n   *\n   * @param response  The response from the failed request.\n   * @param status    The status code of the response.\n   */\n  protected override formatError<ResponseType extends ErrorResponse>(\n    response: ResponseType,\n    status: number,\n  ): Error {\n    return new this._HTTPError(this._getErrorMessageFromResponse(response), status);\n  }\n}\n/**\n * The options for the provider creator that registers an {@link APIClient} in the\n * container.\n * These options allow the application to register multiple instances for different APIs.\n *\n * @group Services/APIClient\n */\nexport type APIClientProviderOptions = {\n  /**\n   * The name of the service that will be registered into the app.\n   *\n   * @default 'apiClient'\n   */\n  serviceName?: string;\n  /**\n   * The name of the configuration setting that has the API information.\n   *\n   * @default 'api'\n   */\n  configSetting?: string;\n  /**\n   * The class the service will instantiate. It has to extend {@link APIClient}.\n   *\n   * @default APIClient\n   */\n  clientClass?: typeof APIClient;\n};\n/**\n * The provider creator to register an instance of {@link APIClient} on the container.\n *\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   // Register it on the container\n *   container.register(apiClientProvider);\n *   // Getting access to the service instance\n *   const apiClient = container.get<APIClient>('apiClient');\n *\n * @example\n *\n * <caption>With custom options</caption>\n *\n *   container.register(\n *     apiClientProvider({\n *       serviceName: 'myApiClient',\n *       configSetting: 'myApi',\n *     }),\n *   );\n *\n * @group Providers\n * @group Services/APIClient\n */\nexport const apiClientProvider = providerCreator(\n  (options: APIClientProviderOptions = {}) =>\n    (app) => {\n      const defaultName = 'apiClient';\n      const { serviceName = defaultName, clientClass: ClientClass = APIClient } = options;\n      let { configSetting } = options;\n      if (!configSetting) {\n        configSetting = serviceName === defaultName ? 'api' : serviceName;\n      }\n\n      app.set(\n        serviceName,\n        () =>\n          new ClientClass({\n            inject: {\n              http: app.get('http'),\n              HTTPError: app.get('HTTPError'),\n            },\n            ...app.getConfig<APIClientSettings>(configSetting!),\n          }),\n      );\n    },\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAKO;AACP,yBAAwC;AACxC,mBAAgC;AAkEzB,MAAM,kBAAkB,iBAAAA,UAAc;AAAA;AAAA;AAAA;AAAA,EAgB3C,YAAY,EAAE,QAAQ,EAAE,MAAM,UAAU,GAAG,GAAG,KAAK,GAAgC;AACjF,UAAM,EAAE,WAAW,SAAS,IAAI,IAAI;AACpC,UAAM,eAAgB,aAAa;AACnC,UAAM,YAAY;AAAA,MAChB;AAAA,MACA,WAAW;AAAA,IACb;AACA,UAAM;AAAA,MACJ,GAAG;AAAA,MACH,aAAa,KAAK;AAAA,IACpB,CAAC;AAtBH;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAgBjB,SAAK,QAAQ;AACb,SAAK,aAAa;AAClB,SAAK,iBAAa,4CAAwB,CAAC,GAAG,SAAS;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,YAAuC;AACzC,eAAO,4CAAwB,CAAC,GAAG,KAAK,UAAU;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,6BAA6B,UAAmB;AACxD,UAAM,MAAM;AAOZ,QAAI,IAAI;AAAO,aAAO,IAAI;AAC1B,QAAI,IAAI,MAAM;AACZ,UAAI,IAAI,KAAK;AAAS,eAAO,IAAI,KAAK;AACtC,UAAI,IAAI,KAAK;AAAO,eAAO,IAAI,KAAK;AAAA,IACtC;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOmB,YACjB,UACA,QACO;AACP,WAAO,IAAI,KAAK,WAAW,KAAK,6BAA6B,QAAQ,GAAG,MAAM;AAAA,EAChF;AACF;AAsDO,MAAM,wBAAoB;AAAA,EAC/B,CAAC,UAAoC,CAAC,MACpC,CAAC,QAAQ;AACP,UAAM,cAAc;AACpB,UAAM,EAAE,cAAc,aAAa,aAAa,cAAc,UAAU,IAAI;AAC5E,QAAI,EAAE,cAAc,IAAI;AACxB,QAAI,CAAC,eAAe;AAClB,sBAAgB,gBAAgB,cAAc,QAAQ;AAAA,IACxD;AAEA,QAAI;AAAA,MACF;AAAA,MACA,MACE,IAAI,YAAY;AAAA,QACd,QAAQ;AAAA,UACN,MAAM,IAAI,IAAI,MAAM;AAAA,UACpB,WAAW,IAAI,IAAI,WAAW;AAAA,QAChC;AAAA,QACA,GAAG,IAAI,UAA6B,aAAc;AAAA,MACpD,CAAC;AAAA,IACL;AAAA,EACF;AACJ;","names":["APIClientBase"]}
+{"version":3,"sources":["../../../src/services/http/apiClient.ts"],"sourcesContent":["import {\n  APIClient as APIClientBase,\n  type ErrorResponse,\n  type APIClientOptions,\n  type FetchClient,\n} from '@homer0/api-utils';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { providerCreator } from '../../utils/index.js';\nimport type { HTTP } from './http.js';\nimport type { HTTPErrorClass } from '../common/index.js';\n\nexport type { ErrorResponse };\n/**\n * The required settings needed to create the an API client.\n *\n * @group Services/APIClient\n */\nexport type APIClientConfig = Pick<APIClientOptions, 'url' | 'endpoints'>;\n/**\n * A dictionary of endpoints for the API client.\n * This is declared as standalone because it needs to reference them multiple times.\n *\n * @group Services/APIClient\n */\nexport type EndpointsType = APIClientOptions['endpoints'];\n/**\n * The format the settings needs to have in the application configuration in order to\n * create a valid API client.\n * The settings may include the endpoints dictionary in the `endpoints` property, or the\n * gateway `property`, with `endpoints` always having priority if both exists.\n * The reason for the `gateway` property to be valid, is in case the application also\n * implements a {@link GatewayController}, using the same property for both things will\n * help reduce the amount of duplicated definitions.\n *\n * @group Services/APIClient\n */\nexport type APIClientSettings = Omit<APIClientConfig, 'endpoints'> &\n  (\n    | {\n        endpoints: EndpointsType;\n        gateway?: EndpointsType;\n      }\n    | {\n        endpoints?: EndpointsType;\n        gateway: EndpointsType;\n      }\n  );\n/**\n * The options to construct a {@link APIClient}.\n *\n * @group Services/APIClient\n */\nexport type APIClientConstructorOptions = APIClientSettings & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    http: HTTP;\n    HTTPError: HTTPErrorClass;\n  };\n};\n/**\n * An API client for the application to use. What makes this service special is that it\n * formats received errors using the {@link _HTTPError} class, and as fetch client, it\n * uses the {@link HTTP} service, allowing the application to to internally handle all the\n * requests and responses.\n *\n * The only reason to use the class directly is if you want to subclass it, as you would\n * normally just register the {@link apiClientProvider}.\n *\n * @group Services\n * @group Services/APIClient\n */\nexport class APIClient extends APIClientBase {\n  /**\n   * The service that makes the requests to the API.\n   */\n  protected readonly _http: HTTP;\n  /**\n   * The class to generate possible errors in the requests.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * The configuration of the API it uses.\n   */\n  protected readonly _apiConfig: APIClientConfig;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({ inject: { http, HTTPError }, ...rest }: APIClientConstructorOptions) {\n    const { endpoints, gateway, url } = rest;\n    const useEndpoints = (endpoints || gateway)!;\n    const apiConfig = {\n      url,\n      endpoints: useEndpoints,\n    };\n    super({\n      ...apiConfig,\n      fetchClient: http.fetch as unknown as FetchClient,\n    });\n\n    this._http = http;\n    this._HTTPError = HTTPError;\n    this._apiConfig = deepAssignWithOverwrite({}, apiConfig);\n  }\n  /**\n   * The configuration for the API.\n   */\n  get apiConfig(): Readonly<APIClientConfig> {\n    return deepAssignWithOverwrite({}, this._apiConfig);\n  }\n  /**\n   * Tries to obtain a message from an error caused on a failed request.\n   *\n   * @param response  The response from the failed request.\n   */\n  protected _getErrorMessageFromResponse(response: unknown) {\n    const res = response as {\n      error?: string;\n      data?: {\n        message?: string;\n        error?: string;\n      };\n    };\n    if (res.error) return res.error;\n    if (res.data) {\n      if (res.data.message) return res.data.message;\n      if (res.data.error) return res.data.error;\n    }\n\n    return 'Unexpected error';\n  }\n  /**\n   * Generates an {@link _HTTPError} from the response of a failed request.\n   *\n   * @param response  The response from the failed request.\n   * @param status    The status code of the response.\n   */\n  protected override formatError<ResponseType extends ErrorResponse>(\n    response: ResponseType,\n    status: number,\n  ): Error {\n    return new this._HTTPError(this._getErrorMessageFromResponse(response), status);\n  }\n}\n/**\n * The options for the provider creator that registers an {@link APIClient} in the\n * container.\n * These options allow the application to register multiple instances for different APIs.\n *\n * @group Services/APIClient\n */\nexport type APIClientProviderOptions = {\n  /**\n   * The name of the service that will be registered into the app.\n   *\n   * @default 'apiClient'\n   */\n  serviceName?: string;\n  /**\n   * The name of the configuration setting that has the API information.\n   *\n   * @default 'api'\n   */\n  configSetting?: string;\n  /**\n   * The class the service will instantiate. It has to extend {@link APIClient}.\n   *\n   * @default APIClient\n   */\n  clientClass?: typeof APIClient;\n};\n/**\n * The provider creator to register an instance of {@link APIClient} on the container.\n *\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   // Register it on the container\n *   container.register(apiClientProvider);\n *   // Getting access to the service instance\n *   const apiClient = container.get<APIClient>('apiClient');\n *\n * @example\n *\n * <caption>With custom options</caption>\n *\n *   container.register(\n *     apiClientProvider({\n *       serviceName: 'myApiClient',\n *       configSetting: 'myApi',\n *     }),\n *   );\n *\n * @group Providers\n * @group Services/APIClient\n */\nexport const apiClientProvider = providerCreator(\n  (options: APIClientProviderOptions = {}) =>\n    (app) => {\n      const defaultName = 'apiClient';\n      const { serviceName = defaultName, clientClass: ClientClass = APIClient } = options;\n      let { configSetting } = options;\n      if (!configSetting) {\n        configSetting = serviceName === defaultName ? 'api' : serviceName;\n      }\n\n      app.set(\n        serviceName,\n        () =>\n          new ClientClass({\n            inject: {\n              http: app.get('http'),\n              HTTPError: app.get('HTTPError'),\n            },\n            ...app.getConfig<APIClientSettings>(configSetting!),\n          }),\n      );\n    },\n);\n"],"mappings":"AAAA;AAAA,EACE,aAAa;AAAA,OAIR;AACP,SAAS,+BAA+B;AACxC,SAAS,uBAAuB;AAkEzB,MAAM,kBAAkB,cAAc;AAAA;AAAA;AAAA;AAAA,EAIxB;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA;AAAA;AAAA;AAAA,EAInB,YAAY,EAAE,QAAQ,EAAE,MAAM,UAAU,GAAG,GAAG,KAAK,GAAgC;AACjF,UAAM,EAAE,WAAW,SAAS,IAAI,IAAI;AACpC,UAAM,eAAgB,aAAa;AACnC,UAAM,YAAY;AAAA,MAChB;AAAA,MACA,WAAW;AAAA,IACb;AACA,UAAM;AAAA,MACJ,GAAG;AAAA,MACH,aAAa,KAAK;AAAA,IACpB,CAAC;AAED,SAAK,QAAQ;AACb,SAAK,aAAa;AAClB,SAAK,aAAa,wBAAwB,CAAC,GAAG,SAAS;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,YAAuC;AACzC,WAAO,wBAAwB,CAAC,GAAG,KAAK,UAAU;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,6BAA6B,UAAmB;AACxD,UAAM,MAAM;AAOZ,QAAI,IAAI,MAAO,QAAO,IAAI;AAC1B,QAAI,IAAI,MAAM;AACZ,UAAI,IAAI,KAAK,QAAS,QAAO,IAAI,KAAK;AACtC,UAAI,IAAI,KAAK,MAAO,QAAO,IAAI,KAAK;AAAA,IACtC;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOmB,YACjB,UACA,QACO;AACP,WAAO,IAAI,KAAK,WAAW,KAAK,6BAA6B,QAAQ,GAAG,MAAM;AAAA,EAChF;AACF;AAsDO,MAAM,oBAAoB;AAAA,EAC/B,CAAC,UAAoC,CAAC,MACpC,CAAC,QAAQ;AACP,UAAM,cAAc;AACpB,UAAM,EAAE,cAAc,aAAa,aAAa,cAAc,UAAU,IAAI;AAC5E,QAAI,EAAE,cAAc,IAAI;AACxB,QAAI,CAAC,eAAe;AAClB,sBAAgB,gBAAgB,cAAc,QAAQ;AAAA,IACxD;AAEA,QAAI;AAAA,MACF;AAAA,MACA,MACE,IAAI,YAAY;AAAA,QACd,QAAQ;AAAA,UACN,MAAM,IAAI,IAAI,MAAM;AAAA,UACpB,WAAW,IAAI,IAAI,WAAW;AAAA,QAChC;AAAA,QACA,GAAG,IAAI,UAA6B,aAAc;AAAA,MACpD,CAAC;AAAA,IACL;AAAA,EACF;AACJ;","names":[]}

package/dist/services/http/http.d.ts

@@ -1,5 +1,5 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-C6I3NCC-.js';
+import { J as Jimpex } from '../../index-BlSpNHox.js';
 import { Request } from 'express';
 import { NodeFetch } from '../../types/http.js';
 import { SimpleLogger } from '@homer0/simple-logger';
@@ -29,7 +29,7 @@ type HTTPOptions = {
  *
  * @group Services/HTTP
  */
-type HTTPContructorOptions = Partial<HTTPOptions> & {
+type HTTPConstructorOptions = Partial<HTTPOptions> & {
     /**
      * A dictionary with the dependencies to inject.
      */
@@ -112,7 +112,7 @@ declare class HTTP {
     /**
      * @param options  The options to construct the class.
      */
-    constructor({ inject: { logger, nodeFetch }, ...options }: HTTPContructorOptions);
+    constructor({ inject: { logger, nodeFetch }, ...options }: HTTPConstructorOptions);
     /**
      * Makes a fetch request.
      *
@@ -138,7 +138,7 @@ declare class HTTP {
      * It takes a dictionary of headers and normalize the names so each word will start with
      * an upper case character. This is helpful in case you added custom headers and didn't
      * care about the casing, or when copying headers from a server request, as they all
-     * come tranformed into lower case.
+     * come transformed into lower case.
      *
      * @param headers  The dictionary of headers to normalize.
      */
@@ -179,4 +179,4 @@ declare class HTTP {
  */
 declare const httpProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
 
-export { type GetCustomHeadersFromRequestOptions, HTTP, type HTTPContructorOptions, type HTTPFetchBody, type HTTPFetchOptions, type HTTPOptions, httpProvider };
+export { type GetCustomHeadersFromRequestOptions, HTTP, type HTTPConstructorOptions, type HTTPFetchBody, type HTTPFetchOptions, type HTTPOptions, httpProvider };