jimpex 7.0.2 → 9.0.0

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

@@ -0,0 +1,237 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-b2a04c78.js';
+import { SimpleLogger } from '@homer0/simple-logger';
+import { SimpleConfig } from '@homer0/simple-config';
+import { FrontendFs } from '../frontend/frontendFs.js';
+import { DeferredPromise } from '@homer0/deferred';
+import '../../types/express.js';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '../../types/utils.js';
+import '@homer0/path-utils';
+import '@homer0/events-hub';
+import 'fs/promises';
+
+/**
+ * The options to customize a {@link HTMLGenerator} instance.
+ *
+ * @group Services/HTMLGenerator
+ */
+type HTMLGeneratorOptions = {
+    /**
+     * The name of the file it should use as template.
+     *
+     * @default 'index.tpl.html'
+     */
+    template: string;
+    /**
+     * The name of the generated file.
+     *
+     * @default 'index.html'
+     */
+    file: string;
+    /**
+     * If `true`, it won't log messages on the terminal when generating the file.
+     *
+     * @default false
+     */
+    silent: boolean;
+    /**
+     * Whether or not to delete the tempalte after generating the file.
+     *
+     * @default true
+     */
+    deleteTemplateAfter: boolean;
+    /**
+     * The placeholder string where the information will be written.
+     *
+     * @default /\{\{appConfi(?:guration)?\}\}/
+     */
+    replacePlaceholder: string | RegExp;
+    /**
+     * A regular expression for dynamic placeholders that will be replaced by values when
+     * the file is generated.
+     *
+     * @default /\{\{(.*?)\}\}/gi
+     */
+    placeholderExpression: RegExp;
+    /**
+     * The name of the variable that will have the information on the file.
+     *
+     * @default 'appConfig'
+     */
+    variableName: string;
+    /**
+     * A list of settings from the app configuration that will be used as the information to
+     * inject on the file.
+     *
+     * @default ['features', 'version', 'postMessagesPrefix']
+     */
+    configKeys: string[];
+};
+/**
+ * An external service that can be used to provide the values the generator will replace
+ * in the template.
+ *
+ * @group Services/HTMLGenerator
+ */
+type HTMLGeneratorValuesService = {
+    /**
+     * A function that will be called to get the values to replace in the template.
+     *
+     * @param options  The service customization options.
+     */
+    getValues: (options: HTMLGeneratorOptions) => Promise<Record<string, unknown>>;
+};
+/**
+ * The options to construct a {@link HTMLGenerator}.
+ *
+ * @group Services/HTMLGenerator
+ */
+type HTMLGeneratorConstructorOptions = Partial<HTMLGeneratorOptions> & {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        config: SimpleConfig;
+        logger: SimpleLogger;
+        frontendFs: FrontendFs;
+        /**
+         * A service that can provide the values to replace in the template. If specified, the
+         * values from `configKeys` will be ignored.
+         */
+        valuesService?: HTMLGeneratorValuesService;
+    };
+};
+/**
+ * Custom options for the provider that will register an instance of {@link HTMLGenerator}
+ * as a service.
+ *
+ * @group Services/HTMLGenerator
+ */
+type HTMLGeneratorProviderOptions = Partial<HTMLGeneratorOptions> & {
+    /**
+     * The name that will be used to register the service on the container. This is to allow
+     * multiple "instances" of the service to be created.
+     *
+     * @default 'htmlGenerator'
+     */
+    serviceName?: string;
+    /**
+     * The name of a service that the generator will use in order to read the values that
+     * will be replaced on the template. If the service is available, the values from
+     * `configKeys` will be ignored.
+     *
+     * @default 'htmlGeneratorValues'
+     */
+    valuesServiceName?: string;
+};
+/**
+ * This is a utility service that generates an HTML file with custom information when the
+ * application is started.
+ *
+ * @group Services
+ * @group Services/HTMLGenerator
+ */
+declare class HTMLGenerator {
+    /**
+     * The service customization options.
+     */
+    protected readonly _options: HTMLGeneratorOptions;
+    /**
+     * The application configuration service, to get the settings specified by the
+     * `configKeys` option.
+     */
+    protected readonly _config: SimpleConfig;
+    /**
+     * The service that logs messages on the terminal, in case the `silent` option is `false`.
+     */
+    protected readonly _logger: SimpleLogger;
+    /**
+     * The service that interacts with the filesystem.
+     */
+    protected readonly _frontendFs: FrontendFs;
+    /**
+     * A service that can provide values to be replaced in the template.
+     */
+    protected readonly _valuesService?: HTMLGeneratorValuesService;
+    /**
+     * Whether or not the file was already generated.
+     */
+    protected _fileReady: boolean;
+    /**
+     * 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.
+     */
+    protected _fileDeferred?: DeferredPromise<void>;
+    /**
+     * @param options  The options to construct the class.
+     * @throws If `valuesService` is specified but it doesn't have a `getValues`
+     *         method.
+     */
+    constructor({ inject: { config, logger, frontendFs, valuesService }, ...options }: HTMLGeneratorConstructorOptions);
+    /**
+     * Gets a promise that will be resolved when the file has been generated.
+     */
+    whenReady(): Promise<void>;
+    /**
+     * Generates the HTML file.
+     */
+    generateHTML(): Promise<void>;
+    /**
+     * Gets the customization options.
+     */
+    get options(): Readonly<HTMLGeneratorOptions>;
+    /**
+     * Helper method to get the values that will be replaced in the template. If a "values
+     * service" was specified in the constructor, it will get the values from there,
+     * otherwise, it will use the `configKeys` option to get the values from the
+     * application configuration.
+     */
+    protected _getValues(): Promise<Record<string, unknown>>;
+    /**
+     * Processes the HTML template by replacing the placeholders with the actual values.
+     *
+     * @param template  The template for the HTML file.
+     * @param values    The values dictionary that should be replaced in the template.
+     */
+    protected _processHTML(template: string, values: Record<string, unknown>): string;
+}
+/**
+ * The service provider that once registered on the container will set an instance of
+ * {@link HTMLGenerator} as the `htmlGenerator` service. it will also hook itself to the
+ * `after-start` event of the application in order to trigger the generator of the HTML
+ * file.
+ *
+ * @example
+ *
+ * <caption>Basic usage</caption>
+ *
+ *   // Register it on the container
+ *   container.register(htmlGeneratorProvider);
+ *   // Getting access to the service instance
+ *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');
+ *
+ * @example
+ *
+ * <caption>Using with custom options</caption>
+ *
+ *   container.register(
+ *     htmlGeneratorProvider({
+ *       serviceName: 'myHtmlGenerator',
+ *       valuesServiceName: 'myValuesService',
+ *       template: 'my-template.tpl.html',
+ *     }),
+ *   );
+ *
+ * @group Providers
+ * @group Services/HTMLGenerator
+ */
+declare const htmlGeneratorProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: HTMLGeneratorProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+
+export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorProviderOptions, HTMLGeneratorValuesService, htmlGeneratorProvider };

