jimpex 7.0.1 → 8.0.0

package/dist/middlewares/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var middlewares_exports = {};
+module.exports = __toCommonJS(middlewares_exports);
+__reExport(middlewares_exports, require("./common"), module.exports);
+__reExport(middlewares_exports, require("./html"), module.exports);
+__reExport(middlewares_exports, require("./utils"), module.exports);
+//# sourceMappingURL=index.js.map

package/dist/middlewares/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/middlewares/index.ts"],"sourcesContent":["export * from './common';\nexport * from './html';\nexport * from './utils';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,gCAAc,qBAAd;AACA,gCAAc,mBADd;AAEA,gCAAc,oBAFd;","names":[]}

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

@@ -0,0 +1,19 @@
+export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware } from './versionValidator.js';
+import '@homer0/jimple';
+import '../../utils/fns/statuses.js';
+import 'statuses';
+import '../../jimpex-7eaee271.js';
+import '@homer0/events-hub';
+import '../../types/express.js';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/simple-config';
+import '../../types/utils.js';
+import '@homer0/simple-logger';
+import '../../services/common/httpError.js';
+import '../../services/common/appError.js';
+import '../../services/http/responsesBuilder.js';

package/dist/middlewares/utils/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var utils_exports = {};
+module.exports = __toCommonJS(utils_exports);
+__reExport(utils_exports, require("./versionValidator"), module.exports);
+//# sourceMappingURL=index.js.map

package/dist/middlewares/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/middlewares/utils/index.ts"],"sourcesContent":["export * from './versionValidator';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,0BAAc,+BAAd;","names":[]}

package/dist/middlewares/utils/versionValidator.d.ts

