jimpex 8.0.0 → 10.0.0

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

@@ -0,0 +1,182 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
+import { Request } from 'express';
+import { NodeFetch } from '../../types/http.mjs';
+import { SimpleLogger } from '@homer0/simple-logger';
+import { BodyInit, Response, RequestInit } from 'node-fetch';
+import '../../types/express.mjs';
+import '../../types/utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import 'https';
+import 'http';
+import 'spdy';
+
+/**
+ * The options to customize the service.
+ *
+ * @group Services/HTTP
+ */
+type HTTPOptions = {
+    /**
+     * Whether or not the service should log the requests and their responses.
+     */
+    logRequests?: boolean;
+};
+/**
+ * The options to construct a {@link HTTP}.
+ *
+ * @group Services/HTTP
+ */
+type HTTPContructorOptions = Partial<HTTPOptions> & {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        logger: SimpleLogger;
+        nodeFetch: NodeFetch;
+    };
+};
+/**
+ * The allowed formats for the body of a request.
+ *
+ * @group Services/HTTP
+ */
+type HTTPFetchBody = string | Record<string | number, unknown> | BodyInit;
+/**
+ * The options for a request.
+ *
+ * @group Services/HTTP
+ */
+type HTTPFetchOptions = {
+    /**
+     * The HTTP method.
+     *
+     * @default 'GET'
+     */
+    method?: string;
+    /**
+     * The headers dictionary.
+     */
+    headers?: Record<string, string>;
+    /**
+     * The body of the request.
+     */
+    body?: HTTPFetchBody;
+    /**
+     * A dictionary of query string parameters.
+     */
+    qs?: Record<string, unknown>;
+    /**
+     * A request object generated by the application. This can be used to copy information
+     * like custom headers or the IP (for the X-Forwarded-For header).
+     */
+    req?: Request;
+};
+/**
+ * The options for the method that extracts custom headers from a request.
+ *
+ * @group Services/HTTP
+ */
+type GetCustomHeadersFromRequestOptions = {
+    /**
+     * Since the method considers all headers that start with `x-` as custom headers,
+     * setting this to `false` is the only way to exclude `x-forwarded-` headers from the
+     * list.
+     *
+     * @default false
+     */
+    includeXForwardedHeaders?: boolean;
+};
+/**
+ * A set of utilities to work with HTTP requests and responses.
+ *
+ * @group Services
+ * @group Services/HTTP
+ */
+declare class HTTP {
+    /**
+     * The service used to log information in the terminal.
+     */
+    protected readonly _logger: SimpleLogger;
+    /**
+     * The node-fetch library. Since it's an ESM only module, Jimpex loads it on boot and makes
+     * it available on the container.
+     */
+    protected readonly _nodeFetch: NodeFetch;
+    /**
+     * The service customization options.
+     */
+    protected readonly _options: HTTPOptions;
+    /**
+     * @param options  The options to construct the class.
+     */
+    constructor({ inject: { logger, nodeFetch }, ...options }: HTTPContructorOptions);
+    /**
+     * Makes a fetch request.
+     *
+     * @param url      The URL to fetch.
+     * @param options  The custom options for the request.
+     */
+    fetch(url: string, options?: HTTPFetchOptions): Promise<Response>;
+    /**
+     * Tries to get the IP address from a given request.
+     *
+     * @param req  The request from which it will try to obtain the IP address.
+     */
+    getIPFromRequest(req: Request): string | undefined;
+    /**
+     * Creates a dictionary with all the custom headers a request has. By custom header it
+     * means all the headers which name start with `x-`.
+     *
+     * @param req      The request from which it will try to get the headers.
+     * @param options  The options to customize the behavior with certain headers.
+     */
+    getCustomHeadersFromRequest(req: Request, options?: GetCustomHeadersFromRequestOptions): Record<string, string>;
+    /**
+     * 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.
+     *
+     * @param headers  The dictionary of headers to normalize.
+     */
+    normalizeHeaders(headers: Record<string, string>): Record<string, string>;
+    /**
+     * The customization options.
+     */
+    get options(): Readonly<HTTPOptions>;
+    /**
+     * Logs a request information into the terminal.
+     *
+     * @param url      The request URL.
+     * @param options  The options for the request.
+     */
+    protected _logRequest(url: string, options: RequestInit): void;
+    /**
+     * Logs a response information into the terminal.
+     *
+     * @param response  The response to log.
+     */
+    protected _logResponse(response: Response): void;
+}
+/**
+ * The service provider that once registered on the container will set an instance of
+ * {@link HTTP} as the `http` service. The provider also checks the `debug.logRequests`
+ * setting on the application configuration in order to enable or not the logging of
+ * requests/responses.
+ *
+ * @example
+ *
+ *   // Register it on the container
+ *   container.register(httpProvider);
+ *   // Getting access to the service instance
+ *   const http = container.get<HTTP>('http');
+ *
+ * @group Providers
+ * @group Services/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 };

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

@@ -1,16 +1,17 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../jimpex-7eaee271.js';
+import { J as Jimpex } from '../../index-C6I3NCC-.js';
 import { Request } from 'express';
-import { BodyInit, Response, RequestInit } from 'node-fetch';
+import { NodeFetch } from '../../types/http.js';
 import { SimpleLogger } from '@homer0/simple-logger';
-import '@homer0/events-hub';
+import { BodyInit, Response, RequestInit } from 'node-fetch';
 import '../../types/express.js';
-import '../../types/http.js';
+import '../../types/utils.js';
+import '@homer0/path-utils';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import 'https';
 import 'http';
 import 'spdy';
-import '@homer0/simple-config';
-import '../../types/utils.js';
 
 /**
  * The options to customize the service.
@@ -34,6 +35,7 @@ type HTTPContructorOptions = Partial<HTTPOptions> & {
      */
     inject: {
         logger: SimpleLogger;
+        nodeFetch: NodeFetch;
     };
 };
 /**
@@ -98,6 +100,11 @@ declare class HTTP {
      * The service used to log information in the terminal.
      */
     protected readonly _logger: SimpleLogger;
