jimpex 8.0.0 → 9.0.0

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-efeb437e.js';
+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 'express';
+import 'node-fetch';
+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 { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, 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-b2a04c78.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 'express';
 import 'node-fetch';
-import '@homer0/simple-config';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
 import 'statuses';
 import '../common/appError.js';
 

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);
   }

package/dist/services/utils/ensureBearerToken.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/utils/ensureBearerToken.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { providerCreator, type Statuses } from '../../utils';\nimport type { HTTPErrorClass } from '../common';\nimport type { DeepPartial, ExpressMiddleware } from '../../types';\n/**\n * The options for the error the middleare can generate.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenErrorOptions = {\n  /**\n   * The error message for the response.\n   *\n   * @default 'Unauthorized'\n   */\n  message: string;\n  /**\n   * The HTTP status that will be added to the error context.\n   *\n   * @default 401\n   */\n  status: number;\n  /**\n   * Context information for the error handler and that can be added to the actual\n   * response.\n   */\n  response: unknown;\n};\n/**\n * The options to customize the service/middleware.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenOptions = {\n  error: EnsureBearerTokenErrorOptions;\n  expression: RegExp;\n  local: string;\n};\n/**\n * The options to construct a {@link EnsureBearerToken}.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerConstructorOptions = DeepPartial<EnsureBearerTokenOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    HTTPError: HTTPErrorClass;\n    statuses: Statuses;\n  };\n};\n/**\n * Custom options for the provider that will register an instance of\n * {@link EnsureBearerToken}\n * as a service.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenProviderOptions = DeepPartial<EnsureBearerTokenOptions> & {\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 'ensureBearerToken'\n   */\n  serviceName?: string;\n};\n/**\n * This service gives you a middleware that verifies if a request has an `Authorization`\n * header with a bearer token; if it does, the token will be saved on the `res.locals`,\n * otherwise, it will generate an error.\n *\n * This is a \"service middleware\" to allow certain flexibility: you can have controllers\n * where some routes are protected and others are not. For those cases, you get the\n * service from the container, and include it only in the routes that need it.\n *\n * @group Services\n * @group Services/EnsureBearerToken\n */\nexport class EnsureBearerToken {\n  /**\n   * To generate the errors when the validation fails.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * The customization options for the service.\n   */\n  protected readonly _options: EnsureBearerTokenOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({\n    inject: { HTTPError, statuses },\n    ...options\n  }: EnsureBearerConstructorOptions) {\n    this._HTTPError = HTTPError;\n    this._options = deepAssignWithOverwrite(\n      {\n        error: {\n          message: 'Unauthorized',\n          status: statuses('unauthorized'),\n          response: {},\n        },\n        expression: /bearer (.*?)(?:$|\\s)/i,\n        local: 'token',\n      },\n      options,\n    );\n  }\n  /**\n   * Generates the middleware that verifies if a request has an `Authorization` header\n   * with a bearer token.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      let unauthorized = true;\n      const {\n        headers: { authorization },\n      } = req;\n      if (authorization) {\n        const matches = this._options.expression.exec(authorization);\n        if (matches) {\n          const [, token] = matches;\n          res.locals[this._options.local] = token;\n          unauthorized = false;\n        }\n      }\n\n      if (unauthorized) {\n        const {\n          error: { message, status, response },\n        } = this._options;\n        next(\n          new this._HTTPError(message, status, {\n            response,\n          }),\n        );\n      } else {\n        next();\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<EnsureBearerTokenOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n}\n/**\n * Generates a \"service middleware\" that can be used on route controllers in order to\n * validate the presence of a bearer token on the requests authorization header.\n *\n * The registered service is an instance of {@link EnsureBearerToken}, and it uses the key\n * `ensureBearerToken`.\n *\n * Since it's a \"provider creator\", when registering it, you can pass custom options.\n *\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   // Register it on the container\n *   container.register(ensureBearerTokenProvider);\n *\n *   // Let's assume we are in a controller now...\n *   // Getting access to the middleware.\n *   const ensureBearerToken = container.get<ExpressMiddleware>('ensureBearerToken');\n *\n * @example\n *\n * <caption>Customizing the service</caption>\n *\n *   // Register it on the container\n *   container.register(\n *     ensureBearerTokenProvider({\n *       serviceName: 'ensureBearerTokenCustom',\n *       error: {\n *         message: 'Missing token!',\n *       },\n *     }),\n *   );\n *\n * @group Providers\n * @group Services/EnsureBearerToken\n */\nexport const ensureBearerTokenProvider = providerCreator(\n  (options: EnsureBearerTokenProviderOptions = {}) =>\n    (app) => {\n      const { serviceName = 'ensureBearerToken', ...rest } = options;\n      app.set(serviceName, () =>\n        new EnsureBearerToken({\n          inject: {\n            HTTPError: app.get('HTTPError'),\n            statuses: app.get('statuses'),\n          },\n          ...rest,\n        }).getMiddleware(),\n      );\n    },\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAwC;AACxC,mBAA+C;AA+ExC,MAAM,kBAAkB;AAAA,EAY7B,YAAY;AAAA,IACV,QAAQ,EAAE,WAAW,SAAS;AAAA,OAC3B;AAAA,EACL,GAAmC;AAXnC,wBAAmB;AAInB,wBAAmB;AAQjB,SAAK,aAAa;AAClB,SAAK,eAAW;AAAA,MACd;AAAA,QACE,OAAO;AAAA,UACL,SAAS;AAAA,UACT,QAAQ,SAAS,cAAc;AAAA,UAC/B,UAAU,CAAC;AAAA,QACb;AAAA,QACA,YAAY;AAAA,QACZ,OAAO;AAAA,MACT;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAKA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AACzB,UAAI,eAAe;AACnB,YAAM;AAAA,QACJ,SAAS,EAAE,cAAc;AAAA,MAC3B,IAAI;AACJ,UAAI,eAAe;AACjB,cAAM,UAAU,KAAK,SAAS,WAAW,KAAK,aAAa;AAC3D,YAAI,SAAS;AACX,gBAAM,CAAC,EAAE,KAAK,IAAI;AAClB,cAAI,OAAO,KAAK,SAAS,SAAS;AAClC,yBAAe;AAAA,QACjB;AAAA,MACF;AAEA,UAAI,cAAc;AAChB,cAAM;AAAA,UACJ,OAAO,EAAE,SAAS,QAAQ,SAAS;AAAA,QACrC,IAAI,KAAK;AACT;AAAA,UACE,IAAI,KAAK,WAAW,SAAS,QAAQ;AAAA,YACnC;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,aAAK;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA,EAIA,IAAI,UAA8C;AAChD,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AACF;AAsCO,MAAM,gCAA4B;AAAA,EACvC,CAAC,UAA4C,CAAC,MAC5C,CAAC,QAAQ;AACP,UAAM,EAAE,cAAc,wBAAwB,KAAK,IAAI;AACvD,QAAI;AAAA,MAAI;AAAA,MAAa,MACnB,IAAI,kBAAkB;AAAA,QACpB,QAAQ;AAAA,UACN,WAAW,IAAI,IAAI,WAAW;AAAA,UAC9B,UAAU,IAAI,IAAI,UAAU;AAAA,QAC9B;AAAA,QACA,GAAG;AAAA,MACL,CAAC,EAAE,cAAc;AAAA,IACnB;AAAA,EACF;AACJ;","names":[]}
+{"version":3,"sources":["../../../src/services/utils/ensureBearerToken.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { providerCreator, type Statuses } from '../../utils';\nimport type { HTTPErrorClass } from '../common';\nimport type { DeepPartial, ExpressMiddleware } from '../../types';\n/**\n * The options for the error the middleare can generate.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenErrorOptions = {\n  /**\n   * The error message for the response.\n   *\n   * @default 'Unauthorized'\n   */\n  message: string;\n  /**\n   * The HTTP status that will be added to the error context.\n   *\n   * @default 401\n   */\n  status: number;\n  /**\n   * Context information for the error handler and that can be added to the actual\n   * response.\n   */\n  response: unknown;\n};\n/**\n * The options to customize the service/middleware.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenOptions = {\n  error: EnsureBearerTokenErrorOptions;\n  expression: RegExp;\n  local: string;\n};\n/**\n * The options to construct a {@link EnsureBearerToken}.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerConstructorOptions = DeepPartial<EnsureBearerTokenOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    HTTPError: HTTPErrorClass;\n    statuses: Statuses;\n  };\n};\n/**\n * Custom options for the provider that will register an instance of\n * {@link EnsureBearerToken}\n * as a service.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenProviderOptions = DeepPartial<EnsureBearerTokenOptions> & {\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 'ensureBearerToken'\n   */\n  serviceName?: string;\n};\n/**\n * This service gives you a middleware that verifies if a request has an `Authorization`\n * header with a bearer token; if it does, the token will be saved on the `res.locals`,\n * otherwise, it will generate an error.\n *\n * This is a \"service middleware\" to allow certain flexibility: you can have controllers\n * where some routes are protected and others are not. For those cases, you get the\n * service from the container, and include it only in the routes that need it.\n *\n * @group Services\n * @group Services/EnsureBearerToken\n */\nexport class EnsureBearerToken {\n  /**\n   * To generate the errors when the validation fails.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * The customization options for the service.\n   */\n  protected readonly _options: EnsureBearerTokenOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({\n    inject: { HTTPError, statuses },\n    ...options\n  }: EnsureBearerConstructorOptions) {\n    this._HTTPError = HTTPError;\n    this._options = deepAssignWithOverwrite(\n      {\n        error: {\n          message: 'Unauthorized',\n          status: statuses('unauthorized'),\n          response: {},\n        },\n        expression: /bearer (.*?)(?:$|\\s)/i,\n        local: 'token',\n      },\n      options,\n    );\n  }\n  /**\n   * Generates the middleware that verifies if a request has an `Authorization` header\n   * with a bearer token.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      let unauthorized = true;\n      const {\n        headers: { authorization },\n      } = req;\n      if (authorization) {\n        const matches = this._options.expression.exec(authorization);\n        if (matches) {\n          const [, token] = matches;\n          res.locals[this._options.local] = token;\n          unauthorized = false;\n        }\n      }\n\n      if (unauthorized) {\n        const {\n          error: { message, status, response },\n        } = this._options;\n        next(\n          new this._HTTPError(message, status, {\n            response,\n          }),\n        );\n      } else {\n        next();\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<EnsureBearerTokenOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n}\n/**\n * Generates a \"service middleware\" that can be used on route controllers in order to\n * validate the presence of a bearer token on the requests authorization header.\n *\n * The registered service is an instance of {@link EnsureBearerToken}, and it uses the key\n * `ensureBearerToken`.\n *\n * Since it's a \"provider creator\", when registering it, you can pass custom options.\n *\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   // Register it on the container\n *   container.register(ensureBearerTokenProvider);\n *\n *   // Let's assume we are in a controller now...\n *   // Getting access to the middleware.\n *   const ensureBearerToken = container.get<ExpressMiddleware>('ensureBearerToken');\n *\n * @example\n *\n * <caption>Customizing the service</caption>\n *\n *   // Register it on the container\n *   container.register(\n *     ensureBearerTokenProvider({\n *       serviceName: 'ensureBearerTokenCustom',\n *       error: {\n *         message: 'Missing token!',\n *       },\n *     }),\n *   );\n *\n * @group Providers\n * @group Services/EnsureBearerToken\n */\nexport const ensureBearerTokenProvider = providerCreator(\n  (options: EnsureBearerTokenProviderOptions = {}) =>\n    (app) => {\n      const { serviceName = 'ensureBearerToken', ...rest } = options;\n      app.set(serviceName, () =>\n        new EnsureBearerToken({\n          inject: {\n            HTTPError: app.get('HTTPError'),\n            statuses: app.get('statuses'),\n          },\n          ...rest,\n        }).getMiddleware(),\n      );\n    },\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAwC;AACxC,mBAA+C;AA+ExC,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA,EAY7B,YAAY;AAAA,IACV,QAAQ,EAAE,WAAW,SAAS;AAAA,IAC9B,GAAG;AAAA,EACL,GAAmC;AAXnC;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAQjB,SAAK,aAAa;AAClB,SAAK,eAAW;AAAA,MACd;AAAA,QACE,OAAO;AAAA,UACL,SAAS;AAAA,UACT,QAAQ,SAAS,cAAc;AAAA,UAC/B,UAAU,CAAC;AAAA,QACb;AAAA,QACA,YAAY;AAAA,QACZ,OAAO;AAAA,MACT;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AACzB,UAAI,eAAe;AACnB,YAAM;AAAA,QACJ,SAAS,EAAE,cAAc;AAAA,MAC3B,IAAI;AACJ,UAAI,eAAe;AACjB,cAAM,UAAU,KAAK,SAAS,WAAW,KAAK,aAAa;AAC3D,YAAI,SAAS;AACX,gBAAM,CAAC,EAAE,KAAK,IAAI;AAClB,cAAI,OAAO,KAAK,SAAS,KAAK,IAAI;AAClC,yBAAe;AAAA,QACjB;AAAA,MACF;AAEA,UAAI,cAAc;AAChB,cAAM;AAAA,UACJ,OAAO,EAAE,SAAS,QAAQ,SAAS;AAAA,QACrC,IAAI,KAAK;AACT;AAAA,UACE,IAAI,KAAK,WAAW,SAAS,QAAQ;AAAA,YACnC;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,aAAK;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA8C;AAChD,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AACF;AAsCO,MAAM,gCAA4B;AAAA,EACvC,CAAC,UAA4C,CAAC,MAC5C,CAAC,QAAQ;AACP,UAAM,EAAE,cAAc,qBAAqB,GAAG,KAAK,IAAI;AACvD,QAAI;AAAA,MAAI;AAAA,MAAa,MACnB,IAAI,kBAAkB;AAAA,QACpB,QAAQ;AAAA,UACN,WAAW,IAAI,IAAI,WAAW;AAAA,UAC9B,UAAU,IAAI,IAAI,UAAU;AAAA,QAC9B;AAAA,QACA,GAAG;AAAA,MACL,CAAC,EAAE,cAAc;AAAA,IACnB;AAAA,EACF;AACJ;","names":[]}

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

@@ -0,0 +1,44 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../index-efeb437e.js';
+import { EnsureBearerTokenProviderOptions } from './ensureBearerToken.mjs';
+export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, ensureBearerTokenProvider } from './ensureBearerToken.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 '../common/httpError.mjs';
+import '../common/appError.mjs';
+
+/**
+ * Registers all the utility services on the container.
+ *
+ * - {@link EnsureBearerToken | ensureBearerToken}
+ *
+ * @example
+ *
+ *   // Register the collection on the container
+ *   container.register(utilsServicesProvider);
+ *   // Getting access to one the services instance
+ *   const ensureBearerToken = container.get<EnsureBearerToken>('ensureBearerToken');
+ *
+ * @group Providers
+ */
+declare const utilsServicesProvider: {
+    ensureBearerTokenProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: EnsureBearerTokenProviderOptions) => (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 { EnsureBearerTokenProviderOptions, utilsServicesProvider };

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

@@ -1,8 +1,7 @@
 import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../jimpex-7eaee271.js';
+import { J as Jimpex } from '../../index-b2a04c78.js';
 import { EnsureBearerTokenProviderOptions } from './ensureBearerToken.js';
 export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, ensureBearerTokenProvider } from './ensureBearerToken.js';
-import '@homer0/events-hub';
 import '../../types/express.js';
 import 'express';
 import '../../types/http.js';
@@ -10,9 +9,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 '../../utils/fns/statuses.js';
 import 'statuses';
 import '../common/httpError.js';

package/dist/services/utils/index.js

@@ -30,6 +30,7 @@ const utilsServicesProvider = (0, import_utils.providers)({
 });
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  utilsServicesProvider
+  utilsServicesProvider,
+  ...require("./ensureBearerToken")
 });
 //# sourceMappingURL=index.js.map