@@ -0,0 +1,214 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { Statuses } from '../../utils/fns/statuses.js';
+import { J as Jimpex, R as MiddlewareConnectFn } from '../../jimpex-7eaee271.js';
+import { ExpressMiddleware } from '../../types/express.js';
+import { DeepPartial } from '../../types/utils.js';
+import { HTTPErrorClass } from '../../services/common/httpError.js';
+import { ResponsesBuilder } from '../../services/http/responsesBuilder.js';
+import { Request } from 'express';
+import 'statuses';
+import '@homer0/events-hub';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/simple-config';
+import '@homer0/simple-logger';
+import '../../services/common/appError.js';
+
+/**
+ * The options for how the middleware should behave if the requested version is `latest`.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorLatestOptions = {
+    /**
+     * Whether or not the middleware should validate the _"latest version"_.
+     *
+     * @default true
+     */
+    allow: boolean;
+    /**
+     * The name of the _"latest version"_. Basically, `req.params.version` must match with
+     * this property in order to be consider "latest".
+     *
+     * @default 'latest'
+     */
+    name: string;
+};
+/**
+ * The options for how to detect if the request comes from a popup and how to compose the
+ * post message the middleware will use to respond.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorPopupOptions = {
+    /**
+     * The name of the query string variable the middleware will check in order to indentify
+     * whether the request comes from a popup or not. The variable must have `'true'` as its
+     * value.
+     *
+     * @default 'popup'
+     */
+    variable: string;
+    /**
+     * The title of the page that will be generated to respond in case the versions don't
+     * match.
+     *
+     * @default 'Conflict'
+     */
+    title: string;
+    /**
+     * The contents of the post message the generated page will send if the versions don't
+     * match.
+     *
+     * @default 'version:conflict'
+     */
+    message: string;
+};
+/**
+ * The options used to customize a {@link VersionValidator} instance.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorOptions = {
+    /**
+     * The version used to validate the requests.
+     */
+    version: string;
+    /**
+     * The options for how the middleware should behave if the requested version is
+     * `latest`.
+     */
+    latest: VersionValidatorLatestOptions;
+    /**
+     * The options for how to detect if the request comes from a popup and how to compose
+     * the post message the middleware will use to respond.
+     */
+    popup: VersionValidatorPopupOptions;
+    /**
+     * The error message to show when the version is invalid.
+     *
+     * @default "The application version doesn't match"
+     * @prettierignore
+     */
+    error: string;
+};
+/**
+ * A partial version of the {@link VersionValidatorOptions}, to be used in the constructor
+ * and the middleware creator. The reason it omits `version` it's because for the
+ * constructor it's required, but for the middleware creator it's not.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorPartialOptions = DeepPartial<Omit<VersionValidatorOptions, 'version'>>;
+/**
+ * The options to construct a {@link VersionValidator}.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorConstructorOptions = VersionValidatorPartialOptions & {
+    /**
+     * The version used to validate the requests.
+     */
+    version: string;
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        HTTPError: HTTPErrorClass;
+        responsesBuilder: ResponsesBuilder;
+        statuses: Statuses;
+    };
+};
+/**
+ * The options for the middleware creator that will mount an instance of
+ * {@link VersionValidator}.
+ *
+ * @group Middlewares/VersionValidator
+ */
+type VersionValidatorMiddlewareOptions = VersionValidatorPartialOptions & {
+    /**
+     * The version used to validate the requests. This is optional in here because if it's
+     * not specified, it will be obtained from the configuration service.
+     */
+    version?: string;
+};
+/**
+ * This is the handler for the middleware/controller that validates the application
+ * version.
+ * This is useful in cases where you want to restrict the access to specific versions; for
+ * example: you have a frontend which needs to be aligned with the "current" version of
+ * the application, since the frontend won't realize a new version was released, the
+ * validator can be used to let the frontend know.
+ * Also, it can be configured to handle requests from popups, in which case, instead of
+ * generating an error message, it will send a post message.
+ *
+ * @group Middleware Classes
+ * @group Middlewares/VersionValidator
+ * @prettierignore
+ */
+declare class VersionValidator {
+    /**
+     * To generate the errors in case the validation fails.
+     */
+    protected readonly _HTTPError: HTTPErrorClass;
+    /**
+     * To generate responses for popups.
+     */
+    protected readonly _responsesBuilder: ResponsesBuilder;
+    /**
+     * The uility service to get HTTP status codes.
+     */
+    protected readonly _statuses: Statuses;
+    /**
+     * The customization options.
+     */
+    protected readonly _options: VersionValidatorOptions;
+    /**
+     * @param options  The options to construct the class.
+     * @throws If no `version` is specified in the options.
+     */
+    constructor({ inject, version, ...options }: VersionValidatorConstructorOptions);
+    /**
+     * Generates the middleware that validates the version.
+     */
+    getMiddleware(): ExpressMiddleware;
+    /**
+     * The customization options.
+     */
+    get options(): Readonly<VersionValidatorOptions>;
+    /**
+     * Helper method that checks if the incoming request is from a popup. It will look for
+     * the query string variable defined in the constructor options.
+     *
+     * @param req  The request object sent by the application.
+     */
+    protected _isPopup(req: Request): boolean;
+    /**
+     * Helper method that checks if the "latest version" is enabled and if the given version
+     * is "the latest" (comparing it with the option name).
+     *
+     * @param version  The version received in the request.
+     */
+    protected _isTheAllowedLatest(version: string): boolean;
+}
+/**
+ * A middleware that will validate a `version` request parameter against the application
+ * version, and generate an error if they don't match.
+ * This is a "middleware/controller" because the wrappers for both are the same, the
+ * difference is that, for controllers, Jimpex sends a second parameter with the route
+ * where they are mounted.
+ * By validating the route parameter, the function can know whether the implementation is
+ * going to use the middleware by itself or as a route middleware.
+ * If used as middleware, it will just return the result of
+ * {@link VersionValidator.getMiddleware}; but if used as controller, it will mount it on
+ * `[route]/:version/*`.
+ *
+ * @group Middlewares
+ * @group Middlewares/VersionValidator
+ */
+declare const versionValidatorMiddleware: _homer0_jimple.ResourceCreator<"middleware", "connect", (options?: VersionValidatorMiddlewareOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType, route: string | undefined) => ExpressMiddleware, MiddlewareConnectFn>;
+
+export { VersionValidator, VersionValidatorConstructorOptions, VersionValidatorLatestOptions, VersionValidatorMiddlewareOptions, VersionValidatorOptions, VersionValidatorPartialOptions, VersionValidatorPopupOptions, versionValidatorMiddleware };

package/dist/middlewares/utils/versionValidator.js

