@pristine-ts/networking 0.0.165 → 0.0.166

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

@@ -1,8 +1,8 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This class defines a basic HttpError. In your code, feel free to throw an HttpError to have this error returned via HTTP.
  * If you throw this error when handling an Event, it won't be returned.
  */
-import { LoggableError } from "@pristine-ts/common";
 export class HttpError extends LoggableError {
     constructor(httpStatus, message, errors) {
         super(message, {

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

@@ -1 +1 @@
-{"version":3,"file":"http.error.js","sourceRoot":"","sources":["../../../../src/errors/http.error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAElD,MAAM,OAAO,SAAU,SAAQ,aAAa;IACxC,YAAmC,UAAkB,EAAW,OAAe,EAAkB,MAAc;QAC3G,KAAK,CAAC,OAAO,EAAE;YACX,UAAU;YACV,MAAM;SACT,CAAC,CAAC;QAJ4B,eAAU,GAAV,UAAU,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAQ;QAAkB,WAAM,GAAN,MAAM,CAAQ;QAM3G,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;CACJ"}
+{"version":3,"file":"http.error.js","sourceRoot":"","sources":["../../../../src/errors/http.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAElD;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,aAAa;IACxC,YAAmC,UAAkB,EAAW,OAAe,EAAkB,MAAc;QAC3G,KAAK,CAAC,OAAO,EAAE;YACX,UAAU;YACV,MAAM;SACT,CAAC,CAAC;QAJ4B,eAAU,GAAV,UAAU,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAQ;QAAkB,WAAM,GAAN,MAAM,CAAQ;QAM3G,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;CACJ"}

package/dist/lib/esm/errors/method-router-adding.error.js

@@ -0,0 +1,21 @@
+import { LoggableError } from "@pristine-ts/common";
+import { MethodRouterNode } from "../nodes/method-router.node";
+/**
+ * This Error is thrown when there's an error that happens when the networking is being initialized.
+ * It is thrown when trying to add a child node to a MethodRouterNode, since a MethodRouterNode is a leaf it cannot have any children.
+ */
+export class MethodRouterAddingError extends LoggableError {
+    constructor(message, splitPaths, method, route, methodRouterNode) {
+        super(message, {
+            splitPaths,
+            method,
+            route,
+            methodRouterNode,
+        });
+        // Set the prototype explicitly.
+        // As specified in the documentation in TypeScript
+        // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
+        Object.setPrototypeOf(this, MethodRouterNode.prototype);
+    }
+}
+//# sourceMappingURL=method-router-adding.error.js.map

package/dist/lib/esm/errors/method-router-adding.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"method-router-adding.error.js","sourceRoot":"","sources":["../../../../src/errors/method-router-adding.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAE9D,OAAO,EAAC,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAE7D;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,aAAa;IAEtD,YAAmB,OAAe,EAAE,UAAoB,EAAE,MAA2B,EAAE,KAAY,EAAE,gBAAkC;QACnI,KAAK,CAAC,OAAO,EAAE;YACX,UAAU;YACV,MAAM;YACN,KAAK;YACL,gBAAgB;SACnB,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CACpE"}

package/dist/lib/esm/errors/path-router-adding.error.js

@@ -1,7 +1,8 @@
+import { LoggableError } from "@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 add a child node to a PathRouterNode.
  */
-import { LoggableError } from "@pristine-ts/common";
 export class PathRouterAddingError extends LoggableError {
     constructor(message, splitPaths, method, route, pathRouterNode) {
         super(message, {

package/dist/lib/esm/errors/path-router-adding.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"path-router-adding.error.js","sourceRoot":"","sources":["../../../../src/errors/path-router-adding.error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAa,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAI9D,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IAEpD,YAAmB,OAAe,EAAE,UAAoB,EAAE,MAA2B,EAAE,KAAY,EAAE,cAA8B;QAC/H,KAAK,CAAC,OAAO,EAAE;YACX,UAAU;YACV,MAAM;YACN,KAAK;YACL,cAAc;SACjB,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CACzE"}
+{"version":3,"file":"path-router-adding.error.js","sourceRoot":"","sources":["../../../../src/errors/path-router-adding.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAI9D;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IAEpD,YAAmB,OAAe,EAAE,UAAoB,EAAE,MAA2B,EAAE,KAAY,EAAE,cAA8B;QAC/H,KAAK,CAAC,OAAO,EAAE;YACX,UAAU;YACV,MAAM;YACN,KAAK;YACL,cAAc;SACjB,CAAC,CAAC;QAEH,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAAI,CAAC;CACzE"}

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

@@ -1,7 +1,8 @@
+import { LoggableError } from "@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.
  */
-import { LoggableError } from "@pristine-ts/common";
 export class PathRouterInstantiationError extends LoggableError {
     constructor(message, path, parent) {
         super(message, {

package/dist/lib/esm/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,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD,MAAM,OAAO,4BAA6B,SAAQ,aAAa;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"}
+{"version":3,"file":"path-router-instantiation.error.js","sourceRoot":"","sources":["../../../../src/errors/path-router-instantiation.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAGlD;;;GAGG;AACH,MAAM,OAAO,4BAA6B,SAAQ,aAAa;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"}

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

@@ -6,9 +6,9 @@ export * from "./parameter-decorator.interface";
 export * from "./query-parameter-decorator.interface";
 export * from "./query-parameters-decorator.interface";
 export * from "./request-parameter-decorator.interface";
-export * from "./router-request-enricher.interface";
-export * from "./router-response-enricher.interface";
 export * from "./route-method-decorator.interface";
 export * from "./route-parameter-decorator.interface";
 export * from "./router.interface";
+export * from "./router-request-enricher.interface";
+export * from "./router-response-enricher.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,sCAAsC,CAAC;AACrD,cAAc,4DAA4D,CAAC;AAC3E,cAAc,yCAAyC,CAAC;AACxD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,iCAAiC,CAAC;AAChD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../src/interfaces/interfaces.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,4DAA4D,CAAC;AAC3E,cAAc,yCAAyC,CAAC;AACxD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,iCAAiC,CAAC;AAChD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,oBAAoB,CAAC;AACnC,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC"}

package/dist/lib/esm/models/models.js

@@ -1,4 +1,3 @@
-export * from "./error-response-body";
 export * from "./request";
 export * from "./response";
 export * from "./route";

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

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/models/models.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/models/models.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}

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

@@ -4,7 +4,13 @@
 export 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;
@@ -14,8 +20,8 @@ export 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;
@@ -23,7 +29,7 @@ export 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);
@@ -31,7 +37,7 @@ export 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/esm/models/request.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/models/request.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,OAAO,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"}
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/models/request.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,OAAO,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"}

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

@@ -1,5 +1,11 @@
+/**
+ * This Response object represents the class used internally that represents a Response.
+ */
 export class Response {
     constructor() {
+        /**
+         * The status code of the response. By default we return a 200.
+         */
         this.status = 200;
     }
 }

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

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

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

@@ -2,6 +2,10 @@
  * This class represents a Route and how it can be routed to the proper controller method.
  */
 export 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/esm/models/route.js.map

@@ -1 +1 @@
-{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../src/models/route.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,OAAO,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"}
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../src/models/route.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,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"}

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

@@ -3,7 +3,6 @@ import { SecurityModule } from "@pristine-ts/security";
 import { TelemetryModule } from "@pristine-ts/telemetry";
 export * from "./decorators/decorators";
 export * from "./enrichers/enrichers";
-//export * from "./enums/enums";
 export * from "./errors/errors";
 export * from "./interfaces/interfaces";
 export * from "./models/models";
@@ -13,11 +12,6 @@ export * from "./utils/utils";
 export * from "./router";
 export const NetworkingModule = {
     keyname: 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: [
         SecurityModule,
         TelemetryModule,

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

@@ -1 +1 @@
-{"version":3,"file":"networking.module.js","sourceRoot":"","sources":["../../../src/networking.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,gCAAgC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAE9B,cAAc,UAAU,CAAC;AAEzB,MAAM,CAAC,MAAM,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,uBAAuB;IAChC;;;OAGG;IACH,qBAAqB,EAAE,EACtB;IAED,aAAa,EAAE;QACX,cAAc;QACd,eAAe;KAClB;IACD,wBAAwB,EAAE,EAEzB;CACJ,CAAA"}
+{"version":3,"file":"networking.module.js","sourceRoot":"","sources":["../../../src/networking.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAE9B,cAAc,UAAU,CAAC;AAEzB,MAAM,CAAC,MAAM,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,uBAAuB;IAChC,aAAa,EAAE;QACX,cAAc;QACd,eAAe;KAClB;IACD,wBAAwB,EAAE,EAEzB;CACJ,CAAA"}

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

@@ -1,8 +1,16 @@
 import { RouterNode } from "./router.node";
+import { MethodRouterAddingError } from "../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.
  */
 export class MethodRouterNode extends 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;
@@ -10,6 +18,11 @@ export class MethodRouterNode extends 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;
     }
@@ -21,20 +34,22 @@ export class MethodRouterNode extends 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 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/esm/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,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAKzC;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,UAAU;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"}
+{"version":3,"file":"method-router.node.js","sourceRoot":"","sources":["../../../../src/nodes/method-router.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAIzC,OAAO,EAAC,uBAAuB,EAAC,MAAM,sCAAsC,CAAC;AAE7E;;;GAGG;AACH,MAAM,OAAO,gBAAiB,SAAQ,UAAU;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,uBAAuB,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"}

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

@@ -6,6 +6,10 @@ import { PathRouterAddingError } from "../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.
  */
 export class PathRouterNode extends 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;
@@ -17,9 +21,9 @@ export class PathRouterNode extends 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
@@ -34,13 +38,15 @@ export class PathRouterNode extends RouterNode {
             if (matchedMethodRouterNodeChild !== undefined) {
                 throw new 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 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;
         }
@@ -48,6 +54,7 @@ export class PathRouterNode extends 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;
     }
@@ -57,8 +64,8 @@ export class PathRouterNode extends 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
@@ -66,7 +73,8 @@ export class PathRouterNode extends 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) {
@@ -88,12 +96,14 @@ export class PathRouterNode extends 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);
@@ -117,14 +127,14 @@ export class PathRouterNode extends 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/esm/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,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAC,4BAA4B,EAAC,MAAM,2CAA2C,CAAC;AACvF,OAAO,EAAC,qBAAqB,EAAC,MAAM,oCAAoC,CAAC;AAEzE;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;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,4BAA4B,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,gBAAgB,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,qBAAqB,CAAC,4DAA4D,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;aAClI;YAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,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"}
+{"version":3,"file":"path-router.node.js","sourceRoot":"","sources":["../../../../src/nodes/path-router.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAC,4BAA4B,EAAC,MAAM,2CAA2C,CAAC;AACvF,OAAO,EAAC,qBAAqB,EAAC,MAAM,oCAAoC,CAAC;AAEzE;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;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,4BAA4B,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,gBAAgB,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,qBAAqB,CAAC,4DAA4D,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;aAClI;YAED,0EAA0E;YAC1E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,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"}

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

@@ -8,11 +8,29 @@ import "reflect-metadata";
 import { injectable } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { NetworkingModuleKeyname } from "../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/esm/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,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,8BAA8B,CAW1C;SAXY,8BAA8B"}
+{"version":3,"file":"body-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/body-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,8BAA8B,CAyB1C;SAzBY,8BAA8B"}

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

@@ -12,10 +12,24 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 import { injectable, injectAll } from "tsyringe";
 import { ServiceDefinitionTagEnum } from "@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/esm/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,OAAO,EAAC,UAAU,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAoB,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;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,UAAU,EAAE;IAEI,WAAA,SAAS,CAAC,wBAAwB,CAAC,gCAAgC,CAAC,CAAA;;GADxE,0CAA0C,CAiBtD;SAjBY,0CAA0C"}
+{"version":3,"file":"controller-method-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/controller-method-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAC,UAAU,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAoB,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;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,UAAU,EAAE;IAMI,WAAA,SAAS,CAAC,wBAAwB,CAAC,gCAAgC,CAAC,CAAA;;GALxE,0CAA0C,CA6BtD;SA7BY,0CAA0C"}

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

@@ -8,11 +8,29 @@ import "reflect-metadata";
 import { injectable } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { NetworkingModuleKeyname } from "../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/esm/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,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,iCAAiC,CAW7C;SAXY,iCAAiC"}
+{"version":3,"file":"headers-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/headers-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,iCAAiC,CAyB7C;SAzBY,iCAAiC"}

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

@@ -8,10 +8,28 @@ import "reflect-metadata";
 import { injectable } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { NetworkingModuleKeyname } from "../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/esm/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,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,kCAAkC,CAW9C;SAXY,kCAAkC"}
+{"version":3,"file":"identity-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/identity-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,kBAAkB,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,kCAAkC,CAyB9C;SAzBY,kCAAkC"}

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

@@ -8,12 +8,31 @@ import { injectable } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { NetworkingModuleKeyname } from "../networking.module.keyname";
 import Url from '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(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/esm/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,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAIpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AACrE,OAAO,GAAG,MAAM,WAAW,CAAC;AAK5B,IAAa,+BAA+B,GAA5C,MAAa,+BAA+B;IACxC,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,MAAM,GAAG,GAAG,IAAI,GAAG,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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,+BAA+B,CAa3C;SAbY,+BAA+B"}
+{"version":3,"file":"query-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/query-parameter-decorator.resolver.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,OAAO,EAAoB,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AACrE,OAAO,GAAG,MAAM,WAAW,CAAC;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,GAAG,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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,+BAA+B,CA2B3C;SA3BY,+BAA+B"}