package/dist/types/events.d.mts

@@ -0,0 +1,14 @@
+import './express.mjs';
+export { E as EventPayload, l as Events, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets } from '../index-efeb437e.js';
+import 'express';
+import './http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import './utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '@homer0/jimple';

package/dist/types/events.d.ts

@@ -1,13 +1,14 @@
 import './express.js';
-export { E as EventPayload, l as Events, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets } from '../jimpex-7eaee271.js';
+export { E as EventPayload, l as Events, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets } from '../index-b2a04c78.js';
 import 'express';
-import '@homer0/jimple';
-import '@homer0/events-hub';
 import './http.js';
 import 'https';
 import 'http';
 import 'spdy';
 import 'node-fetch';
-import '@homer0/simple-config';
 import './utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '@homer0/jimple';

package/dist/types/express.d.mts

@@ -0,0 +1,10 @@
+import { RequestHandler, ErrorRequestHandler } from 'express';
+export { Express, NextFunction, Request, Response, Router } from 'express';
+
+type ExpressMiddlewareLike = RequestHandler | ErrorRequestHandler;
+type ExpressMiddleware = RequestHandler;
+type AsyncExpressMiddleware = (...args: Parameters<ExpressMiddleware>) => Promise<void>;
+type ExpressErrorHandler = ErrorRequestHandler;
+type RouterMethod = 'all' | 'get' | 'head' | 'post' | 'patch' | 'put' | 'delete' | 'connect' | 'options' | 'trace';
+
+export { AsyncExpressMiddleware, ExpressErrorHandler, ExpressMiddleware, ExpressMiddlewareLike, RouterMethod };