@@ -0,0 +1,128 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var versionValidator_exports = {};
+__export(versionValidator_exports, {
+  VersionValidator: () => VersionValidator,
+  versionValidatorMiddleware: () => versionValidatorMiddleware
+});
+module.exports = __toCommonJS(versionValidator_exports);
+var import_deep_assign = require("@homer0/deep-assign");
+var import_utils = require("../../utils");
+class VersionValidator {
+  constructor({ inject, version, ...options }) {
+    __publicField(this, "_HTTPError");
+    __publicField(this, "_responsesBuilder");
+    __publicField(this, "_statuses");
+    __publicField(this, "_options");
+    this._HTTPError = inject.HTTPError;
+    this._responsesBuilder = inject.responsesBuilder;
+    this._statuses = inject.statuses;
+    this._options = (0, import_deep_assign.deepAssignWithOverwrite)(
+      {
+        error: "The application version doesn't match",
+        latest: {
+          allow: true,
+          name: "latest"
+        },
+        popup: {
+          variable: "popup",
+          title: "Conflict",
+          message: "vesion:conflict"
+        },
+        version
+      },
+      options
+    );
+    if (!this._options.version) {
+      throw new Error("You need to supply a version");
+    }
+  }
+  getMiddleware() {
+    return (req, res, next) => {
+      const { version } = req.params;
+      if (!version) {
+        next();
+        return;
+      }
+      if (version === this._options.version || this._isTheAllowedLatest(version)) {
+        next();
+        return;
+      }
+      const status = this._statuses("conflict");
+      if (this._isPopup(req)) {
+        const { title, message } = this._options.popup;
+        this._responsesBuilder.htmlPostMessage({
+          res,
+          title,
+          message,
+          status
+        });
+        return;
+      }
+      next(
+        new this._HTTPError(this._options.error, status, {
+          response: {
+            validation: true
+          }
+        })
+      );
+    };
+  }
+  get options() {
+    return (0, import_deep_assign.deepAssignWithOverwrite)({}, this._options);
+  }
+  _isPopup(req) {
+    const popup = req.query[this._options.popup.variable];
+    return !!(popup && String(popup).toLowerCase() === "true");
+  }
+  _isTheAllowedLatest(version) {
+    const { allow, name } = this._options.latest;
+    return allow && version === name;
+  }
+}
+const versionValidatorMiddleware = (0, import_utils.middlewareCreator)(
+  (options = {}) => (app, route) => {
+    const version = app.getConfig("version");
+    const middleware = new VersionValidator({
+      inject: {
+        HTTPError: app.get("HTTPError"),
+        responsesBuilder: app.get("responsesBuilder"),
+        statuses: app.get("statuses")
+      },
+      version,
+      ...options
+    }).getMiddleware();
+    if (route) {
+      const router = app.getRouter();
+      return router.all("/:version/*", middleware);
+    }
+    return middleware;
+  }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  VersionValidator,
+  versionValidatorMiddleware
+});
+//# sourceMappingURL=versionValidator.js.map

