jimpex 8.0.0 → 10.0.0

package/dist/services/http/responsesBuilder.d.mts

@@ -0,0 +1,179 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
+import { Response } from 'express';
+import { Statuses } from '../../utils/fns/statuses.mjs';
+import { SimpleConfig } from '@homer0/simple-config';
+import '../../types/express.mjs';
+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/events-hub';
+import 'statuses';
+
+/**
+ * The options to construct a {@link ResponsesBuilder}.
+ *
+ * @group Services/ResponsesBuilder
+ */
+type ResponsesBuilderConstructorOptions = {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        config: SimpleConfig;
+        statuses: Statuses;
+    };
+};
+/**
+ * The options to build a response for a post message.
+ *
+ * @group Services/ResponsesBuilder
+ */
+type HTMLPostMessageResponseOptions = {
+    /**
+     * The response object generated by the application.
+     */
+    res: Response;
+    /**
+     * The title for the HTML.
+     */
+    title: string;
+    /**
+     * The contents of the post message.
+     */
+    message: string;
+    /**
+     * The status code for the response.
+     *
+     * @default 200
+     */
+    status?: number | string;
+    /**
+     * From which object will the `postMessage` method called from.
+     *
+     * @default 'window.opener'
+     */
+    target?: string;
+    /**
+     * Whether or not to call `window.close` after sending the message.
+     *
+     * @default true
+     */
+    close?: boolean;
+    /**
+     * In case `close` is set to `true`, this option is to specify how many milliseconds
+     * should be waited before closing the window.
+     *
+     * @default 700
+     */
+    closeDelay?: number;
+};
+/**
+ * The options to build a reponse for JSON.
+ *
+ * @group Services/ResponsesBuilder
+ */
+type JSONResponseOptions = {
+    /**
+     * The response object generated by the application.
+     */
+    res: Response;
+    /**
+     * The actual data for the response. It will be added in a `data` property.
+     */
+    data: unknown;
+    /**
+     * The status code for the response.
+     *
+     * @default 200
+     */
+    status?: number | string;
+    /**
+     * Extra information to include inside the `metadata` object.
+     */
+    metadata?: object;
+};
+/**
+ * A utility service to build responses.
+ *
+ * @group Services
+ * @group Services/ResponsesBuilder
+ */
+declare class ResponsesBuilder {
+    /**
+     * The application configuration, to get the `version` and the `postMessagesPrefix`.
+     */
+    protected readonly _config: SimpleConfig;
+    /**
+     * The uility service to get HTTP status codes.
+     */
+    protected readonly _statuses: Statuses;
+    /**
+     * @param options  The options to construct the service.
+     */
+    constructor({ inject: { config, statuses } }: ResponsesBuilderConstructorOptions);
+    /**
+     * Generates and send an HTML response that emits a post message.
+     * The post message will be prefixed with the value of the configuration setting
+     * `postMessagesPrefix`.
+     *
+     * @param options  The options to customize how the HTML is generated.
+     */
+    htmlPostMessage(options: HTMLPostMessageResponseOptions): void;
+    /**
+     * Generates and sends a JSON response.
+     *
+     * @param options  The options to customize how the JSON is generated.
+     * @example
+     *
+     * <caption>The generated looks like this.</caption>
+     *
+     * {
+     *   metadata: {
+     *     version: 'dev',
+     *     status: 200,
+     *   },
+     *   data: { foo: 'bar' },
+     * }
+     *
+     */
+    json(options: JSONResponseOptions): void;
+    /**
+     * Generates a basic HTML template for the service to use when generating a post message
+     * response.
+     *
+     * @param title  The HTML `<title />` attribute.
+     * @param code   Javascript code to be wrapped on a `<script />` tag.
+     */
+    protected _htmlTemplate(title: string, code: string): string;
+    /**
+     * Utility method used to make sure a recevied status is a valid status code. If the
+     * status is a string, the method will try to find the code from the `statuses` package.
+     *
+     * @param status  The status to normalize.
+     * @returns If `status` is a string, but there's no valid code, it will return 200.
+     */
+    protected _normalizeStatus(status: number | string): number;
+}
+/**
+ * The service provider that once registered on the container will set an instance of
+ * {@link ResponsesBuilder} as the `responsesBuilder` service.
+ *
+ * @example
+ *
+ *   // Register it on the container
+ *   container.register(responsesBuilderProvider);
+ *   // Getting access to the service instance
+ *   const responsesBuilder = container.get<ResponsesBuilder>('responsesBuilder');
+ *
+ * @group Providers
+ * @group Services/ResponsesBuilder
+ */
+declare const responsesBuilderProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+
+export { type HTMLPostMessageResponseOptions, type JSONResponseOptions, ResponsesBuilder, type ResponsesBuilderConstructorOptions, responsesBuilderProvider };

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