package/dist/types/http.d.mts

@@ -0,0 +1,79 @@
+import { Server } from 'https';
+export { Server as HTTPSServer } from 'https';
+import { Server as Server$1 } from 'http';
+export { Server as HTTPServer } from 'http';
+import { ServerOptions } from 'spdy';
+import { Express } from 'express';
+export { Response as HTTPResponse } from 'node-fetch';
+
+/**
+ * @group Jimpex
+ */
+type JimpexServer = Express | Server;
+/**
+ * @group Jimpex
+ */
+type JimpexServerInstance = Server$1 | Server;
+/**
+ * The paths to the SSL credentials. Depending on the application options, they can be
+ * relative to the project root, or the application executable, but they can't be
+ * absolute.
+ *
+ * @group Jimpex
+ */
+type JimpexHTTPSCredentials = {
+    /**
+     * The path to the certificate authority file.
+     */
+    ca?: string;
+    /**
+     * The path to the certificate file.
+     */
+    cert?: string;
+    /**
+     * The path to the key file.
+     */
+    key?: string;
+};
+/**
+ * The options to enable HTTP2.
+ *
+ * @group Jimpex
+ */
+type JimpexHTTP2Options = {
+    /**
+     * Whether or not to enable HTTP2.
+     */
+    enabled?: boolean;
+    /**
+     * Custom options for the Spdy server.
+     *
+     * @see {@link https://github.com/spdy-http2/node-spdy#options}
+     */
+    spdy?: ServerOptions['spdy'];
+};
+/**
+ * The options to enable HTTPS.
+ *
+ * @group Jimpex
+ */
+type JimpexHTTPSOptions = {
+    /**
+     * Whether or not to enable HTTPS.
+     */
+    enabled?: boolean;
+    /**
+     * The SSL credentials, and their location.
+     */
+    credentials?: JimpexHTTPSCredentials & {
+        /**
+         * If `true`, the credentials will be located relative to the project root, otherwise,
+         * they will be located relative to the application executable.
+         *
+         * @default false
+         */
+        onHome?: boolean;
+    };
+};
+
+export { JimpexHTTP2Options, JimpexHTTPSCredentials, JimpexHTTPSOptions, JimpexServer, JimpexServerInstance };