package/dist/services/html/htmlGenerator.js

@@ -0,0 +1,221 @@
+"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");
+class HTMLGenerator {
+  /**
+   * @param options  The options to construct the class.
+   * @throws If `valuesService` is specified but it doesn't have a `getValues`
+   *         method.
+   */
+  constructor({
+    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)(
+      {
+        template: "index.tpl.html",
+        file: "index.html",
+        silent: false,
+        deleteTemplateAfter: true,
+        replacePlaceholder: /\{\{appConfig(?:uration)?\}\}/,
+        placeholderExpression: /\{\{(.*?)\}\}/gi,
+        variableName: "appConfig",
+        configKeys: ["features", "version", "postMessagesPrefix"]
+      },
+      options
+    );
+    if (this._valuesService && typeof this._valuesService.getValues !== "function") {
+      throw new Error("The HTMLGenerator values service must have a `getValues` method");
+    }
+  }
+  /**
+   * Gets a promise that will be resolved when the file has been generated.
+   */
+  whenReady() {
+    return this._fileDeferred ? this._fileDeferred.promise : Promise.resolve();
+  }
+  /**
+   * 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)();
+    const { template, deleteTemplateAfter, file, silent } = this._options;
+    try {
+      const templateContents = await this._frontendFs.read(template);
+      const values = await this._getValues();
+      const html = this._processHTML(templateContents, values);
+      await this._frontendFs.write(file, html);
+      if (!silent) {
+        this._logger.success(`The HTML file was successfully generated (${file})`);
+      }
+      if (deleteTemplateAfter) {
+        await this._frontendFs.delete(template);
+        if (!silent) {
+          this._logger.info(`The HTML template was successfully removed (${template})`);
+        }
+      }
+      this._fileReady = true;
+      this._fileDeferred.resolve();
+      this._fileDeferred = void 0;
+      return void 0;
+    } catch (error) {
+      this._fileDeferred.reject(error);
+      this._fileDeferred = void 0;
+      if (!silent) {
+        this._logger.error("There was an error while generating the HTML");
+      }
+      throw error;
+    }
+  }
+  /**
+   * Gets the customization options.
+   */
+  get options() {
+    return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
+  }
+  /**
+   * Helper method to get the values that will be replaced in the template. If a "values
+   * service" was specified in the constructor, it will get the values from there,
+   * otherwise, it will use the `configKeys` option to get the values from the
+   * application configuration.
+   */
+  _getValues() {
+    if (this._valuesService) {
+      return this._valuesService.getValues(this._options);
+    }
+    const { configKeys } = this._options;
+    if (configKeys && configKeys.length) {
+      return Promise.resolve(this._config.get(configKeys));
+    }
+    return Promise.resolve({});
+  }
+  /**
+   * Processes the HTML template by replacing the placeholders with the actual values.
+   *
+   * @param template  The template for the HTML file.
+   * @param values    The values dictionary that should be replaced in the template.
+   */
+  _processHTML(template, values) {
+    const { replacePlaceholder, placeholderExpression, variableName } = this._options;
+    const htmlObject = JSON.stringify(values);
+    let code = template.replace(
+      replacePlaceholder,
+      `window.${variableName} = ${htmlObject}`
+    );
+    const matches = [];
+    let match = placeholderExpression.exec(code);
+    while (match) {
+      const [string, value] = match;
+      if (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)));
+    });
+    return code;
+  }
+}
+const htmlGeneratorProvider = (0, import_utils.providerCreator)(
+  (options = {}) => (app) => {
+    const {
+      serviceName = "htmlGenerator",
+      valuesServiceName = "htmlGeneratorValues",
+      ...rest
+    } = options;
+    app.set(
+      serviceName,
+      () => new HTMLGenerator({
+        inject: {
+          config: app.get("config"),
+          logger: app.get("logger"),
+          frontendFs: app.get("frontendFs"),
+          valuesService: app.try(valuesServiceName)
+        },
+        ...rest
+      })
+    );
+    app.once("afterStart", () => {
+      app.get(serviceName).generateHTML();
+    });
+  }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HTMLGenerator,
+  htmlGeneratorProvider
+});
+//# sourceMappingURL=htmlGenerator.js.map

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

