@pristine-ts/jwt 0.0.139 → 0.0.143

package/dist/lib/cjs/decorators/jwt-payload.decorators.js

@@ -1,8 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.jwtPayload = void 0;
+/**
+ * This decorator can be used to inject the decoded JWT payload of a request in a parameter of a method in a controller.
+ */
 const jwtPayload = () => {
-    return (target, propertyKey, parameterIndex) => {
+    return (
+    /**
+     * The class on which the decorator is used.
+     */
+    target, 
+    /**
+     * The method on which the decorator is used.
+     */
+    propertyKey, 
+    /**
+     * The index of the parameter for which the decorator is used.
+     */
+    parameterIndex) => {
+        // Verify that the object target.constructor.prototype["__metadata__"]["methods"][propertyKey]["arguments"] exists or we create it.
+        // This object is a convention defined by Pristine on where to save controller method parameter decorator information and is used in the router to retrieve that information.
         if (target.constructor.prototype.hasOwnProperty("__metadata__") === false) {
             target.constructor.prototype["__metadata__"] = {};
         }
@@ -15,9 +32,11 @@ const jwtPayload = () => {
         if (target.constructor.prototype["__metadata__"]["methods"][propertyKey].hasOwnProperty("arguments") === false) {
             target.constructor.prototype["__metadata__"]["methods"][propertyKey]["arguments"] = [];
         }
+        // Set the type of method parameter. Each decorator has it's own type.
         const methodParameter = {
             type: "jwtPayload"
         };
+        // Save the method parameter with the proper parameter index (index of the parameter in the list of parameters of a method).
         target.constructor.prototype["__metadata__"]["methods"][propertyKey]["arguments"][parameterIndex] = methodParameter;
     };
 };

package/dist/lib/cjs/decorators/jwt-payload.decorators.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-payload.decorators.js","sourceRoot":"","sources":["../../../../src/decorators/jwt-payload.decorators.ts"],"names":[],"mappings":";;;AAEO,MAAM,UAAU,GAAG,GAAG,EAAE;IAC3B,OAAO,CACH,MAAc,EACd,WAA4B,EAC5B,cAAsB,EACxB,EAAE;QACA,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,KAAK,KAAK,EAAE;YACvE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,CAAA;SACpD;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YAClF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAA;SAC/D;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC/F,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAA;SAC5E;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC5G,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;SAC1F;QAED,MAAM,eAAe,GAAiC;YAClD,IAAI,EAAE,YAAY;SACrB,CAAC;QAEF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,GAAG,eAAe,CAAC;IACxH,CAAC,CAAA;AACL,CAAC,CAAC;AA5BW,QAAA,UAAU,cA4BrB"}
+{"version":3,"file":"jwt-payload.decorators.js","sourceRoot":"","sources":["../../../../src/decorators/jwt-payload.decorators.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACI,MAAM,UAAU,GAAG,GAAG,EAAE;IAC3B,OAAO;IACH;;OAEG;IACH,MAAc;IAEd;;OAEG;IACH,WAA4B;IAE5B;;OAEG;IACH,cAAsB,EACxB,EAAE;QACA,mIAAmI;QACnI,6KAA6K;QAC7K,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,KAAK,KAAK,EAAE;YACvE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,CAAA;SACpD;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YAClF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAA;SAC/D;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC/F,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAA;SAC5E;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC5G,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;SAC1F;QAED,sEAAsE;QACtE,MAAM,eAAe,GAAiC;YAClD,IAAI,EAAE,YAAY;SACrB,CAAC;QAEF,4HAA4H;QAC5H,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,GAAG,eAAe,CAAC;IACxH,CAAC,CAAA;AACL,CAAC,CAAC;AA3CW,QAAA,UAAU,cA2CrB"}

package/dist/lib/cjs/errors/invalid-jwt.error.js

@@ -1,11 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidJwtError = void 0;
+const common_1 = require("@pristine-ts/common");
 /**
  * This Error is thrown when you try to decode a JWT but the token is invalid.
  */
-const common_1 = require("@pristine-ts/common");
 class InvalidJwtError extends common_1.LoggableError {
+    /**
+     * This Error is thrown when you try to decode a JWT but the token is invalid.
+     * @param message The error message to show.
+     * @param previousError The previous error.
+     * @param request The request that contained the JWT.
+     * @param token The actual JWT.
+     * @param algorithm The algorithm used to decode the JWT.
+     * @param publicKey The public key used to decode the JWT.
+     */
     constructor(message, previousError, request, token, algorithm, publicKey) {
         super(message, {
             request,

package/dist/lib/cjs/errors/invalid-jwt.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"invalid-jwt.error.js","sourceRoot":"","sources":["../../../../src/errors/invalid-jwt.error.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,gDAAoE;AAEpE,MAAa,eAAgB,SAAQ,sBAAa;IAE9C,YAAmB,OAAe,EAAE,aAAoB,EAAE,OAAyB,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS;QAC5G,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,aAAa;YACb,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CACnE;AAfD,0CAeC"}
+{"version":3,"file":"invalid-jwt.error.js","sourceRoot":"","sources":["../../../../src/errors/invalid-jwt.error.ts"],"names":[],"mappings":";;;AAAA,gDAAoE;AAEpE;;GAEG;AACH,MAAa,eAAgB,SAAQ,sBAAa;IAE9C;;;;;;;;OAQG;IACH,YAAmB,OAAe,EAAE,aAAoB,EAAE,OAAyB,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS;QAC5G,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,aAAa;YACb,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CACnE;AAxBD,0CAwBC"}

package/dist/lib/cjs/errors/jwt-authorization-header.error.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JwtAuthorizationHeaderError = void 0;
+const common_1 = require("@pristine-ts/common");
 /**
  * This Error is thrown when there's you try to decode a JWT in a request but the AuthorizationHeader is missing.
  */
-const common_1 = require("@pristine-ts/common");
 class JwtAuthorizationHeaderError extends common_1.LoggableError {
+    /**
+     * This Error is thrown when there's you try to decode a JWT in a request but the AuthorizationHeader is missing.
+     * @param message The error message.
+     * @param request The request that is missing the AuthorizationHeader.
+     */
     constructor(message, request) {
         super(message, {
             request,

package/dist/lib/cjs/errors/jwt-authorization-header.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-authorization-header.error.js","sourceRoot":"","sources":["../../../../src/errors/jwt-authorization-header.error.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,gDAAoE;AAEpE,MAAa,2BAA4B,SAAQ,sBAAa;IAC1D,YAAmB,OAAe,EAAE,OAAyB;QACzD,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;SACV,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CAC/E;AAVD,kEAUC"}
+{"version":3,"file":"jwt-authorization-header.error.js","sourceRoot":"","sources":["../../../../src/errors/jwt-authorization-header.error.ts"],"names":[],"mappings":";;;AAAA,gDAAoE;AAEpE;;GAEG;AACH,MAAa,2BAA4B,SAAQ,sBAAa;IAC1D;;;;OAIG;IACH,YAAmB,OAAe,EAAE,OAAyB;QACzD,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;SACV,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CAC/E;AAfD,kEAeC"}

package/dist/lib/cjs/guards/jwt-protected.guard.js

@@ -14,11 +14,19 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JwtProtectedGuard = void 0;
 const tsyringe_1 = require("tsyringe");
+/**
+ * This guard is used to verify that a route can only be accessed when a request has a valid JWT.
+ */
 let JwtProtectedGuard = class JwtProtectedGuard {
     constructor(jwtManager) {
         this.jwtManager = jwtManager;
         this.keyname = "jwt.protected";
     }
+    /**
+     * Verifies if the JWT is valid and authorizes access if it is.
+     * @param request
+     * @param identity
+     */
     isAuthorized(request, identity) {
         return new Promise((resolve) => {
             this.jwtManager.validateAndDecode(request)
@@ -26,6 +34,10 @@ let JwtProtectedGuard = class JwtProtectedGuard {
                 .catch(reason => resolve(false));
         });
     }
+    /**
+     * Sets the context for the guard.
+     * @param context
+     */
     setContext(context) {
         this.guardContext = context;
         return Promise.resolve();

package/dist/lib/cjs/guards/jwt-protected.guard.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-protected.guard.js","sourceRoot":"","sources":["../../../../src/guards/jwt-protected.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCAA4C;AAO5C,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YAA4D,UAA+B;QAA/B,eAAU,GAAV,UAAU,CAAqB;QAGpF,YAAO,GAAG,eAAe,CAAC;IAFjC,CAAC;IAMD,YAAY,CAAC,OAAyB,EAAE,QAA4B;QAChE,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,EAAE;YACpC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC;iBACrC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IAED,UAAU,CAAC,OAAY;QACnB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAE5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ,CAAA;AArBY,iBAAiB;IAD7B,qBAAU,EAAE;IAEI,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;;GADjC,iBAAiB,CAqB7B;AArBY,8CAAiB"}
+{"version":3,"file":"jwt-protected.guard.js","sourceRoot":"","sources":["../../../../src/guards/jwt-protected.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCAA4C;AAM5C;;GAEG;AAEH,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YAA4D,UAA+B;QAA/B,eAAU,GAAV,UAAU,CAAqB;QAGpF,YAAO,GAAG,eAAe,CAAC;IAFjC,CAAC;IAMD;;;;OAIG;IACH,YAAY,CAAC,OAAyB,EAAE,QAA4B;QAChE,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,EAAE;YACpC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC;iBACrC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAY;QACnB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAE5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ,CAAA;AA9BY,iBAAiB;IAD7B,qBAAU,EAAE;IAEI,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;;GADjC,iBAAiB,CA8B7B;AA9BY,8CAAiB"}

package/dist/lib/cjs/jwt.module.js

@@ -12,7 +12,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JwtModule = void 0;
 const networking_1 = require("@pristine-ts/networking");
-const jwt_manager_1 = require("./managers/jwt.manager");
 const jwt_module_keyname_1 = require("./jwt.module.keyname");
 const configuration_1 = require("@pristine-ts/configuration");
 __exportStar(require("./decorators/decorators"), exports);
@@ -50,10 +49,6 @@ exports.JwtModule = {
     ],
     importModules: [
         networking_1.NetworkingModule,
-    ],
-    providerRegistrations: [{
-            token: "JwtManagerInterface",
-            useToken: jwt_manager_1.JwtManager,
-        }]
+    ]
 };
 //# sourceMappingURL=jwt.module.js.map

package/dist/lib/cjs/jwt.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt.module.js","sourceRoot":"","sources":["../../../src/jwt.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,wDAAyD;AACzD,wDAAkD;AAGlD,6DAAsD;AACtD,8DAAuE;AAEvE,0DAAwC;AACxC,kDAAgC;AAChC,kDAAgC;AAChC,0DAAwC;AACxC,sDAAoC;AACpC,wDAAsC;AACtC,uDAAqC;AAExB,QAAA,SAAS,GAAoB;IACtC,OAAO,EAAE,qCAAgB;IACzB,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,qCAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,OAAO;YACrB,gBAAgB,EAAE;gBACd,IAAI,2CAA2B,CAAC,wBAAwB,CAAC;aAC5D;SACJ;QACD;YACI,aAAa,EAAE,qCAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,IAAI;SACnB;QACD;YACI,aAAa,EAAE,qCAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;QACD;YACI,aAAa,EAAE,qCAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;KACJ;IACD,aAAa,EAAE;QACX,6BAAgB;KACnB;IACD,qBAAqB,EAAE,CAAC;YACpB,KAAK,EAAE,qBAAqB;YAC5B,QAAQ,EAAE,wBAAU;SACvB,CAAC;CACL,CAAA"}
+{"version":3,"file":"jwt.module.js","sourceRoot":"","sources":["../../../src/jwt.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,wDAAyD;AAIzD,6DAAsD;AACtD,8DAAuE;AAEvE,0DAAwC;AACxC,kDAAgC;AAChC,kDAAgC;AAChC,0DAAwC;AACxC,sDAAoC;AACpC,wDAAsC;AACtC,uDAAqC;AAExB,QAAA,SAAS,GAAoB;IACtC,OAAO,EAAE,qCAAgB;IACzB,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,qCAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,OAAO;YACrB,gBAAgB,EAAE;gBACd,IAAI,2CAA2B,CAAC,wBAAwB,CAAC;aAC5D;SACJ;QACD;YACI,aAAa,EAAE,qCAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,IAAI;SACnB;QACD;YACI,aAAa,EAAE,qCAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;QACD;YACI,aAAa,EAAE,qCAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;KACJ;IACD,aAAa,EAAE;QACX,6BAAgB;KACnB;CACJ,CAAA"}

package/dist/lib/cjs/managers/jwt.manager.js

@@ -15,16 +15,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JwtManager = void 0;
 require("reflect-metadata");
 const tsyringe_1 = require("tsyringe");
+const common_1 = require("@pristine-ts/common");
 const jsonwebtoken_1 = require("jsonwebtoken");
 const jwt_authorization_header_error_1 = require("../errors/jwt-authorization-header.error");
 const invalid_jwt_error_1 = require("../errors/invalid-jwt.error");
+const jwt_module_keyname_1 = require("../jwt.module.keyname");
+/**
+ * The JwtManager makes decodes and validates JWT token so that they can be used.
+ */
 let JwtManager = class JwtManager {
+    /**
+     * The JwtManager makes decodes and validates JWT token so that they can be used.
+     * @param publicKey The public key to use to validate the JWT token.
+     * @param algorithm The algorithm to use to decode the JWT token.
+     * @param privateKey
+     * @param passphrase
+     */
     constructor(publicKey, algorithm, privateKey, passphrase) {
         this.publicKey = publicKey;
         this.algorithm = algorithm;
         this.privateKey = privateKey;
         this.passphrase = passphrase;
     }
+    /**
+     * Validates that the request contains the Authorization and that it is properly formed and returns the JWT.
+     * @param request The request to validate.
+     * @private
+     */
     validateRequestAndReturnToken(request) {
         if (request.headers === undefined || request.headers.hasOwnProperty("Authorization") === false) {
             throw new jwt_authorization_header_error_1.JwtAuthorizationHeaderError("The Authorization header wasn't found in the Request.", request);
@@ -38,6 +55,10 @@ let JwtManager = class JwtManager {
         }
         return authorizationHeader.substr(7, authorizationHeader.length);
     }
+    /**
+     * Validates that the request is authorized by validating the JWT and returning the decoded JWT.
+     * @param request The request to validate that contains the JWT.
+     */
     validateAndDecode(request) {
         return new Promise((resolve, reject) => {
             try {
@@ -58,6 +79,8 @@ let JwtManager = class JwtManager {
     }
 };
 JwtManager = __decorate([
+    common_1.moduleScoped(jwt_module_keyname_1.JwtModuleKeyname),
+    common_1.tag("JwtManagerInterface"),
     tsyringe_1.injectable(),
     __param(0, tsyringe_1.inject("%pristine.jwt.publicKey%")),
     __param(1, tsyringe_1.inject("%pristine.jwt.algorithm%")),

package/dist/lib/cjs/managers/jwt.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt.manager.js","sourceRoot":"","sources":["../../../../src/managers/jwt.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4BAAyB;AACzB,uCAAuF;AAGvF,+CAA8C;AAC9C,6FAAqF;AACrF,mEAA4D;AAI5D,IAAa,UAAU,GAAvB,MAAa,UAAU;IACnB,YACyD,SAAiB,EACjB,SAAoB,EACnB,UAAmB,EACnB,UAAmB;QAHpB,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAW;QACnB,eAAU,GAAV,UAAU,CAAS;QACnB,eAAU,GAAV,UAAU,CAAS;IAE7E,CAAC;IAEO,6BAA6B,CAAC,OAAyB;QAC3D,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,KAAK,KAAK,EAAE;YAC5F,MAAM,IAAI,4DAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAE1D,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,MAAM,IAAI,4DAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YACrD,MAAM,IAAI,4DAA2B,CAAC,gEAAgE,EAAE,OAAO,CAAC,CAAA;SACnH;QAED,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAEM,iBAAiB,CAAC,OAAyB;QAC9C,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI;gBACA,MAAM,KAAK,GAAG,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;gBAE1D,qBAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE;oBAC1B,UAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;iBAC/B,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;oBAChB,IAAI,GAAG,EAAE;wBACL,OAAO,MAAM,CAAC,IAAI,mCAAe,CAAC,qBAAqB,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;qBAClH;oBAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAA;aAEL;YAAC,OAAO,CAAC,EAAE;gBACR,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;aACpB;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ,CAAA;AA/CY,UAAU;IADtB,qBAAU,EAAE;IAGJ,WAAA,iBAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,iBAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,iBAAM,CAAC,2BAA2B,CAAC,CAAA;IACnC,WAAA,iBAAM,CAAC,2BAA2B,CAAC,CAAA;;GAL/B,UAAU,CA+CtB;AA/CY,gCAAU"}
+{"version":3,"file":"jwt.manager.js","sourceRoot":"","sources":["../../../../src/managers/jwt.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4BAAyB;AACzB,uCAAuF;AACvF,gDAAwE;AAExE,+CAA8C;AAC9C,6FAAqF;AACrF,mEAA4D;AAE5D,8DAAuD;AAEvD;;GAEG;AAIH,IAAa,UAAU,GAAvB,MAAa,UAAU;IACnB;;;;;;OAMG;IACH,YACyD,SAAiB,EACjB,SAAoB,EACnB,UAAmB,EACnB,UAAmB;QAHpB,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAW;QACnB,eAAU,GAAV,UAAU,CAAS;QACnB,eAAU,GAAV,UAAU,CAAS;IAE7E,CAAC;IAED;;;;OAIG;IACK,6BAA6B,CAAC,OAAyB;QAC3D,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,KAAK,KAAK,EAAE;YAC5F,MAAM,IAAI,4DAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAE1D,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,MAAM,IAAI,4DAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YACrD,MAAM,IAAI,4DAA2B,CAAC,gEAAgE,EAAE,OAAO,CAAC,CAAA;SACnH;QAED,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,OAAyB;QAC9C,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI;gBACA,MAAM,KAAK,GAAG,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;gBAE1D,qBAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE;oBAC1B,UAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;iBAC/B,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;oBAChB,IAAI,GAAG,EAAE;wBACL,OAAO,MAAM,CAAC,IAAI,mCAAe,CAAC,qBAAqB,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;qBAClH;oBAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAA;aAEL;YAAC,OAAO,CAAC,EAAE;gBACR,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;aACpB;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ,CAAA;AA/DY,UAAU;IAHtB,qBAAY,CAAC,qCAAgB,CAAC;IAC9B,YAAG,CAAC,qBAAqB,CAAC;IAC1B,qBAAU,EAAE;IAUJ,WAAA,iBAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,iBAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,iBAAM,CAAC,2BAA2B,CAAC,CAAA;IACnC,WAAA,iBAAM,CAAC,2BAA2B,CAAC,CAAA;;GAZ/B,UAAU,CA+DtB;AA/DY,gCAAU"}

package/dist/lib/cjs/resolvers/jwt-payload-parameter-decorator.resolver.js

@@ -8,6 +8,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -21,13 +24,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JwtPayloadParameterDecoratorResolver = void 0;
 require("reflect-metadata");
 const tsyringe_1 = require("tsyringe");
-const jwt_manager_1 = require("../managers/jwt.manager");
 const common_1 = require("@pristine-ts/common");
 const jwt_module_keyname_1 = require("../jwt.module.keyname");
+/**
+ * The JwtPayloadParameterDecoratorResolver resolves the decoded JWT in the parameter of a route of a controller when the @jwtPayload() decorator is used.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let JwtPayloadParameterDecoratorResolver = class JwtPayloadParameterDecoratorResolver {
     constructor(jwtManager) {
         this.jwtManager = jwtManager;
     }
+    /**
+     * Resolves the decoded JWT.
+     * @param methodArgument The argument of the method that needs to be resolved.
+     * @param request The request being handled by the controller method.
+     * @param routeParameters The parameters of the route (path parameter).
+     * @param identity The identity of the user making the request.
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         return __awaiter(this, void 0, void 0, function* () {
             // Here, we need to decrypt the header and return the decrypted jwt payload
@@ -40,6 +53,10 @@ let JwtPayloadParameterDecoratorResolver = class JwtPayloadParameterDecoratorRes
             return payload;
         });
     }
+    /**
+     * Verifies if the resolver supports this type of method argument.
+     * @param methodArgument The argument of the method that needs to be resolved.
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "jwtPayload";
     }
@@ -48,7 +65,8 @@ JwtPayloadParameterDecoratorResolver = __decorate([
     common_1.moduleScoped(jwt_module_keyname_1.JwtModuleKeyname),
     common_1.tag(common_1.ServiceDefinitionTagEnum.MethodParameterDecoratorResolver),
     tsyringe_1.injectable(),
-    __metadata("design:paramtypes", [jwt_manager_1.JwtManager])
+    __param(0, tsyringe_1.inject("JwtManagerInterface")),
+    __metadata("design:paramtypes", [Object])
 ], JwtPayloadParameterDecoratorResolver);
 exports.JwtPayloadParameterDecoratorResolver = JwtPayloadParameterDecoratorResolver;
 //# sourceMappingURL=jwt-payload-parameter-decorator.resolver.js.map

package/dist/lib/cjs/resolvers/jwt-payload-parameter-decorator.resolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-payload-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/jwt-payload-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,4BAAyB;AACzB,uCAAoC;AAEpC,yDAAmD;AACnD,gDAAmG;AACnG,8DAAuD;AAKvD,IAAa,oCAAoC,GAAjD,MAAa,oCAAoC;IAE7C,YAA6B,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IACnD,CAAC;IAEK,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;YAEtC,2EAA2E;YAC3E,IAAI,OAAO,GAAG,EAAE,CAAC;YAEjB,IAAI;gBACA,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;aAC9D;YAAC,OAAO,CAAC,EAAE;aACX;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAED,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,YAAY,CAAC;IAC3G,CAAC;CACJ,CAAA;AAxBY,oCAAoC;IAHhD,qBAAY,CAAC,qCAAgB,CAAC;IAC9B,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;qCAGgC,wBAAU;GAF1C,oCAAoC,CAwBhD;AAxBY,oFAAoC"}
+{"version":3,"file":"jwt-payload-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/jwt-payload-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,4BAAyB;AACzB,uCAA4C;AAE5C,gDAAmG;AACnG,8DAAuD;AAGvD;;;GAGG;AAIH,IAAa,oCAAoC,GAAjD,MAAa,oCAAoC;IAE7C,YAA4D,UAA+B;QAA/B,eAAU,GAAV,UAAU,CAAqB;IAC3F,CAAC;IAED;;;;;;OAMG;IACG,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;YAEtC,2EAA2E;YAC3E,IAAI,OAAO,GAAG,EAAE,CAAC;YAEjB,IAAI;gBACA,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;aAC9D;YAAC,OAAO,CAAC,EAAE;aACX;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAED;;;OAGG;IACH,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,YAAY,CAAC;IAC3G,CAAC;CACJ,CAAA;AAnCY,oCAAoC;IAHhD,qBAAY,CAAC,qCAAgB,CAAC;IAC9B,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;IAGI,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;;GAFjC,oCAAoC,CAmChD;AAnCY,oFAAoC"}

package/dist/lib/esm/decorators/jwt-payload.decorators.js

@@ -1,5 +1,22 @@
+/**
+ * This decorator can be used to inject the decoded JWT payload of a request in a parameter of a method in a controller.
+ */
 export const jwtPayload = () => {
-    return (target, propertyKey, parameterIndex) => {
+    return (
+    /**
+     * The class on which the decorator is used.
+     */
+    target, 
+    /**
+     * The method on which the decorator is used.
+     */
+    propertyKey, 
+    /**
+     * The index of the parameter for which the decorator is used.
+     */
+    parameterIndex) => {
+        // Verify that the object target.constructor.prototype["__metadata__"]["methods"][propertyKey]["arguments"] exists or we create it.
+        // This object is a convention defined by Pristine on where to save controller method parameter decorator information and is used in the router to retrieve that information.
         if (target.constructor.prototype.hasOwnProperty("__metadata__") === false) {
             target.constructor.prototype["__metadata__"] = {};
         }
@@ -12,9 +29,11 @@ export const jwtPayload = () => {
         if (target.constructor.prototype["__metadata__"]["methods"][propertyKey].hasOwnProperty("arguments") === false) {
             target.constructor.prototype["__metadata__"]["methods"][propertyKey]["arguments"] = [];
         }
+        // Set the type of method parameter. Each decorator has it's own type.
         const methodParameter = {
             type: "jwtPayload"
         };
+        // Save the method parameter with the proper parameter index (index of the parameter in the list of parameters of a method).
         target.constructor.prototype["__metadata__"]["methods"][propertyKey]["arguments"][parameterIndex] = methodParameter;
     };
 };

package/dist/lib/esm/decorators/jwt-payload.decorators.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-payload.decorators.js","sourceRoot":"","sources":["../../../../src/decorators/jwt-payload.decorators.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE;IAC3B,OAAO,CACH,MAAc,EACd,WAA4B,EAC5B,cAAsB,EACxB,EAAE;QACA,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,KAAK,KAAK,EAAE;YACvE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,CAAA;SACpD;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YAClF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAA;SAC/D;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC/F,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAA;SAC5E;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC5G,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;SAC1F;QAED,MAAM,eAAe,GAAiC;YAClD,IAAI,EAAE,YAAY;SACrB,CAAC;QAEF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,GAAG,eAAe,CAAC;IACxH,CAAC,CAAA;AACL,CAAC,CAAC"}
+{"version":3,"file":"jwt-payload.decorators.js","sourceRoot":"","sources":["../../../../src/decorators/jwt-payload.decorators.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE;IAC3B,OAAO;IACH;;OAEG;IACH,MAAc;IAEd;;OAEG;IACH,WAA4B;IAE5B;;OAEG;IACH,cAAsB,EACxB,EAAE;QACA,mIAAmI;QACnI,6KAA6K;QAC7K,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,KAAK,KAAK,EAAE;YACvE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,CAAA;SACpD;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YAClF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAA;SAC/D;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC/F,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAA;SAC5E;QAED,IAAI,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE;YAC5G,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;SAC1F;QAED,sEAAsE;QACtE,MAAM,eAAe,GAAiC;YAClD,IAAI,EAAE,YAAY;SACrB,CAAC;QAEF,4HAA4H;QAC5H,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,GAAG,eAAe,CAAC;IACxH,CAAC,CAAA;AACL,CAAC,CAAC"}

package/dist/lib/esm/errors/invalid-jwt.error.js

@@ -1,8 +1,17 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This Error is thrown when you try to decode a JWT but the token is invalid.
  */
-import { LoggableError } from "@pristine-ts/common";
 export class InvalidJwtError extends LoggableError {
+    /**
+     * This Error is thrown when you try to decode a JWT but the token is invalid.
+     * @param message The error message to show.
+     * @param previousError The previous error.
+     * @param request The request that contained the JWT.
+     * @param token The actual JWT.
+     * @param algorithm The algorithm used to decode the JWT.
+     * @param publicKey The public key used to decode the JWT.
+     */
     constructor(message, previousError, request, token, algorithm, publicKey) {
         super(message, {
             request,

package/dist/lib/esm/errors/invalid-jwt.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"invalid-jwt.error.js","sourceRoot":"","sources":["../../../../src/errors/invalid-jwt.error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAC,aAAa,EAAmB,MAAM,qBAAqB,CAAC;AAEpE,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAE9C,YAAmB,OAAe,EAAE,aAAoB,EAAE,OAAyB,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS;QAC5G,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,aAAa;YACb,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CACnE"}
+{"version":3,"file":"invalid-jwt.error.js","sourceRoot":"","sources":["../../../../src/errors/invalid-jwt.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAmB,MAAM,qBAAqB,CAAC;AAEpE;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAE9C;;;;;;;;OAQG;IACH,YAAmB,OAAe,EAAE,aAAoB,EAAE,OAAyB,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS;QAC5G,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,aAAa;YACb,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CACnE"}

package/dist/lib/esm/errors/jwt-authorization-header.error.js

@@ -1,8 +1,13 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This Error is thrown when there's you try to decode a JWT in a request but the AuthorizationHeader is missing.
  */
-import { LoggableError } from "@pristine-ts/common";
 export class JwtAuthorizationHeaderError extends LoggableError {
+    /**
+     * This Error is thrown when there's you try to decode a JWT in a request but the AuthorizationHeader is missing.
+     * @param message The error message.
+     * @param request The request that is missing the AuthorizationHeader.
+     */
     constructor(message, request) {
         super(message, {
             request,

package/dist/lib/esm/errors/jwt-authorization-header.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-authorization-header.error.js","sourceRoot":"","sources":["../../../../src/errors/jwt-authorization-header.error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAC,aAAa,EAAmB,MAAM,qBAAqB,CAAC;AAEpE,MAAM,OAAO,2BAA4B,SAAQ,aAAa;IAC1D,YAAmB,OAAe,EAAE,OAAyB;QACzD,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;SACV,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CAC/E"}
+{"version":3,"file":"jwt-authorization-header.error.js","sourceRoot":"","sources":["../../../../src/errors/jwt-authorization-header.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAmB,MAAM,qBAAqB,CAAC;AAEpE;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,aAAa;IAC1D;;;;OAIG;IACH,YAAmB,OAAe,EAAE,OAAyB;QACzD,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;SACV,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CAC/E"}

package/dist/lib/esm/guards/jwt-protected.guard.js

@@ -11,11 +11,19 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
 import { inject, injectable } from "tsyringe";
+/**
+ * This guard is used to verify that a route can only be accessed when a request has a valid JWT.
+ */
 let JwtProtectedGuard = class JwtProtectedGuard {
     constructor(jwtManager) {
         this.jwtManager = jwtManager;
         this.keyname = "jwt.protected";
     }
+    /**
+     * Verifies if the JWT is valid and authorizes access if it is.
+     * @param request
+     * @param identity
+     */
     isAuthorized(request, identity) {
         return new Promise((resolve) => {
             this.jwtManager.validateAndDecode(request)
@@ -23,6 +31,10 @@ let JwtProtectedGuard = class JwtProtectedGuard {
                 .catch(reason => resolve(false));
         });
     }
+    /**
+     * Sets the context for the guard.
+     * @param context
+     */
     setContext(context) {
         this.guardContext = context;
         return Promise.resolve();

package/dist/lib/esm/guards/jwt-protected.guard.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-protected.guard.js","sourceRoot":"","sources":["../../../../src/guards/jwt-protected.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAO5C,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YAA4D,UAA+B;QAA/B,eAAU,GAAV,UAAU,CAAqB;QAGpF,YAAO,GAAG,eAAe,CAAC;IAFjC,CAAC;IAMD,YAAY,CAAC,OAAyB,EAAE,QAA4B;QAChE,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,EAAE;YACpC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC;iBACrC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IAED,UAAU,CAAC,OAAY;QACnB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAE5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ,CAAA;AArBY,iBAAiB;IAD7B,UAAU,EAAE;IAEI,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GADjC,iBAAiB,CAqB7B;SArBY,iBAAiB"}
+{"version":3,"file":"jwt-protected.guard.js","sourceRoot":"","sources":["../../../../src/guards/jwt-protected.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAM5C;;GAEG;AAEH,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YAA4D,UAA+B;QAA/B,eAAU,GAAV,UAAU,CAAqB;QAGpF,YAAO,GAAG,eAAe,CAAC;IAFjC,CAAC;IAMD;;;;OAIG;IACH,YAAY,CAAC,OAAyB,EAAE,QAA4B;QAChE,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,EAAE;YACpC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC;iBACrC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAY;QACnB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAE5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ,CAAA;AA9BY,iBAAiB;IAD7B,UAAU,EAAE;IAEI,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GADjC,iBAAiB,CA8B7B;SA9BY,iBAAiB"}

package/dist/lib/esm/jwt.module.js

@@ -1,5 +1,4 @@
 import { NetworkingModule } from "@pristine-ts/networking";
-import { JwtManager } from "./managers/jwt.manager";
 import { JwtModuleKeyname } from "./jwt.module.keyname";
 import { EnvironmentVariableResolver } from "@pristine-ts/configuration";
 export * from "./decorators/decorators";
@@ -37,10 +36,6 @@ export const JwtModule = {
     ],
     importModules: [
         NetworkingModule,
-    ],
-    providerRegistrations: [{
-            token: "JwtManagerInterface",
-            useToken: JwtManager,
-        }]
+    ]
 };
 //# sourceMappingURL=jwt.module.js.map

package/dist/lib/esm/jwt.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt.module.js","sourceRoot":"","sources":["../../../src/jwt.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAC,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAGlD,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAC,2BAA2B,EAAC,MAAM,4BAA4B,CAAC;AAEvE,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AAErC,MAAM,CAAC,MAAM,SAAS,GAAoB;IACtC,OAAO,EAAE,gBAAgB;IACzB,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,gBAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,OAAO;YACrB,gBAAgB,EAAE;gBACd,IAAI,2BAA2B,CAAC,wBAAwB,CAAC;aAC5D;SACJ;QACD;YACI,aAAa,EAAE,gBAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,IAAI;SACnB;QACD;YACI,aAAa,EAAE,gBAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;QACD;YACI,aAAa,EAAE,gBAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;KACJ;IACD,aAAa,EAAE;QACX,gBAAgB;KACnB;IACD,qBAAqB,EAAE,CAAC;YACpB,KAAK,EAAE,qBAAqB;YAC5B,QAAQ,EAAE,UAAU;SACvB,CAAC;CACL,CAAA"}
+{"version":3,"file":"jwt.module.js","sourceRoot":"","sources":["../../../src/jwt.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAC,MAAM,yBAAyB,CAAC;AAIzD,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAC,2BAA2B,EAAC,MAAM,4BAA4B,CAAC;AAEvE,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AAErC,MAAM,CAAC,MAAM,SAAS,GAAoB;IACtC,OAAO,EAAE,gBAAgB;IACzB,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,gBAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,OAAO;YACrB,gBAAgB,EAAE;gBACd,IAAI,2BAA2B,CAAC,wBAAwB,CAAC;aAC5D;SACJ;QACD;YACI,aAAa,EAAE,gBAAgB,GAAG,YAAY;YAC9C,UAAU,EAAE,IAAI;SACnB;QACD;YACI,aAAa,EAAE,gBAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;QACD;YACI,aAAa,EAAE,gBAAgB,GAAG,aAAa;YAC/C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;SACnB;KACJ;IACD,aAAa,EAAE;QACX,gBAAgB;KACnB;CACJ,CAAA"}

package/dist/lib/esm/managers/jwt.manager.js

@@ -12,16 +12,33 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 import "reflect-metadata";
 import { inject, injectable } from "tsyringe";
+import { moduleScoped, tag } from "@pristine-ts/common";
 import { verify } from "jsonwebtoken";
 import { JwtAuthorizationHeaderError } from "../errors/jwt-authorization-header.error";
 import { InvalidJwtError } from "../errors/invalid-jwt.error";
+import { JwtModuleKeyname } from "../jwt.module.keyname";
+/**
+ * The JwtManager makes decodes and validates JWT token so that they can be used.
+ */
 let JwtManager = class JwtManager {
+    /**
+     * The JwtManager makes decodes and validates JWT token so that they can be used.
+     * @param publicKey The public key to use to validate the JWT token.
+     * @param algorithm The algorithm to use to decode the JWT token.
+     * @param privateKey
+     * @param passphrase
+     */
     constructor(publicKey, algorithm, privateKey, passphrase) {
         this.publicKey = publicKey;
         this.algorithm = algorithm;
         this.privateKey = privateKey;
         this.passphrase = passphrase;
     }
+    /**
+     * Validates that the request contains the Authorization and that it is properly formed and returns the JWT.
+     * @param request The request to validate.
+     * @private
+     */
     validateRequestAndReturnToken(request) {
         if (request.headers === undefined || request.headers.hasOwnProperty("Authorization") === false) {
             throw new JwtAuthorizationHeaderError("The Authorization header wasn't found in the Request.", request);
@@ -35,6 +52,10 @@ let JwtManager = class JwtManager {
         }
         return authorizationHeader.substr(7, authorizationHeader.length);
     }
+    /**
+     * Validates that the request is authorized by validating the JWT and returning the decoded JWT.
+     * @param request The request to validate that contains the JWT.
+     */
     validateAndDecode(request) {
         return new Promise((resolve, reject) => {
             try {
@@ -55,6 +76,8 @@ let JwtManager = class JwtManager {
     }
 };
 JwtManager = __decorate([
+    moduleScoped(JwtModuleKeyname),
+    tag("JwtManagerInterface"),
     injectable(),
     __param(0, inject("%pristine.jwt.publicKey%")),
     __param(1, inject("%pristine.jwt.algorithm%")),

package/dist/lib/esm/managers/jwt.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt.manager.js","sourceRoot":"","sources":["../../../../src/managers/jwt.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAiC,MAAM,EAAE,UAAU,EAAY,MAAM,UAAU,CAAC;AAGvF,OAAO,EAAY,MAAM,EAAC,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAC,2BAA2B,EAAC,MAAM,0CAA0C,CAAC;AACrF,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAI5D,IAAa,UAAU,GAAvB,MAAa,UAAU;IACnB,YACyD,SAAiB,EACjB,SAAoB,EACnB,UAAmB,EACnB,UAAmB;QAHpB,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAW;QACnB,eAAU,GAAV,UAAU,CAAS;QACnB,eAAU,GAAV,UAAU,CAAS;IAE7E,CAAC;IAEO,6BAA6B,CAAC,OAAyB;QAC3D,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,KAAK,KAAK,EAAE;YAC5F,MAAM,IAAI,2BAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAE1D,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,MAAM,IAAI,2BAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YACrD,MAAM,IAAI,2BAA2B,CAAC,gEAAgE,EAAE,OAAO,CAAC,CAAA;SACnH;QAED,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAEM,iBAAiB,CAAC,OAAyB;QAC9C,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI;gBACA,MAAM,KAAK,GAAG,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;gBAE1D,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE;oBAC1B,UAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;iBAC/B,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;oBAChB,IAAI,GAAG,EAAE;wBACL,OAAO,MAAM,CAAC,IAAI,eAAe,CAAC,qBAAqB,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;qBAClH;oBAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAA;aAEL;YAAC,OAAO,CAAC,EAAE;gBACR,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;aACpB;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ,CAAA;AA/CY,UAAU;IADtB,UAAU,EAAE;IAGJ,WAAA,MAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,MAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,MAAM,CAAC,2BAA2B,CAAC,CAAA;IACnC,WAAA,MAAM,CAAC,2BAA2B,CAAC,CAAA;;GAL/B,UAAU,CA+CtB;SA/CY,UAAU"}
+{"version":3,"file":"jwt.manager.js","sourceRoot":"","sources":["../../../../src/managers/jwt.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAiC,MAAM,EAAE,UAAU,EAAY,MAAM,UAAU,CAAC;AACvF,OAAO,EAAC,YAAY,EAAoB,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAExE,OAAO,EAAY,MAAM,EAAC,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAC,2BAA2B,EAAC,MAAM,0CAA0C,CAAC;AACrF,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAE5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AAEvD;;GAEG;AAIH,IAAa,UAAU,GAAvB,MAAa,UAAU;IACnB;;;;;;OAMG;IACH,YACyD,SAAiB,EACjB,SAAoB,EACnB,UAAmB,EACnB,UAAmB;QAHpB,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAW;QACnB,eAAU,GAAV,UAAU,CAAS;QACnB,eAAU,GAAV,UAAU,CAAS;IAE7E,CAAC;IAED;;;;OAIG;IACK,6BAA6B,CAAC,OAAyB;QAC3D,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,KAAK,KAAK,EAAE;YAC5F,MAAM,IAAI,2BAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAE1D,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,MAAM,IAAI,2BAA2B,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;SAC3G;QAED,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;YACrD,MAAM,IAAI,2BAA2B,CAAC,gEAAgE,EAAE,OAAO,CAAC,CAAA;SACnH;QAED,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,OAAyB;QAC9C,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI;gBACA,MAAM,KAAK,GAAG,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;gBAE1D,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE;oBAC1B,UAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;iBAC/B,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;oBAChB,IAAI,GAAG,EAAE;wBACL,OAAO,MAAM,CAAC,IAAI,eAAe,CAAC,qBAAqB,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;qBAClH;oBAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAA;aAEL;YAAC,OAAO,CAAC,EAAE;gBACR,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;aACpB;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ,CAAA;AA/DY,UAAU;IAHtB,YAAY,CAAC,gBAAgB,CAAC;IAC9B,GAAG,CAAC,qBAAqB,CAAC;IAC1B,UAAU,EAAE;IAUJ,WAAA,MAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,MAAM,CAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,MAAM,CAAC,2BAA2B,CAAC,CAAA;IACnC,WAAA,MAAM,CAAC,2BAA2B,CAAC,CAAA;;GAZ/B,UAAU,CA+DtB;SA/DY,UAAU"}

package/dist/lib/esm/resolvers/jwt-payload-parameter-decorator.resolver.js

@@ -7,6 +7,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -17,14 +20,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import "reflect-metadata";
-import { injectable } from "tsyringe";
-import { JwtManager } from "../managers/jwt.manager";
+import { inject, injectable } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { JwtModuleKeyname } from "../jwt.module.keyname";
+/**
+ * The JwtPayloadParameterDecoratorResolver resolves the decoded JWT in the parameter of a route of a controller when the @jwtPayload() decorator is used.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let JwtPayloadParameterDecoratorResolver = class JwtPayloadParameterDecoratorResolver {
     constructor(jwtManager) {
         this.jwtManager = jwtManager;
     }
+    /**
+     * Resolves the decoded JWT.
+     * @param methodArgument The argument of the method that needs to be resolved.
+     * @param request The request being handled by the controller method.
+     * @param routeParameters The parameters of the route (path parameter).
+     * @param identity The identity of the user making the request.
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         return __awaiter(this, void 0, void 0, function* () {
             // Here, we need to decrypt the header and return the decrypted jwt payload
@@ -37,6 +50,10 @@ let JwtPayloadParameterDecoratorResolver = class JwtPayloadParameterDecoratorRes
             return payload;
         });
     }
+    /**
+     * Verifies if the resolver supports this type of method argument.
+     * @param methodArgument The argument of the method that needs to be resolved.
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "jwtPayload";
     }
@@ -45,7 +62,8 @@ JwtPayloadParameterDecoratorResolver = __decorate([
     moduleScoped(JwtModuleKeyname),
     tag(ServiceDefinitionTagEnum.MethodParameterDecoratorResolver),
     injectable(),
-    __metadata("design:paramtypes", [JwtManager])
+    __param(0, inject("JwtManagerInterface")),
+    __metadata("design:paramtypes", [Object])
 ], JwtPayloadParameterDecoratorResolver);
 export { JwtPayloadParameterDecoratorResolver };
 //# sourceMappingURL=jwt-payload-parameter-decorator.resolver.js.map

package/dist/lib/esm/resolvers/jwt-payload-parameter-decorator.resolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-payload-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/jwt-payload-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAEpC,OAAO,EAAC,UAAU,EAAC,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AAKvD,IAAa,oCAAoC,GAAjD,MAAa,oCAAoC;IAE7C,YAA6B,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IACnD,CAAC;IAEK,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;YAEtC,2EAA2E;YAC3E,IAAI,OAAO,GAAG,EAAE,CAAC;YAEjB,IAAI;gBACA,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;aAC9D;YAAC,OAAO,CAAC,EAAE;aACX;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAED,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,YAAY,CAAC;IAC3G,CAAC;CACJ,CAAA;AAxBY,oCAAoC;IAHhD,YAAY,CAAC,gBAAgB,CAAC;IAC9B,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;qCAGgC,UAAU;GAF1C,oCAAoC,CAwBhD;SAxBY,oCAAoC"}
+{"version":3,"file":"jwt-payload-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/jwt-payload-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAE5C,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AAGvD;;;GAGG;AAIH,IAAa,oCAAoC,GAAjD,MAAa,oCAAoC;IAE7C,YAA4D,UAA+B;QAA/B,eAAU,GAAV,UAAU,CAAqB;IAC3F,CAAC;IAED;;;;;;OAMG;IACG,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;YAEtC,2EAA2E;YAC3E,IAAI,OAAO,GAAG,EAAE,CAAC;YAEjB,IAAI;gBACA,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;aAC9D;YAAC,OAAO,CAAC,EAAE;aACX;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAED;;;OAGG;IACH,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,YAAY,CAAC;IAC3G,CAAC;CACJ,CAAA;AAnCY,oCAAoC;IAHhD,YAAY,CAAC,gBAAgB,CAAC;IAC9B,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;IAGI,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GAFjC,oCAAoC,CAmChD;SAnCY,oCAAoC"}

package/dist/types/decorators/jwt-payload.decorators.d.ts

@@ -1 +1,4 @@
+/**
+ * This decorator can be used to inject the decoded JWT payload of a request in a parameter of a method in a controller.
+ */
 export declare const jwtPayload: () => (target: Object, propertyKey: string | symbol, parameterIndex: number) => void;

package/dist/types/errors/invalid-jwt.error.d.ts

@@ -1,7 +1,16 @@
+import { LoggableError, RequestInterface } from "@pristine-ts/common";
 /**
  * This Error is thrown when you try to decode a JWT but the token is invalid.
  */
-import { LoggableError, RequestInterface } from "@pristine-ts/common";
 export declare class InvalidJwtError extends LoggableError {
+    /**
+     * This Error is thrown when you try to decode a JWT but the token is invalid.
+     * @param message The error message to show.
+     * @param previousError The previous error.
+     * @param request The request that contained the JWT.
+     * @param token The actual JWT.
+     * @param algorithm The algorithm used to decode the JWT.
+     * @param publicKey The public key used to decode the JWT.
+     */
     constructor(message: string, previousError: Error, request: RequestInterface, token: any, algorithm: any, publicKey: any);
 }

package/dist/types/errors/jwt-authorization-header.error.d.ts

@@ -1,7 +1,12 @@
+import { LoggableError, RequestInterface } from "@pristine-ts/common";
 /**
  * This Error is thrown when there's you try to decode a JWT in a request but the AuthorizationHeader is missing.
  */
-import { LoggableError, RequestInterface } from "@pristine-ts/common";
 export declare class JwtAuthorizationHeaderError extends LoggableError {
+    /**
+     * This Error is thrown when there's you try to decode a JWT in a request but the AuthorizationHeader is missing.
+     * @param message The error message.
+     * @param request The request that is missing the AuthorizationHeader.
+     */
     constructor(message: string, request: RequestInterface);
 }

package/dist/types/guards/jwt-protected.guard.d.ts

@@ -2,11 +2,23 @@ import { JwtManagerInterface } from "../interfaces/jwt-manager.interface";
 import { IdentityInterface, RequestInterface } from "@pristine-ts/common";
 import { GuardInterface } from "@pristine-ts/security";
 import { GuardContextInterface } from "@pristine-ts/security";
+/**
+ * This guard is used to verify that a route can only be accessed when a request has a valid JWT.
+ */
 export declare class JwtProtectedGuard implements GuardInterface {
     private readonly jwtManager;
     constructor(jwtManager: JwtManagerInterface);
     keyname: string;
     guardContext: GuardContextInterface;
+    /**
+     * Verifies if the JWT is valid and authorizes access if it is.
+     * @param request
+     * @param identity
+     */
     isAuthorized(request: RequestInterface, identity?: IdentityInterface): Promise<boolean>;
+    /**
+     * Sets the context for the guard.
+     * @param context
+     */
     setContext(context: any): Promise<void>;
 }

package/dist/types/interfaces/jwt-manager.interface.d.ts

@@ -1,4 +1,11 @@
 import { RequestInterface } from "@pristine-ts/common";
+/**
+ * The JwtManager Interface defines the methods that a JWT manager must implement.
+ */
 export interface JwtManagerInterface {
+    /**
+     * Validates and returns the decoded JWT.
+     * @param request The request containing the JWT.
+     */
     validateAndDecode(request: RequestInterface): Promise<any>;
 }

package/dist/types/interfaces/jwt-payload-decorator.interface.d.ts

@@ -1,4 +1,7 @@
 import { ParameterDecoratorInterface } from "@pristine-ts/networking";
+/**
+ * The JwtPayloadDecoratorInterface defines what a JWT payload decorator needs.
+ */
 export interface JwtPayloadDecoratorInterface extends ParameterDecoratorInterface {
     type: "jwtPayload";
 }

package/dist/types/managers/jwt.manager.d.ts

@@ -2,12 +2,31 @@ import "reflect-metadata";
 import { RequestInterface } from "@pristine-ts/common";
 import { Algorithm } from "jsonwebtoken";
 import { JwtManagerInterface } from "../interfaces/jwt-manager.interface";
+/**
+ * The JwtManager makes decodes and validates JWT token so that they can be used.
+ */
 export declare class JwtManager implements JwtManagerInterface {
     private readonly publicKey;
     private readonly algorithm;
     private readonly privateKey?;
     private readonly passphrase?;
+    /**
+     * The JwtManager makes decodes and validates JWT token so that they can be used.
+     * @param publicKey The public key to use to validate the JWT token.
+     * @param algorithm The algorithm to use to decode the JWT token.
+     * @param privateKey
+     * @param passphrase
+     */
     constructor(publicKey: string, algorithm: Algorithm, privateKey?: string | undefined, passphrase?: string | undefined);
+    /**
+     * Validates that the request contains the Authorization and that it is properly formed and returns the JWT.
+     * @param request The request to validate.
+     * @private
+     */
     private validateRequestAndReturnToken;
+    /**
+     * Validates that the request is authorized by validating the JWT and returning the decoded JWT.
+     * @param request The request to validate that contains the JWT.
+     */
     validateAndDecode(request: RequestInterface): Promise<any>;
 }

package/dist/types/resolvers/jwt-payload-parameter-decorator.resolver.d.ts

@@ -1,12 +1,27 @@
 import "reflect-metadata";
 import { ControllerMethodParameterDecoratorResolverInterface, Request } from "@pristine-ts/networking";
-import { JwtManager } from "../managers/jwt.manager";
 import { IdentityInterface } from "@pristine-ts/common";
+import { JwtManagerInterface } from "../interfaces/jwt-manager.interface";
+/**
+ * The JwtPayloadParameterDecoratorResolver resolves the decoded JWT in the parameter of a route of a controller when the @jwtPayload() decorator is used.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 export declare class JwtPayloadParameterDecoratorResolver implements ControllerMethodParameterDecoratorResolverInterface {
     private readonly jwtManager;
-    constructor(jwtManager: JwtManager);
+    constructor(jwtManager: JwtManagerInterface);
+    /**
+     * Resolves the decoded JWT.
+     * @param methodArgument The argument of the method that needs to be resolved.
+     * @param request The request being handled by the controller method.
+     * @param routeParameters The parameters of the route (path parameter).
+     * @param identity The identity of the user making the request.
+     */
     resolve(methodArgument: any, request: Request, routeParameters: {
         [p: string]: string;
     }, identity?: IdentityInterface): Promise<any>;
+    /**
+     * Verifies if the resolver supports this type of method argument.
+     * @param methodArgument The argument of the method that needs to be resolved.
+     */
     supports(methodArgument: any): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pristine-ts/jwt",
-  "version": "0.0.139",
+  "version": "0.0.143",
   "description": "",
   "module": "dist/lib/esm/jwt.module.js",
   "main": "dist/lib/cjs/jwt.module.js",
@@ -19,9 +19,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@pristine-ts/common": "^0.0.139",
-    "@pristine-ts/networking": "^0.0.139",
-    "@pristine-ts/security": "^0.0.139",
+    "@pristine-ts/common": "^0.0.143",
+    "@pristine-ts/networking": "^0.0.143",
+    "@pristine-ts/security": "^0.0.143",
     "jsonwebtoken": "^8.5.1"
   },
   "devDependencies": {
@@ -61,5 +61,5 @@
       "src/*.{js,ts}"
     ]
   },
-  "gitHead": "9057da83ea4c70c321246e5201b57ce7f3239ff6"
+  "gitHead": "b755c7c2a01ad7fce56c6050b4c09cea05afd5ff"
 }

package/readme.md

@@ -0,0 +1 @@
+# JWT module