package/dist/types/index.d.mts

@@ -0,0 +1,14 @@
+export { E as EventPayload, l as Events, m as JimpexConfigOptions, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions } from '../index-efeb437e.js';
+export { AsyncExpressMiddleware, ExpressErrorHandler, ExpressMiddleware, ExpressMiddlewareLike, RouterMethod } from './express.mjs';
+export { JimpexHTTP2Options, JimpexHTTPSCredentials, JimpexHTTPSOptions, JimpexServer, JimpexServerInstance } from './http.mjs';
+export { DeepPartial, DeepReadonly, Dict, NoStringIndex } from './utils.mjs';
+export { PathUtils } from '@homer0/path-utils';
+export { SimpleLogger as Logger } from '@homer0/simple-logger';
+export { SimpleConfig as Config } from '@homer0/simple-config';
+export { EventsHub } from '@homer0/events-hub';
+export { Express, NextFunction, Request, Response, Router } from 'express';
+export { Response as HTTPResponse } from 'node-fetch';
+export { Server as HTTPSServer } from 'https';
+export { Server as HTTPServer } from 'http';
+import '@homer0/jimple';
+import 'spdy';

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { E as EventPayload, l as Events, m as JimpexConfigOptions, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions } from '../jimpex-7eaee271.js';
+export { E as EventPayload, l as Events, m as JimpexConfigOptions, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions } from '../index-b2a04c78.js';
 export { AsyncExpressMiddleware, ExpressErrorHandler, ExpressMiddleware, ExpressMiddlewareLike, RouterMethod } from './express.js';
 export { JimpexHTTP2Options, JimpexHTTPSCredentials, JimpexHTTPSOptions, JimpexServer, JimpexServerInstance } from './http.js';
 export { DeepPartial, DeepReadonly, Dict, NoStringIndex } from './utils.js';