@@ -0,0 +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":[]}

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

@@ -0,0 +1,43 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-efeb437e.js';
+import { HTMLGeneratorProviderOptions } from './htmlGenerator.mjs';
+export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorValuesService, htmlGeneratorProvider } from './htmlGenerator.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 '../frontend/frontendFs.mjs';
+import 'fs/promises';
+import '@homer0/deferred';
+
+/**
+ * Registers all the HTML services on the container.
+ *
+ * - {@link HTMLGenerator | htmlGenerator}
+ *
+ * @example
+ *
+ *   // Register the collection on the container
+ *   container.register(htmlServicesProvider);
+ *   // Getting access to one the services instance
+ *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');
+ *
+ * @group Providers
+ */
+declare const htmlServicesProvider: {
+    htmlGeneratorProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: HTMLGeneratorProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+} & Record<string, _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>> & {
+    provider: true;
+} & {
+    register: _homer0_jimple.ProviderRegisterFn<Jimpex>;
+} & Record<string, unknown>;
+
+export { HTMLGeneratorProviderOptions, htmlServicesProvider };

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

@@ -0,0 +1,43 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-b2a04c78.js';
+import { HTMLGeneratorProviderOptions } from './htmlGenerator.js';
+export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorValuesService, htmlGeneratorProvider } from './htmlGenerator.js';
+import '../../types/express.js';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '../../types/utils.js';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../frontend/frontendFs.js';
+import 'fs/promises';
+import '@homer0/deferred';
+
+/**
+ * Registers all the HTML services on the container.
+ *
+ * - {@link HTMLGenerator | htmlGenerator}
+ *
+ * @example
+ *
+ *   // Register the collection on the container
+ *   container.register(htmlServicesProvider);
+ *   // Getting access to one the services instance
+ *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');
+ *
+ * @group Providers
+ */
+declare const htmlServicesProvider: {
+    htmlGeneratorProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: HTMLGeneratorProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+} & Record<string, _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>> & {
+    provider: true;
+} & {
+    register: _homer0_jimple.ProviderRegisterFn<Jimpex>;
+} & Record<string, unknown>;
+
+export { HTMLGeneratorProviderOptions, htmlServicesProvider };

package/dist/services/html/index.js

@@ -0,0 +1,36 @@
+"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")
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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":[]}