@@ -1,9 +1,8 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../jimpex-7eaee271.js';
+import { J as Jimpex } from '../../index-C6I3NCC-.js';
 import { Response } from 'express';
 import { Statuses } from '../../utils/fns/statuses.js';
 import { SimpleConfig } from '@homer0/simple-config';
-import '@homer0/events-hub';
 import '../../types/express.js';
 import '../../types/http.js';
 import 'https';
@@ -11,7 +10,9 @@ import 'http';
 import 'spdy';
 import 'node-fetch';
 import '../../types/utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/events-hub';
 import 'statuses';
 
 /**
@@ -175,4 +176,4 @@ declare class ResponsesBuilder {
  */
 declare const responsesBuilderProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
 
-export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider };
+export { type HTMLPostMessageResponseOptions, type JSONResponseOptions, ResponsesBuilder, type ResponsesBuilderConstructorOptions, responsesBuilderProvider };

package/dist/services/http/responsesBuilder.js

@@ -30,12 +30,28 @@ module.exports = __toCommonJS(responsesBuilder_exports);
 var import_utils = require("../../utils");
 const DEFAULT_CLOSE_DELAY_FOR_POST_MESSAGE = 700;
 class ResponsesBuilder {
+  /**
+   * @param options  The options to construct the service.
+   */
   constructor({ inject: { config, statuses } }) {
+    /**
+     * The application configuration, to get the `version` and the `postMessagesPrefix`.
+     */
     __publicField(this, "_config");
+    /**
+     * The uility service to get HTTP status codes.
+     */
     __publicField(this, "_statuses");
     this._config = config;
     this._statuses = statuses;
   }
+  /**
+   * Generates and send an HTML response that emits a post message.
+   * The post message will be prefixed with the value of the configuration setting
+   * `postMessagesPrefix`.
+   *
+   * @param options  The options to customize how the HTML is generated.
+   */
   htmlPostMessage(options) {
     const {
       res,
@@ -66,6 +82,23 @@ class ResponsesBuilder {
     res.write(html);
     res.end();
   }
+  /**
+   * Generates and sends a JSON response.
+   *
+   * @param options  The options to customize how the JSON is generated.
+   * @example
+   *
+   * <caption>The generated looks like this.</caption>
+   *
+   * {
+   *   metadata: {
+   *     version: 'dev',
+   *     status: 200,
+   *   },
+   *   data: { foo: 'bar' },
+   * }
+   *
+   */
   json(options) {
     const { res, data, status, metadata = {} } = options;
     const useStatus = typeof status === "undefined" ? this._statuses("ok") : this._normalizeStatus(status);
@@ -80,6 +113,13 @@ class ResponsesBuilder {
     });
     res.end();
   }
+  /**
+   * Generates a basic HTML template for the service to use when generating a post message
+   * response.
+   *
+   * @param title  The HTML `<title />` attribute.
+   * @param code   Javascript code to be wrapped on a `<script />` tag.
+   */
   _htmlTemplate(title, code) {
     return `
       <!DOCTYPE html>
@@ -93,11 +133,18 @@ class ResponsesBuilder {
         <body>
           <script type="text/javascript">
           ${code}
-        <\/script>
+        </script>
       </body>
     </html>
     `;
   }
+  /**
+   * Utility method used to make sure a recevied status is a valid status code. If the
+   * status is a string, the method will try to find the code from the `statuses` package.
+   *
+   * @param status  The status to normalize.
+   * @returns If `status` is a string, but there's no valid code, it will return 200.
+   */
   _normalizeStatus(status) {
     let useStatus;
     try {

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/http/responsesBuilder.ts"],"sourcesContent":["import type { Config, Response } from '../../types';\nimport { provider, type Statuses } from '../../utils';\n/**\n * The options to construct a {@link ResponsesBuilder}.\n *\n * @group Services/ResponsesBuilder\n */\nexport type ResponsesBuilderConstructorOptions = {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    config: Config;\n    statuses: Statuses;\n  };\n};\n/**\n * The options to build a response for a post message.\n *\n * @group Services/ResponsesBuilder\n */\nexport type HTMLPostMessageResponseOptions = {\n  /**\n   * The response object generated by the application.\n   */\n  res: Response;\n  /**\n   * The title for the HTML.\n   */\n  title: string;\n  /**\n   * The contents of the post message.\n   */\n  message: string;\n  /**\n   * The status code for the response.\n   *\n   * @default 200\n   */\n  status?: number | string;\n  /**\n   * From which object will the `postMessage` method called from.\n   *\n   * @default 'window.opener'\n   */\n  target?: string;\n  /**\n   * Whether or not to call `window.close` after sending the message.\n   *\n   * @default true\n   */\n  close?: boolean;\n  /**\n   * In case `close` is set to `true`, this option is to specify how many milliseconds\n   * should be waited before closing the window.\n   *\n   * @default 700\n   */\n  closeDelay?: number;\n};\n/**\n * The options to build a reponse for JSON.\n *\n * @group Services/ResponsesBuilder\n */\nexport type JSONResponseOptions = {\n  /**\n   * The response object generated by the application.\n   */\n  res: Response;\n  /**\n   * The actual data for the response. It will be added in a `data` property.\n   */\n  data: unknown;\n  /**\n   * The status code for the response.\n   *\n   * @default 200\n   */\n  status?: number | string;\n  /**\n   * Extra information to include inside the `metadata` object.\n   */\n  metadata?: object;\n};\n/**\n * The default time to wait before closing a window, in case it's enabled.\n */\nconst DEFAULT_CLOSE_DELAY_FOR_POST_MESSAGE = 700;\n/**\n * A utility service to build responses.\n *\n * @group Services\n * @group Services/ResponsesBuilder\n */\nexport class ResponsesBuilder {\n  /**\n   * The application configuration, to get the `version` and the `postMessagesPrefix`.\n   */\n  protected readonly _config: Config;\n  /**\n   * The uility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * @param options  The options to construct the service.\n   */\n  constructor({ inject: { config, statuses } }: ResponsesBuilderConstructorOptions) {\n    this._config = config;\n    this._statuses = statuses;\n  }\n  /**\n   * Generates and send an HTML response that emits a post message.\n   * The post message will be prefixed with the value of the configuration setting\n   * `postMessagesPrefix`.\n   *\n   * @param options  The options to customize how the HTML is generated.\n   */\n  htmlPostMessage(options: HTMLPostMessageResponseOptions): void {\n    const {\n      res,\n      title,\n      message,\n      status,\n      target = 'window.opener',\n      close = true,\n      closeDelay = DEFAULT_CLOSE_DELAY_FOR_POST_MESSAGE,\n    } = options;\n    const prefix = this._config.get<string | undefined>('postMessagesPrefix') ?? '';\n    const closeCode = close\n      ? `setTimeout(function() { window.close(); }, ${closeDelay});`\n      : '';\n\n    const html = this._htmlTemplate(\n      title,\n      `\n      (function() {\n        if (${target}) {\n          ${target}.postMessage('${prefix}${message}', '*');\n          ${closeCode}\n        }\n      })();\n      `,\n    );\n\n    const useStatus =\n      typeof status === 'undefined'\n        ? (this._statuses('ok') as number)\n        : this._normalizeStatus(status);\n\n    res.setHeader('Content-Type', 'text/html');\n    res.setHeader('Cache-Control', 'no-cache, max-age=0, must-revalidate, no-store');\n    res.status(useStatus);\n    res.write(html);\n    res.end();\n  }\n  /**\n   * Generates and sends a JSON response.\n   *\n   * @param options  The options to customize how the JSON is generated.\n   * @example\n   *\n   * <caption>The generated looks like this.</caption>\n   *\n   * {\n   *   metadata: {\n   *     version: 'dev',\n   *     status: 200,\n   *   },\n   *   data: { foo: 'bar' },\n   * }\n   *\n   */\n  json(options: JSONResponseOptions): void {\n    const { res, data, status, metadata = {} } = options;\n    const useStatus =\n      typeof status === 'undefined'\n        ? (this._statuses('ok') as number)\n        : this._normalizeStatus(status);\n\n    res.status(useStatus);\n    res.json({\n      metadata: {\n        version: this._config.get<string>('version'),\n        status: useStatus,\n        ...metadata,\n      },\n      data,\n    });\n    res.end();\n  }\n  /**\n   * Generates a basic HTML template for the service to use when generating a post message\n   * response.\n   *\n   * @param title  The HTML `<title />` attribute.\n   * @param code   Javascript code to be wrapped on a `<script />` tag.\n   */\n  protected _htmlTemplate(title: string, code: string): string {\n    return `\n      <!DOCTYPE html>\n      <html>\n        <head>\n          <meta charset=\"utf-8\" />\n          <meta http-equiv=\"x-ua-compatible\" content=\"ie=edge\" />\n          <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n          <title>${title}</title>\n        </head>\n        <body>\n          <script type=\"text/javascript\">\n          ${code}\n        </script>\n      </body>\n    </html>\n    `;\n  }\n  /**\n   * Utility method used to make sure a recevied status is a valid status code. If the\n   * status is a string, the method will try to find the code from the `statuses` package.\n   *\n   * @param status  The status to normalize.\n   * @returns If `status` is a string, but there's no valid code, it will return 200.\n   */\n  protected _normalizeStatus(status: number | string): number {\n    let useStatus: number;\n    try {\n      if (typeof status === 'string') {\n        useStatus = this._statuses(status) as number;\n      } else {\n        this._statuses(status);\n        useStatus = status;\n      }\n    } catch (_) {\n      useStatus = this._statuses('ok') as number;\n    }\n\n    return useStatus;\n  }\n}\n/**\n * The service provider that once registered on the container will set an instance of\n * {@link ResponsesBuilder} as the `responsesBuilder` service.\n *\n * @example\n *\n *   // Register it on the container\n *   container.register(responsesBuilderProvider);\n *   // Getting access to the service instance\n *   const responsesBuilder = container.get<ResponsesBuilder>('responsesBuilder');\n *\n * @group Providers\n * @group Services/ResponsesBuilder\n */\nexport const responsesBuilderProvider = provider((app) => {\n  app.set(\n    'responsesBuilder',\n    () =>\n      new ResponsesBuilder({\n        inject: {\n          config: app.getConfig(),\n          statuses: app.get('statuses'),\n        },\n      }),\n  );\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,mBAAwC;AAuFxC,MAAM,uCAAuC;AAOtC,MAAM,iBAAiB;AAAA,EAY5B,YAAY,EAAE,QAAQ,EAAE,QAAQ,SAAS,EAAE,GAAuC;AARlF,wBAAmB;AAInB,wBAAmB;AAKjB,SAAK,UAAU;AACf,SAAK,YAAY;AAAA,EACnB;AAAA,EAQA,gBAAgB,SAA+C;AAC7D,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,aAAa;AAAA,IACf,IAAI;AACJ,UAAM,SAAS,KAAK,QAAQ,IAAwB,oBAAoB,KAAK;AAC7E,UAAM,YAAY,QACd,8CAA8C,iBAC9C;AAEJ,UAAM,OAAO,KAAK;AAAA,MAChB;AAAA,MACA;AAAA;AAAA,cAEQ;AAAA,YACF,uBAAuB,SAAS;AAAA,YAChC;AAAA;AAAA;AAAA;AAAA,IAIR;AAEA,UAAM,YACJ,OAAO,WAAW,cACb,KAAK,UAAU,IAAI,IACpB,KAAK,iBAAiB,MAAM;AAElC,QAAI,UAAU,gBAAgB,WAAW;AACzC,QAAI,UAAU,iBAAiB,gDAAgD;AAC/E,QAAI,OAAO,SAAS;AACpB,QAAI,MAAM,IAAI;AACd,QAAI,IAAI;AAAA,EACV;AAAA,EAkBA,KAAK,SAAoC;AACvC,UAAM,EAAE,KAAK,MAAM,QAAQ,WAAW,CAAC,EAAE,IAAI;AAC7C,UAAM,YACJ,OAAO,WAAW,cACb,KAAK,UAAU,IAAI,IACpB,KAAK,iBAAiB,MAAM;AAElC,QAAI,OAAO,SAAS;AACpB,QAAI,KAAK;AAAA,MACP,UAAU;AAAA,QACR,SAAS,KAAK,QAAQ,IAAY,SAAS;AAAA,QAC3C,QAAQ;AAAA,QACR,GAAG;AAAA,MACL;AAAA,MACA;AAAA,IACF,CAAC;AACD,QAAI,IAAI;AAAA,EACV;AAAA,EAQU,cAAc,OAAe,MAAsB;AAC3D,WAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAOQ;AAAA;AAAA;AAAA;AAAA,YAIP;AAAA;AAAA;AAAA;AAAA;AAAA,EAKV;AAAA,EAQU,iBAAiB,QAAiC;AAC1D,QAAI;AACJ,QAAI;AACF,UAAI,OAAO,WAAW,UAAU;AAC9B,oBAAY,KAAK,UAAU,MAAM;AAAA,MACnC,OAAO;AACL,aAAK,UAAU,MAAM;AACrB,oBAAY;AAAA,MACd;AAAA,IACF,SAAS,GAAP;AACA,kBAAY,KAAK,UAAU,IAAI;AAAA,IACjC;AAEA,WAAO;AAAA,EACT;AACF;AAeO,MAAM,+BAA2B,uBAAS,CAAC,QAAQ;AACxD,MAAI;AAAA,IACF;AAAA,IACA,MACE,IAAI,iBAAiB;AAAA,MACnB,QAAQ;AAAA,QACN,QAAQ,IAAI,UAAU;AAAA,QACtB,UAAU,IAAI,IAAI,UAAU;AAAA,MAC9B;AAAA,IACF,CAAC;AAAA,EACL;AACF,CAAC;","names":[]}
+{"version":3,"sources":["../../../src/services/http/responsesBuilder.ts"],"sourcesContent":["import type { Config, Response } from '../../types';\nimport { provider, type Statuses } from '../../utils';\n/**\n * The options to construct a {@link ResponsesBuilder}.\n *\n * @group Services/ResponsesBuilder\n */\nexport type ResponsesBuilderConstructorOptions = {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    config: Config;\n    statuses: Statuses;\n  };\n};\n/**\n * The options to build a response for a post message.\n *\n * @group Services/ResponsesBuilder\n */\nexport type HTMLPostMessageResponseOptions = {\n  /**\n   * The response object generated by the application.\n   */\n  res: Response;\n  /**\n   * The title for the HTML.\n   */\n  title: string;\n  /**\n   * The contents of the post message.\n   */\n  message: string;\n  /**\n   * The status code for the response.\n   *\n   * @default 200\n   */\n  status?: number | string;\n  /**\n   * From which object will the `postMessage` method called from.\n   *\n   * @default 'window.opener'\n   */\n  target?: string;\n  /**\n   * Whether or not to call `window.close` after sending the message.\n   *\n   * @default true\n   */\n  close?: boolean;\n  /**\n   * In case `close` is set to `true`, this option is to specify how many milliseconds\n   * should be waited before closing the window.\n   *\n   * @default 700\n   */\n  closeDelay?: number;\n};\n/**\n * The options to build a reponse for JSON.\n *\n * @group Services/ResponsesBuilder\n */\nexport type JSONResponseOptions = {\n  /**\n   * The response object generated by the application.\n   */\n  res: Response;\n  /**\n   * The actual data for the response. It will be added in a `data` property.\n   */\n  data: unknown;\n  /**\n   * The status code for the response.\n   *\n   * @default 200\n   */\n  status?: number | string;\n  /**\n   * Extra information to include inside the `metadata` object.\n   */\n  metadata?: object;\n};\n/**\n * The default time to wait before closing a window, in case it's enabled.\n */\nconst DEFAULT_CLOSE_DELAY_FOR_POST_MESSAGE = 700;\n/**\n * A utility service to build responses.\n *\n * @group Services\n * @group Services/ResponsesBuilder\n */\nexport class ResponsesBuilder {\n  /**\n   * The application configuration, to get the `version` and the `postMessagesPrefix`.\n   */\n  protected readonly _config: Config;\n  /**\n   * The uility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * @param options  The options to construct the service.\n   */\n  constructor({ inject: { config, statuses } }: ResponsesBuilderConstructorOptions) {\n    this._config = config;\n    this._statuses = statuses;\n  }\n  /**\n   * Generates and send an HTML response that emits a post message.\n   * The post message will be prefixed with the value of the configuration setting\n   * `postMessagesPrefix`.\n   *\n   * @param options  The options to customize how the HTML is generated.\n   */\n  htmlPostMessage(options: HTMLPostMessageResponseOptions): void {\n    const {\n      res,\n      title,\n      message,\n      status,\n      target = 'window.opener',\n      close = true,\n      closeDelay = DEFAULT_CLOSE_DELAY_FOR_POST_MESSAGE,\n    } = options;\n    const prefix = this._config.get<string | undefined>('postMessagesPrefix') ?? '';\n    const closeCode = close\n      ? `setTimeout(function() { window.close(); }, ${closeDelay});`\n      : '';\n\n    const html = this._htmlTemplate(\n      title,\n      `\n      (function() {\n        if (${target}) {\n          ${target}.postMessage('${prefix}${message}', '*');\n          ${closeCode}\n        }\n      })();\n      `,\n    );\n\n    const useStatus =\n      typeof status === 'undefined'\n        ? (this._statuses('ok') as number)\n        : this._normalizeStatus(status);\n\n    res.setHeader('Content-Type', 'text/html');\n    res.setHeader('Cache-Control', 'no-cache, max-age=0, must-revalidate, no-store');\n    res.status(useStatus);\n    res.write(html);\n    res.end();\n  }\n  /**\n   * Generates and sends a JSON response.\n   *\n   * @param options  The options to customize how the JSON is generated.\n   * @example\n   *\n   * <caption>The generated looks like this.</caption>\n   *\n   * {\n   *   metadata: {\n   *     version: 'dev',\n   *     status: 200,\n   *   },\n   *   data: { foo: 'bar' },\n   * }\n   *\n   */\n  json(options: JSONResponseOptions): void {\n    const { res, data, status, metadata = {} } = options;\n    const useStatus =\n      typeof status === 'undefined'\n        ? (this._statuses('ok') as number)\n        : this._normalizeStatus(status);\n\n    res.status(useStatus);\n    res.json({\n      metadata: {\n        version: this._config.get<string>('version'),\n        status: useStatus,\n        ...metadata,\n      },\n      data,\n    });\n    res.end();\n  }\n  /**\n   * Generates a basic HTML template for the service to use when generating a post message\n   * response.\n   *\n   * @param title  The HTML `<title />` attribute.\n   * @param code   Javascript code to be wrapped on a `<script />` tag.\n   */\n  protected _htmlTemplate(title: string, code: string): string {\n    return `\n      <!DOCTYPE html>\n      <html>\n        <head>\n          <meta charset=\"utf-8\" />\n          <meta http-equiv=\"x-ua-compatible\" content=\"ie=edge\" />\n          <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n          <title>${title}</title>\n        </head>\n        <body>\n          <script type=\"text/javascript\">\n          ${code}\n        </script>\n      </body>\n    </html>\n    `;\n  }\n  /**\n   * Utility method used to make sure a recevied status is a valid status code. If the\n   * status is a string, the method will try to find the code from the `statuses` package.\n   *\n   * @param status  The status to normalize.\n   * @returns If `status` is a string, but there's no valid code, it will return 200.\n   */\n  protected _normalizeStatus(status: number | string): number {\n    let useStatus: number;\n    try {\n      if (typeof status === 'string') {\n        useStatus = this._statuses(status) as number;\n      } else {\n        this._statuses(status);\n        useStatus = status;\n      }\n    } catch (_) {\n      useStatus = this._statuses('ok') as number;\n    }\n\n    return useStatus;\n  }\n}\n/**\n * The service provider that once registered on the container will set an instance of\n * {@link ResponsesBuilder} as the `responsesBuilder` service.\n *\n * @example\n *\n *   // Register it on the container\n *   container.register(responsesBuilderProvider);\n *   // Getting access to the service instance\n *   const responsesBuilder = container.get<ResponsesBuilder>('responsesBuilder');\n *\n * @group Providers\n * @group Services/ResponsesBuilder\n */\nexport const responsesBuilderProvider = provider((app) => {\n  app.set(\n    'responsesBuilder',\n    () =>\n      new ResponsesBuilder({\n        inject: {\n          config: app.getConfig(),\n          statuses: app.get('statuses'),\n        },\n      }),\n  );\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,mBAAwC;AAuFxC,MAAM,uCAAuC;AAOtC,MAAM,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAY5B,YAAY,EAAE,QAAQ,EAAE,QAAQ,SAAS,EAAE,GAAuC;AARlF;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAKjB,SAAK,UAAU;AACf,SAAK,YAAY;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,gBAAgB,SAA+C;AAC7D,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,aAAa;AAAA,IACf,IAAI;AACJ,UAAM,SAAS,KAAK,QAAQ,IAAwB,oBAAoB,KAAK;AAC7E,UAAM,YAAY,QACd,8CAA8C,UAAU,OACxD;AAEJ,UAAM,OAAO,KAAK;AAAA,MAChB;AAAA,MACA;AAAA;AAAA,cAEQ,MAAM;AAAA,YACR,MAAM,iBAAiB,MAAM,GAAG,OAAO;AAAA,YACvC,SAAS;AAAA;AAAA;AAAA;AAAA,IAIjB;AAEA,UAAM,YACJ,OAAO,WAAW,cACb,KAAK,UAAU,IAAI,IACpB,KAAK,iBAAiB,MAAM;AAElC,QAAI,UAAU,gBAAgB,WAAW;AACzC,QAAI,UAAU,iBAAiB,gDAAgD;AAC/E,QAAI,OAAO,SAAS;AACpB,QAAI,MAAM,IAAI;AACd,QAAI,IAAI;AAAA,EACV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,KAAK,SAAoC;AACvC,UAAM,EAAE,KAAK,MAAM,QAAQ,WAAW,CAAC,EAAE,IAAI;AAC7C,UAAM,YACJ,OAAO,WAAW,cACb,KAAK,UAAU,IAAI,IACpB,KAAK,iBAAiB,MAAM;AAElC,QAAI,OAAO,SAAS;AACpB,QAAI,KAAK;AAAA,MACP,UAAU;AAAA,QACR,SAAS,KAAK,QAAQ,IAAY,SAAS;AAAA,QAC3C,QAAQ;AAAA,QACR,GAAG;AAAA,MACL;AAAA,MACA;AAAA,IACF,CAAC;AACD,QAAI,IAAI;AAAA,EACV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,cAAc,OAAe,MAAsB;AAC3D,WAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAOQ,KAAK;AAAA;AAAA;AAAA;AAAA,YAIZ,IAAI;AAAA;AAAA;AAAA;AAAA;AAAA,EAKd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,iBAAiB,QAAiC;AAC1D,QAAI;AACJ,QAAI;AACF,UAAI,OAAO,WAAW,UAAU;AAC9B,oBAAY,KAAK,UAAU,MAAM;AAAA,MACnC,OAAO;AACL,aAAK,UAAU,MAAM;AACrB,oBAAY;AAAA,MACd;AAAA,IACF,SAAS,GAAG;AACV,kBAAY,KAAK,UAAU,IAAI;AAAA,IACjC;AAEA,WAAO;AAAA,EACT;AACF;AAeO,MAAM,+BAA2B,uBAAS,CAAC,QAAQ;AACxD,MAAI;AAAA,IACF;AAAA,IACA,MACE,IAAI,iBAAiB;AAAA,MACnB,QAAQ;AAAA,QACN,QAAQ,IAAI,UAAU;AAAA,QACtB,UAAU,IAAI,IAAI,UAAU;AAAA,MAC9B;AAAA,IACF,CAAC;AAAA,EACL;AACF,CAAC;","names":[]}

package/dist/services/index.d.mts

@@ -0,0 +1,33 @@
+export { commonServicesProvider } from './common/index.mjs';
+export { frontendServicesProvider } from './frontend/index.mjs';
+export { htmlServicesProvider } from './html/index.mjs';
+export { httpServicesProvider } from './http/index.mjs';
+export { utilsServicesProvider } from './utils/index.mjs';
+export { AppError, AppErrorClass, AppErrorContext, CreateAppErrorFn, appErrorProvider, createAppError } from './common/appError.mjs';
+export { CreateHTTPErrorFn, HTTPError, HTTPErrorClass, createHTTPError, httpErrorProvider } from './common/httpError.mjs';
+export { SendFile, SendFileGeneratorOptions, SendFileOptions, sendFile, sendFileProvider } from './common/sendFile.mjs';
+export { FrontendFs, FrontendFsOptions, frontendFsProvider } from './frontend/frontendFs.mjs';
+export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorProviderOptions, HTMLGeneratorValuesService, htmlGeneratorProvider } from './html/htmlGenerator.mjs';
+export { ErrorResponse } from '@homer0/api-utils';
+export { APIClient, APIClientConfig, APIClientConstructorOptions, APIClientProviderOptions, APIClientSettings, EndpointsType, apiClientProvider } from './http/apiClient.mjs';
+export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFetchBody, HTTPFetchOptions, HTTPOptions, httpProvider } from './http/http.mjs';
+export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider } from './http/responsesBuilder.mjs';
+export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, EnsureBearerTokenProviderOptions, ensureBearerTokenProvider } from './utils/ensureBearerToken.mjs';
+import '@homer0/jimple';
+import '../index-Bwf7JHu9.mjs';
+import '../types/express.mjs';
+import 'express';
+import '../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '../types/utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../utils/fns/statuses.mjs';
+import 'statuses';
+import 'fs/promises';
+import '@homer0/deferred';

package/dist/services/index.d.ts

@@ -14,8 +14,7 @@ export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFe
 export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider } from './http/responsesBuilder.js';
 export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, EnsureBearerTokenProviderOptions, ensureBearerTokenProvider } from './utils/ensureBearerToken.js';
 import '@homer0/jimple';