package/dist/types/index.js

@@ -21,4 +21,13 @@ __reExport(types_exports, require("./http"), module.exports);
 __reExport(types_exports, require("./options"), module.exports);
 __reExport(types_exports, require("./utils"), module.exports);
 __reExport(types_exports, require("./wootils"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./events"),
+  ...require("./express"),
+  ...require("./http"),
+  ...require("./options"),
+  ...require("./utils"),
+  ...require("./wootils")
+});
 //# sourceMappingURL=index.js.map

package/dist/types/options.d.mts

@@ -0,0 +1,14 @@
+import '@homer0/simple-config';
+export { m as JimpexConfigOptions, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions } from '../index-efeb437e.js';
+import './express.mjs';
+import 'express';
+import './http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import './utils.mjs';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/events-hub';
+import '@homer0/jimple';

package/dist/types/options.d.ts

@@ -1,7 +1,5 @@
 import '@homer0/simple-config';
-export { m as JimpexConfigOptions, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions } from '../jimpex-7eaee271.js';
-import '@homer0/jimple';
-import '@homer0/events-hub';
+export { m as JimpexConfigOptions, o as JimpexExpressOptions, s as JimpexHealthCheckFn, r as JimpexHealthStatus, t as JimpexOptions, p as JimpexPathOptions, q as JimpexServicesOptions, u as JimpexStartCallback, n as JimpexStaticsOptions } from '../index-b2a04c78.js';
 import './express.js';
 import 'express';
 import './http.js';
