@pristine-ts/networking 0.0.165 → 0.0.169

package/dist/lib/cjs/errors/path-router-instantiation.error.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PathRouterInstantiationError = void 0;
+const common_1 = require("@pristine-ts/common");
 /**
- * This Error is thrown when there's an error that happens when the networking is being initialized
+ * This Error is thrown when there's an error that happens when the networking is being initialized.
+ * It is thrown when an error occurs when trying to instantiate a PathRouterNode.
  */
-const common_1 = require("@pristine-ts/common");
 class PathRouterInstantiationError extends common_1.LoggableError {
     constructor(message, path, parent) {
         super(message, {

package/dist/lib/cjs/errors/path-router-instantiation.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"path-router-instantiation.error.js","sourceRoot":"","sources":["../../../../src/errors/path-router-instantiation.error.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,gDAAkD;AAGlD,MAAa,4BAA6B,SAAQ,sBAAa;IAE3D,YAAmB,OAAe,EAAE,IAAY,EAAE,MAAuB;QACrE,KAAK,CAAC,OAAO,EAAE;YACX,IAAI;YACJ,MAAM;SACT,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,4BAA4B,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CAChF;AAZD,oEAYC"}
+{"version":3,"file":"path-router-instantiation.error.js","sourceRoot":"","sources":["../../../../src/errors/path-router-instantiation.error.ts"],"names":[],"mappings":";;;AAAA,gDAAkD;AAGlD;;;GAGG;AACH,MAAa,4BAA6B,SAAQ,sBAAa;IAE3D,YAAmB,OAAe,EAAE,IAAY,EAAE,MAAuB;QACrE,KAAK,CAAC,OAAO,EAAE;YACX,IAAI;YACJ,MAAM;SACT,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,4BAA4B,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CAChF;AAZD,oEAYC"}

package/dist/lib/cjs/interfaces/interfaces.js

@@ -18,9 +18,9 @@ __exportStar(require("./parameter-decorator.interface"), exports);
 __exportStar(require("./query-parameter-decorator.interface"), exports);
 __exportStar(require("./query-parameters-decorator.interface"), exports);
 __exportStar(require("./request-parameter-decorator.interface"), exports);
-__exportStar(require("./router-request-enricher.interface"), exports);
-__exportStar(require("./router-response-enricher.interface"), exports);
 __exportStar(require("./route-method-decorator.interface"), exports);
 __exportStar(require("./route-parameter-decorator.interface"), exports);
 __exportStar(require("./router.interface"), exports);
+__exportStar(require("./router-request-enricher.interface"), exports);
+__exportStar(require("./router-response-enricher.interface"), exports);
 //# sourceMappingURL=interfaces.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../src/interfaces/interfaces.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uEAAqD;AACrD,6FAA2E;AAC3E,0EAAwD;AACxD,6EAA2D;AAC3D,kEAAgD;AAChD,wEAAsD;AACtD,yEAAuD;AACvD,0EAAwD;AACxD,sEAAoD;AACpD,uEAAqD;AACrD,qEAAmD;AACnD,wEAAsD;AACtD,qDAAmC"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../src/interfaces/interfaces.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uEAAqD;AACrD,6FAA2E;AAC3E,0EAAwD;AACxD,6EAA2D;AAC3D,kEAAgD;AAChD,wEAAsD;AACtD,yEAAuD;AACvD,0EAAwD;AACxD,qEAAmD;AACnD,wEAAsD;AACtD,qDAAmC;AACnC,sEAAoD;AACpD,uEAAqD"}

package/dist/lib/cjs/models/models.js

@@ -10,7 +10,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./error-response-body"), exports);
 __exportStar(require("./request"), exports);
 __exportStar(require("./response"), exports);
 __exportStar(require("./route"), exports);

package/dist/lib/cjs/models/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/models/models.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAsC;AACtC,4CAA0B;AAC1B,6CAA2B;AAC3B,0CAAwB"}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/models/models.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,6CAA2B;AAC3B,0CAAwB"}

package/dist/lib/cjs/models/request.js

@@ -7,7 +7,13 @@ exports.Request = void 0;
 class Request {
     constructor(requestInterface) {
         var _a, _b;
+        /**
+         * The headers of the request.
+         */
         this.headers = {};
+        /**
+         * The body of the request.
+         */
         this.body = {};
         this.httpMethod = requestInterface.httpMethod;
         this.url = requestInterface.url;
@@ -17,8 +23,8 @@ class Request {
     /**
      * This method sets a header parameter in the Request.
      *
-     * @param name
-     * @param value
+     * @param name The name of the header.
+     * @param value The value of the header.
      */
     setHeader(name, value) {
         this.headers[name] = value;
@@ -26,7 +32,7 @@ class Request {
     /**
      * This method returns whether or not the header exists in the Request.
      *
-     * @param name
+     * @param name The name of the header.
      */
     hasHeader(name) {
         return this.headers.hasOwnProperty(name);
@@ -34,7 +40,7 @@ class Request {
     /**
      * This method returns the header corresponding to the name or undefined if it doesn't exist.
      *
-     * @param name
+     * @param name The name of the header.
      */
     getHeader(name) {
         return this.headers[name];

package/dist/lib/cjs/models/request.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/models/request.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,MAAa,OAAO;IAMhB,YAAY,gBAAkC;;QAH9C,YAAO,GAA8B,EAAE,CAAC;QACxC,SAAI,GAAQ,EAAE,CAAC;QAGX,IAAI,CAAC,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC;QAC9C,IAAI,CAAC,GAAG,GAAG,gBAAgB,CAAC,GAAG,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,MAAA,gBAAgB,CAAC,OAAO,mCAAI,EAAE,CAAC;QAC9C,IAAI,CAAC,IAAI,GAAG,MAAA,gBAAgB,CAAC,IAAI,mCAAI,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAY,EAAE,KAAa;QACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACJ;AAxCD,0BAwCC"}
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/models/request.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,MAAa,OAAO;IAqBhB,YAAY,gBAAkC;;QAV9C;;WAEG;QACH,YAAO,GAA8B,EAAE,CAAC;QAExC;;WAEG;QACH,SAAI,GAAQ,EAAE,CAAC;QAGX,IAAI,CAAC,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC;QAC9C,IAAI,CAAC,GAAG,GAAG,gBAAgB,CAAC,GAAG,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,MAAA,gBAAgB,CAAC,OAAO,mCAAI,EAAE,CAAC;QAC9C,IAAI,CAAC,IAAI,GAAG,MAAA,gBAAgB,CAAC,IAAI,mCAAI,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAY,EAAE,KAAa;QACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACJ;AAvDD,0BAuDC"}

package/dist/lib/cjs/models/response.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Response = void 0;
+/**
+ * This Response object represents the class used internally that represents a Response.
+ */
 class Response {
     constructor() {
+        /**
+         * The status code of the response. By default we return a 200.
+         */
         this.status = 200;
     }
 }

package/dist/lib/cjs/models/response.js.map

@@ -1 +1 @@
-{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../src/models/response.ts"],"names":[],"mappings":";;;AAGA,MAAa,QAAQ;IAArB;QACI,WAAM,GAAW,GAAG,CAAC;IAIzB,CAAC;CAAA;AALD,4BAKC"}
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../src/models/response.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,QAAQ;IAArB;QACI;;WAEG;QACH,WAAM,GAAW,GAAG,CAAC;IAgBzB,CAAC;CAAA;AApBD,4BAoBC"}

package/dist/lib/cjs/models/route.js

@@ -5,6 +5,10 @@ exports.Route = void 0;
  * This class represents a Route and how it can be routed to the proper controller method.
  */
 class Route {
+    /**
+     * @param controllerInstantiationToken The instantiation token of the controller. Usually this will be the controller's constructor name.
+     * @param methodPropertyKey The name of the method that corresponds to the route in the controller.
+     */
     constructor(controllerInstantiationToken, methodPropertyKey) {
         this.controllerInstantiationToken = controllerInstantiationToken;
         this.methodPropertyKey = methodPropertyKey;

package/dist/lib/cjs/models/route.js.map

@@ -1 +1 @@
-{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../src/models/route.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,MAAa,KAAK;IAWd,YAA4B,4BAAiC,EAAkB,iBAAyB;QAA5E,iCAA4B,GAA5B,4BAA4B,CAAK;QAAkB,sBAAiB,GAAjB,iBAAiB,CAAQ;QAVxG;;WAEG;QACH,oBAAe,GAAkC,EAAE,CAAC;IAQpD,CAAC;CACJ;AAbD,sBAaC"}
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../src/models/route.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,KAAK;IAWd;;;OAGG;IACH,YAA4B,4BAAiC,EAAkB,iBAAyB;QAA5E,iCAA4B,GAA5B,4BAA4B,CAAK;QAAkB,sBAAiB,GAAjB,iBAAiB,CAAQ;QAdxG;;WAEG;QACH,oBAAe,GAAkC,EAAE,CAAC;IAYpD,CAAC;CACJ;AAjBD,sBAiBC"}

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

@@ -16,7 +16,6 @@ const security_1 = require("@pristine-ts/security");
 const telemetry_1 = require("@pristine-ts/telemetry");
 __exportStar(require("./decorators/decorators"), exports);
 __exportStar(require("./enrichers/enrichers"), exports);
-//export * from "./enums/enums";
 __exportStar(require("./errors/errors"), exports);
 __exportStar(require("./interfaces/interfaces"), exports);
 __exportStar(require("./models/models"), exports);
@@ -26,11 +25,6 @@ __exportStar(require("./utils/utils"), exports);
 __exportStar(require("./router"), exports);
 exports.NetworkingModule = {
     keyname: networking_module_keyname_1.NetworkingModuleKeyname,
-    /**
-     * This property allows you to custom register specific services. For example, you can assign a tag or use a factory
-     * to instantiate a specific class.
-     */
-    providerRegistrations: [],
     importModules: [
         security_1.SecurityModule,
         telemetry_1.TelemetryModule,

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

@@ -1 +1 @@
-{"version":3,"file":"networking.module.js","sourceRoot":"","sources":["../../../src/networking.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,2EAAoE;AACpE,oDAAqD;AACrD,sDAAuD;AAEvD,0DAAwC;AACxC,wDAAsC;AACtC,gCAAgC;AAChC,kDAAgC;AAChC,0DAAwC;AACxC,kDAAgC;AAChC,gDAA8B;AAC9B,wDAAsC;AACtC,gDAA8B;AAE9B,2CAAyB;AAEZ,QAAA,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,mDAAuB;IAChC;;;OAGG;IACH,qBAAqB,EAAE,EACtB;IAED,aAAa,EAAE;QACX,yBAAc;QACd,2BAAe;KAClB;IACD,wBAAwB,EAAE,EAEzB;CACJ,CAAA"}
+{"version":3,"file":"networking.module.js","sourceRoot":"","sources":["../../../src/networking.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,2EAAoE;AACpE,oDAAqD;AACrD,sDAAuD;AAEvD,0DAAwC;AACxC,wDAAsC;AACtC,kDAAgC;AAChC,0DAAwC;AACxC,kDAAgC;AAChC,gDAA8B;AAC9B,wDAAsC;AACtC,gDAA8B;AAE9B,2CAAyB;AAEZ,QAAA,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,mDAAuB;IAChC,aAAa,EAAE;QACX,yBAAc;QACd,2BAAe;KAClB;IACD,wBAAwB,EAAE,EAEzB;CACJ,CAAA"}

package/dist/lib/cjs/nodes/method-router.node.js

@@ -2,10 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MethodRouterNode = void 0;
 const router_node_1 = require("./router.node");
+const method_router_adding_error_1 = require("../errors/method-router-adding.error");
 /**
  * This class represents the Leaf node of the RouteTree.
+ * It will always have a parent node that will be a PathRouterNode.
  */
 class MethodRouterNode extends router_node_1.RouterNode {
+    /**
+     * @param parent The parent node of the current node.
+     * @param method The http method of the current method node.
+     * @param route The route associated with the current node.
+     * @param levelFromRoot The depth level from the root node.
+     */
     constructor(parent, method, route, levelFromRoot) {
         super();
         this.method = method;
@@ -13,6 +21,11 @@ class MethodRouterNode extends router_node_1.RouterNode {
         this.levelFromRoot = levelFromRoot;
         this.parent = parent;
     }
+    /**
+     * Returns whether or not the node matches.
+     * This verification is made by verify the http method matches with the http method of the current node.
+     * @param method The http method to compare.
+     */
     matches(method) {
         return this.method === method;
     }
@@ -24,20 +37,22 @@ class MethodRouterNode extends router_node_1.RouterNode {
     }
     /**
      * This method adds all the required nodes to match the splitPaths and the method.
-     *
+     * Since a MethodRouterNode is a leaf node, you can't add anything after it, this method therefore doesn't do anything.
      * @param splitPaths
      * @param method
      * @param route
      */
     add(splitPaths, method, route) {
+        throw new method_router_adding_error_1.MethodRouterAddingError("Impossible to add a child node to a MethodRouterNode.", splitPaths, method, route, this);
     }
     /**
-     * This method checks to see if the method matches. If yes,
+     * This method receives an array of path and recursively calls its children if this node matches
+     * the first splitPath. If the node is a MethodRouterNode, it checks to see if the method matches. If yes,
      * it returns itself as the node found. This method should always return a MethodRouterNode. However, Typescript
      * doesn't like these recursive imports so we return the base class
      *
-     * @param splitPaths
-     * @param method
+     * @param splitPaths A list of all the parts of the paths spliced at the forward slashes.
+     * @param method The http method for which to find a node.
      */
     find(splitPaths, method) {
         if (this.parent.isCatchAll()) {

package/dist/lib/cjs/nodes/method-router.node.js.map

@@ -1 +1 @@
-{"version":3,"file":"method-router.node.js","sourceRoot":"","sources":["../../../../src/nodes/method-router.node.ts"],"names":[],"mappings":";;;AAAA,+CAAyC;AAKzC;;GAEG;AACH,MAAa,gBAAiB,SAAQ,wBAAU;IAC5C,YAAmB,MAAsB,EAAkB,MAA2B,EAAkB,KAAY,EAAkB,aAAqB;QACvJ,KAAK,EAAE,CAAC;QAD+C,WAAM,GAAN,MAAM,CAAqB;QAAkB,UAAK,GAAL,KAAK,CAAO;QAAkB,kBAAa,GAAb,aAAa,CAAQ;QAGvJ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,OAAO,CAAC,MAA2B;QAC/B,OAAO,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,UAAU;QACN,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,UAAoB,EAAE,MAA2B,EAAE,KAAY;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,UAAoB,EAAE,MAA2B;QAClD,IAAG,IAAI,CAAC,MAAO,CAAC,UAAU,EAAE,EAAE;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;SAC7C;QAED,OAAO,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,CAAC;CACJ;AA3CD,4CA2CC"}
+{"version":3,"file":"method-router.node.js","sourceRoot":"","sources":["../../../../src/nodes/method-router.node.ts"],"names":[],"mappings":";;;AAAA,+CAAyC;AAIzC,qFAA6E;AAE7E;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,wBAAU;IAC5C;;;;;OAKG;IACH,YAAmB,MAAsB,EAAkB,MAA2B,EAAkB,KAAY,EAAkB,aAAqB;QACvJ,KAAK,EAAE,CAAC;QAD+C,WAAM,GAAN,MAAM,CAAqB;QAAkB,UAAK,GAAL,KAAK,CAAO;QAAkB,kBAAa,GAAb,aAAa,CAAQ;QAGvJ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAA2B;QAC/B,OAAO,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,UAAU;QACN,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,UAAoB,EAAE,MAA2B,EAAE,KAAY;QAC/D,MAAM,IAAI,oDAAuB,CAAC,uDAAuD,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAChI,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,UAAoB,EAAE,MAA2B;QAClD,IAAG,IAAI,CAAC,MAAO,CAAC,UAAU,EAAE,EAAE;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;SAC7C;QAED,OAAO,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,CAAC;CACJ;AAxDD,4CAwDC"}

package/dist/lib/cjs/nodes/path-router.node.js

@@ -9,6 +9,10 @@ const path_router_adding_error_1 = require("../errors/path-router-adding.error")
  * This class represents a Path Node in the Router Node. It can never be a leaf node and will always have children.
  */
 class PathRouterNode extends router_node_1.RouterNode {
+    /**
+     * @param path The path associated with the current node.
+     * @param parent The parent node of the current node.
+     */
     constructor(path, parent) {
         super();
         this.path = path;
@@ -20,9 +24,9 @@ class PathRouterNode extends router_node_1.RouterNode {
     /**
      * This method adds all the required nodes to match the splitPaths and the method.
      *
-     * @param splitPaths
-     * @param method
-     * @param route
+     * @param splitPaths A list of all the parts of the paths spliced at the forward slashes.
+     * @param method The http method for this route.
+     * @param route The route.
      */
     add(splitPaths, method, route, levelFromRoot) {
         // Check to make sure that the first split path matches the current node
@@ -37,13 +41,15 @@ class PathRouterNode extends router_node_1.RouterNode {
             if (matchedMethodRouterNodeChild !== undefined) {
                 throw new path_router_adding_error_1.PathRouterAddingError("There is already an HTTP Method associated with this path.", splitPaths, method, route, this);
             }
+            // Add a new child node of type MethodRouterNode for this new http method.
             this.children.push(new method_router_node_1.MethodRouterNode(this, method, route, levelFromRoot + 1));
             return;
         }
         // Loop over our children that are of PathRouterNode and check if the next path matches
         const matchedChild = this.children.filter(child => child instanceof PathRouterNode).find((child) => child.matches(splitPaths[1]));
-        // If there's a matched child, call the add httpMethod on it and return.
+        // If there's a matched child, call the add method on it and return.
         if (matchedChild !== undefined) {
+            // Remove the first part of the path as it is used by the current node.
             matchedChild.add(splitPaths.slice(1), method, route, levelFromRoot + 1);
             return;
         }
@@ -51,6 +57,7 @@ class PathRouterNode extends router_node_1.RouterNode {
         const pathRouterNode = new PathRouterNode(splitPaths[1], this);
         this.children.push(pathRouterNode);
         // Then, call add on the latest pathRouterNode child
+        // Remove the first part of the path as it is used by the current node.
         pathRouterNode.add(splitPaths.slice(1), method, route, levelFromRoot + 1);
         return;
     }
@@ -60,8 +67,8 @@ class PathRouterNode extends router_node_1.RouterNode {
      * it returns itself as the node found. This method should always return a MethodRouterNode. However, Typescript
      * doesn't like these recursive imports so we return the base class
      *
-     * @param splitPaths
-     * @param method
+     * @param splitPaths A list of all the parts of the paths spliced at the forward slashes.
+     * @param method The http method for which to find a node.
      */
     find(splitPaths, method) {
         // If splitPaths is 0 or if the first path doesn't match this current node, we return
@@ -69,7 +76,8 @@ class PathRouterNode extends router_node_1.RouterNode {
             return null;
         }
         const foundChildren = [];
-        // Since we checked above if we didn't match, it means we match. We check if one of our children matches.
+        // Since we checked above if we didn't match, it means we match.
+        // We check if one of our children matches the next part of the path.
         for (const child of this.children) {
             const foundChild = child.find(splitPaths.slice(1), method);
             if (foundChild !== null) {
@@ -91,12 +99,14 @@ class PathRouterNode extends router_node_1.RouterNode {
     /**
      * This httpMethod navigates the tree upwards and returns all the routeParameters
      *
-     * @param splitPaths
+     * @param splitPaths A list of all the parts of the paths spliced at the forward slashes.
      */
     getRouteParameters(splitPaths) {
         let parameters = {};
         if (this.matches(splitPaths[0])) {
-            // If the current path is a parameter path, meaning has services/{id-of-service}
+            // If the current path is a path parameter
+            // We support both ways of setting a path parameter, either curly brackets, or colons
+            // ie: services/{serviceId} or service/:serviceId
             if (this.path.startsWith("/{") && this.path.endsWith("}")) {
                 const name = this.path.slice(2, this.path.length - 1);
                 parameters[name] = splitPaths[0].slice(1, splitPaths[0].length);
@@ -120,14 +130,14 @@ class PathRouterNode extends router_node_1.RouterNode {
         return this.path.startsWith("/*");
     }
     /**
-     * This method returns whether or not this pathRouterNode represents a route parameter, e.g.: /{id} or :id
+     * This method returns whether or not this pathRouterNode represents a route parameter, e.g.: /{id} or /:id
      */
     isRouteParameter() {
-        // If the current path is a parameter path, meaning has services/{id-of-service}
+        // If the current path is a path parameter, meaning has services/{id-of-service}
         if (this.path.startsWith("/{") && this.path.endsWith("}")) {
             return true;
         }
-        // We also support parameter path written as services/:id-of-service
+        // We also support path parameter written as services/:id-of-service
         if (this.path.startsWith("/:")) {
             return true;
         }

package/dist/lib/cjs/nodes/path-router.node.js.map

@@ -1 +1 @@
-{"version":3,"file":"path-router.node.js","sourceRoot":"","sources":["../../../../src/nodes/path-router.node.ts"],"names":[],"mappings":";;;AAAA,+CAAyC;AAEzC,6DAAsD;AAEtD,+FAAuF;AACvF,iFAAyE;AAEzE;;GAEG;AACH,MAAa,cAAe,SAAQ,wBAAU;IAC1C,YAAmC,IAAY,EAAE,MAAuB;QACpE,KAAK,EAAE,CAAC;QADuB,SAAI,GAAJ,IAAI,CAAQ;QAG3C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE;YAChC,MAAM,IAAI,8DAA4B,CAAC,4CAA4C,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;SACtG;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,UAAoB,EAAE,MAA2B,EAAE,KAAY,EAAE,aAAqB;QACtF,wEAAwE;QACxE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE;YAChE,OAAO;SACV;QAED,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,6HAA6H;QAC7H,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,4FAA4F;YAC5F,MAAM,4BAA4B,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,qCAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,KAAuB,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;YAE9J,IAAI,4BAA4B,KAAK,SAAS,EAAE;gBAC5C,MAAM,IAAI,gDAAqB,CAAC,4DAA4D,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;aAClI;YAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC;YACjF,OAAO;SACV;QAED,uFAAuF;QACvF,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,KAAqB,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAElJ,wEAAwE;QACxE,IAAI,YAAY,KAAK,SAAS,EAAE;YAC5B,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC;YACxE,OAAO;SACV;QAED,2EAA2E;QAC3E,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEnC,oDAAoD;QACpD,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC;QAC1E,OAAO;IACX,CAAC;IAGD;;;;;;;;OAQG;IACH,IAAI,CAAC,UAAoB,EAAE,MAA2B;QAClD,qFAAqF;QACrF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE;YAChE,OAAO,IAAI,CAAC;SACf;QAED,MAAM,aAAa,GAAiB,EAAE,CAAC;QAEvC,yGAAyG;QACzG,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3D,IAAI,UAAU,KAAK,IAAI,EAAE;gBACrB,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAClC;SACJ;QAED,IAAG,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC;SACf;QAED,mGAAmG;QACnG,sFAAsF;QACtF,MAAM,eAAe,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,UAAU,EAAE,MAAK,KAAK,CAAA,EAAA,CAAC,CAAC;QAExF,IAAG,eAAe,IAAI,SAAS,EAAE;YAC7B,OAAO,eAAe,CAAC;SAC1B;QAED,4HAA4H;QAC5H,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,UAAoB;QACnC,IAAI,UAAU,GAAG,EAAE,CAAC;QAEpB,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE;YAC7B,gFAAgF;YAChF,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACvD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEtD,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aAEnE;iBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAElD,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aACnE;SACJ;QAED,+FAA+F;QAC/F,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC3B,MAAM,MAAM,GAAmB,IAAI,CAAC,MAAwB,CAAC;YAE7D,UAAU,mCAAO,UAAU,GAAK,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACnF;QAED,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,UAAU;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,gBAAgB;QACZ,gFAAgF;QAChF,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACvD,OAAO,IAAI,CAAC;SACf;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC;SACf;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,IAAY;QAChB,IAAG,IAAI,CAAC,UAAU,EAAE,EAAE;YAClB,OAAO,IAAI,CAAC;SACf;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,EAAE;YACzB,OAAO,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;IAC9B,CAAC;CACJ;AA5KD,wCA4KC"}
+{"version":3,"file":"path-router.node.js","sourceRoot":"","sources":["../../../../src/nodes/path-router.node.ts"],"names":[],"mappings":";;;AAAA,+CAAyC;AAEzC,6DAAsD;AAEtD,+FAAuF;AACvF,iFAAyE;AAEzE;;GAEG;AACH,MAAa,cAAe,SAAQ,wBAAU;IAC1C;;;OAGG;IACH,YAAmC,IAAY,EAAE,MAAuB;QACpE,KAAK,EAAE,CAAC;QADuB,SAAI,GAAJ,IAAI,CAAQ;QAG3C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE;YAChC,MAAM,IAAI,8DAA4B,CAAC,4CAA4C,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;SACtG;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,UAAoB,EAAE,MAA2B,EAAE,KAAY,EAAE,aAAqB;QACtF,wEAAwE;QACxE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE;YAChE,OAAO;SACV;QAED,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,6HAA6H;QAC7H,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,4FAA4F;YAC5F,MAAM,4BAA4B,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,qCAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,KAAuB,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;YAE9J,IAAI,4BAA4B,KAAK,SAAS,EAAE;gBAC5C,MAAM,IAAI,gDAAqB,CAAC,4DAA4D,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;aAClI;YAED,0EAA0E;YAC1E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC;YACjF,OAAO;SACV;QAED,uFAAuF;QACvF,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,KAAqB,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAElJ,oEAAoE;QACpE,IAAI,YAAY,KAAK,SAAS,EAAE;YAC5B,uEAAuE;YACvE,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC;YACxE,OAAO;SACV;QAED,2EAA2E;QAC3E,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEnC,oDAAoD;QACpD,uEAAuE;QACvE,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC;QAC1E,OAAO;IACX,CAAC;IAGD;;;;;;;;OAQG;IACH,IAAI,CAAC,UAAoB,EAAE,MAA2B;QAClD,qFAAqF;QACrF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE;YAChE,OAAO,IAAI,CAAC;SACf;QAED,MAAM,aAAa,GAAiB,EAAE,CAAC;QAEvC,gEAAgE;QAChE,qEAAqE;QACrE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3D,IAAI,UAAU,KAAK,IAAI,EAAE;gBACrB,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAClC;SACJ;QAED,IAAG,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC;SACf;QAED,mGAAmG;QACnG,sFAAsF;QACtF,MAAM,eAAe,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,UAAU,EAAE,MAAK,KAAK,CAAA,EAAA,CAAC,CAAC;QAExF,IAAG,eAAe,IAAI,SAAS,EAAE;YAC7B,OAAO,eAAe,CAAC;SAC1B;QAED,4HAA4H;QAC5H,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,UAAoB;QACnC,IAAI,UAAU,GAAG,EAAE,CAAC;QAEpB,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE;YAC7B,0CAA0C;YAC1C,qFAAqF;YACrF,iDAAiD;YACjD,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACvD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEtD,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aAEnE;iBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAElD,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;aACnE;SACJ;QAED,+FAA+F;QAC/F,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC3B,MAAM,MAAM,GAAmB,IAAI,CAAC,MAAwB,CAAC;YAE7D,UAAU,mCAAO,UAAU,GAAK,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACnF;QAED,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,UAAU;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,gBAAgB;QACZ,gFAAgF;QAChF,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACvD,OAAO,IAAI,CAAC;SACf;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC;SACf;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,IAAY;QAChB,IAAG,IAAI,CAAC,UAAU,EAAE,EAAE;YAClB,OAAO,IAAI,CAAC;SACf;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,EAAE;YACzB,OAAO,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;IAC9B,CAAC;CACJ;AAtLD,wCAsLC"}

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

@@ -11,11 +11,29 @@ require("reflect-metadata");
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const networking_module_keyname_1 = require("../networking.module.keyname");
+/**
+ * The BodyParameterDecoratorResolver resolves the value of the body of the request so that it can be injected it into the
+ * parameter of the route of the controller that was annotated with the @body decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let BodyParameterDecoratorResolver = class BodyParameterDecoratorResolver {
+    /**
+     * Resolves the value of the body of the request.
+     * The router than injects that value into the parameter of the controller method.
+     * @param methodArgument The method argument created by the decorator.
+     * @param request The request
+     * @param routeParameters The router parameters
+     * @param identity The identity making the request
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         var _a;
         return Promise.resolve((_a = request.body) !== null && _a !== void 0 ? _a : null);
     }
+    /**
+     * Returns whether or not the resolver support such a method argument.
+     * Usually we will check the methodArgument.type field to determine if it is a supported type.
+     * @param methodArgument
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "body";
     }

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

@@ -1 +1 @@
-{"version":3,"file":"body-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/body-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAAyB;AACzB,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AAKrE,IAAa,8BAA8B,GAA3C,MAAa,8BAA8B;IACvC,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,OAAO,CAAC,IAAI,mCAAI,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,MAAM,CAAC;IACrG,CAAC;CACJ,CAAA;AAXY,8BAA8B;IAH1C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,8BAA8B,CAW1C;AAXY,wEAA8B"}
+{"version":3,"file":"body-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/body-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAAyB;AACzB,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AAIrE;;;;GAIG;AAIH,IAAa,8BAA8B,GAA3C,MAAa,8BAA8B;IAEvC;;;;;;;OAOG;IACH,OAAO,CAAC,cAA+C,EAC/C,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,OAAO,CAAC,IAAI,mCAAI,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,cAA2C;QAChD,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,MAAM,CAAC;IACrG,CAAC;CACJ,CAAA;AAzBY,8BAA8B;IAH1C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,8BAA8B,CAyB1C;AAzBY,wEAA8B"}

package/dist/lib/cjs/resolvers/controller-method-parameter-decorator.resolver.js

@@ -15,10 +15,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ControllerMethodParameterDecoratorResolver = void 0;
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
+/**
+ * This service calls the resolvers to resolve the value to be injected in the parameter of a method.
+ */
 let ControllerMethodParameterDecoratorResolver = class ControllerMethodParameterDecoratorResolver {
+    /**
+     * This service calls the resolvers to resolve the value to be injected in the parameter of a method.
+     * @param methodParameterDecoratorResolvers The parameter decorator resolvers. All services with the tag ServiceDefinitionTagEnum.MethodParameterDecoratorResolver will be automatically injected here.
+     */
     constructor(methodParameterDecoratorResolvers) {
         this.methodParameterDecoratorResolvers = methodParameterDecoratorResolvers;
     }
+    /**
+     * This method calls the parameter decorator resolver that supports the type of the decorator and resolves the value to be injected in the parameter.
+     * @param methodArgument The method argument created by the decorator.
+     * @param request The request
+     * @param routeParameters The router parameters
+     * @param identity The identity making the request
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         for (let methodParameterDecoratorResolver of this.methodParameterDecoratorResolvers) {
             if (methodParameterDecoratorResolver.supports(methodArgument)) {

package/dist/lib/cjs/resolvers/controller-method-parameter-decorator.resolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"controller-method-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/controller-method-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCAA+C;AAC/C,gDAAgF;AAMhF,IAAa,0CAA0C,GAAvD,MAAa,0CAA0C;IACnD,YAAmG,iCAAwF;QAAxF,sCAAiC,GAAjC,iCAAiC,CAAuD;IAC3L,CAAC;IAEM,OAAO,CAAC,cAA2C,EAC3C,OAAgB,EAChB,eAA0C,EAC1C,QAA4B;QAEvC,KAAK,IAAI,gCAAgC,IAAI,IAAI,CAAC,iCAAiC,EAAE;YACjF,IAAG,gCAAgC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;gBAC1D,OAAO,gCAAgC,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;aACvG;SACJ;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;CACJ,CAAA;AAjBY,0CAA0C;IADtD,qBAAU,EAAE;IAEI,WAAA,oBAAS,CAAC,iCAAwB,CAAC,gCAAgC,CAAC,CAAA;;GADxE,0CAA0C,CAiBtD;AAjBY,gGAA0C"}
+{"version":3,"file":"controller-method-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/controller-method-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCAA+C;AAC/C,gDAAgF;AAKhF;;GAEG;AAEH,IAAa,0CAA0C,GAAvD,MAAa,0CAA0C;IACnD;;;OAGG;IACH,YAAmG,iCAAwF;QAAxF,sCAAiC,GAAjC,iCAAiC,CAAuD;IAC3L,CAAC;IAGD;;;;;;OAMG;IACI,OAAO,CAAC,cAA2C,EAC3C,OAAgB,EAChB,eAA0C,EAC1C,QAA4B;QAEvC,KAAK,IAAI,gCAAgC,IAAI,IAAI,CAAC,iCAAiC,EAAE;YACjF,IAAG,gCAAgC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;gBAC1D,OAAO,gCAAgC,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;aACvG;SACJ;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;CACJ,CAAA;AA7BY,0CAA0C;IADtD,qBAAU,EAAE;IAMI,WAAA,oBAAS,CAAC,iCAAwB,CAAC,gCAAgC,CAAC,CAAA;;GALxE,0CAA0C,CA6BtD;AA7BY,gGAA0C"}

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

@@ -11,11 +11,29 @@ require("reflect-metadata");
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const networking_module_keyname_1 = require("../networking.module.keyname");
+/**
+ * The HeadersParameterDecoratorResolver resolves the value of the headers of the request so that it can be injected it into the
+ * parameter of the route of the controller that was annotated with the @headers decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let HeadersParameterDecoratorResolver = class HeadersParameterDecoratorResolver {
+    /**
+     * Resolves the value of the headers of the request.
+     * The router than injects that value into the parameter of the controller method.
+     * @param methodArgument The method argument created by the decorator.
+     * @param request The request
+     * @param routeParameters The router parameters
+     * @param identity The identity making the request
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         var _a;
         return Promise.resolve((_a = request.headers) !== null && _a !== void 0 ? _a : null);
     }
+    /**
+     * Returns whether or not the resolver support such a method argument.
+     * Usually we will check the methodArgument.type field to determine if it is a supported type.
+     * @param methodArgument
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "headers";
     }

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

@@ -1 +1 @@
-{"version":3,"file":"headers-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/headers-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAAyB;AACzB,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AAKrE,IAAa,iCAAiC,GAA9C,MAAa,iCAAiC;IAC1C,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,CAAC;IACxG,CAAC;CACJ,CAAA;AAXY,iCAAiC;IAH7C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,iCAAiC,CAW7C;AAXY,8EAAiC"}
+{"version":3,"file":"headers-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/headers-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAAyB;AACzB,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AAIrE;;;;GAIG;AAIH,IAAa,iCAAiC,GAA9C,MAAa,iCAAiC;IAE1C;;;;;;;OAOG;IACH,OAAO,CAAC,cAAkD,EAClD,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,cAA2C;QAChD,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,CAAC;IACxG,CAAC;CACJ,CAAA;AAzBY,iCAAiC;IAH7C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,iCAAiC,CAyB7C;AAzBY,8EAAiC"}

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

@@ -11,10 +11,28 @@ require("reflect-metadata");
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const networking_module_keyname_1 = require("../networking.module.keyname");
+/**
+ * The IdentityParameterDecoratorResolver resolves the value of the identity (parsed by the authenticator) of the request
+ * so that it can be injected it into the parameter of the route of the controller that was annotated with the @identity decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let IdentityParameterDecoratorResolver = class IdentityParameterDecoratorResolver {
+    /**
+     * Resolves the value of the identity of the request.
+     * The router than injects that value into the parameter of the controller method.
+     * @param methodArgument The method argument created by the decorator.
+     * @param request The request
+     * @param routeParameters The router parameters
+     * @param identity The identity making the request
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         return Promise.resolve(identity !== null && identity !== void 0 ? identity : null);
     }
+    /**
+     * Returns whether or not the resolver support such a method argument.
+     * Usually we will check the methodArgument.type field to determine if it is a supported type.
+     * @param methodArgument
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "identity";
     }

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

@@ -1 +1 @@
-{"version":3,"file":"identity-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/identity-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAAyB;AACzB,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AAKrE,IAAa,kCAAkC,GAA/C,MAAa,kCAAkC;IAC3C,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,UAAU,CAAC;IACzG,CAAC;CACJ,CAAA;AAXY,kCAAkC;IAH9C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,kCAAkC,CAW9C;AAXY,gFAAkC"}
+{"version":3,"file":"identity-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/identity-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAAyB;AACzB,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AAIrE;;;;GAIG;AAIH,IAAa,kCAAkC,GAA/C,MAAa,kCAAkC;IAE3C;;;;;;;OAOG;IACH,OAAO,CAAC,cAAmD,EACnD,OAAgB,EAChB,eAAwC,EACxC,QAA4B;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,cAA2C;QAChD,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,UAAU,CAAC;IACzG,CAAC;CACJ,CAAA;AAzBY,kCAAkC;IAH9C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,kCAAkC,CAyB9C;AAzBY,gFAAkC"}

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

@@ -14,12 +14,31 @@ const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const networking_module_keyname_1 = require("../networking.module.keyname");
 const url_parse_1 = __importDefault(require("url-parse"));
+/**
+ * The QueryParameterDecoratorResolver resolves the value of the query parameter with the name passed to the decorator
+ * of the request so that it can be injected it into the parameter of the route of the controller that was annotated
+ * with the @queryParameter decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let QueryParameterDecoratorResolver = class QueryParameterDecoratorResolver {
+    /**
+     * Resolves the value of the query parameter with the specified name of the request.
+     * The router than injects that value into the parameter of the controller method.
+     * @param methodArgument The method argument created by the decorator including the query parameter name.
+     * @param request The request
+     * @param routeParameters The router parameters
+     * @param identity The identity making the request
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         var _a;
         const url = new url_parse_1.default(request.url, true);
         return Promise.resolve((_a = url.query[methodArgument.queryParameterName]) !== null && _a !== void 0 ? _a : null);
     }
+    /**
+     * Returns whether or not the resolver support such a method argument.
+     * Usually we will check the methodArgument.type field to determine if it is a supported type.
+     * @param methodArgument
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "queryParameter";
     }

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

@@ -1 +1 @@
-{"version":3,"file":"query-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/query-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAoC;AAIpC,gDAAmG;AACnG,4EAAqE;AACrE,0DAA4B;AAK5B,IAAa,+BAA+B,GAA5C,MAAa,+BAA+B;IACxC,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,MAAM,GAAG,GAAG,IAAI,mBAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,mCAAI,IAAI,CAAC,CAAC;IACjF,CAAC;IAED,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,gBAAgB,CAAC;IAC/G,CAAC;CACJ,CAAA;AAbY,+BAA+B;IAH3C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,+BAA+B,CAa3C;AAbY,0EAA+B"}
+{"version":3,"file":"query-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/query-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AACrE,0DAA4B;AAI5B;;;;;GAKG;AAIH,IAAa,+BAA+B,GAA5C,MAAa,+BAA+B;IAExC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAgD,EAChD,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,MAAM,GAAG,GAAG,IAAI,mBAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,mCAAI,IAAI,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,cAA2C;QAChD,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,gBAAgB,CAAC;IAC/G,CAAC;CACJ,CAAA;AA3BY,+BAA+B;IAH3C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,+BAA+B,CA2B3C;AA3BY,0EAA+B"}

package/dist/lib/cjs/resolvers/query-parameters-decorator.resolver.js

@@ -14,12 +14,30 @@ const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const networking_module_keyname_1 = require("../networking.module.keyname");
 const url_parse_1 = __importDefault(require("url-parse"));
+/**
+ * The QueryParametersDecoratorResolver resolves the value (a  map) of the query parameters of the request so that it can be injected it into the
+ * parameter of the route of the controller that was annotated with the @queryParameters decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let QueryParametersDecoratorResolver = class QueryParametersDecoratorResolver {
+    /**
+     * Resolves the value of all the query parameters of the request.
+     * The router than injects that value into the parameter of the controller method.
+     * @param methodArgument The method argument created by the decorator.
+     * @param request The request
+     * @param routeParameters The router parameters
+     * @param identity The identity making the request
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         var _a;
         const url = new url_parse_1.default(request.url, true);
         return Promise.resolve((_a = url.query) !== null && _a !== void 0 ? _a : null);
     }
+    /**
+     * Returns whether or not the resolver support such a method argument.
+     * Usually we will check the methodArgument.type field to determine if it is a supported type.
+     * @param methodArgument
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "queryParameters";
     }

package/dist/lib/cjs/resolvers/query-parameters-decorator.resolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-parameters-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/query-parameters-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AACrE,0DAA4B;AAK5B,IAAa,gCAAgC,GAA7C,MAAa,gCAAgC;IACzC,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,MAAM,GAAG,GAAG,IAAI,mBAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,KAAK,mCAAI,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,QAAQ,CAAC,cAAmB;QACxB,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,iBAAiB,CAAC;IAChH,CAAC;CACJ,CAAA;AAbY,gCAAgC;IAH5C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,gCAAgC,CAa5C;AAbY,4EAAgC"}
+{"version":3,"file":"query-parameters-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/query-parameters-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAoC;AAGpC,gDAAmG;AACnG,4EAAqE;AACrE,0DAA4B;AAI5B;;;;GAIG;AAIH,IAAa,gCAAgC,GAA7C,MAAa,gCAAgC;IAEzC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAiD,EACjD,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,MAAM,GAAG,GAAG,IAAI,mBAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,KAAK,mCAAI,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,cAA2C;QAChD,OAAO,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,iBAAiB,CAAC;IAChH,CAAC;CACJ,CAAA;AA3BY,gCAAgC;IAH5C,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,iCAAwB,CAAC,gCAAgC,CAAC;IAC9D,qBAAU,EAAE;GACA,gCAAgC,CA2B5C;AA3BY,4EAAgC"}

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

@@ -10,11 +10,29 @@ exports.RouteParameterDecoratorResolver = void 0;
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const networking_module_keyname_1 = require("../networking.module.keyname");
+/**
+ * The RouteParameterDecoratorResolver resolves the value of the route parameter specified of the request so that it can be injected it into the
+ * parameter of the route of the controller that was annotated with the @routeParameter decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let RouteParameterDecoratorResolver = class RouteParameterDecoratorResolver {
+    /**
+     * Resolves the value of the the route parameter with the specified name of the request.
+     * The router than injects that value into the parameter of the controller method.
+     * @param methodArgument The method argument created by the decorator, including the name of the parameter to resolve.
+     * @param request The request
+     * @param routeParameters The router parameters
+     * @param identity The identity making the request
+     */
     resolve(methodArgument, request, routeParameters, identity) {
         var _a;
         return Promise.resolve((_a = routeParameters[methodArgument.routeParameterName]) !== null && _a !== void 0 ? _a : null);
     }
+    /**
+     * Returns whether or not the resolver support such a method argument.
+     * Usually we will check the methodArgument.type field to determine if it is a supported type.
+     * @param methodArgument
+     */
     supports(methodArgument) {
         return methodArgument && methodArgument.hasOwnProperty("type") && methodArgument.type === "routeParameter";
     }