jimpex 10.0.0 → 10.0.2

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;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":[]}
+{"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/package.json

@@ -2,68 +2,68 @@
   "name": "jimpex",
   "description": "Express as dependency injection container.",
   "homepage": "https://homer0.github.io/jimpex/",
-  "version": "10.0.0",
+  "version": "10.0.2",
   "repository": "homer0/jimpex",
   "author": "Leonardo Apiwan (@homer0) <me@homer0.com>",
   "license": "MIT",
   "dependencies": {
-    "@homer0/api-utils": "^3.0.4",
-    "@homer0/deep-assign": "^3.0.4",
-    "@homer0/deferred": "^3.0.4",
-    "@homer0/env-utils": "^3.0.4",
-    "@homer0/events-hub": "^3.0.4",
-    "@homer0/jimple": "^3.0.4",
-    "@homer0/object-utils": "^3.0.4",
-    "@homer0/package-info": "^3.0.4",
-    "@homer0/path-utils": "^3.0.4",
-    "@homer0/root-file": "^3.0.4",
-    "@homer0/simple-config": "^3.0.4",
-    "@homer0/simple-logger": "^3.0.4",
-    "@homer0/ts-async-import": "^1.1.3",
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "body-parser": "^1.20.2",
-    "compression": "^1.7.4",
-    "express": "^4.19.2",
-    "mime": "^4.0.1",
+    "@homer0/api-utils": "^3.0.6",
+    "@homer0/deep-assign": "^3.0.6",
+    "@homer0/deferred": "^3.0.6",
+    "@homer0/env-utils": "^3.0.6",
+    "@homer0/events-hub": "^3.0.6",
+    "@homer0/jimple": "^3.0.6",
+    "@homer0/object-utils": "^3.0.6",
+    "@homer0/package-info": "^3.0.6",
+    "@homer0/path-utils": "^3.0.6",
+    "@homer0/root-file": "^3.0.6",
+    "@homer0/simple-config": "^3.0.6",
+    "@homer0/simple-logger": "^3.0.6",
+    "@homer0/ts-async-import": "^1.1.5",
+    "body-parser": "^1.20.3",
+    "compression": "^1.7.5",
+    "express": "^4.21.1",
+    "mime": "^4.0.4",
     "multer": "1.4.5-lts.1",
     "node-fetch": "^3.3.2",
-    "semantic-release": "^23.0.7",
     "spdy": "^4.0.2",
     "statuses": "^2.0.1",
     "urijs": "^1.19.11"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.2.1",
-    "@commitlint/config-conventional": "^19.1.0",
-    "@homer0/eslint-plugin": "^12.0.4",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@homer0/eslint-plugin": "^12.0.6",
     "@homer0/prettier-config": "^1.1.3",
-    "@homer0/prettier-plugin-jsdoc": "^8.0.0",
-    "@homer0/tsconfig": "^1.0.15",
+    "@homer0/prettier-plugin-jsdoc": "^9.1.0",
+    "@homer0/tsconfig": "^1.0.17",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
     "@types/body-parser": "^1.19.5",
     "@types/compression": "^1.7.5",
-    "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.12",
-    "@types/multer": "^1.4.11",
-    "@types/node": "^20.12.5",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^29.5.14",
+    "@types/multer": "^1.4.12",
+    "@types/node": "^22.9.0",
     "@types/spdy": "^3.4.9",
     "@types/statuses": "^2.0.5",
     "@types/urijs": "^1.19.25",
-    "eslint": "^8.57.0",
-    "husky": "^9.0.11",
+    "eslint": "^8.57.1",
+    "husky": "^9.1.6",
     "is-ci": "^3.0.1",
     "jest": "^29.7.0",
-    "leasot": "^13.3.0",
-    "lint-staged": "^15.2.2",
-    "ts-jest": "^29.1.2",
+    "leasot": "^14.4.0",
+    "lint-staged": "^15.2.10",
+    "semantic-release": "^24.2.0",
+    "ts-jest": "^29.2.5",
     "ts-node-dev": "^2.0.0",
-    "tsup": "^8.0.2",
-    "typedoc": "0.25.12",
-    "typescript": "^5.4.4"
+    "tsup": "^8.3.5",
+    "typedoc": "0.26.11",
+    "typescript": "^5.6.3"
   },
   "engine-strict": true,
   "engines": {
-    "node": ">=18.17 <21"
+    "node": ">=18.17 <23"
   },
   "main": "./dist/index.js",
   "module": "./dist/esm/index.js",

package/src/services/http/responsesBuilder.ts

@@ -230,7 +230,7 @@ export class ResponsesBuilder {
         this._statuses(status);
         useStatus = status;
       }
-    } catch (_) {
+    } catch {
       useStatus = this._statuses('ok') as number;
     }