@@ -10,4 +8,7 @@ import 'http';
 import 'spdy';
 import 'node-fetch';
 import './utils.js';
+import '@homer0/path-utils';
 import '@homer0/simple-logger';
+import '@homer0/events-hub';
+import '@homer0/jimple';

package/dist/types/utils.d.mts

@@ -0,0 +1,48 @@
+/**
+ * A simple dictionary with unknown values.
+ *
+ * @group Utilities
+ */
+type Dict = Record<string, unknown>;
+/**
+ * Utility to make a deep "partial" of an existing type.
+ *
+ * @template T  The type to make a partial of.
+ * @group Utilities
+ */
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+/**
+ * Utility to make a deep "readonly" of an existing type.
+ *
+ * @template T  The type to make a readonly of.
+ * @group Utilities
+ */
+type DeepReadonly<T> = {
+    readonly [P in keyof T]: T[P] extends (infer U)[] ? DeepReadonly<U>[] : T[P] extends object ? DeepReadonly<T[P]> : T[P];
+};
+/**
+ * Utility to remove string indexes from types.
+ *
+ * @template T  The type to remove string indexes from.
+ * @example
+ *
+ *   type Foo = {
+ *     a: string;
+ *     b: string;
+ *     [key: string]: string;
+ *   };
+ *   type Bar = RemoveStringIndexes<Foo>;
+ *   // Bar = {
+ *   //  a: string;
+ *   //  b: string;
+ *   // };
+ *
+ * @group Utilities
+ */
+type NoStringIndex<T> = {
+    [K in keyof T as string extends K ? never : K]: T[K];
+};
+
+export { DeepPartial, DeepReadonly, Dict, NoStringIndex };

package/dist/types/wootils.d.mts

@@ -0,0 +1,4 @@
+export { PathUtils } from '@homer0/path-utils';
+export { SimpleLogger as Logger } from '@homer0/simple-logger';
+export { SimpleConfig as Config } from '@homer0/simple-config';
+export { EventsHub } from '@homer0/events-hub';

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

@@ -0,0 +1,5 @@
+export { notUndefined } from './others.mjs';
+export { createRouteExpression, removeLeadingSlash, removeSlashes, removeTrailingSlash } from './routes.mjs';
+export { Statuses } from './statuses.mjs';
+export { escapeForRegExp } from './text.mjs';
+export { default as statuses } from 'statuses';

package/dist/utils/fns/index.js

@@ -19,4 +19,11 @@ __reExport(fns_exports, require("./others"), module.exports);
 __reExport(fns_exports, require("./routes"), module.exports);
 __reExport(fns_exports, require("./statuses"), module.exports);
 __reExport(fns_exports, require("./text"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./others"),
+  ...require("./routes"),
+  ...require("./statuses"),
+  ...require("./text")
+});
 //# sourceMappingURL=index.js.map

package/dist/utils/fns/others.d.mts

@@ -0,0 +1,17 @@
+/**
+ * A utility function that can be used in `.filter` calls to remove `undefined` values and
+ * assert that the type is not longer `undefined`.
+ *
+ * @param value  The value to check.
+ * @template T  The type that is not `undefined`.
+ * @example
+ *
+ *   const arr: (number | undefined)[] = [1, 2, 3, undefined];
+ *   const filtered = arr.filter(notUndefined);
+ *   // filtered = [1, 2, 3] and its type is number[]
+ *
+ * @group Utilities
+ */
+declare const notUndefined: <T>(value: T | undefined) => value is T;
+
+export { notUndefined };