package/dist/middlewares/utils/versionValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/middlewares/utils/versionValidator.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { middlewareCreator, type Statuses } from '../../utils';\nimport { DeepPartial, Request, ExpressMiddleware } from '../../types';\nimport type { HTTPErrorClass, ResponsesBuilder } from '../../services';\n/**\n * The options for how the middleware should behave if the requested version is `latest`.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorLatestOptions = {\n  /**\n   * Whether or not the middleware should validate the _\"latest version\"_.\n   *\n   * @default true\n   */\n  allow: boolean;\n  /**\n   * The name of the _\"latest version\"_. Basically, `req.params.version` must match with\n   * this property in order to be consider \"latest\".\n   *\n   * @default 'latest'\n   */\n  name: string;\n};\n/**\n * The options for how to detect if the request comes from a popup and how to compose the\n * post message the middleware will use to respond.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorPopupOptions = {\n  /**\n   * The name of the query string variable the middleware will check in order to indentify\n   * whether the request comes from a popup or not. The variable must have `'true'` as its\n   * value.\n   *\n   * @default 'popup'\n   */\n  variable: string;\n  /**\n   * The title of the page that will be generated to respond in case the versions don't\n   * match.\n   *\n   * @default 'Conflict'\n   */\n  title: string;\n  /**\n   * The contents of the post message the generated page will send if the versions don't\n   * match.\n   *\n   * @default 'version:conflict'\n   */\n  message: string;\n};\n/**\n * The options used to customize a {@link VersionValidator} instance.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorOptions = {\n  /**\n   * The version used to validate the requests.\n   */\n  version: string;\n  /**\n   * The options for how the middleware should behave if the requested version is\n   * `latest`.\n   */\n  latest: VersionValidatorLatestOptions;\n  /**\n   * The options for how to detect if the request comes from a popup and how to compose\n   * the post message the middleware will use to respond.\n   */\n  popup: VersionValidatorPopupOptions;\n  /**\n   * The error message to show when the version is invalid.\n   *\n   * @default \"The application version doesn't match\"\n   * @prettierignore\n   */\n  error: string;\n};\n/**\n * A partial version of the {@link VersionValidatorOptions}, to be used in the constructor\n * and the middleware creator. The reason it omits `version` it's because for the\n * constructor it's required, but for the middleware creator it's not.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorPartialOptions = DeepPartial<\n  Omit<VersionValidatorOptions, 'version'>\n>;\n/**\n * The options to construct a {@link VersionValidator}.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorConstructorOptions = VersionValidatorPartialOptions & {\n  /**\n   * The version used to validate the requests.\n   */\n  version: string;\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    HTTPError: HTTPErrorClass;\n    responsesBuilder: ResponsesBuilder;\n    statuses: Statuses;\n  };\n};\n/**\n * The options for the middleware creator that will mount an instance of\n * {@link VersionValidator}.\n *\n * @group Middlewares/VersionValidator\n */\nexport type VersionValidatorMiddlewareOptions = VersionValidatorPartialOptions & {\n  /**\n   * The version used to validate the requests. This is optional in here because if it's\n   * not specified, it will be obtained from the configuration service.\n   */\n  version?: string;\n};\n/**\n * This is the handler for the middleware/controller that validates the application\n * version.\n * This is useful in cases where you want to restrict the access to specific versions; for\n * example: you have a frontend which needs to be aligned with the \"current\" version of\n * the application, since the frontend won't realize a new version was released, the\n * validator can be used to let the frontend know.\n * Also, it can be configured to handle requests from popups, in which case, instead of\n * generating an error message, it will send a post message.\n *\n * @group Middleware Classes\n * @group Middlewares/VersionValidator\n * @prettierignore\n */\nexport class VersionValidator {\n  /**\n   * To generate the errors in case the validation fails.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * To generate responses for popups.\n   */\n  protected readonly _responsesBuilder: ResponsesBuilder;\n  /**\n   * The uility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * The customization options.\n   */\n  protected readonly _options: VersionValidatorOptions;\n  /**\n   * @param options  The options to construct the class.\n   * @throws If no `version` is specified in the options.\n   */\n  constructor({ inject, version, ...options }: VersionValidatorConstructorOptions) {\n    this._HTTPError = inject.HTTPError;\n    this._responsesBuilder = inject.responsesBuilder;\n    this._statuses = inject.statuses;\n    this._options = deepAssignWithOverwrite(\n      {\n        error: \"The application version doesn't match\",\n        latest: {\n          allow: true,\n          name: 'latest',\n        },\n        popup: {\n          variable: 'popup',\n          title: 'Conflict',\n          message: 'vesion:conflict',\n        },\n        version,\n      },\n      options,\n    );\n\n    if (!this._options.version) {\n      throw new Error('You need to supply a version');\n    }\n  }\n  /**\n   * Generates the middleware that validates the version.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      // Get the `version` parameter from the request.\n      const { version } = req.params;\n      // If no version is present, move on to the next middleware.\n      if (!version) {\n        next();\n        return;\n      }\n      // If the version matches, or it's a \"latest\" version, move on to the next middleware.\n      if (version === this._options.version || this._isTheAllowedLatest(version)) {\n        next();\n        return;\n      }\n\n      const status = this._statuses('conflict');\n      // If the request comes from a popup, send the post message.\n      if (this._isPopup(req)) {\n        const { title, message } = this._options.popup;\n        this._responsesBuilder.htmlPostMessage({\n          res,\n          title,\n          message,\n          status,\n        });\n        return;\n      }\n\n      // Every other validation failed, and it's not a popup, so generate an error.\n      next(\n        new this._HTTPError(this._options.error, status, {\n          response: {\n            validation: true,\n          },\n        }),\n      );\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<VersionValidatorOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n  /**\n   * Helper method that checks if the incoming request is from a popup. It will look for\n   * the query string variable defined in the constructor options.\n   *\n   * @param req  The request object sent by the application.\n   */\n  protected _isPopup(req: Request): boolean {\n    const popup = req.query[this._options.popup.variable];\n    return !!(popup && String(popup).toLowerCase() === 'true');\n  }\n  /**\n   * Helper method that checks if the \"latest version\" is enabled and if the given version\n   * is \"the latest\" (comparing it with the option name).\n   *\n   * @param version  The version received in the request.\n   */\n  protected _isTheAllowedLatest(version: string): boolean {\n    const { allow, name } = this._options.latest;\n    return allow && version === name;\n  }\n}\n/**\n * A middleware that will validate a `version` request parameter against the application\n * version, and generate an error if they don't match.\n * This is a \"middleware/controller\" because the wrappers for both are the same, the\n * difference is that, for controllers, Jimpex sends a second parameter with the route\n * where they are mounted.\n * By validating the route parameter, the function can know whether the implementation is\n * going to use the middleware by itself or as a route middleware.\n * If used as middleware, it will just return the result of\n * {@link VersionValidator.getMiddleware}; but if used as controller, it will mount it on\n * `[route]/:version/*`.\n *\n * @group Middlewares\n * @group Middlewares/VersionValidator\n */\nexport const versionValidatorMiddleware = middlewareCreator(\n  (options: VersionValidatorMiddlewareOptions = {}) =>\n    (app, route) => {\n      const version = app.getConfig<string>('version');\n      const middleware = new VersionValidator({\n        inject: {\n          HTTPError: app.get('HTTPError'),\n          responsesBuilder: app.get('responsesBuilder'),\n          statuses: app.get('statuses'),\n        },\n        version,\n        ...options,\n      }).getMiddleware();\n\n      if (route) {\n        const router = app.getRouter();\n        return router.all('/:version/*', middleware);\n      }\n\n      return middleware;\n    },\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAwC;AACxC,mBAAiD;AAyI1C,MAAM,iBAAiB;AAAA,EAqB5B,YAAY,EAAE,QAAQ,YAAY,QAAQ,GAAuC;AAjBjF,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAMjB,SAAK,aAAa,OAAO;AACzB,SAAK,oBAAoB,OAAO;AAChC,SAAK,YAAY,OAAO;AACxB,SAAK,eAAW;AAAA,MACd;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,UACN,OAAO;AAAA,UACP,MAAM;AAAA,QACR;AAAA,QACA,OAAO;AAAA,UACL,UAAU;AAAA,UACV,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,SAAS,SAAS;AAC1B,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AAAA,EACF;AAAA,EAIA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AAEzB,YAAM,EAAE,QAAQ,IAAI,IAAI;AAExB,UAAI,CAAC,SAAS;AACZ,aAAK;AACL;AAAA,MACF;AAEA,UAAI,YAAY,KAAK,SAAS,WAAW,KAAK,oBAAoB,OAAO,GAAG;AAC1E,aAAK;AACL;AAAA,MACF;AAEA,YAAM,SAAS,KAAK,UAAU,UAAU;AAExC,UAAI,KAAK,SAAS,GAAG,GAAG;AACtB,cAAM,EAAE,OAAO,QAAQ,IAAI,KAAK,SAAS;AACzC,aAAK,kBAAkB,gBAAgB;AAAA,UACrC;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF,CAAC;AACD;AAAA,MACF;AAGA;AAAA,QACE,IAAI,KAAK,WAAW,KAAK,SAAS,OAAO,QAAQ;AAAA,UAC/C,UAAU;AAAA,YACR,YAAY;AAAA,UACd;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAIA,IAAI,UAA6C;AAC/C,eAAO,4CAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AAAA,EAOU,SAAS,KAAuB;AACxC,UAAM,QAAQ,IAAI,MAAM,KAAK,SAAS,MAAM;AAC5C,WAAO,CAAC,EAAE,SAAS,OAAO,KAAK,EAAE,YAAY,MAAM;AAAA,EACrD;AAAA,EAOU,oBAAoB,SAA0B;AACtD,UAAM,EAAE,OAAO,KAAK,IAAI,KAAK,SAAS;AACtC,WAAO,SAAS,YAAY;AAAA,EAC9B;AACF;AAgBO,MAAM,iCAA6B;AAAA,EACxC,CAAC,UAA6C,CAAC,MAC7C,CAAC,KAAK,UAAU;AACd,UAAM,UAAU,IAAI,UAAkB,SAAS;AAC/C,UAAM,aAAa,IAAI,iBAAiB;AAAA,MACtC,QAAQ;AAAA,QACN,WAAW,IAAI,IAAI,WAAW;AAAA,QAC9B,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,QAC5C,UAAU,IAAI,IAAI,UAAU;AAAA,MAC9B;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAEjB,QAAI,OAAO;AACT,YAAM,SAAS,IAAI,UAAU;AAC7B,aAAO,OAAO,IAAI,eAAe,UAAU;AAAA,IAC7C;AAEA,WAAO;AAAA,EACT;AACJ;","names":[]}

package/dist/services/common/appError.d.ts

@@ -0,0 +1,138 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex } from '../../jimpex-7eaee271.js';
+import { Statuses } from '../../utils/fns/statuses.js';
+import '@homer0/events-hub';
+import '../../types/express.js';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/simple-config';
+import '../../types/utils.js';
+import '@homer0/simple-logger';
+import 'statuses';
+
+/**
+ * A dictionary with some context information that can be provided to {@link AppError}.
+ *
+ * @group Services/AppError
+ */
+type AppErrorContext = {
+    /**
+     * Extra information that the error handler can pick and include the response.
+     */
+    response?: unknown;
+    /**
+     * A status code or name for the error handler to set in the response.
+     */
+    status?: string | number;
+} & Record<string, unknown>;
+/**
+ * A simple subclass of `Error` but with support for context information.
+ *
+ * @group Services
+ * @group Services/AppError
+ */
+declare class AppError extends Error {
+    /**
+     * The date of when the error was generated.
+     */
+    readonly _date: Date;
+    /**
+     * The context information that can be provided to the error, and picked by the error
+     * handler.
+     */
+    readonly _context: AppErrorContext;
+    /**
+     * The service that generates HTTP status codes.
+     */
+    protected _statuses: Statuses;
+    /**
+     * @param message   The message of the error.
+     * @param context   The context information, for the error handler.
+     * @param statuses  A reference to the service that generates HTTP status codes. This
+     *                  is in case the implementation wants to use a special version from
+     *                  the container; otherwise, it will use the `statuses` library
+     *                  directly.
+     */
+    constructor(message: string, context?: AppErrorContext, statuses?: Statuses);
+    /**
+     * Gets an object that can be included in a response from the application. This method
+     * is a helper for the `response` getter, as it allows for the assertion of the response
+     * type.
+     *
+     * @template T  The type of the response.
+     */
+    getResponse<T>(): T;
+    /**
+     * Information about the error that can be included in a response. This is set using the
+     * `response` key in the `context` option.
+     */
+    get response(): unknown;
+    /**
+     * An HTTP status code related to the error. This is set using the `status` key on the
+     * `context`.
+     */
+    get status(): number | undefined;
+    /**
+     * Context information related to the error.
+     */
+    get context(): unknown;
+    /**
+     * The date of when the error was generated.
+     */
+    get date(): Date;
+    /**
+     * Utility method that formats the context before saving it in the instance:
+     * - If the context includes a `status` as a `string`, it will try to replace it with
+     * its actual status code from the `statuses `service.
+     *
+     * @param context  The original context sent to the constructor.
+     */
+    protected _parseContext(context: AppErrorContext): AppErrorContext;
+}
+/**
+ * Shorthand for `new AppError()`.
+ *
+ * @param args  The same parameters as the {@link AppError} constructor.
+ * @returns A new instance of {@link AppError}.
+ * @group Services
+ * @group Services/AppError
+ */
+declare const createAppError: (message: string, context?: AppErrorContext | undefined, statuses?: Statuses | undefined) => AppError;
+/**
+ * The type of the function that generates a new instance of {@link AppError}.
+ * This is exported to make it easy to type the dependency injection.
+ *
+ * @group Services/AppError
+ */
+type CreateAppErrorFn = typeof createAppError;
+/**
+ * THe type of the {@link AppError} class.
+ * This is exported to make it easy to type the dependency injection.
+ *
+ * @group Services/AppError
+ */
+type AppErrorClass = typeof AppError;
+/**
+ * A service provider that will register both, {@link AppError} and
+ * {@link createAppError}, on the container. `AppError` will be the key for class, and
+ * `appError` will be for the generator function.
+ *
+ * @example
+ *
+ *   // Register it on the container
+ *   container.register(appErrorProvider);
+ *   // Getting access to the class.
+ *   const AppError = container.get<AppErrorClass>('AppError');
+ *   // Getting access to the function.
+ *   const appError = container.get<CreateAppErrorFn>('appError');
+ *
+ * @group Providers
+ * @group Services/AppError
+ */
+declare const appErrorProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
+
+export { AppError, AppErrorClass, AppErrorContext, CreateAppErrorFn, appErrorProvider, createAppError };

package/dist/services/common/appError.js

@@ -0,0 +1,80 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var appError_exports = {};
+__export(appError_exports, {
+  AppError: () => AppError,
+  appErrorProvider: () => appErrorProvider,
+  createAppError: () => createAppError
+});
+module.exports = __toCommonJS(appError_exports);
+var import_utils = require("../../utils");
+class AppError extends Error {
+  constructor(message, context = {}, statuses = import_utils.statuses) {
+    super(message);
+    __publicField(this, "_date");
+    __publicField(this, "_context");
+    __publicField(this, "_statuses");
+    this.name = this.constructor.name;
+    this._date = new Date();
+    this._statuses = statuses;
+    this._context = this._parseContext(context);
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, this.constructor);
+    }
+  }
+  getResponse() {
+    return this.response;
+  }
+  get response() {
+    return this._context.response || {};
+  }
+  get status() {
+    return this._context.status;
+  }
+  get context() {
+    return this._context;
+  }
+  get date() {
+    return this._date;
+  }
+  _parseContext(context) {
+    const result = { ...context };
+    if (result.status && typeof result.status === "string") {
+      result.status = this._statuses.code[result.status.toLowerCase()] || result.status;
+    }
+    return result;
+  }
+}
+const createAppError = (...args) => new AppError(...args);
+const appErrorProvider = (0, import_utils.provider)((app) => {
+  app.set("AppError", () => AppError);
+  app.set("appError", () => createAppError);
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AppError,
+  appErrorProvider,
+  createAppError
+});
+//# sourceMappingURL=appError.js.map

