@pristine-ts/security 0.0.188 → 0.0.192

package/dist/lib/esm/enums/resource-action.enum.js

@@ -1,3 +1,8 @@
+/**
+ * The resource action enum specifies the most common actions that can be taken on a resource.
+ * It's used in the voters to validate if a user is authorized to execute that action.
+ * More actions can be defined in more specified enum based on the resource type.
+ */
 export var ResourceActionEnum;
 (function (ResourceActionEnum) {
     ResourceActionEnum["List"] = "LIST";

package/dist/lib/esm/enums/resource-action.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource-action.enum.js","sourceRoot":"","sources":["../../../../src/enums/resource-action.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,mCAAa,CAAA;IACb,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;AACrB,CAAC,EANW,kBAAkB,KAAlB,kBAAkB,QAM7B"}
+{"version":3,"file":"resource-action.enum.js","sourceRoot":"","sources":["../../../../src/enums/resource-action.enum.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAN,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,mCAAa,CAAA;IACb,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;AACrB,CAAC,EANW,kBAAkB,KAAlB,kBAAkB,QAM7B"}

package/dist/lib/esm/enums/vote.enum.js

@@ -1,3 +1,6 @@
+/**
+ * The vote enum defines the different decisions that a voter can take.
+ */
 export var VoteEnum;
 (function (VoteEnum) {
     VoteEnum["Grant"] = "GRANT";

package/dist/lib/esm/enums/vote.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"vote.enum.js","sourceRoot":"","sources":["../../../../src/enums/vote.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAChB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,+BAAmB,CAAA;AACvB,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB"}
+{"version":3,"file":"vote.enum.js","sourceRoot":"","sources":["../../../../src/enums/vote.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAChB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,+BAAmB,CAAA;AACvB,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB"}

package/dist/lib/esm/enums/voting-strategy.enum.js

@@ -1,6 +1,16 @@
+/**
+ * The voting strategy enum defines the different strategies that the permission manager uses to
+ * merge the results of all the voter.
+ */
 export var VotingStrategyEnum;
 (function (VotingStrategyEnum) {
+    /**
+     * When all the voters abstain from voting, the access is granted.
+     */
     VotingStrategyEnum["GrantOnUnanimousAbstention"] = "GRANT_ON_UNANIMOUS_ABSTENTION";
+    /**
+     * When all the voters abstain from voting, the access is denied.
+     */
     VotingStrategyEnum["DenyOnUnanimousAbstention"] = "DENY_ON_UNANIMOUS_ABSTENTION";
 })(VotingStrategyEnum || (VotingStrategyEnum = {}));
 //# sourceMappingURL=voting-strategy.enum.js.map

package/dist/lib/esm/enums/voting-strategy.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"voting-strategy.enum.js","sourceRoot":"","sources":["../../../../src/enums/voting-strategy.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,kFAA4D,CAAA;IAC5D,gFAA0D,CAAA;AAC9D,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B"}
+{"version":3,"file":"voting-strategy.enum.js","sourceRoot":"","sources":["../../../../src/enums/voting-strategy.enum.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC1B;;OAEG;IACH,kFAA4D,CAAA;IAE5D;;OAEG;IACH,gFAA0D,CAAA;AAC9D,CAAC,EAVW,kBAAkB,KAAlB,kBAAkB,QAU7B"}

package/dist/lib/esm/errors/authenticator-decorator.error.js

@@ -1,7 +1,7 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
- * This Error is thrown when there's an error that happens when the guards ere being initialized
+ * This Error is thrown when there's an error with the authenticator decorator.
  */
-import { LoggableError } from "@pristine-ts/common";
 export class AuthenticatorDecoratorError extends LoggableError {
     constructor(message, authenticator, options, target, propertyKey, descriptor) {
         super(message, {

package/dist/lib/esm/errors/authenticator-decorator.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticator-decorator.error.js","sourceRoot":"","sources":["../../../../src/errors/authenticator-decorator.error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD,MAAM,OAAO,2BAA4B,SAAQ,aAAa;IAE1D,YAAmB,OAAe,EAAE,aAAgD,EAAE,OAAY,EAAE,MAAW,EAC5F,WAAoB,EACpB,UAA+B;QAC9C,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,aAAa;YACb,OAAO;YACP,MAAM;YACN,WAAW;YACX,UAAU;SACb,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACvE,CAAC;CACJ"}
+{"version":3,"file":"authenticator-decorator.error.js","sourceRoot":"","sources":["../../../../src/errors/authenticator-decorator.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,aAAa;IAE1D,YAAmB,OAAe,EAAE,aAAgD,EAAE,OAAY,EAAE,MAAW,EAC5F,WAAoB,EACpB,UAA+B;QAC9C,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,aAAa;YACb,OAAO;YACP,MAAM;YACN,WAAW;YACX,UAAU;SACb,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACvE,CAAC;CACJ"}

package/dist/lib/esm/errors/authenticator-instantiation.error.js

@@ -1,7 +1,7 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This Error is thrown when there's an error that happens when the authenticator are being initialized
  */
-import { LoggableError } from "@pristine-ts/common";
 export class AuthenticatorInstantiationError extends LoggableError {
     constructor(message, instantiatedAuthenticator, authenticatorContext) {
         super(message, {

package/dist/lib/esm/errors/authenticator-instantiation.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticator-instantiation.error.js","sourceRoot":"","sources":["../../../../src/errors/authenticator-instantiation.error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD,MAAM,OAAO,+BAAgC,SAAQ,aAAa;IAG9D,YAAmB,OAAe,EAAE,yBAA4D,EAAE,oBAAyB;QACvH,KAAK,CAAC,OAAO,EAAE;YACX,yBAAyB;YACzB,oBAAoB;SACvB,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,+BAA+B,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;CACJ"}
+{"version":3,"file":"authenticator-instantiation.error.js","sourceRoot":"","sources":["../../../../src/errors/authenticator-instantiation.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,aAAa;IAG9D,YAAmB,OAAe,EAAE,yBAA4D,EAAE,oBAAyB;QACvH,KAAK,CAAC,OAAO,EAAE;YACX,yBAAyB;YACzB,oBAAoB;SACvB,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,+BAA+B,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;CACJ"}

package/dist/lib/esm/errors/errors.js

@@ -1,3 +1,4 @@
+export * from "./authenticator-decorator.error";
 export * from "./authenticator-instantiation.error";
 export * from "./guard-decorator.error";
 export * from "./guard-instantiation.error";

package/dist/lib/esm/errors/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../../src/errors/errors.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC;AACpD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../../src/errors/errors.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC"}

package/dist/lib/esm/errors/guard-decorator.error.js

@@ -1,7 +1,7 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This Error is thrown when there's an error that happens when the guards ere being initialized
  */
-import { LoggableError } from "@pristine-ts/common";
 export class GuardDecoratorError extends LoggableError {
     constructor(message, guard, options, target, propertyKey, descriptor) {
         super(message, {

package/dist/lib/esm/errors/guard-decorator.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"guard-decorator.error.js","sourceRoot":"","sources":["../../../../src/errors/guard-decorator.error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IAElD,YAAmB,OAAe,EAAE,KAAgC,EAAE,OAAY,EAAE,MAAW,EAC5E,WAAoB,EACpB,UAA+B;QAC9C,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,KAAK;YACL,OAAO;YACP,MAAM;YACN,WAAW;YACX,UAAU;SACb,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC/D,CAAC;CACJ"}
+{"version":3,"file":"guard-decorator.error.js","sourceRoot":"","sources":["../../../../src/errors/guard-decorator.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IAElD,YAAmB,OAAe,EAAE,KAAgC,EAAE,OAAY,EAAE,MAAW,EAC5E,WAAoB,EACpB,UAA+B;QAC9C,KAAK,CAAC,OAAO,EAAE;YACX,OAAO;YACP,KAAK;YACL,OAAO;YACP,MAAM;YACN,WAAW;YACX,UAAU;SACb,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC/D,CAAC;CACJ"}

package/dist/lib/esm/errors/guard-instantiation.error.js

@@ -1,7 +1,7 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This Error is thrown when there's an error that happens when the guards ere being initialized
  */
-import { LoggableError } from "@pristine-ts/common";
 export class GuardInstantiationError extends LoggableError {
     constructor(message, instantiatedGuard, guardContext) {
         super(message, {

package/dist/lib/esm/errors/guard-instantiation.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"guard-instantiation.error.js","sourceRoot":"","sources":["../../../../src/errors/guard-instantiation.error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD,MAAM,OAAO,uBAAwB,SAAQ,aAAa;IACtD,YAAmB,OAAe,EAAE,iBAA4C,EAAE,YAAiB;QAC/F,KAAK,CAAC,OAAO,EAAE;YACX,iBAAiB;YACjB,YAAY;SACf,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;IACnE,CAAC;CACJ"}
+{"version":3,"file":"guard-instantiation.error.js","sourceRoot":"","sources":["../../../../src/errors/guard-instantiation.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,aAAa;IACtD,YAAmB,OAAe,EAAE,iBAA4C,EAAE,YAAiB;QAC/F,KAAK,CAAC,OAAO,EAAE;YACX,iBAAiB;YACjB,YAAY;SACf,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;IACnE,CAAC;CACJ"}

package/dist/lib/esm/factories/authenticator.factory.js

@@ -6,10 +6,21 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { injectable } from "tsyringe";
 import { AuthenticatorInstantiationError } from "../errors/authenticator-instantiation.error";
+/**
+ * The AuthenticatorFactory returns the proper instantiated authenticator.
+ */
 let AuthenticatorFactory = class AuthenticatorFactory {
+    /**
+     * This function takes the authenticator context and returns the proper instantiated authenticator.
+     * It also validates that the authenticator is valid (it implements the AuthenticatorInterface).
+     * @param authenticatorContext The authenticator context that holds the authenticator and options to use.
+     * @param container The dependency container from which to retrieve the instantiated authenticator.
+     */
     fromContext(authenticatorContext, container) {
         // Check if the guard needs to be instantiated
         let instantiatedAuthenticator = authenticatorContext.authenticator;
+        // If authenticatorContext.authenticator is a function, we resolve that function through the container.
+        // TODO: validate if this is good.
         if (typeof instantiatedAuthenticator === 'function') {
             instantiatedAuthenticator = container.resolve(instantiatedAuthenticator);
         }

package/dist/lib/esm/factories/authenticator.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticator.factory.js","sourceRoot":"","sources":["../../../../src/factories/authenticator.factory.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAsB,UAAU,EAAC,MAAM,UAAU,CAAC;AAGzD,OAAO,EAAC,+BAA+B,EAAC,MAAM,6CAA6C,CAAC;AAG5F,IAAa,oBAAoB,GAAjC,MAAa,oBAAoB;IAC7B,WAAW,CAAC,oBAAmD,EAAE,SAA8B;QAC3F,8CAA8C;QAC9C,IAAI,yBAAyB,GAA2B,oBAAoB,CAAC,aAAuC,CAAC;QAErH,IAAI,OAAO,yBAAyB,KAAK,UAAU,EAAE;YACjD,yBAAyB,GAAG,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;SAC5E;QAED,uDAAuD;QACvD,IAAI,OAAO,yBAAyB,CAAC,YAAY,KAAK,UAAU,EAAE;YAC9D,MAAM,IAAI,+BAA+B,CAAC,oGAAoG,EAAE,yBAAyB,EAAE,oBAAoB,CAAC,CAAC;SACpM;QAED,qDAAqD;QACrD,IAAI,OAAO,yBAAyB,CAAC,UAAU,KAAK,UAAU,EAAE;YAC5D,MAAM,IAAI,+BAA+B,CAAC,kGAAkG,EAAE,yBAAyB,EAAE,oBAAoB,CAAC,CAAC;SAClM;QAED,OAAO,yBAAyB,CAAC;IACrC,CAAC;CACJ,CAAA;AArBY,oBAAoB;IADhC,UAAU,EAAE;GACA,oBAAoB,CAqBhC;SArBY,oBAAoB"}
+{"version":3,"file":"authenticator.factory.js","sourceRoot":"","sources":["../../../../src/factories/authenticator.factory.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAsB,UAAU,EAAC,MAAM,UAAU,CAAC;AAGzD,OAAO,EAAC,+BAA+B,EAAC,MAAM,6CAA6C,CAAC;AAE5F;;GAEG;AAEH,IAAa,oBAAoB,GAAjC,MAAa,oBAAoB;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,oBAAmD,EAAE,SAA8B;QAC3F,8CAA8C;QAC9C,IAAI,yBAAyB,GAA2B,oBAAoB,CAAC,aAAuC,CAAC;QAErH,uGAAuG;QACvG,kCAAkC;QAClC,IAAI,OAAO,yBAAyB,KAAK,UAAU,EAAE;YACjD,yBAAyB,GAAG,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;SAC5E;QAED,uDAAuD;QACvD,IAAI,OAAO,yBAAyB,CAAC,YAAY,KAAK,UAAU,EAAE;YAC9D,MAAM,IAAI,+BAA+B,CAAC,oGAAoG,EAAE,yBAAyB,EAAE,oBAAoB,CAAC,CAAC;SACpM;QAED,qDAAqD;QACrD,IAAI,OAAO,yBAAyB,CAAC,UAAU,KAAK,UAAU,EAAE;YAC5D,MAAM,IAAI,+BAA+B,CAAC,kGAAkG,EAAE,yBAAyB,EAAE,oBAAoB,CAAC,CAAC;SAClM;QAED,OAAO,yBAAyB,CAAC;IACrC,CAAC;CACJ,CAAA;AA9BY,oBAAoB;IADhC,UAAU,EAAE;GACA,oBAAoB,CA8BhC;SA9BY,oBAAoB"}

package/dist/lib/esm/factories/guard.factory.js

@@ -6,10 +6,21 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { injectable } from "tsyringe";
 import { GuardInstantiationError } from "../errors/guard-instantiation.error";
+/**
+ * The GuardFactory returns the proper instantiated guard.
+ */
 let GuardFactory = class GuardFactory {
+    /**
+     * This function takes the guard context and returns the proper instantiated guard.
+     * It also validates that the guard is valid (it implements the GuardInterface).
+     * @param guardContext The guard context that contains the guard and the options to use.
+     * @param container The dependency container from which to retrieve the instantiated guard.
+     */
     fromContext(guardContext, container) {
         // Check if the guard needs to be instantiated
         let instantiatedGuard = guardContext.guard;
+        // If guardContext.guard  is a function, we resolve that function through the container.
+        // TODO: validate if this is good.
         if (typeof instantiatedGuard === 'function') {
             instantiatedGuard = container.resolve(instantiatedGuard);
         }

package/dist/lib/esm/factories/guard.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"guard.factory.js","sourceRoot":"","sources":["../../../../src/factories/guard.factory.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAsB,UAAU,EAAC,MAAM,UAAU,CAAC;AAIzD,OAAO,EAAC,uBAAuB,EAAC,MAAM,qCAAqC,CAAC;AAG5E,IAAa,YAAY,GAAzB,MAAa,YAAY;IACrB,WAAW,CAAC,YAAmC,EAAE,SAA8B;QAC3E,8CAA8C;QAC9C,IAAI,iBAAiB,GAAmB,YAAY,CAAC,KAAuB,CAAC;QAE7E,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;YACzC,iBAAiB,GAAG,SAAS,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SAC5D;QAED,uDAAuD;QACvD,IAAI,OAAO,iBAAiB,CAAC,YAAY,KAAK,UAAU,EAAE;YACtD,MAAM,IAAI,uBAAuB,CAAC,wDAAwD,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;SAChI;QAED,qDAAqD;QACrD,IAAI,OAAO,iBAAiB,CAAC,UAAU,KAAK,UAAU,EAAE;YACpD,MAAM,IAAI,uBAAuB,CAAC,sDAAsD,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;SAC9H;QAED,OAAO,iBAAiB,CAAC;IAC7B,CAAC;CACJ,CAAA;AArBY,YAAY;IADxB,UAAU,EAAE;GACA,YAAY,CAqBxB;SArBY,YAAY"}
+{"version":3,"file":"guard.factory.js","sourceRoot":"","sources":["../../../../src/factories/guard.factory.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAsB,UAAU,EAAC,MAAM,UAAU,CAAC;AAGzD,OAAO,EAAC,uBAAuB,EAAC,MAAM,qCAAqC,CAAC;AAE5E;;GAEG;AAEH,IAAa,YAAY,GAAzB,MAAa,YAAY;IAErB;;;;;OAKG;IACH,WAAW,CAAC,YAAmC,EAAE,SAA8B;QAC3E,8CAA8C;QAC9C,IAAI,iBAAiB,GAAmB,YAAY,CAAC,KAAuB,CAAC;QAE7E,wFAAwF;QACxF,kCAAkC;QAClC,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;YACzC,iBAAiB,GAAG,SAAS,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SAC5D;QAED,uDAAuD;QACvD,IAAI,OAAO,iBAAiB,CAAC,YAAY,KAAK,UAAU,EAAE;YACtD,MAAM,IAAI,uBAAuB,CAAC,wDAAwD,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;SAChI;QAED,qDAAqD;QACrD,IAAI,OAAO,iBAAiB,CAAC,UAAU,KAAK,UAAU,EAAE;YACpD,MAAM,IAAI,uBAAuB,CAAC,sDAAsD,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;SAC9H;QAED,OAAO,iBAAiB,CAAC;IAC7B,CAAC;CACJ,CAAA;AA9BY,YAAY;IADxB,UAAU,EAAE;GACA,YAAY,CA8BxB;SA9BY,YAAY"}

package/dist/lib/esm/guards/role.guard.js

@@ -20,33 +20,59 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { inject, injectable } from "tsyringe";
+/**
+ * The role guard is a guard that validates if the identity making the request has the required roles.
+ */
 let RoleGuard = class RoleGuard {
+    /**
+     * The role guard is a guard that validates if the identity making the request has the required roles.
+     * @param rolesClaimKey The key in the claims of the access token where the roles are defined.
+     */
     constructor(rolesClaimKey) {
         this.rolesClaimKey = rolesClaimKey;
+        /**
+         * The keyname of the guard.
+         */
         this.keyname = "role";
     }
+    /**
+     * Sets the context for the guard.
+     * @param context The context for the guard to use.
+     */
     setContext(context) {
         this.guardContext = context;
         return Promise.resolve();
     }
+    /**
+     * Returns whether or not the guard authorizes the request.
+     * For the role guard, it validates that the identity making the request has the requested roles.
+     * The identity needs all of the requested roles to be authorized.
+     * @param request The request to authorize.
+     * @param identity The identity making the request.
+     */
     isAuthorized(request, identity) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const neededRoles = [];
+            // If we have no context we deny.
             if (this.guardContext === undefined) {
                 return false;
             }
+            // Find what roles are needed based on the context.
             if (this.guardContext.options && this.guardContext.options.hasOwnProperty("roles") && Array.isArray(this.guardContext.options.roles)) {
                 neededRoles.push(...this.guardContext.options.roles);
             }
+            // If the identity does not have a roles claim, we deny.
             if (neededRoles.length > 0 && (((_a = identity === null || identity === void 0 ? void 0 : identity.claims) === null || _a === void 0 ? void 0 : _a.hasOwnProperty(this.rolesClaimKey)) === false || !Array.isArray(identity === null || identity === void 0 ? void 0 : identity.claims[this.rolesClaimKey]))) {
                 return false;
             }
+            // If the identity is missing one of the needed roles, we deny.
             for (const role of neededRoles) {
                 if (!(identity === null || identity === void 0 ? void 0 : identity.claims[this.rolesClaimKey].includes(role))) {
                     return false;
                 }
             }
+            // If the identity has all the requested roles we authorize.
             return true;
         });
     }

package/dist/lib/esm/guards/role.guard.js.map

@@ -1 +1 @@
-{"version":3,"file":"role.guard.js","sourceRoot":"","sources":["../../../../src/guards/role.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAO5C,IAAa,SAAS,GAAtB,MAAa,SAAS;IAKlB,YAA0E,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QAJxF,YAAO,GAAG,MAAM,CAAC;IAKxB,CAAC;IAED,UAAU,CAAC,OAAY;QACnB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAE5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAEK,YAAY,CAAC,OAAgB,EAAE,QAA4B;;;YAC7D,MAAM,WAAW,GAAa,EAAE,CAAC;YAEjC,IAAG,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;gBAChC,OAAO,KAAK,CAAC;aAChB;YAED,IAAG,IAAI,CAAC,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;gBAChI,WAAW,CAAC,IAAI,CAAC,GAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aACzD;YAED,IAAG,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,0CAAE,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,MAAK,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAC;gBAClJ,OAAO,KAAK,CAAC;aAChB;YACD,KAAI,MAAM,IAAI,IAAI,WAAW,EAAE;gBAC3B,IAAG,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA,EAAC;oBACpD,OAAO,KAAK,CAAC;iBAChB;aACJ;YACD,OAAO,IAAI,CAAC;;KACf;CACJ,CAAA;AAnCY,SAAS;IADrB,UAAU,EAAE;IAMI,WAAA,MAAM,CAAC,mCAAmC,CAAC,CAAA;;GAL/C,SAAS,CAmCrB;SAnCY,SAAS"}
+{"version":3,"file":"role.guard.js","sourceRoot":"","sources":["../../../../src/guards/role.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAM5C;;GAEG;AAEH,IAAa,SAAS,GAAtB,MAAa,SAAS;IAWlB;;;OAGG;IACH,YAA0E,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QAd/F;;WAEG;QACI,YAAO,GAAG,MAAM,CAAC;IAYxB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAY;QACnB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAE5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACG,YAAY,CAAC,OAAgB,EAAE,QAA4B;;;YAC7D,MAAM,WAAW,GAAa,EAAE,CAAC;YAEjC,iCAAiC;YACjC,IAAG,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;gBAChC,OAAO,KAAK,CAAC;aAChB;YAED,mDAAmD;YACnD,IAAG,IAAI,CAAC,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;gBAChI,WAAW,CAAC,IAAI,CAAC,GAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aACzD;YAED,wDAAwD;YACxD,IAAG,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,0CAAE,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,MAAK,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAC;gBAClJ,OAAO,KAAK,CAAC;aAChB;YAED,+DAA+D;YAC/D,KAAI,MAAM,IAAI,IAAI,WAAW,EAAE;gBAC3B,IAAG,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA,EAAC;oBACpD,OAAO,KAAK,CAAC;iBAChB;aACJ;YAED,4DAA4D;YAC5D,OAAO,IAAI,CAAC;;KACf;CACJ,CAAA;AA/DY,SAAS;IADrB,UAAU,EAAE;IAgBI,WAAA,MAAM,CAAC,mCAAmC,CAAC,CAAA;;GAf/C,SAAS,CA+DrB;SA/DY,SAAS"}

package/dist/lib/esm/interfaces/interfaces.js

@@ -1,7 +1,9 @@
 export * from "./authentication-manager.interface";
 export * from "./authenticator.interface";
+export * from "./authenticator-context.interface";
 export * from "./authorizer-manager.interface";
 export * from "./guard.interface";
 export * from "./guard-context.interface";
+export * from "./identity-provider.interface";
 export * from "./voter.interface";
 //# sourceMappingURL=interfaces.js.map

package/dist/lib/esm/interfaces/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../src/interfaces/interfaces.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAC;AACnD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../src/interfaces/interfaces.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAC;AACnD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC"}

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

@@ -23,12 +23,28 @@ import { inject, injectable, injectAll } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { AuthenticatorFactory } from "../factories/authenticator.factory";
 import { SecurityModuleKeyname } from "../security.module.keyname";
+/**
+ * The authentication manager provides authentication by returning the identity executing the action.
+ * It is tagged and can be injected using AuthenticationManagerInterface which facilitates mocking.
+ */
 let AuthenticationManager = class AuthenticationManager {
+    /**
+     * The authentication manager provides authentication by returning the identity executing the action.
+     * @param identityProviders The identity providers to use to provide the identity. All services tagged with ServiceDefinitionTagEnum.IdentityProvider will be injected here.
+     * @param logHandler The log handler to output logs.
+     * @param authenticatorFactory The factory to create the authenticator.
+     */
     constructor(identityProviders, logHandler, authenticatorFactory) {
         this.identityProviders = identityProviders;
         this.logHandler = logHandler;
         this.authenticatorFactory = authenticatorFactory;
     }
+    /**
+     * Authenticates a request by providing the identity that made the request.
+     * @param request The request to authenticate
+     * @param routeContext The context associated with the route.
+     * @param container The dependency container from which to resolve the authenticator.
+     */
     authenticate(request, routeContext, container) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!routeContext || routeContext.authenticator === undefined) {
@@ -50,7 +66,6 @@ let AuthenticationManager = class AuthenticationManager {
             }
             catch (e) {
                 this.logHandler.error(e.message, { e }, SecurityModuleKeyname);
-                identity = undefined;
                 throw e;
             }
             return identity;

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

@@ -1 +1 @@
-{"version":3,"file":"authentication.manager.js","sourceRoot":"","sources":["../../../../src/managers/authentication.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAsB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AAE5E,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAInG,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AAOjE,IAAa,qBAAqB,GAAlC,MAAa,qBAAqB;IAC9B,YAC2E,iBAA8C,EACrE,UAA+B,EAC/C,oBAA0C;QAFH,sBAAiB,GAAjB,iBAAiB,CAA6B;QACrE,eAAU,GAAV,UAAU,CAAqB;QAC/C,yBAAoB,GAApB,oBAAoB,CAAsB;IAC9E,CAAC;IAEY,YAAY,CAAC,OAAgB,EAAE,YAAiB,EAAE,SAA8B;;YACzF,IAAG,CAAC,YAAY,IAAI,YAAY,CAAC,aAAa,KAAK,SAAS,EAAE;gBAC1D,OAAO,SAAS,CAAC;aACpB;YAED,IAAI,QAAuC,CAAC;YAE5C,MAAM,oBAAoB,GAAkC,YAAY,CAAC,aAAa,CAAC;YAEvF,IAAI;gBACA,MAAM,yBAAyB,GAA2B,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;gBAEjI,MAAM,yBAAyB,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;gBAEjE,QAAQ,GAAG,MAAM,yBAAyB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAEjE,IAAG,QAAQ,IAAI,SAAS,EAAE;oBACtB,OAAO,QAAQ,CAAC;iBACnB;gBAED,mCAAmC;gBACnC,KAAK,MAAM,gBAAgB,IAAI,IAAI,CAAC,iBAAiB,EAAE;oBACnD,QAAQ,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;iBACvD;aAEJ;YACD,OAAO,CAAC,EAAE;gBACN,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,EAAC,CAAC,EAAC,EAAE,qBAAqB,CAAC,CAAC;gBAC7D,QAAQ,GAAG,SAAS,CAAC;gBACrB,MAAM,CAAC,CAAC;aACX;YAED,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ,CAAA;AAzCY,qBAAqB;IAHjC,YAAY,CAAC,qBAAqB,CAAC;IACnC,GAAG,CAAC,gCAAgC,CAAC;IACrC,UAAU,EAAE;IAGJ,WAAA,SAAS,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAA;IACpD,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;oDACwB,oBAAoB;GAJrE,qBAAqB,CAyCjC;SAzCY,qBAAqB"}
+{"version":3,"file":"authentication.manager.js","sourceRoot":"","sources":["../../../../src/managers/authentication.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAsB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AAE5E,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAInG,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AAIjE;;;GAGG;AAIH,IAAa,qBAAqB,GAAlC,MAAa,qBAAqB;IAE9B;;;;;OAKG;IACH,YAC2E,iBAA8C,EACrE,UAA+B,EAC/C,oBAA0C;QAFH,sBAAiB,GAAjB,iBAAiB,CAA6B;QACrE,eAAU,GAAV,UAAU,CAAqB;QAC/C,yBAAoB,GAApB,oBAAoB,CAAsB;IAC9E,CAAC;IAED;;;;;OAKG;IACU,YAAY,CAAC,OAAgB,EAAE,YAAiB,EAAE,SAA8B;;YACzF,IAAG,CAAC,YAAY,IAAI,YAAY,CAAC,aAAa,KAAK,SAAS,EAAE;gBAC1D,OAAO,SAAS,CAAC;aACpB;YAED,IAAI,QAAuC,CAAC;YAE5C,MAAM,oBAAoB,GAAkC,YAAY,CAAC,aAAa,CAAC;YAEvF,IAAI;gBACA,MAAM,yBAAyB,GAA2B,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;gBAEjI,MAAM,yBAAyB,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;gBAEjE,QAAQ,GAAG,MAAM,yBAAyB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAEjE,IAAG,QAAQ,IAAI,SAAS,EAAE;oBACtB,OAAO,QAAQ,CAAC;iBACnB;gBAED,mCAAmC;gBACnC,KAAK,MAAM,gBAAgB,IAAI,IAAI,CAAC,iBAAiB,EAAE;oBACnD,QAAQ,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;iBACvD;aAEJ;YAAC,OAAO,CAAC,EAAE;gBACR,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,EAAC,CAAC,EAAC,EAAE,qBAAqB,CAAC,CAAC;gBAC7D,MAAM,CAAC,CAAC;aACX;YAED,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ,CAAA;AApDY,qBAAqB;IAHjC,YAAY,CAAC,qBAAqB,CAAC;IACnC,GAAG,CAAC,gCAAgC,CAAC;IACrC,UAAU,EAAE;IAUJ,WAAA,SAAS,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAA;IACpD,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;oDACwB,oBAAoB;GAXrE,qBAAqB,CAoDjC;SApDY,qBAAqB"}

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

@@ -23,11 +23,27 @@ import { inject, injectable } from "tsyringe";
 import { moduleScoped, tag } from "@pristine-ts/common";
 import { GuardFactory } from "../factories/guard.factory";
 import { SecurityModuleKeyname } from "../security.module.keyname";
+/**
+ * The authorizer manager provides authorization by authorizing the action.
+ * It is tagged and can be injected using AuthorizerManagerInterface which facilitates mocking.
+ */
 let AuthorizerManager = class AuthorizerManager {
+    /**
+     * The authorizer manager provides authorization by authorizing the action.
+     * @param logHandler The log handler to output logs.
+     * @param guardFactory The factory to create the guard.
+     */
     constructor(logHandler, guardFactory) {
         this.logHandler = logHandler;
         this.guardFactory = guardFactory;
     }
+    /**
+     * Returns whether or not the request is authorized to access the route.
+     * @param request The request to authorize.
+     * @param routeContext The route context.
+     * @param container The dependency container to resolve the guard from.
+     * @param identity The identity making the request.
+     */
     isAuthorized(request, routeContext, container, identity) {
         return __awaiter(this, void 0, void 0, function* () {
             // If there are no guards defined, we simply return that it is authorized.

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

@@ -1 +1 @@
-{"version":3,"file":"authorizer.manager.js","sourceRoot":"","sources":["../../../../src/managers/authorizer.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAsB,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAEjE,OAAO,EAAoB,YAAY,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AAMjE,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YAAmE,UAA+B,EAC9D,YAA0B;QADK,eAAU,GAAV,UAAU,CAAqB;QAC9D,iBAAY,GAAZ,YAAY,CAAc;IAC9D,CAAC;IAEY,YAAY,CAAC,OAAgB,EAAE,YAAiB,EAAE,SAA8B,EAAE,QAA4B;;YACvH,0EAA0E;YAC1E,IAAG,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,KAAK,EAAE;gBACnG,OAAO,IAAI,CAAC;aACf;YAED,IAAI,YAAY,GAAG,IAAI,CAAC;YAExB,KAAK,MAAM,YAAY,IAAI,YAAY,CAAC,MAAM,EAAE;gBAC5C,IAAI;oBACA,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;oBAEjF,MAAM,iBAAiB,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;oBAEjD,MAAM,YAAY,GAAE,MAAM,iBAAiB,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAC5E,YAAY,GAAG,YAAY,IAAI,YAAY,CAAC;iBAC/C;gBACD,OAAO,CAAC,EAAE;oBACN,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC;oBACxD,YAAY,GAAG,KAAK,CAAC;iBACxB;aACJ;YAED,OAAO,YAAY,CAAC;QACxB,CAAC;KAAA;CACJ,CAAA;AA9BY,iBAAiB;IAH7B,YAAY,CAAC,qBAAqB,CAAC;IACnC,GAAG,CAAC,4BAA4B,CAAC;IACjC,UAAU,EAAE;IAEW,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;6CACC,YAAY;GAFrD,iBAAiB,CA8B7B;SA9BY,iBAAiB"}
+{"version":3,"file":"authorizer.manager.js","sourceRoot":"","sources":["../../../../src/managers/authorizer.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAsB,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAEjE,OAAO,EAAoB,YAAY,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AAGjE;;;GAGG;AAIH,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAE1B;;;;OAIG;IACH,YAAmE,UAA+B,EAC9D,YAA0B;QADK,eAAU,GAAV,UAAU,CAAqB;QAC9D,iBAAY,GAAZ,YAAY,CAAc;IAC9D,CAAC;IAED;;;;;;OAMG;IACU,YAAY,CAAC,OAAgB,EAAE,YAAiB,EAAE,SAA8B,EAAE,QAA4B;;YACvH,0EAA0E;YAC1E,IAAG,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,KAAK,EAAE;gBACnG,OAAO,IAAI,CAAC;aACf;YAED,IAAI,YAAY,GAAG,IAAI,CAAC;YAExB,KAAK,MAAM,YAAY,IAAI,YAAY,CAAC,MAAM,EAAE;gBAC5C,IAAI;oBACA,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;oBAEjF,MAAM,iBAAiB,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;oBAEjD,MAAM,YAAY,GAAE,MAAM,iBAAiB,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAC5E,YAAY,GAAG,YAAY,IAAI,YAAY,CAAC;iBAC/C;gBACD,OAAO,CAAC,EAAE;oBACN,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC;oBACxD,YAAY,GAAG,KAAK,CAAC;iBACxB;aACJ;YAED,OAAO,YAAY,CAAC;QACxB,CAAC;KAAA;CACJ,CAAA;AA3CY,iBAAiB;IAH7B,YAAY,CAAC,qBAAqB,CAAC;IACnC,GAAG,CAAC,4BAA4B,CAAC;IACjC,UAAU,EAAE;IAQW,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;6CACC,YAAY;GARrD,iBAAiB,CA2C7B;SA3CY,iBAAiB"}

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

@@ -1,4 +1,4 @@
-export * from "./authorizer.manager";
 export * from "./authentication.manager";
+export * from "./authorizer.manager";
 export * from "./permission.manager";
 //# sourceMappingURL=managers.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"managers.js","sourceRoot":"","sources":["../../../../src/managers/managers.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"managers.js","sourceRoot":"","sources":["../../../../src/managers/managers.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC"}

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

@@ -24,11 +24,27 @@ import { VotingStrategyEnum } from "../enums/voting-strategy.enum";
 import { VoteEnum } from "../enums/vote.enum";
 import { ServiceDefinitionTagEnum } from "@pristine-ts/common";
 import { SecurityModuleKeyname } from "../security.module.keyname";
+/**
+ * The permission manager verifies if the correct permission are there to access and take an action on a resource.
+ */
 let PermissionManager = class PermissionManager {
+    /**
+     * The permission manager verifies if the correct permission are there to access and take an action on a resource.
+     * @param voters The voters that determine if access is granted.
+     * All services with the tag ServiceDefinitionTagEnum.Voter will be injected here
+     * @param logHandler The log handler to output logs.
+     */
     constructor(voters, logHandler) {
         this.voters = voters;
         this.logHandler = logHandler;
     }
+    /**
+     * Returns whether or not the permission manager grants access to the resource.
+     * @param identity The identity trying to have access to a resource.
+     * @param action The action trying to be executed on the resource.
+     * @param resource The resource being accessed.
+     * @param votingStrategy The voting strategy that defines how to merge the votes. Default is DenyOnUnanimousAbstention.
+     */
     hasAccessToResource(identity, action, resource, votingStrategy = VotingStrategyEnum.DenyOnUnanimousAbstention) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.voters.length === 0) {

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

@@ -1 +1 @@
-{"version":3,"file":"permission.manager.js","sourceRoot":"","sources":["../../../../src/managers/permission.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAEvD,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEjE,OAAO,EAAC,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAoB,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AAGjE,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YAA+E,MAAwB,EACpC,UAA+B;QADnB,WAAM,GAAN,MAAM,CAAkB;QACpC,eAAU,GAAV,UAAU,CAAqB;IAClG,CAAC;IAEK,mBAAmB,CAAC,QAA2B,EAAE,MAAc,EAAE,QAAgB,EAAE,iBAAqC,kBAAkB,CAAC,yBAAyB;;YAEtK,IAAG,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAC;gBACxB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,4CAA4C,EAAE;oBAClE,QAAQ;oBACR,MAAM;oBACN,QAAQ;iBACX,EAAE,qBAAqB,CAAC,CAAC;aAC7B;YAED,MAAM,KAAK,GAAe,EAAE,CAAC;YAE7B,KAAI,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC5B,IAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE;oBACnC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,wBAAwB,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,GAAG,oCAAoC,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAC,EAAE,qBAAqB,CAAE,CAAC;oBACrM,SAAS;iBACZ;gBAED,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;oBAC1D,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,wBAAwB,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,GAAG,gBAAgB,GAAG,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAC,EAAE,qBAAqB,CAAE,CAAC;oBAExL,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACpB;gBAAC,OAAO,KAAK,EAAE;oBACZ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAC,EAAE,qBAAqB,CAAC,CAAC;oBACrH,MAAM,KAAK,CAAC;iBACf;aAEJ;YAED,IAAI,iBAAiB,GAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEhE,IAAI,cAAc,KAAK,kBAAkB,CAAC,yBAAyB,EAAE;gBACjE,IAAG,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,QAAQ,CAAC,OAAO,CAAC,EAAC;oBACtE,iBAAiB,GAAG,KAAK,CAAC;iBAC7B;aACJ;YAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,uBAAuB,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,eAAe,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC,EAAE,qBAAqB,CAAC,CAAC;YAE9L,OAAO,iBAAiB,CAAC;QAC7B,CAAC;KAAA;CACJ,CAAA;AA/CY,iBAAiB;IAD7B,UAAU,EAAE;IAEW,WAAA,SAAS,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAA;IACzC,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GAFxC,iBAAiB,CA+C7B;SA/CY,iBAAiB"}
+{"version":3,"file":"permission.manager.js","sourceRoot":"","sources":["../../../../src/managers/permission.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAEvD,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEjE,OAAO,EAAC,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAoB,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AAEjE;;GAEG;AAEH,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAE1B;;;;;OAKG;IACH,YAA+E,MAAwB,EACpC,UAA+B;QADnB,WAAM,GAAN,MAAM,CAAkB;QACpC,eAAU,GAAV,UAAU,CAAqB;IAClG,CAAC;IAED;;;;;;OAMG;IACG,mBAAmB,CAAC,QAA2B,EAAE,MAAc,EAAE,QAAgB,EAAE,iBAAqC,kBAAkB,CAAC,yBAAyB;;YAEtK,IAAG,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAC;gBACxB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,4CAA4C,EAAE;oBAClE,QAAQ;oBACR,MAAM;oBACN,QAAQ;iBACX,EAAE,qBAAqB,CAAC,CAAC;aAC7B;YAED,MAAM,KAAK,GAAe,EAAE,CAAC;YAE7B,KAAI,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC5B,IAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE;oBACnC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,wBAAwB,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,GAAG,oCAAoC,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAC,EAAE,qBAAqB,CAAE,CAAC;oBACrM,SAAS;iBACZ;gBAED,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;oBAC1D,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,wBAAwB,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,GAAG,gBAAgB,GAAG,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAC,EAAE,qBAAqB,CAAE,CAAC;oBAExL,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACpB;gBAAC,OAAO,KAAK,EAAE;oBACZ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAC,EAAE,qBAAqB,CAAC,CAAC;oBACrH,MAAM,KAAK,CAAC;iBACf;aAEJ;YAED,IAAI,iBAAiB,GAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEhE,IAAI,cAAc,KAAK,kBAAkB,CAAC,yBAAyB,EAAE;gBACjE,IAAG,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,QAAQ,CAAC,OAAO,CAAC,EAAC;oBACtE,iBAAiB,GAAG,KAAK,CAAC;iBAC7B;aACJ;YAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,uBAAuB,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,eAAe,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC,EAAE,qBAAqB,CAAC,CAAC;YAE9L,OAAO,iBAAiB,CAAC;QAC7B,CAAC;KAAA;CACJ,CAAA;AA7DY,iBAAiB;IAD7B,UAAU,EAAE;IASW,WAAA,SAAS,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAA;IACzC,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GATxC,iBAAiB,CA6D7B;SA7DY,iBAAiB"}

package/dist/lib/esm/providers/default-identity.provider.js

@@ -8,7 +8,9 @@ import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common
 import { SecurityModuleKeyname } from "../security.module.keyname";
 import { injectable } from "tsyringe";
 /**
+ * This default identity provider is here so that there is always at least one service tagged with IdentityProvider
  * Until there's a fix for: https://github.com/microsoft/tsyringe/issues/63
+ * It resolves the same identity it is passed.
  */
 let DefaultIdentityProvider = class DefaultIdentityProvider {
     provide(identity) {

package/dist/lib/esm/providers/default-identity.provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"default-identity.provider.js","sourceRoot":"","sources":["../../../../src/providers/default-identity.provider.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC;;GAEG;AAIH,IAAa,uBAAuB,GAApC,MAAa,uBAAuB;IAChC,OAAO,CAAC,QAA2B;QAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;CACJ,CAAA;AAJY,uBAAuB;IAHnC,UAAU,EAAE;IACZ,GAAG,CAAC,wBAAwB,CAAC,gBAAgB,CAAC;IAC9C,YAAY,CAAC,qBAAqB,CAAC;GACvB,uBAAuB,CAInC;SAJY,uBAAuB"}
+{"version":3,"file":"default-identity.provider.js","sourceRoot":"","sources":["../../../../src/providers/default-identity.provider.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,qBAAqB,EAAC,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC;;;;GAIG;AAIH,IAAa,uBAAuB,GAApC,MAAa,uBAAuB;IAChC,OAAO,CAAC,QAA2B;QAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;CACJ,CAAA;AAJY,uBAAuB;IAHnC,UAAU,EAAE;IACZ,GAAG,CAAC,wBAAwB,CAAC,gBAAgB,CAAC;IAC9C,YAAY,CAAC,qBAAqB,CAAC;GACvB,uBAAuB,CAInC;SAJY,uBAAuB"}

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

@@ -17,6 +17,9 @@ export const SecurityModule = {
     ],
     providerRegistrations: [],
     configurationDefinitions: [
+        /**
+         * The key in the claims of the access token where the roles are defined.
+         */
         {
             parameterName: SecurityModuleKeyname + ".rolesClaimKey",
             isRequired: false,

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

@@ -1 +1 @@
-{"version":3,"file":"security.module.js","sourceRoot":"","sources":["../../../src/security.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,2BAA2B,EAAC,MAAM,4BAA4B,CAAC;AAEvE,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAE1C,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC3C,OAAO,EAAE,qBAAqB;IAC9B,aAAa,EAAE;QACX,aAAa;KAChB;IACD,qBAAqB,EAAE,EAAE;IACzB,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,qBAAqB,GAAG,gBAAgB;YACvD,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,OAAO;YACrB,gBAAgB,EAAE;gBACd,IAAI,2BAA2B,CAAC,mCAAmC,CAAC;aACvE;SACJ;KACJ;CAEJ,CAAA"}
+{"version":3,"file":"security.module.js","sourceRoot":"","sources":["../../../src/security.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,2BAA2B,EAAC,MAAM,4BAA4B,CAAC;AAEvE,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAE1C,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC3C,OAAO,EAAE,qBAAqB;IAC9B,aAAa,EAAE;QACX,aAAa;KAChB;IACD,qBAAqB,EAAE,EAAE;IACzB,wBAAwB,EAAE;QACtB;;WAEG;QACH;YACI,aAAa,EAAE,qBAAqB,GAAG,gBAAgB;YACvD,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,OAAO;YACrB,gBAAgB,EAAE;gBACd,IAAI,2BAA2B,CAAC,mCAAmC,CAAC;aACvE;SACJ;KACJ;CAEJ,CAAA"}

package/dist/types/decorators/authenticator.decorator.d.ts

@@ -1,2 +1,8 @@
 import { AuthenticatorInterface } from "../interfaces/authenticator.interface";
+/**
+ * This decorator specifies the authenticator that should be used to authenticate a request.
+ * It should be used either on a controller class or directly on a method.
+ * @param authenticator The authenticator to use.
+ * @param options Any options that will be passed on to the authenticator.
+ */
 export declare const authenticator: (authenticator: AuthenticatorInterface | Function, options?: any) => (target: any, propertyKey?: string | undefined, descriptor?: PropertyDescriptor | undefined) => void;

package/dist/types/decorators/guard.decorator.d.ts

@@ -1,2 +1,8 @@
 import { GuardInterface } from "../interfaces/guard.interface";
+/**
+ * This decorator specifies the guard that should be used to authorize a request.
+ * It should be used either on a controller class or directly on a method.
+ * @param guard
+ * @param options Any options that will be passed on to the guard.
+ */
 export declare const guard: (guard: GuardInterface | Function, options?: any) => (target: any, propertyKey?: string | undefined, descriptor?: PropertyDescriptor | undefined) => void;

package/dist/types/enums/resource-action.enum.d.ts

@@ -1,3 +1,8 @@
+/**
+ * The resource action enum specifies the most common actions that can be taken on a resource.
+ * It's used in the voters to validate if a user is authorized to execute that action.
+ * More actions can be defined in more specified enum based on the resource type.
+ */
 export declare enum ResourceActionEnum {
     List = "LIST",
     Read = "READ",

package/dist/types/enums/vote.enum.d.ts

@@ -1,3 +1,6 @@
+/**
+ * The vote enum defines the different decisions that a voter can take.
+ */
 export declare enum VoteEnum {
     Grant = "GRANT",
     Deny = "DENY",

package/dist/types/enums/voting-strategy.enum.d.ts

@@ -1,4 +1,14 @@
+/**
+ * The voting strategy enum defines the different strategies that the permission manager uses to
+ * merge the results of all the voter.
+ */
 export declare enum VotingStrategyEnum {
+    /**
+     * When all the voters abstain from voting, the access is granted.
+     */
     GrantOnUnanimousAbstention = "GRANT_ON_UNANIMOUS_ABSTENTION",
+    /**
+     * When all the voters abstain from voting, the access is denied.
+     */
     DenyOnUnanimousAbstention = "DENY_ON_UNANIMOUS_ABSTENTION"
 }

package/dist/types/errors/authenticator-decorator.error.d.ts

@@ -1,8 +1,8 @@
-/**
- * This Error is thrown when there's an error that happens when the guards ere being initialized
- */
 import { LoggableError } from "@pristine-ts/common";
 import { AuthenticatorInterface } from "../interfaces/authenticator.interface";
+/**
+ * This Error is thrown when there's an error with the authenticator decorator.
+ */
 export declare class AuthenticatorDecoratorError extends LoggableError {
     constructor(message: string, authenticator: AuthenticatorInterface | Function, options: any, target: any, propertyKey?: string, descriptor?: PropertyDescriptor);
 }

package/dist/types/errors/authenticator-instantiation.error.d.ts

@@ -1,8 +1,8 @@
+import { LoggableError } from "@pristine-ts/common";
+import { AuthenticatorInterface } from "../interfaces/authenticator.interface";
 /**
  * This Error is thrown when there's an error that happens when the authenticator are being initialized
  */
-import { LoggableError } from "@pristine-ts/common";
-import { AuthenticatorInterface } from "../interfaces/authenticator.interface";
 export declare class AuthenticatorInstantiationError extends LoggableError {
     previousError?: Error;
     constructor(message: string, instantiatedAuthenticator: AuthenticatorInterface | Function, authenticatorContext: any);

package/dist/types/errors/errors.d.ts

@@ -1,3 +1,4 @@
+export * from "./authenticator-decorator.error";
 export * from "./authenticator-instantiation.error";
 export * from "./guard-decorator.error";
 export * from "./guard-instantiation.error";

package/dist/types/errors/guard-decorator.error.d.ts

@@ -1,8 +1,8 @@
+import { LoggableError } from "@pristine-ts/common";
+import { GuardInterface } from "../interfaces/guard.interface";
 /**
  * This Error is thrown when there's an error that happens when the guards ere being initialized
  */
-import { LoggableError } from "@pristine-ts/common";
-import { GuardInterface } from "../interfaces/guard.interface";
 export declare class GuardDecoratorError extends LoggableError {
     constructor(message: string, guard: GuardInterface | Function, options: any, target: any, propertyKey?: string, descriptor?: PropertyDescriptor);
 }

package/dist/types/errors/guard-instantiation.error.d.ts

@@ -1,8 +1,8 @@
+import { LoggableError } from "@pristine-ts/common";
+import { GuardInterface } from "../interfaces/guard.interface";
 /**
  * This Error is thrown when there's an error that happens when the guards ere being initialized
  */
-import { LoggableError } from "@pristine-ts/common";
-import { GuardInterface } from "../interfaces/guard.interface";
 export declare class GuardInstantiationError extends LoggableError {
     constructor(message: string, instantiatedGuard: GuardInterface | Function, guardContext: any);
 }

package/dist/types/factories/authenticator.factory.d.ts

@@ -1,6 +1,15 @@
 import { DependencyContainer } from "tsyringe";
 import { AuthenticatorContextInterface } from "../interfaces/authenticator-context.interface";
 import { AuthenticatorInterface } from "../interfaces/authenticator.interface";
+/**
+ * The AuthenticatorFactory returns the proper instantiated authenticator.
+ */
 export declare class AuthenticatorFactory {
+    /**
+     * This function takes the authenticator context and returns the proper instantiated authenticator.
+     * It also validates that the authenticator is valid (it implements the AuthenticatorInterface).
+     * @param authenticatorContext The authenticator context that holds the authenticator and options to use.
+     * @param container The dependency container from which to retrieve the instantiated authenticator.
+     */
     fromContext(authenticatorContext: AuthenticatorContextInterface, container: DependencyContainer): AuthenticatorInterface;
 }

package/dist/types/factories/guard.factory.d.ts

@@ -1,6 +1,15 @@
 import { DependencyContainer } from "tsyringe";
 import { GuardContextInterface } from "../interfaces/guard-context.interface";
 import { GuardInterface } from "../interfaces/guard.interface";
+/**
+ * The GuardFactory returns the proper instantiated guard.
+ */
 export declare class GuardFactory {
+    /**
+     * This function takes the guard context and returns the proper instantiated guard.
+     * It also validates that the guard is valid (it implements the GuardInterface).
+     * @param guardContext The guard context that contains the guard and the options to use.
+     * @param container The dependency container from which to retrieve the instantiated guard.
+     */
     fromContext(guardContext: GuardContextInterface, container: DependencyContainer): GuardInterface;
 }