-import '../jimpex-7eaee271.js';
-import '@homer0/events-hub';
+import '../index-C6I3NCC-.js';
 import '../types/express.js';
 import 'express';
 import '../types/http.js';
@@ -23,11 +22,12 @@ import 'https';
 import 'http';
 import 'spdy';
 import 'node-fetch';
-import '@homer0/simple-config';
 import '../types/utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import '../utils/fns/statuses.js';
 import 'statuses';
-import '@homer0/path-utils';
 import 'fs/promises';
 import '@homer0/deferred';

package/dist/services/index.js

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

package/dist/services/utils/ensureBearerToken.d.mts

@@ -0,0 +1,158 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
+import { ExpressMiddleware } from '../../types/express.mjs';
+import { Statuses } from '../../utils/fns/statuses.mjs';
+import { DeepPartial } from '../../types/utils.mjs';
+import { HTTPErrorClass } from '../common/httpError.mjs';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import 'express';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import 'statuses';
+import '../common/appError.mjs';
+
+/**
+ * The options for the error the middleare can generate.
+ *
+ * @group Services/EnsureBearerToken
+ */
+type EnsureBearerTokenErrorOptions = {
+    /**
+     * The error message for the response.
+     *
+     * @default 'Unauthorized'
+     */
+    message: string;
+    /**
+     * The HTTP status that will be added to the error context.
+     *
+     * @default 401
+     */
+    status: number;
+    /**
+     * Context information for the error handler and that can be added to the actual
+     * response.
+     */
+    response: unknown;
+};
+/**
+ * The options to customize the service/middleware.
+ *
+ * @group Services/EnsureBearerToken
+ */
+type EnsureBearerTokenOptions = {
+    error: EnsureBearerTokenErrorOptions;
+    expression: RegExp;
+    local: string;
+};
+/**
+ * The options to construct a {@link EnsureBearerToken}.
+ *
+ * @group Services/EnsureBearerToken
+ */
+type EnsureBearerConstructorOptions = DeepPartial<EnsureBearerTokenOptions> & {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        HTTPError: HTTPErrorClass;
+        statuses: Statuses;
+    };
+};
+/**
+ * Custom options for the provider that will register an instance of
+ * {@link EnsureBearerToken}
+ * as a service.
+ *
+ * @group Services/EnsureBearerToken
+ */
+type EnsureBearerTokenProviderOptions = DeepPartial<EnsureBearerTokenOptions> & {
+    /**
+     * 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 'ensureBearerToken'
+     */
+    serviceName?: string;
+};
+/**
+ * This service gives you a middleware that verifies if a request has an `Authorization`
+ * header with a bearer token; if it does, the token will be saved on the `res.locals`,
+ * otherwise, it will generate an error.
+ *
+ * This is a "service middleware" to allow certain flexibility: you can have controllers
+ * where some routes are protected and others are not. For those cases, you get the
+ * service from the container, and include it only in the routes that need it.
+ *
+ * @group Services
+ * @group Services/EnsureBearerToken
+ */
+declare class EnsureBearerToken {
+    /**
+     * To generate the errors when the validation fails.
+     */
+    protected readonly _HTTPError: HTTPErrorClass;
+    /**
+     * The customization options for the service.
+     */
+    protected readonly _options: EnsureBearerTokenOptions;
+    /**
+     * @param options  The options to construct the class.
+     */
+    constructor({ inject: { HTTPError, statuses }, ...options }: EnsureBearerConstructorOptions);
+    /**
+     * Generates the middleware that verifies if a request has an `Authorization` header
+     * with a bearer token.
+     */
+    getMiddleware(): ExpressMiddleware;
+    /**
+     * The customization options.
+     */
+    get options(): Readonly<EnsureBearerTokenOptions>;
+}
+/**
+ * Generates a "service middleware" that can be used on route controllers in order to
+ * validate the presence of a bearer token on the requests authorization header.
+ *
+ * The registered service is an instance of {@link EnsureBearerToken}, and it uses the key
+ * `ensureBearerToken`.
+ *
+ * Since it's a "provider creator", when registering it, you can pass custom options.
+ *
+ * @example
+ *
+ * <caption>Basic usage</caption>
+ *
+ *   // Register it on the container
+ *   container.register(ensureBearerTokenProvider);
+ *
+ *   // Let's assume we are in a controller now...
+ *   // Getting access to the middleware.
+ *   const ensureBearerToken = container.get<ExpressMiddleware>('ensureBearerToken');
+ *
+ * @example
+ *
+ * <caption>Customizing the service</caption>
+ *
+ *   // Register it on the container
+ *   container.register(
+ *     ensureBearerTokenProvider({
+ *       serviceName: 'ensureBearerTokenCustom',
+ *       error: {
+ *         message: 'Missing token!',
+ *       },
+ *     }),
+ *   );
+ *
+ * @group Providers
+ * @group Services/EnsureBearerToken
+ */
+declare const ensureBearerTokenProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: EnsureBearerTokenProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+
+export { type EnsureBearerConstructorOptions, EnsureBearerToken, type EnsureBearerTokenErrorOptions, type EnsureBearerTokenOptions, type EnsureBearerTokenProviderOptions, ensureBearerTokenProvider };