package/dist/services/common/appError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/services/common/appError.ts"],"sourcesContent":["import { provider, statuses as statusesFn, type Statuses } from '../../utils';\n/**\n * A dictionary with some context information that can be provided to {@link AppError}.\n *\n * @group Services/AppError\n */\nexport type AppErrorContext = {\n  /**\n   * Extra information that the error handler can pick and include the response.\n   */\n  response?: unknown;\n  /**\n   * A status code or name for the error handler to set in the response.\n   */\n  status?: string | number;\n} & Record<string, unknown>;\n/**\n * A simple subclass of `Error` but with support for context information.\n *\n * @group Services\n * @group Services/AppError\n */\nexport class AppError extends Error {\n  /**\n   * The date of when the error was generated.\n   */\n  readonly _date: Date;\n  /**\n   * The context information that can be provided to the error, and picked by the error\n   * handler.\n   */\n  readonly _context: AppErrorContext;\n  /**\n   * The service that generates HTTP status codes.\n   */\n  protected _statuses: Statuses;\n  /**\n   * @param message   The message of the error.\n   * @param context   The context information, for the error handler.\n   * @param statuses  A reference to the service that generates HTTP status codes. This\n   *                  is in case the implementation wants to use a special version from\n   *                  the container; otherwise, it will use the `statuses` library\n   *                  directly.\n   */\n  constructor(\n    message: string,\n    context: AppErrorContext = {},\n    statuses: Statuses = statusesFn,\n  ) {\n    super(message);\n    this.name = this.constructor.name;\n    this._date = new Date();\n    this._statuses = statuses;\n    this._context = this._parseContext(context);\n\n    // Limit the stack trace if possible.\n    if (Error.captureStackTrace) {\n      Error.captureStackTrace(this, this.constructor);\n    }\n  }\n  /**\n   * Gets an object that can be included in a response from the application. This method\n   * is a helper for the `response` getter, as it allows for the assertion of the response\n   * type.\n   *\n   * @template T  The type of the response.\n   */\n  getResponse<T>(): T {\n    return this.response as T;\n  }\n  /**\n   * Information about the error that can be included in a response. This is set using the\n   * `response` key in the `context` option.\n   */\n  get response(): unknown {\n    return this._context.response || {};\n  }\n  /**\n   * An HTTP status code related to the error. This is set using the `status` key on the\n   * `context`.\n   */\n  get status(): number | undefined {\n    return this._context.status as number | undefined;\n  }\n  /**\n   * Context information related to the error.\n   */\n  get context(): unknown {\n    return this._context;\n  }\n  /**\n   * The date of when the error was generated.\n   */\n  get date(): Date {\n    return this._date;\n  }\n  /**\n   * Utility method that formats the context before saving it in the instance:\n   * - If the context includes a `status` as a `string`, it will try to replace it with\n   * its actual status code from the `statuses `service.\n   *\n   * @param context  The original context sent to the constructor.\n   */\n  protected _parseContext(context: AppErrorContext): AppErrorContext {\n    const result = { ...context };\n    if (result.status && typeof result.status === 'string') {\n      result.status = this._statuses.code[result.status.toLowerCase()] || result.status;\n    }\n\n    return result;\n  }\n}\n/**\n * Shorthand for `new AppError()`.\n *\n * @param args  The same parameters as the {@link AppError} constructor.\n * @returns A new instance of {@link AppError}.\n * @group Services\n * @group Services/AppError\n */\nexport const createAppError = (\n  ...args: ConstructorParameters<typeof AppError>\n): AppError => new AppError(...args);\n/**\n * The type of the function that generates a new instance of {@link AppError}.\n * This is exported to make it easy to type the dependency injection.\n *\n * @group Services/AppError\n */\nexport type CreateAppErrorFn = typeof createAppError;\n/**\n * THe type of the {@link AppError} class.\n * This is exported to make it easy to type the dependency injection.\n *\n * @group Services/AppError\n */\nexport type AppErrorClass = typeof AppError;\n/**\n * A service provider that will register both, {@link AppError} and\n * {@link createAppError}, on the container. `AppError` will be the key for class, and\n * `appError` will be for the generator function.\n *\n * @example\n *\n *   // Register it on the container\n *   container.register(appErrorProvider);\n *   // Getting access to the class.\n *   const AppError = container.get<AppErrorClass>('AppError');\n *   // Getting access to the function.\n *   const appError = container.get<CreateAppErrorFn>('appError');\n *\n * @group Providers\n * @group Services/AppError\n */\nexport const appErrorProvider = provider((app) => {\n  app.set('AppError', () => AppError);\n  app.set('appError', () => createAppError);\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAgE;AAsBzD,MAAM,iBAAiB,MAAM;AAAA,EAsBlC,YACE,SACA,UAA2B,CAAC,GAC5B,WAAqB,aAAAA,UACrB;AACA,UAAM,OAAO;AAvBf,wBAAS;AAKT,wBAAS;AAIT,wBAAU;AAeR,SAAK,OAAO,KAAK,YAAY;AAC7B,SAAK,QAAQ,IAAI,KAAK;AACtB,SAAK,YAAY;AACjB,SAAK,WAAW,KAAK,cAAc,OAAO;AAG1C,QAAI,MAAM,mBAAmB;AAC3B,YAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,IAChD;AAAA,EACF;AAAA,EAQA,cAAoB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA,EAKA,IAAI,WAAoB;AACtB,WAAO,KAAK,SAAS,YAAY,CAAC;AAAA,EACpC;AAAA,EAKA,IAAI,SAA6B;AAC/B,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAIA,IAAI,UAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,IAAI,OAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA,EAQU,cAAc,SAA2C;AACjE,UAAM,SAAS,EAAE,GAAG,QAAQ;AAC5B,QAAI,OAAO,UAAU,OAAO,OAAO,WAAW,UAAU;AACtD,aAAO,SAAS,KAAK,UAAU,KAAK,OAAO,OAAO,YAAY,MAAM,OAAO;AAAA,IAC7E;AAEA,WAAO;AAAA,EACT;AACF;AASO,MAAM,iBAAiB,IACzB,SACU,IAAI,SAAS,GAAG,IAAI;AAgC5B,MAAM,uBAAmB,uBAAS,CAAC,QAAQ;AAChD,MAAI,IAAI,YAAY,MAAM,QAAQ;AAClC,MAAI,IAAI,YAAY,MAAM,cAAc;AAC1C,CAAC;","names":["statusesFn"]}