+    /**
+     * The node-fetch library. Since it's an ESM only module, Jimpex loads it on boot and makes
+     * it available on the container.
+     */
+    protected readonly _nodeFetch: NodeFetch;
     /**
      * The service customization options.
      */
@@ -105,7 +112,7 @@ declare class HTTP {
     /**
      * @param options  The options to construct the class.
      */
-    constructor({ inject: { logger }, ...options }: HTTPContructorOptions);
+    constructor({ inject: { logger, nodeFetch }, ...options }: HTTPContructorOptions);
     /**
      * Makes a fetch request.
      *
@@ -172,4 +179,4 @@ declare class HTTP {
  */
 declare const httpProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
 
-export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFetchBody, HTTPFetchOptions, HTTPOptions, httpProvider };
+export { type GetCustomHeadersFromRequestOptions, HTTP, type HTTPContructorOptions, type HTTPFetchBody, type HTTPFetchOptions, type HTTPOptions, httpProvider };

package/dist/services/http/http.js

@@ -19,6 +19,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -33,15 +37,29 @@ __export(http_exports, {
   httpProvider: () => httpProvider
 });
 module.exports = __toCommonJS(http_exports);
-var import_node_fetch = __toESM(require("node-fetch"));
 var import_urijs = __toESM(require("urijs"));
 var import_deep_assign = require("@homer0/deep-assign");
 var import_utils = require("../../utils");
 class HTTP {
-  constructor({ inject: { logger }, ...options }) {
+  /**
+   * @param options  The options to construct the class.
+   */
+  constructor({ inject: { logger, nodeFetch }, ...options }) {
+    /**
+     * The service used to log information in the terminal.
+     */
     __publicField(this, "_logger");
+    /**
+     * The node-fetch library. Since it's an ESM only module, Jimpex loads it on boot and makes
+     * it available on the container.
+     */
+    __publicField(this, "_nodeFetch");
+    /**
+     * The service customization options.
+     */
     __publicField(this, "_options");
     this._logger = logger;
+    this._nodeFetch = nodeFetch;
     this._options = (0, import_deep_assign.deepAssignWithOverwrite)(
       {
         logRequests: false
@@ -50,6 +68,12 @@ class HTTP {
     );
     this.fetch = this.fetch.bind(this);
   }
+  /**
+   * Makes a fetch request.
+   *
+   * @param url      The URL to fetch.
+   * @param options  The custom options for the request.
+   */
   async fetch(url, options = {}) {
     let useURL = url;
     if (options.qs) {
@@ -78,12 +102,17 @@ class HTTP {
     if (logRequests) {
       this._logRequest(useURL, fetchOptions);
     }
-    const response = await (0, import_node_fetch.default)(useURL, fetchOptions);
+    const response = await this._nodeFetch(useURL, fetchOptions);
     if (logRequests) {
       this._logResponse(response);
     }
     return response;
   }
+  /**
+   * Tries to get the IP address from a given request.
+   *
+   * @param req  The request from which it will try to obtain the IP address.
+   */
   getIPFromRequest(req) {
     const headerValue = req.headers["x-forwarded-for"];
     if (headerValue) {
@@ -91,6 +120,13 @@ class HTTP {
     }
     return req?.connection?.remoteAddress || req?.socket?.remoteAddress;
   }
+  /**
+   * Creates a dictionary with all the custom headers a request has. By custom header it
+   * means all the headers which name start with `x-`.
+   *
+   * @param req      The request from which it will try to get the headers.
+   * @param options  The options to customize the behavior with certain headers.
+   */
   getCustomHeadersFromRequest(req, options = {}) {
     const { includeXForwardedHeaders = false } = options;
     return Object.keys(req.headers).reduce((acc, headerName) => {
@@ -100,6 +136,14 @@ class HTTP {
       return acc;
     }, {});
   }
+  /**
+   * 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.
+   *
+   * @param headers  The dictionary of headers to normalize.
+   */
   normalizeHeaders(headers) {
     return Object.keys(headers).reduce((acc, name) => {
       const newName = name.split("-").map((part) => part.replace(/^(\w)/, (_, letter) => letter.toUpperCase())).join("-");
@@ -107,9 +151,18 @@ class HTTP {
       return acc;
     }, {});
   }
+  /**
+   * The customization options.
+   */
   get options() {
     return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
   }
+  /**
+   * Logs a request information into the terminal.
+   *
+   * @param url      The request URL.
+   * @param options  The options for the request.
+   */
   _logRequest(url, options) {
     const { method, headers } = options;
     const prefix = "REQUEST> ";
@@ -125,6 +178,11 @@ class HTTP {
     }
     this._logger.info(lines);
   }
+  /**
+   * Logs a response information into the terminal.
+   *
+   * @param response  The response to log.
+   */
   _logResponse(response) {
     const prefix = "RESPONSE> ";
     const lines = [
@@ -144,7 +202,8 @@ const httpProvider = (0, import_utils.provider)((app) => {
     const logRequests = config.get("debug.logRequests") === true;
     return new HTTP({
       inject: {
-        logger: app.get("logger")
+        logger: app.get("logger"),
+        nodeFetch: app.get("node-fetch")
       },
       logRequests
     });

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/http/http.ts"],"sourcesContent":["import fetch, { type RequestInit, type BodyInit } from 'node-fetch';\nimport urijs from 'urijs';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { provider } from '../../utils';\nimport { Logger, Request, HTTPResponse } from '../../types';\n/**\n * The options to customize the service.\n *\n * @group Services/HTTP\n */\nexport type HTTPOptions = {\n  /**\n   * Whether or not the service should log the requests and their responses.\n   */\n  logRequests?: boolean;\n};\n/**\n * The options to construct a {@link HTTP}.\n *\n * @group Services/HTTP\n */\nexport type HTTPContructorOptions = Partial<HTTPOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    logger: Logger;\n  };\n};\n/**\n * The allowed formats for the body of a request.\n *\n * @group Services/HTTP\n */\nexport type HTTPFetchBody = string | Record<string | number, unknown> | BodyInit;\n/**\n * The options for a request.\n *\n * @group Services/HTTP\n */\nexport type HTTPFetchOptions = {\n  /**\n   * The HTTP method.\n   *\n   * @default 'GET'\n   */\n  method?: string;\n  /**\n   * The headers dictionary.\n   */\n  headers?: Record<string, string>;\n  /**\n   * The body of the request.\n   */\n  body?: HTTPFetchBody;\n  /**\n   * A dictionary of query string parameters.\n   */\n  qs?: Record<string, unknown>;\n  /**\n   * A request object generated by the application. This can be used to copy information\n   * like custom headers or the IP (for the X-Forwarded-For header).\n   */\n  req?: Request;\n};\n/**\n * The options for the method that extracts custom headers from a request.\n *\n * @group Services/HTTP\n */\nexport type GetCustomHeadersFromRequestOptions = {\n  /**\n   * Since the method considers all headers that start with `x-` as custom headers,\n   * setting this to `false` is the only way to exclude `x-forwarded-` headers from the\n   * list.\n   *\n   * @default false\n   */\n  includeXForwardedHeaders?: boolean;\n};\n/**\n * A set of utilities to work with HTTP requests and responses.\n *\n * @group Services\n * @group Services/HTTP\n */\nexport class HTTP {\n  /**\n   * The service used to log information in the terminal.\n   */\n  protected readonly _logger: Logger;\n  /**\n   * The service customization options.\n   */\n  protected readonly _options: HTTPOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({ inject: { logger }, ...options }: HTTPContructorOptions) {\n    this._logger = logger;\n    this._options = deepAssignWithOverwrite(\n      {\n        logRequests: false,\n      },\n      options,\n    );\n\n    this.fetch = this.fetch.bind(this);\n  }\n  /**\n   * Makes a fetch request.\n   *\n   * @param url      The URL to fetch.\n   * @param options  The custom options for the request.\n   */\n  async fetch(url: string, options: HTTPFetchOptions = {}): Promise<HTTPResponse> {\n    let useURL = url;\n    if (options.qs) {\n      useURL = urijs(url).query(options.qs).toString();\n    }\n\n    const fetchOptions: RequestInit = {\n      method: (options.method || 'get').toUpperCase(),\n      body: options.body as BodyInit,\n    };\n\n    let defaultHeaders: Record<string, string> | undefined;\n    if (options.req) {\n      defaultHeaders = this.getCustomHeadersFromRequest(options.req);\n      const ip = this.getIPFromRequest(options.req);\n      if (ip) {\n        defaultHeaders['x-forwarded-for'] = ip;\n      }\n    }\n    const headers = {\n      ...defaultHeaders,\n      ...options.headers,\n    };\n\n    if (Object.keys(headers).length) {\n      fetchOptions.headers = this.normalizeHeaders(headers);\n    }\n\n    const { logRequests } = this._options;\n    if (logRequests) {\n      this._logRequest(useURL, fetchOptions);\n    }\n\n    const response = await fetch(useURL, fetchOptions);\n    if (logRequests) {\n      this._logResponse(response);\n    }\n\n    return response;\n  }\n  /**\n   * Tries to get the IP address from a given request.\n   *\n   * @param req  The request from which it will try to obtain the IP address.\n   */\n  getIPFromRequest(req: Request): string | undefined {\n    const headerValue = req.headers['x-forwarded-for'];\n    if (headerValue) {\n      return String(headerValue);\n    }\n\n    return req?.connection?.remoteAddress || req?.socket?.remoteAddress;\n  }\n  /**\n   * Creates a dictionary with all the custom headers a request has. By custom header it\n   * means all the headers which name start with `x-`.\n   *\n   * @param req      The request from which it will try to get the headers.\n   * @param options  The options to customize the behavior with certain headers.\n   */\n  getCustomHeadersFromRequest(\n    req: Request,\n    options: GetCustomHeadersFromRequestOptions = {},\n  ): Record<string, string> {\n    const { includeXForwardedHeaders = false } = options;\n    return Object.keys(req.headers).reduce<Record<string, string>>((acc, headerName) => {\n      if (\n        headerName.startsWith('x-') &&\n        (includeXForwardedHeaders || !headerName.startsWith('x-forwarded-'))\n      ) {\n        acc[headerName] = req.headers[headerName] as string;\n      }\n      return acc;\n    }, {});\n  }\n  /**\n   * It takes a dictionary of headers and normalize the names so each word will start with\n   * an upper case character. This is helpful in case you added custom headers and didn't\n   * care about the casing, or when copying headers from a server request, as they all\n   * come tranformed into lower case.\n   *\n   * @param headers  The dictionary of headers to normalize.\n   */\n  normalizeHeaders(headers: Record<string, string>): Record<string, string> {\n    return Object.keys(headers).reduce<Record<string, string>>((acc, name) => {\n      const newName = name\n        .split('-')\n        .map((part) => part.replace(/^(\\w)/, (_, letter) => letter.toUpperCase()))\n        .join('-');\n\n      acc[newName] = headers[name]!;\n      return acc;\n    }, {});\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<HTTPOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Logs a request information into the terminal.\n   *\n   * @param url      The request URL.\n   * @param options  The options for the request.\n   */\n  protected _logRequest(url: string, options: RequestInit): void {\n    const { method, headers } = options;\n    const prefix = 'REQUEST> ';\n    const lines = ['--->>', `${prefix}${method} ${url}`];\n    if (headers) {\n      Object.keys(headers).forEach((header) => {\n        const value = headers[header as keyof typeof headers];\n        lines.push(`${prefix}${header}: ${value}`);\n      });\n    }\n\n    if (options.body) {\n      lines.push(`${prefix}body: \"${options.body}\"`);\n    }\n\n    this._logger.info(lines);\n  }\n  /**\n   * Logs a response information into the terminal.\n   *\n   * @param response  The response to log.\n   */\n  protected _logResponse(response: HTTPResponse) {\n    const prefix = 'RESPONSE> ';\n    const lines = [\n      '<<---',\n      `${prefix}${response.url}`,\n      `${prefix}status: ${response.status}`,\n    ];\n\n    response.headers.forEach((value, header) => {\n      lines.push(`${prefix}${header}: ${value}`);\n    });\n\n    this._logger.info(lines);\n  }\n}\n/**\n * The service provider that once registered on the container will set an instance of\n * {@link HTTP} as the `http` service. The provider also checks the `debug.logRequests`\n * setting on the application configuration in order to enable or not the logging of\n * requests/responses.\n *\n * @example\n *\n *   // Register it on the container\n *   container.register(httpProvider);\n *   // Getting access to the service instance\n *   const http = container.get<HTTP>('http');\n *\n * @group Providers\n * @group Services/HTTP\n */\nexport const httpProvider = provider((app) => {\n  app.set('http', () => {\n    const config = app.getConfig();\n    const logRequests = config.get<boolean | undefined>('debug.logRequests') === true;\n    return new HTTP({\n      inject: {\n        logger: app.get('logger'),\n      },\n      logRequests,\n    });\n  });\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAuD;AACvD,mBAAkB;AAClB,yBAAwC;AACxC,mBAAyB;AAmFlB,MAAM,KAAK;AAAA,EAYhB,YAAY,EAAE,QAAQ,EAAE,OAAO,MAAM,QAAQ,GAA0B;AARvE,wBAAmB;AAInB,wBAAmB;AAKjB,SAAK,UAAU;AACf,SAAK,eAAW;AAAA,MACd;AAAA,QACE,aAAa;AAAA,MACf;AAAA,MACA;AAAA,IACF;AAEA,SAAK,QAAQ,KAAK,MAAM,KAAK,IAAI;AAAA,EACnC;AAAA,EAOA,MAAM,MAAM,KAAa,UAA4B,CAAC,GAA0B;AAC9E,QAAI,SAAS;AACb,QAAI,QAAQ,IAAI;AACd,mBAAS,aAAAA,SAAM,GAAG,EAAE,MAAM,QAAQ,EAAE,EAAE,SAAS;AAAA,IACjD;AAEA,UAAM,eAA4B;AAAA,MAChC,SAAS,QAAQ,UAAU,OAAO,YAAY;AAAA,MAC9C,MAAM,QAAQ;AAAA,IAChB;AAEA,QAAI;AACJ,QAAI,QAAQ,KAAK;AACf,uBAAiB,KAAK,4BAA4B,QAAQ,GAAG;AAC7D,YAAM,KAAK,KAAK,iBAAiB,QAAQ,GAAG;AAC5C,UAAI,IAAI;AACN,uBAAe,qBAAqB;AAAA,MACtC;AAAA,IACF;AACA,UAAM,UAAU;AAAA,MACd,GAAG;AAAA,MACH,GAAG,QAAQ;AAAA,IACb;AAEA,QAAI,OAAO,KAAK,OAAO,EAAE,QAAQ;AAC/B,mBAAa,UAAU,KAAK,iBAAiB,OAAO;AAAA,IACtD;AAEA,UAAM,EAAE,YAAY,IAAI,KAAK;AAC7B,QAAI,aAAa;AACf,WAAK,YAAY,QAAQ,YAAY;AAAA,IACvC;AAEA,UAAM,WAAW,UAAM,kBAAAC,SAAM,QAAQ,YAAY;AACjD,QAAI,aAAa;AACf,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA,EAMA,iBAAiB,KAAkC;AACjD,UAAM,cAAc,IAAI,QAAQ;AAChC,QAAI,aAAa;AACf,aAAO,OAAO,WAAW;AAAA,IAC3B;AAEA,WAAO,KAAK,YAAY,iBAAiB,KAAK,QAAQ;AAAA,EACxD;AAAA,EAQA,4BACE,KACA,UAA8C,CAAC,GACvB;AACxB,UAAM,EAAE,2BAA2B,MAAM,IAAI;AAC7C,WAAO,OAAO,KAAK,IAAI,OAAO,EAAE,OAA+B,CAAC,KAAK,eAAe;AAClF,UACE,WAAW,WAAW,IAAI,MACzB,4BAA4B,CAAC,WAAW,WAAW,cAAc,IAClE;AACA,YAAI,cAAc,IAAI,QAAQ;AAAA,MAChC;AACA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AAAA,EASA,iBAAiB,SAAyD;AACxE,WAAO,OAAO,KAAK,OAAO,EAAE,OAA+B,CAAC,KAAK,SAAS;AACxE,YAAM,UAAU,KACb,MAAM,GAAG,EACT,IAAI,CAAC,SAAS,KAAK,QAAQ,SAAS,CAAC,GAAG,WAAW,OAAO,YAAY,CAAC,CAAC,EACxE,KAAK,GAAG;AAEX,UAAI,WAAW,QAAQ;AACvB,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AAAA,EAIA,IAAI,UAAiC;AACnC,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA,EAOU,YAAY,KAAa,SAA4B;AAC7D,UAAM,EAAE,QAAQ,QAAQ,IAAI;AAC5B,UAAM,SAAS;AACf,UAAM,QAAQ,CAAC,SAAS,GAAG,SAAS,UAAU,KAAK;AACnD,QAAI,SAAS;AACX,aAAO,KAAK,OAAO,EAAE,QAAQ,CAAC,WAAW;AACvC,cAAM,QAAQ,QAAQ;AACtB,cAAM,KAAK,GAAG,SAAS,WAAW,OAAO;AAAA,MAC3C,CAAC;AAAA,IACH;AAEA,QAAI,QAAQ,MAAM;AAChB,YAAM,KAAK,GAAG,gBAAgB,QAAQ,OAAO;AAAA,IAC/C;AAEA,SAAK,QAAQ,KAAK,KAAK;AAAA,EACzB;AAAA,EAMU,aAAa,UAAwB;AAC7C,UAAM,SAAS;AACf,UAAM,QAAQ;AAAA,MACZ;AAAA,MACA,GAAG,SAAS,SAAS;AAAA,MACrB,GAAG,iBAAiB,SAAS;AAAA,IAC/B;AAEA,aAAS,QAAQ,QAAQ,CAAC,OAAO,WAAW;AAC1C,YAAM,KAAK,GAAG,SAAS,WAAW,OAAO;AAAA,IAC3C,CAAC;AAED,SAAK,QAAQ,KAAK,KAAK;AAAA,EACzB;AACF;AAiBO,MAAM,mBAAe,uBAAS,CAAC,QAAQ;AAC5C,MAAI,IAAI,QAAQ,MAAM;AACpB,UAAM,SAAS,IAAI,UAAU;AAC7B,UAAM,cAAc,OAAO,IAAyB,mBAAmB,MAAM;AAC7E,WAAO,IAAI,KAAK;AAAA,MACd,QAAQ;AAAA,QACN,QAAQ,IAAI,IAAI,QAAQ;AAAA,MAC1B;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH,CAAC;","names":["urijs","fetch"]}
+{"version":3,"sources":["../../../src/services/http/http.ts"],"sourcesContent":["import urijs from 'urijs';\nimport type { RequestInit, BodyInit } from 'node-fetch';\nimport { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { provider } from '../../utils';\nimport { Logger, Request, HTTPResponse, NodeFetch } from '../../types';\n\n/**\n * The options to customize the service.\n *\n * @group Services/HTTP\n */\nexport type HTTPOptions = {\n  /**\n   * Whether or not the service should log the requests and their responses.\n   */\n  logRequests?: boolean;\n};\n/**\n * The options to construct a {@link HTTP}.\n *\n * @group Services/HTTP\n */\nexport type HTTPContructorOptions = Partial<HTTPOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    logger: Logger;\n    nodeFetch: NodeFetch;\n  };\n};\n/**\n * The allowed formats for the body of a request.\n *\n * @group Services/HTTP\n */\nexport type HTTPFetchBody = string | Record<string | number, unknown> | BodyInit;\n/**\n * The options for a request.\n *\n * @group Services/HTTP\n */\nexport type HTTPFetchOptions = {\n  /**\n   * The HTTP method.\n   *\n   * @default 'GET'\n   */\n  method?: string;\n  /**\n   * The headers dictionary.\n   */\n  headers?: Record<string, string>;\n  /**\n   * The body of the request.\n   */\n  body?: HTTPFetchBody;\n  /**\n   * A dictionary of query string parameters.\n   */\n  qs?: Record<string, unknown>;\n  /**\n   * A request object generated by the application. This can be used to copy information\n   * like custom headers or the IP (for the X-Forwarded-For header).\n   */\n  req?: Request;\n};\n/**\n * The options for the method that extracts custom headers from a request.\n *\n * @group Services/HTTP\n */\nexport type GetCustomHeadersFromRequestOptions = {\n  /**\n   * Since the method considers all headers that start with `x-` as custom headers,\n   * setting this to `false` is the only way to exclude `x-forwarded-` headers from the\n   * list.\n   *\n   * @default false\n   */\n  includeXForwardedHeaders?: boolean;\n};\n/**\n * A set of utilities to work with HTTP requests and responses.\n *\n * @group Services\n * @group Services/HTTP\n */\nexport class HTTP {\n  /**\n   * The service used to log information in the terminal.\n   */\n  protected readonly _logger: Logger;\n  /**\n   * The node-fetch library. Since it's an ESM only module, Jimpex loads it on boot and makes\n   * it available on the container.\n   */\n  protected readonly _nodeFetch: NodeFetch;\n  /**\n   * The service customization options.\n   */\n  protected readonly _options: HTTPOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({ inject: { logger, nodeFetch }, ...options }: HTTPContructorOptions) {\n    this._logger = logger;\n    this._nodeFetch = nodeFetch;\n    this._options = deepAssignWithOverwrite(\n      {\n        logRequests: false,\n      },\n      options,\n    );\n\n    this.fetch = this.fetch.bind(this);\n  }\n  /**\n   * Makes a fetch request.\n   *\n   * @param url      The URL to fetch.\n   * @param options  The custom options for the request.\n   */\n  async fetch(url: string, options: HTTPFetchOptions = {}): Promise<HTTPResponse> {\n    let useURL = url;\n    if (options.qs) {\n      useURL = urijs(url).query(options.qs).toString();\n    }\n\n    const fetchOptions: RequestInit = {\n      method: (options.method || 'get').toUpperCase(),\n      body: options.body as BodyInit,\n    };\n\n    let defaultHeaders: Record<string, string> | undefined;\n    if (options.req) {\n      defaultHeaders = this.getCustomHeadersFromRequest(options.req);\n      const ip = this.getIPFromRequest(options.req);\n      if (ip) {\n        defaultHeaders['x-forwarded-for'] = ip;\n      }\n    }\n    const headers = {\n      ...defaultHeaders,\n      ...options.headers,\n    };\n\n    if (Object.keys(headers).length) {\n      fetchOptions.headers = this.normalizeHeaders(headers);\n    }\n\n    const { logRequests } = this._options;\n    if (logRequests) {\n      this._logRequest(useURL, fetchOptions);\n    }\n\n    const response = await this._nodeFetch(useURL, fetchOptions);\n    if (logRequests) {\n      this._logResponse(response);\n    }\n\n    return response;\n  }\n  /**\n   * Tries to get the IP address from a given request.\n   *\n   * @param req  The request from which it will try to obtain the IP address.\n   */\n  getIPFromRequest(req: Request): string | undefined {\n    const headerValue = req.headers['x-forwarded-for'];\n    if (headerValue) {\n      return String(headerValue);\n    }\n\n    return req?.connection?.remoteAddress || req?.socket?.remoteAddress;\n  }\n  /**\n   * Creates a dictionary with all the custom headers a request has. By custom header it\n   * means all the headers which name start with `x-`.\n   *\n   * @param req      The request from which it will try to get the headers.\n   * @param options  The options to customize the behavior with certain headers.\n   */\n  getCustomHeadersFromRequest(\n    req: Request,\n    options: GetCustomHeadersFromRequestOptions = {},\n  ): Record<string, string> {\n    const { includeXForwardedHeaders = false } = options;\n    return Object.keys(req.headers).reduce<Record<string, string>>((acc, headerName) => {\n      if (\n        headerName.startsWith('x-') &&\n        (includeXForwardedHeaders || !headerName.startsWith('x-forwarded-'))\n      ) {\n        acc[headerName] = req.headers[headerName] as string;\n      }\n      return acc;\n    }, {});\n  }\n  /**\n   * It takes a dictionary of headers and normalize the names so each word will start with\n   * an upper case character. This is helpful in case you added custom headers and didn't\n   * care about the casing, or when copying headers from a server request, as they all\n   * come tranformed into lower case.\n   *\n   * @param headers  The dictionary of headers to normalize.\n   */\n  normalizeHeaders(headers: Record<string, string>): Record<string, string> {\n    return Object.keys(headers).reduce<Record<string, string>>((acc, name) => {\n      const newName = name\n        .split('-')\n        .map((part) => part.replace(/^(\\w)/, (_, letter) => letter.toUpperCase()))\n        .join('-');\n\n      acc[newName] = headers[name]!;\n      return acc;\n    }, {});\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<HTTPOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Logs a request information into the terminal.\n   *\n   * @param url      The request URL.\n   * @param options  The options for the request.\n   */\n  protected _logRequest(url: string, options: RequestInit): void {\n    const { method, headers } = options;\n    const prefix = 'REQUEST> ';\n    const lines = ['--->>', `${prefix}${method} ${url}`];\n    if (headers) {\n      Object.keys(headers).forEach((header) => {\n        const value = headers[header as keyof typeof headers];\n        lines.push(`${prefix}${header}: ${value}`);\n      });\n    }\n\n    if (options.body) {\n      lines.push(`${prefix}body: \"${options.body}\"`);\n    }\n\n    this._logger.info(lines);\n  }\n  /**\n   * Logs a response information into the terminal.\n   *\n   * @param response  The response to log.\n   */\n  protected _logResponse(response: HTTPResponse) {\n    const prefix = 'RESPONSE> ';\n    const lines = [\n      '<<---',\n      `${prefix}${response.url}`,\n      `${prefix}status: ${response.status}`,\n    ];\n\n    response.headers.forEach((value, header) => {\n      lines.push(`${prefix}${header}: ${value}`);\n    });\n\n    this._logger.info(lines);\n  }\n}\n/**\n * The service provider that once registered on the container will set an instance of\n * {@link HTTP} as the `http` service. The provider also checks the `debug.logRequests`\n * setting on the application configuration in order to enable or not the logging of\n * requests/responses.\n *\n * @example\n *\n *   // Register it on the container\n *   container.register(httpProvider);\n *   // Getting access to the service instance\n *   const http = container.get<HTTP>('http');\n *\n * @group Providers\n * @group Services/HTTP\n */\nexport const httpProvider = provider((app) => {\n  app.set('http', () => {\n    const config = app.getConfig();\n    const logRequests = config.get<boolean | undefined>('debug.logRequests') === true;\n    return new HTTP({\n      inject: {\n        logger: app.get('logger'),\n        nodeFetch: app.get('node-fetch'),\n      },\n      logRequests,\n    });\n  });\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkB;AAElB,yBAAwC;AACxC,mBAAyB;AAqFlB,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA,EAiBhB,YAAY,EAAE,QAAQ,EAAE,QAAQ,UAAU,GAAG,GAAG,QAAQ,GAA0B;AAblF;AAAA;AAAA;AAAA,wBAAmB;AAKnB;AAAA;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAKjB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,eAAW;AAAA,MACd;AAAA,QACE,aAAa;AAAA,MACf;AAAA,MACA;AAAA,IACF;AAEA,SAAK,QAAQ,KAAK,MAAM,KAAK,IAAI;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,MAAM,KAAa,UAA4B,CAAC,GAA0B;AAC9E,QAAI,SAAS;AACb,QAAI,QAAQ,IAAI;AACd,mBAAS,aAAAA,SAAM,GAAG,EAAE,MAAM,QAAQ,EAAE,EAAE,SAAS;AAAA,IACjD;AAEA,UAAM,eAA4B;AAAA,MAChC,SAAS,QAAQ,UAAU,OAAO,YAAY;AAAA,MAC9C,MAAM,QAAQ;AAAA,IAChB;AAEA,QAAI;AACJ,QAAI,QAAQ,KAAK;AACf,uBAAiB,KAAK,4BAA4B,QAAQ,GAAG;AAC7D,YAAM,KAAK,KAAK,iBAAiB,QAAQ,GAAG;AAC5C,UAAI,IAAI;AACN,uBAAe,iBAAiB,IAAI;AAAA,MACtC;AAAA,IACF;AACA,UAAM,UAAU;AAAA,MACd,GAAG;AAAA,MACH,GAAG,QAAQ;AAAA,IACb;AAEA,QAAI,OAAO,KAAK,OAAO,EAAE,QAAQ;AAC/B,mBAAa,UAAU,KAAK,iBAAiB,OAAO;AAAA,IACtD;AAEA,UAAM,EAAE,YAAY,IAAI,KAAK;AAC7B,QAAI,aAAa;AACf,WAAK,YAAY,QAAQ,YAAY;AAAA,IACvC;AAEA,UAAM,WAAW,MAAM,KAAK,WAAW,QAAQ,YAAY;AAC3D,QAAI,aAAa;AACf,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAiB,KAAkC;AACjD,UAAM,cAAc,IAAI,QAAQ,iBAAiB;AACjD,QAAI,aAAa;AACf,aAAO,OAAO,WAAW;AAAA,IAC3B;AAEA,WAAO,KAAK,YAAY,iBAAiB,KAAK,QAAQ;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,4BACE,KACA,UAA8C,CAAC,GACvB;AACxB,UAAM,EAAE,2BAA2B,MAAM,IAAI;AAC7C,WAAO,OAAO,KAAK,IAAI,OAAO,EAAE,OAA+B,CAAC,KAAK,eAAe;AAClF,UACE,WAAW,WAAW,IAAI,MACzB,4BAA4B,CAAC,WAAW,WAAW,cAAc,IAClE;AACA,YAAI,UAAU,IAAI,IAAI,QAAQ,UAAU;AAAA,MAC1C;AACA,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,iBAAiB,SAAyD;AACxE,WAAO,OAAO,KAAK,OAAO,EAAE,OAA+B,CAAC,KAAK,SAAS;AACxE,YAAM,UAAU,KACb,MAAM,GAAG,EACT,IAAI,CAAC,SAAS,KAAK,QAAQ,SAAS,CAAC,GAAG,WAAW,OAAO,YAAY,CAAC,CAAC,EACxE,KAAK,GAAG;AAEX,UAAI,OAAO,IAAI,QAAQ,IAAI;AAC3B,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAAiC;AACnC,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,YAAY,KAAa,SAA4B;AAC7D,UAAM,EAAE,QAAQ,QAAQ,IAAI;AAC5B,UAAM,SAAS;AACf,UAAM,QAAQ,CAAC,SAAS,GAAG,MAAM,GAAG,MAAM,IAAI,GAAG,EAAE;AACnD,QAAI,SAAS;AACX,aAAO,KAAK,OAAO,EAAE,QAAQ,CAAC,WAAW;AACvC,cAAM,QAAQ,QAAQ,MAA8B;AACpD,cAAM,KAAK,GAAG,MAAM,GAAG,MAAM,KAAK,KAAK,EAAE;AAAA,MAC3C,CAAC;AAAA,IACH;AAEA,QAAI,QAAQ,MAAM;AAChB,YAAM,KAAK,GAAG,MAAM,UAAU,QAAQ,IAAI,GAAG;AAAA,IAC/C;AAEA,SAAK,QAAQ,KAAK,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,aAAa,UAAwB;AAC7C,UAAM,SAAS;AACf,UAAM,QAAQ;AAAA,MACZ;AAAA,MACA,GAAG,MAAM,GAAG,SAAS,GAAG;AAAA,MACxB,GAAG,MAAM,WAAW,SAAS,MAAM;AAAA,IACrC;AAEA,aAAS,QAAQ,QAAQ,CAAC,OAAO,WAAW;AAC1C,YAAM,KAAK,GAAG,MAAM,GAAG,MAAM,KAAK,KAAK,EAAE;AAAA,IAC3C,CAAC;AAED,SAAK,QAAQ,KAAK,KAAK;AAAA,EACzB;AACF;AAiBO,MAAM,mBAAe,uBAAS,CAAC,QAAQ;AAC5C,MAAI,IAAI,QAAQ,MAAM;AACpB,UAAM,SAAS,IAAI,UAAU;AAC7B,UAAM,cAAc,OAAO,IAAyB,mBAAmB,MAAM;AAC7E,WAAO,IAAI,KAAK;AAAA,MACd,QAAQ;AAAA,QACN,QAAQ,IAAI,IAAI,QAAQ;AAAA,QACxB,WAAW,IAAI,IAAI,YAAY;AAAA,MACjC;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH,CAAC;","names":["urijs"]}

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

@@ -0,0 +1,51 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
+export { ErrorResponse } from '@homer0/api-utils';
+import { APIClientProviderOptions } from './apiClient.mjs';
+export { APIClient, APIClientConfig, APIClientConstructorOptions, APIClientSettings, EndpointsType, apiClientProvider } from './apiClient.mjs';
+export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFetchBody, HTTPFetchOptions, HTTPOptions, httpProvider } from './http.mjs';
+export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider } from './responsesBuilder.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 '../common/httpError.mjs';
+import '../../utils/fns/statuses.mjs';
+import 'statuses';
+import '../common/appError.mjs';
+
+/**
+ * Registers all the HTTP services on the container.
+ *
+ * - {@link APIClient | apiClient}
+ * - {@link HTTP | http}
+ * - {@link ResponsesBuilder | responsesBuilder}
+ *
+ * @example
+ *
+ *   // Register the collection on the container
+ *   container.register(httpServicesProvider);
+ *   // Getting access to one the services instance
+ *   const apiClient = container.get<APIClient>('apiClient');
+ *
+ * @group Providers
+ */
+declare const httpServicesProvider: {
+    apiClientProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: APIClientProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+    httpProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+    responsesBuilderProvider: _homer0_jimple.Resource<"provider", "register", _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 { APIClientProviderOptions, httpServicesProvider };

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

@@ -1,11 +1,10 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../jimpex-7eaee271.js';
+import { J as Jimpex } from '../../index-C6I3NCC-.js';
 export { ErrorResponse } from '@homer0/api-utils';
 import { APIClientProviderOptions } from './apiClient.js';
 export { APIClient, APIClientConfig, APIClientConstructorOptions, APIClientSettings, EndpointsType, apiClientProvider } from './apiClient.js';
 export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFetchBody, HTTPFetchOptions, HTTPOptions, httpProvider } from './http.js';
 export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider } from './responsesBuilder.js';
-import '@homer0/events-hub';
 import '../../types/express.js';
 import 'express';
 import '../../types/http.js';
@@ -13,9 +12,11 @@ import 'https';
 import 'http';
 import 'spdy';
 import 'node-fetch';
-import '@homer0/simple-config';
 import '../../types/utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import '../common/httpError.js';
 import '../../utils/fns/statuses.js';
 import 'statuses';

package/dist/services/http/index.js

@@ -36,6 +36,9 @@ const httpServicesProvider = (0, import_utils.providers)({
 });
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  httpServicesProvider
+  httpServicesProvider,
+  ...require("./apiClient"),
+  ...require("./http"),
+  ...require("./responsesBuilder")
 });
 //# sourceMappingURL=index.js.map