package/dist/services/utils/ensureBearerToken.d.ts

@@ -1,18 +1,19 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../jimpex-7eaee271.js';
+import { J as Jimpex } from '../../index-C6I3NCC-.js';
 import { ExpressMiddleware } from '../../types/express.js';
 import { Statuses } from '../../utils/fns/statuses.js';
 import { DeepPartial } from '../../types/utils.js';
 import { HTTPErrorClass } from '../common/httpError.js';
-import '@homer0/events-hub';
-import 'express';
 import '../../types/http.js';
 import 'https';
 import 'http';
 import 'spdy';
 import 'node-fetch';
-import '@homer0/simple-config';
+import 'express';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import 'statuses';
 import '../common/appError.js';
 
@@ -154,4 +155,4 @@ declare class EnsureBearerToken {
  */
 declare const ensureBearerTokenProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: EnsureBearerTokenProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
 
-export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, EnsureBearerTokenProviderOptions, ensureBearerTokenProvider };
+export { type EnsureBearerConstructorOptions, EnsureBearerToken, type EnsureBearerTokenErrorOptions, type EnsureBearerTokenOptions, type EnsureBearerTokenProviderOptions, ensureBearerTokenProvider };

package/dist/services/utils/ensureBearerToken.js

@@ -30,11 +30,20 @@ module.exports = __toCommonJS(ensureBearerToken_exports);
 var import_deep_assign = require("@homer0/deep-assign");
 var import_utils = require("../../utils");
 class EnsureBearerToken {
+  /**
+   * @param options  The options to construct the class.
+   */
   constructor({
     inject: { HTTPError, statuses },
     ...options
   }) {
+    /**
+     * To generate the errors when the validation fails.
+     */
     __publicField(this, "_HTTPError");
+    /**
+     * The customization options for the service.
+     */
     __publicField(this, "_options");
     this._HTTPError = HTTPError;
     this._options = (0, import_deep_assign.deepAssignWithOverwrite)(
@@ -50,6 +59,10 @@ class EnsureBearerToken {
       options
     );
   }
+  /**
+   * Generates the middleware that verifies if a request has an `Authorization` header
+   * with a bearer token.
+   */
   getMiddleware() {
     return (req, res, next) => {
       let unauthorized = true;
@@ -78,6 +91,9 @@ class EnsureBearerToken {
       }
     };
   }
+  /**
+   * The customization options.
+   */
   get options() {
     return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
   }