@pristine-ts/networking 0.0.165 → 0.0.166

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

@@ -8,12 +8,30 @@ import { injectable } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { NetworkingModuleKeyname } from "../networking.module.keyname";
 import Url from '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(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/esm/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,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;AAK5B,IAAa,gCAAgC,GAA7C,MAAa,gCAAgC;IACzC,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,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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,gCAAgC,CAa5C;SAbY,gCAAgC"}
+{"version":3,"file":"query-parameters-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/query-parameters-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;;;;GAIG;AAIH,IAAa,gCAAgC,GAA7C,MAAa,gCAAgC;IAEzC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAiD,EACjD,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,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,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,gCAAgC,CA2B5C;SA3BY,gCAAgC"}

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

@@ -7,11 +7,29 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { injectable } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { NetworkingModuleKeyname } from "../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";
     }

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

@@ -1 +1 @@
-{"version":3,"file":"route-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/route-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;AAKrE,IAAa,+BAA+B,GAA5C,MAAa,+BAA+B;IACxC,OAAO,CAAC,cAAmB,EACnB,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,eAAe,CAAC,cAAc,CAAC,kBAAkB,CAAC,mCAAI,IAAI,CAAC,CAAC;IACvF,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;AAXY,+BAA+B;IAH3C,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,+BAA+B,CAW3C;SAXY,+BAA+B"}
+{"version":3,"file":"route-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/route-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;AAGrE;;;;GAIG;AAIH,IAAa,+BAA+B,GAA5C,MAAa,+BAA+B;IAExC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAgD,EAChD,OAAgB,EAChB,eAAwC,EACxC,QAA4B;;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAA,eAAe,CAAC,cAAc,CAAC,kBAAkB,CAAC,mCAAI,IAAI,CAAC,CAAC;IACvF,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;AAzBY,+BAA+B;IAH3C,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,wBAAwB,CAAC,gCAAgC,CAAC;IAC9D,UAAU,EAAE;GACA,+BAA+B,CAyB3C;SAzBY,+BAA+B"}

package/dist/lib/esm/router.js

@@ -30,7 +30,19 @@ import Url from 'url-parse';
 import { ServiceDefinitionTagEnum } from "@pristine-ts/common";
 import { NetworkingModuleKeyname } from "./networking.module.keyname";
 import { SpanKeynameEnum } from "@pristine-ts/telemetry";
+/**
+ * The router service is the service that creates the routing tree from the controllers.
+ * It also executes a request properly by routing it to the intended controller and returns the response.
+ */
 let Router = class Router {
+    /**
+     * The router service is the service that creates the routing tree from the controllers.
+     * It also executes a request properly by routing it to the intended controller and returns the response.
+     * @param loghandler The log handler
+     * @param controllerMethodParameterDecoratorResolver The controller method parameter decorator resolver used to resolve the values.
+     * @param authorizerManager The authorizer manager to validate authorization.
+     * @param authenticationManager The authentication manager to validate authentication.
+     */
     constructor(loghandler, controllerMethodParameterDecoratorResolver, authorizerManager, authenticationManager) {
         this.loghandler = loghandler;
         this.controllerMethodParameterDecoratorResolver = controllerMethodParameterDecoratorResolver;
@@ -96,6 +108,7 @@ let Router = class Router {
                 routeParameters
             }, NetworkingModuleKeyname);
             let identity;
+            // Authenticate the request
             try {
                 const routerRequestAuthenticationSpan = tracingManager.startSpan(SpanKeynameEnum.RouterRequestAuthentication, SpanKeynameEnum.RouterRequestExecution);
                 identity = yield this.authenticationManager.authenticate(request, methodNode.route.context, container);
@@ -120,6 +133,7 @@ let Router = class Router {
             }
             // Call the controller with the resolved Method arguments
             try {
+                // Verify that the identity making the request is authorized to make such a request
                 if ((yield this.authorizerManager.isAuthorized(request, methodNode.route.context, container, identity)) === false) {
                     this.loghandler.error("User not authorized to access this url.", {
                         request,
@@ -130,6 +144,7 @@ let Router = class Router {
                     routerRequestExecutionSpan.end();
                     return reject(new ForbiddenHttpError("You are not allowed to access this."));
                 }
+                // Execute all the enrichers to enrich the request.
                 const requestEnrichersSpan = tracingManager.startSpan(SpanKeynameEnum.RouterRequestEnrichers, SpanKeynameEnum.RouterRequestExecution);
                 const enrichedRequest = yield this.executeRequestEnrichers(request, container, methodNode);
                 requestEnrichersSpan.end();
@@ -137,6 +152,7 @@ let Router = class Router {
                     request,
                     enrichedRequest,
                 }, NetworkingModuleKeyname);
+                // Resolve the value to inject in the method arguments that have a decorator resolver
                 const resolvedMethodArguments = [];
                 for (const methodArgument of methodNode.route.methodArguments) {
                     resolvedMethodArguments.push(yield this.controllerMethodParameterDecoratorResolver.resolve(methodArgument, enrichedRequest, routeParameters, identity));

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

@@ -1 +1 @@
-{"version":3,"file":"router.js","sourceRoot":"","sources":["../../../src/router.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAsB,MAAM,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AAEhE,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAC,iBAAiB,EAAC,MAAM,+BAA+B,CAAC;AAGhE,OAAO,EAAC,cAAc,EAAC,MAAM,0BAA0B,CAAC;AAGxD,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAC,0CAA0C,EAAC,MAAM,4DAA4D,CAAC;AACtH,OAAO,GAAG,MAAM,WAAW,CAAC;AAC5B,OAAO,EAAgC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAK5F,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAO,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAGtF,IAAa,MAAM,GAAnB,MAAa,MAAM;IAGf,YAAoE,UAA+B,EAC9D,0CAAsF,EAChD,iBAA6C,EACzC,qBAAqD;QAHhE,eAAU,GAAV,UAAU,CAAqB;QAC9D,+CAA0C,GAA1C,0CAA0C,CAA4C;QAChD,sBAAiB,GAAjB,iBAAiB,CAA4B;QACzC,0BAAqB,GAArB,qBAAqB,CAAgC;QAL5H,SAAI,GAAe,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC;IAMnD,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,IAAY,EAAE,MAA2B,EAAE,KAAY;QACnE,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAE3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACI,OAAO,CAAC,OAAgB,EAAE,SAA8B;QAC3D,MAAM,cAAc,GAA4B,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAE7F,MAAM,0BAA0B,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,sBAAsB,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAEtI,OAAO,IAAI,OAAO,CAAW,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;YACnD,sGAAsG;YACtG,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAExC,sBAAsB;YACtB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAElD,MAAM,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,0BAA0B,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;YACpI,6DAA6D;YAC7D,MAAM,UAAU,GAAqB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAqB,CAAC;YACvG,cAAc,CAAC,GAAG,EAAE,CAAC;YAErB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,EAAE;gBACrC,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,OAAO;gBACP,GAAG;gBACH,UAAU;aACb,EAAE,uBAAuB,CAAC,CAAC;YAE5B,2CAA2C;YAC3C,IAAG,UAAU,KAAK,IAAI,EAAE;gBACpB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;oBAC1C,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,OAAO;oBACP,GAAG;iBACN,EAAE,uBAAuB,CAAC,CAAC;gBAE5B,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,IAAI,iBAAiB,CAAC,4BAA4B,GAAG,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC;aAC5F;YAED,2BAA2B;YAC3B,MAAM,eAAe,GAAI,UAAU,CAAC,MAAyB,CAAC,kBAAkB,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;YAEtG,6BAA6B;YAC7B,MAAM,4BAA4B,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,wBAAwB,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;YAChJ,MAAM,UAAU,GAAQ,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;YACzF,4BAA4B,CAAC,GAAG,EAAE,CAAC;YAEnC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,0CAA0C,EAAE;gBAC9D,UAAU;gBACV,eAAe;aAClB,EAAE,uBAAuB,CAAC,CAAC;YAE5B,IAAI,QAAuC,CAAC;YAG5C,IAAI;gBACA,MAAM,+BAA+B,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,2BAA2B,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;gBACtJ,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBACvG,+BAA+B,CAAC,GAAG,EAAE,CAAC;gBAEtC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,EAAE;oBACrC,QAAQ;iBACX,EAAE,uBAAuB,CAAC,CAAC;aAC/B;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;oBAC1C,KAAK;oBACL,OAAO;oBACP,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO;oBACjC,SAAS;iBACZ,EAAE,uBAAuB,CAAC,CAAC;gBAE5B,yEAAyE;gBACzE,IAAG,KAAK,YAAY,kBAAkB,KAAK,KAAK,EAAC;oBAC7C,KAAK,GAAG,IAAI,kBAAkB,CAAC,qCAAqC,CAAC,CAAC;iBACzE;gBAED,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;aACxB;YAED,yDAAyD;YACzD,IAAI;gBAEA,IAAG,CAAA,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,MAAK,KAAK,EAAE;oBAC5G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,yCAAyC,EAAE;wBAC7D,OAAO;wBACP,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO;wBACjC,SAAS;wBACT,QAAQ;qBACX,EAAE,uBAAuB,CAAC,CAAC;oBAE5B,0BAA0B,CAAC,GAAG,EAAE,CAAC;oBACjC,OAAO,MAAM,CAAC,IAAI,kBAAkB,CAAC,qCAAqC,CAAC,CAAC,CAAC;iBAChF;gBAED,MAAM,oBAAoB,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,sBAAsB,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;gBACtI,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;gBAC3F,oBAAoB,CAAC,GAAG,EAAE,CAAC;gBAE3B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,gCAAgC,EAAE;oBACpD,OAAO;oBACP,eAAe;iBAClB,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,MAAM,uBAAuB,GAAU,EAAE,CAAC;gBAE1C,KAAK,MAAM,cAAc,IAAI,UAAU,CAAC,KAAK,CAAC,eAAe,EAAE;oBAC3D,uBAAuB,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,0CAA0C,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;iBAC3J;gBAED,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,8BAA8B,EAAE;oBAClD,uBAAuB;iBAC1B,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,MAAM,kBAAkB,GAAG,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,uBAAuB,CAAC,CAAC;gBAErH,uEAAuE;gBACvE,8CAA8C;gBAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;gBAE3D,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,yCAAyC,EAAE;oBAC7D,QAAQ;iBACX,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,IAAI,gBAA0B,CAAC;gBAC/B,oEAAoE;gBACpE,IAAG,QAAQ,YAAY,QAAQ,EAAE;oBAC7B,gBAAgB,GAAG,QAAQ,CAAC;iBAC/B;qBAAM;oBACH,8FAA8F;oBAC9F,kFAAkF;oBAClF,gBAAgB,GAAG,IAAI,QAAQ,EAAE,CAAC;oBAClC,gBAAgB,CAAC,MAAM,GAAG,GAAG,CAAC;oBAC9B,gBAAgB,CAAC,IAAI,GAAG,QAAQ,CAAC;iBACpC;gBAED,MAAM,qBAAqB,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,uBAAuB,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;gBACxI,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;gBAC/G,qBAAqB,CAAC,GAAG,EAAE,CAAC;gBAE5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iCAAiC,EAAE;oBACrD,gBAAgB;oBAChB,gBAAgB;iBACnB,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,OAAO,CAAC,gBAAgB,CAAC,CAAC;aACpC;YACD,OAAO,KAAK,EAAE;gBACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,gEAAgE,EAAE;oBACpF,KAAK;iBACR,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;aACxB;QACL,CAAC,CAAA,CAAC,CAAA;IACN,CAAC;IAED;;;;;;;;OAQG;IACW,wBAAwB,CAAC,QAAkB,EAAE,OAAgB,EAAE,SAA8B,EAAE,UAA4B;;YACrI,oCAAoC;YACpC,IAAI,gBAAgB,GAAG,QAAQ,CAAC;YAEhC,yDAAyD;YACzD,IAAI,SAAS,CAAC,YAAY,CAAC,wBAAwB,CAAC,sBAAsB,EAAE,IAAI,CAAC,EAAE;gBAC/E,MAAM,SAAS,GAAU,SAAS,CAAC,UAAU,CAAC,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;gBAE/F,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;oBAC9B,+HAA+H;oBAC/H,2EAA2E;oBAC3E,IAAI,OAAO,QAAQ,CAAC,cAAc,KAAK,WAAW,EAAE;wBAChD,kCAAkC;wBAClC,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,4HAA4H,CAAC,CAAA;qBACtN;oBAED,IAAI;wBACA,8CAA8C;wBAC9C,gBAAgB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAE,QAA4C,CAAC,cAAc,CAAC,gBAAgB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;qBACjJ;oBAAC,OAAO,CAAC,EAAE;wBACR,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kHAAkH,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,EAAE,EAAC,CAAC,EAAC,EAAE,uBAAuB,CAAC,CAAC;wBAC3M,MAAM,CAAC,CAAC;qBACX;iBACJ;aACJ;YAED,OAAO,gBAAgB,CAAC;QAC5B,CAAC;KAAA;IAED;;;;;;;OAOG;IACW,uBAAuB,CAAE,OAAgB,EAAE,SAA8B,EAAE,UAA4B;;YACjH,oCAAoC;YACpC,IAAI,eAAe,GAAG,OAAO,CAAC;YAE9B,wDAAwD;YACxD,IAAI,SAAS,CAAC,YAAY,CAAC,wBAAwB,CAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE;gBAC9E,MAAM,SAAS,GAAU,SAAS,CAAC,UAAU,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC;gBAE9F,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;oBAC9B,+HAA+H;oBAC/H,2EAA2E;oBAC3E,IAAI,OAAO,QAAQ,CAAC,aAAa,KAAK,WAAW,EAAE;wBAC/C,kCAAkC;wBAClC,MAAM,IAAI,KAAK,CAAC,sCAAsC,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,yHAAyH,CAAC,CAAA;qBAClN;oBAED,IAAI;wBACA,8CAA8C;wBAC9C,eAAe,GAAG,MAAM,OAAO,CAAC,OAAO,CAAE,QAA2C,CAAC,aAAa,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;qBACpI;oBAAC,OAAO,CAAC,EAAE;wBACR,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kHAAkH,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,EAAE,EAAC,CAAC,EAAC,EAAE,uBAAuB,CAAC,CAAC;wBAC3M,MAAM,CAAC,CAAC;qBACX;iBACJ;aACJ;YAED,OAAO,eAAe,CAAC;QAC3B,CAAC;KAAA;CACJ,CAAA;AApQY,MAAM;IADlB,SAAS,EAAE;IAIa,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;IAE7B,WAAA,MAAM,CAAC,4BAA4B,CAAC,CAAA;IACpC,WAAA,MAAM,CAAC,gCAAgC,CAAC,CAAA;6CAFoB,0CAA0C;GAJlH,MAAM,CAoQlB;SApQY,MAAM"}
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../../../src/router.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAsB,MAAM,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AAEhE,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAC,iBAAiB,EAAC,MAAM,+BAA+B,CAAC;AAGhE,OAAO,EAAC,cAAc,EAAC,MAAM,0BAA0B,CAAC;AAGxD,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAC,0CAA0C,EAAC,MAAM,4DAA4D,CAAC;AACtH,OAAO,GAAG,MAAM,WAAW,CAAC;AAC5B,OAAO,EAAgC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAK5F,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAO,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAEtF;;;GAGG;AAEH,IAAa,MAAM,GAAnB,MAAa,MAAM;IAGf;;;;;;;OAOG;IACH,YAAoE,UAA+B,EAC9D,0CAAsF,EAChD,iBAA6C,EACzC,qBAAqD;QAHhE,eAAU,GAAV,UAAU,CAAqB;QAC9D,+CAA0C,GAA1C,0CAA0C,CAA4C;QAChD,sBAAiB,GAAjB,iBAAiB,CAA4B;QACzC,0BAAqB,GAArB,qBAAqB,CAAgC;QAb5H,SAAI,GAAe,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC;IAcnD,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,IAAY,EAAE,MAA2B,EAAE,KAAY;QACnE,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAE3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACI,OAAO,CAAC,OAAgB,EAAE,SAA8B;QAC3D,MAAM,cAAc,GAA4B,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAE7F,MAAM,0BAA0B,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,sBAAsB,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAEtI,OAAO,IAAI,OAAO,CAAW,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;YACnD,sGAAsG;YACtG,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAExC,sBAAsB;YACtB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAElD,MAAM,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,0BAA0B,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;YACpI,6DAA6D;YAC7D,MAAM,UAAU,GAAqB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAqB,CAAC;YACvG,cAAc,CAAC,GAAG,EAAE,CAAC;YAErB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,EAAE;gBACrC,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,OAAO;gBACP,GAAG;gBACH,UAAU;aACb,EAAE,uBAAuB,CAAC,CAAC;YAE5B,2CAA2C;YAC3C,IAAG,UAAU,KAAK,IAAI,EAAE;gBACpB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;oBAC1C,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,OAAO;oBACP,GAAG;iBACN,EAAE,uBAAuB,CAAC,CAAC;gBAE5B,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,IAAI,iBAAiB,CAAC,4BAA4B,GAAG,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC;aAC5F;YAED,2BAA2B;YAC3B,MAAM,eAAe,GAAI,UAAU,CAAC,MAAyB,CAAC,kBAAkB,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;YAEtG,6BAA6B;YAC7B,MAAM,4BAA4B,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,wBAAwB,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;YAChJ,MAAM,UAAU,GAAQ,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;YACzF,4BAA4B,CAAC,GAAG,EAAE,CAAC;YAEnC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,0CAA0C,EAAE;gBAC9D,UAAU;gBACV,eAAe;aAClB,EAAE,uBAAuB,CAAC,CAAC;YAE5B,IAAI,QAAuC,CAAC;YAE5C,2BAA2B;YAC3B,IAAI;gBACA,MAAM,+BAA+B,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,2BAA2B,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;gBACtJ,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBACvG,+BAA+B,CAAC,GAAG,EAAE,CAAC;gBAEtC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,EAAE;oBACrC,QAAQ;iBACX,EAAE,uBAAuB,CAAC,CAAC;aAC/B;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;oBAC1C,KAAK;oBACL,OAAO;oBACP,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO;oBACjC,SAAS;iBACZ,EAAE,uBAAuB,CAAC,CAAC;gBAE5B,yEAAyE;gBACzE,IAAG,KAAK,YAAY,kBAAkB,KAAK,KAAK,EAAC;oBAC7C,KAAK,GAAG,IAAI,kBAAkB,CAAC,qCAAqC,CAAC,CAAC;iBACzE;gBAED,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;aACxB;YAED,yDAAyD;YACzD,IAAI;gBAEA,mFAAmF;gBACnF,IAAG,CAAA,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,MAAK,KAAK,EAAE;oBAC5G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,yCAAyC,EAAE;wBAC7D,OAAO;wBACP,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO;wBACjC,SAAS;wBACT,QAAQ;qBACX,EAAE,uBAAuB,CAAC,CAAC;oBAE5B,0BAA0B,CAAC,GAAG,EAAE,CAAC;oBACjC,OAAO,MAAM,CAAC,IAAI,kBAAkB,CAAC,qCAAqC,CAAC,CAAC,CAAC;iBAChF;gBAED,mDAAmD;gBACnD,MAAM,oBAAoB,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,sBAAsB,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;gBACtI,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;gBAC3F,oBAAoB,CAAC,GAAG,EAAE,CAAC;gBAE3B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,gCAAgC,EAAE;oBACpD,OAAO;oBACP,eAAe;iBAClB,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,qFAAqF;gBACrF,MAAM,uBAAuB,GAAU,EAAE,CAAC;gBAE1C,KAAK,MAAM,cAAc,IAAI,UAAU,CAAC,KAAK,CAAC,eAAe,EAAE;oBAC3D,uBAAuB,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,0CAA0C,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;iBAC3J;gBAED,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,8BAA8B,EAAE;oBAClD,uBAAuB;iBAC1B,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,MAAM,kBAAkB,GAAG,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,uBAAuB,CAAC,CAAC;gBAErH,uEAAuE;gBACvE,8CAA8C;gBAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;gBAE3D,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,yCAAyC,EAAE;oBAC7D,QAAQ;iBACX,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,IAAI,gBAA0B,CAAC;gBAC/B,oEAAoE;gBACpE,IAAG,QAAQ,YAAY,QAAQ,EAAE;oBAC7B,gBAAgB,GAAG,QAAQ,CAAC;iBAC/B;qBAAM;oBACH,8FAA8F;oBAC9F,kFAAkF;oBAClF,gBAAgB,GAAG,IAAI,QAAQ,EAAE,CAAC;oBAClC,gBAAgB,CAAC,MAAM,GAAG,GAAG,CAAC;oBAC9B,gBAAgB,CAAC,IAAI,GAAG,QAAQ,CAAC;iBACpC;gBAED,MAAM,qBAAqB,GAAG,cAAc,CAAC,SAAS,CAAC,eAAe,CAAC,uBAAuB,EAAE,eAAe,CAAC,sBAAsB,CAAC,CAAC;gBACxI,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;gBAC/G,qBAAqB,CAAC,GAAG,EAAE,CAAC;gBAE5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iCAAiC,EAAE;oBACrD,gBAAgB;oBAChB,gBAAgB;iBACnB,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,OAAO,CAAC,gBAAgB,CAAC,CAAC;aACpC;YACD,OAAO,KAAK,EAAE;gBACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,gEAAgE,EAAE;oBACpF,KAAK;iBACR,EAAE,uBAAuB,CAAC,CAAA;gBAE3B,0BAA0B,CAAC,GAAG,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;aACxB;QACL,CAAC,CAAA,CAAC,CAAA;IACN,CAAC;IAED;;;;;;;;OAQG;IACW,wBAAwB,CAAC,QAAkB,EAAE,OAAgB,EAAE,SAA8B,EAAE,UAA4B;;YACrI,oCAAoC;YACpC,IAAI,gBAAgB,GAAG,QAAQ,CAAC;YAEhC,yDAAyD;YACzD,IAAI,SAAS,CAAC,YAAY,CAAC,wBAAwB,CAAC,sBAAsB,EAAE,IAAI,CAAC,EAAE;gBAC/E,MAAM,SAAS,GAAU,SAAS,CAAC,UAAU,CAAC,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;gBAE/F,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;oBAC9B,+HAA+H;oBAC/H,2EAA2E;oBAC3E,IAAI,OAAO,QAAQ,CAAC,cAAc,KAAK,WAAW,EAAE;wBAChD,kCAAkC;wBAClC,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,4HAA4H,CAAC,CAAA;qBACtN;oBAED,IAAI;wBACA,8CAA8C;wBAC9C,gBAAgB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAE,QAA4C,CAAC,cAAc,CAAC,gBAAgB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;qBACjJ;oBAAC,OAAO,CAAC,EAAE;wBACR,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kHAAkH,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,EAAE,EAAC,CAAC,EAAC,EAAE,uBAAuB,CAAC,CAAC;wBAC3M,MAAM,CAAC,CAAC;qBACX;iBACJ;aACJ;YAED,OAAO,gBAAgB,CAAC;QAC5B,CAAC;KAAA;IAED;;;;;;;OAOG;IACW,uBAAuB,CAAE,OAAgB,EAAE,SAA8B,EAAE,UAA4B;;YACjH,oCAAoC;YACpC,IAAI,eAAe,GAAG,OAAO,CAAC;YAE9B,wDAAwD;YACxD,IAAI,SAAS,CAAC,YAAY,CAAC,wBAAwB,CAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE;gBAC9E,MAAM,SAAS,GAAU,SAAS,CAAC,UAAU,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC;gBAE9F,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;oBAC9B,+HAA+H;oBAC/H,2EAA2E;oBAC3E,IAAI,OAAO,QAAQ,CAAC,aAAa,KAAK,WAAW,EAAE;wBAC/C,kCAAkC;wBAClC,MAAM,IAAI,KAAK,CAAC,sCAAsC,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,yHAAyH,CAAC,CAAA;qBAClN;oBAED,IAAI;wBACA,8CAA8C;wBAC9C,eAAe,GAAG,MAAM,OAAO,CAAC,OAAO,CAAE,QAA2C,CAAC,aAAa,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;qBACpI;oBAAC,OAAO,CAAC,EAAE;wBACR,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kHAAkH,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,EAAE,EAAC,CAAC,EAAC,EAAE,uBAAuB,CAAC,CAAC;wBAC3M,MAAM,CAAC,CAAC;qBACX;iBACJ;aACJ;YAED,OAAO,eAAe,CAAC;QAC3B,CAAC;KAAA;CACJ,CAAA;AA/QY,MAAM;IADlB,SAAS,EAAE;IAYa,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;IAE7B,WAAA,MAAM,CAAC,4BAA4B,CAAC,CAAA;IACpC,WAAA,MAAM,CAAC,gCAAgC,CAAC,CAAA;6CAFoB,0CAA0C;GAZlH,MAAM,CA+QlB;SA/QY,MAAM"}

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

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

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

@@ -1,2 +1,6 @@
 export declare const controllerRegistry: any[];
+/**
+ * The controller decorator can be used on a class to register this class as a controller in the router.
+ * @param basePath The base path for all the routes in the controller.
+ */
 export declare const controller: (basePath: string) => (constructor: Function) => void;

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

@@ -1,7 +1,7 @@
 export * from "./body.decorator";
 export * from "./controller.decorator";
-export * from "./identity.decorator";
 export * from "./headers.decorator";
+export * from "./identity.decorator";
 export * from "./query-parameter.decorator";
 export * from "./query-parameters.decorator";
 export * from "./request.decorator";

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

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

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

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

package/dist/types/decorators/query-parameter.decorator.d.ts

@@ -1 +1,5 @@
+/**
+ * The queryParameter decorator can be used to inject a specific query parameter of a request in a parameter of a method in a controller.
+ * @param name The name of the query parameter to inject.
+ */
 export declare const queryParameter: (name: string) => (target: Object, propertyKey: string | symbol, parameterIndex: number) => void;

package/dist/types/decorators/query-parameters.decorator.d.ts

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

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

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

package/dist/types/decorators/response-header.decorator.d.ts

@@ -1 +1,8 @@
+/**
+ * The responseHeader decorator can be used to specify a header that needs to be added to the response before sending it back.
+ * This decorator can be used with either method (route) or a class (controller).
+ * If used on the class than it will be applied to every route of the controller.
+ * @param key The key of the header
+ * @param value The value to set the header to.
+ */
 export declare const responseHeader: (key: string, value: string) => (target: any, propertyKey?: string | undefined, descriptor?: PropertyDescriptor | undefined) => void;

package/dist/types/decorators/route-parameter.decorator.d.ts

@@ -1 +1,5 @@
+/**
+ * The routeParameter decorator can be used to inject a specific route parameter of a request in a parameter of a method in a controller.
+ * @param name The name of the route(path) parameter to inject.
+ */
 export declare const routeParameter: (name: string) => (target: Object, propertyKey: string | symbol, parameterIndex: number) => void;

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

@@ -1,2 +1,7 @@
 import { HttpMethod } from "@pristine-ts/common";
-export declare const route: (httpMethod: HttpMethod | string, path: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * The route decorator can be used on a method to register this method as a route of the controller in the router.
+ * @param httpMethod The http method of the route
+ * @param path The part of the path following the base path of the controller. For path parameters use the colons. (ie: resources/:id)
+ */
+export declare const route: (httpMethod: HttpMethod | string, path: string) => (target: Object, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/types/enrichers/router-response.enricher.d.ts

@@ -2,6 +2,10 @@ import { Response } from "../models/response";
 import { Request } from "../models/request";
 import { RouterResponseEnricherInterface } from "../interfaces/router-response-enricher.interface";
 import { MethodRouterNode } from "../nodes/method-router.node";
+/**
+ * The RouterResponseEnricher enriches the response of the router by adding the response headers specified by the response header decorator.
+ * It is tagged as an RouterResponseEnricher so it can be automatically injected with the all the other RouterResponseEnrichers.
+ */
 export declare class RouterResponseEnricher implements RouterResponseEnricherInterface {
     enrichResponse(response: Response, request: Request, methodNode: MethodRouterNode): Promise<Response>;
 }

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

@@ -2,5 +2,7 @@ export * from "./bad-request.http-error";
 export * from "./forbidden.http-error";
 export * from "./http.error";
 export * from "./invalid-body.http-error";
-export * from "./path-router-instantiation.error";
+export * from "./method-router-adding.error";
 export * from "./not-found.http-error";
+export * from "./path-router-adding.error";
+export * from "./path-router-instantiation.error";

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

@@ -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 declare class HttpError extends LoggableError {
     readonly httpStatus: number;
     readonly message: string;

package/dist/types/errors/method-router-adding.error.d.ts

@@ -0,0 +1,10 @@
+import { HttpMethod, LoggableError } from "@pristine-ts/common";
+import { Route } from "../models/route";
+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 declare class MethodRouterAddingError extends LoggableError {
+    constructor(message: string, splitPaths: string[], method: HttpMethod | string, route: Route, methodRouterNode: MethodRouterNode);
+}

package/dist/types/errors/path-router-adding.error.d.ts

@@ -1,9 +1,10 @@
-/**
- * This Error is thrown when there's an error that happens when the networking is being initialized
- */
 import { HttpMethod, LoggableError } from "@pristine-ts/common";
 import { PathRouterNode } from "../nodes/path-router.node";
 import { Route } from "../models/route";
+/**
+ * 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.
+ */
 export declare class PathRouterAddingError extends LoggableError {
     constructor(message: string, splitPaths: string[], method: HttpMethod | string, route: Route, pathRouterNode: PathRouterNode);
 }

package/dist/types/errors/path-router-instantiation.error.d.ts

@@ -1,8 +1,9 @@
-/**
- * This Error is thrown when there's an error that happens when the networking is being initialized
- */
 import { LoggableError } from "@pristine-ts/common";
 import { PathRouterNode } from "../nodes/path-router.node";
+/**
+ * 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.
+ */
 export declare class PathRouterInstantiationError extends LoggableError {
     constructor(message: string, path: string, parent?: PathRouterNode);
 }

package/dist/types/interfaces/controller-method-parameter-decorator-resolver.interface.d.ts

@@ -1,8 +1,25 @@
 import { Request } from "../models/request";
 import { IdentityInterface } from "@pristine-ts/common";
+import { ParameterDecoratorInterface } from "./parameter-decorator.interface";
+/**
+ * This interface defines the methods that a decorator resolver for method parameter in a controller must implement.
+ */
 export interface ControllerMethodParameterDecoratorResolverInterface {
-    supports(methodArgument: any): boolean;
-    resolve(methodArgument: any, request: Request, routeParameters: {
+    /**
+     * 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: ParameterDecoratorInterface): boolean;
+    /**
+     * Resolves the value for the decorator.
+     * The router than injects that value into the parameter of the controller method.
+     * @param methodArgument The information on where to retrieve the value.
+     * @param request The request itself.
+     * @param routeParameters The parameters and their values in the route of the controller.
+     * @param identity The identity making the request
+     */
+    resolve(methodArgument: ParameterDecoratorInterface, request: Request, routeParameters: {
         [key: string]: string;
     }, identity?: IdentityInterface): Promise<any>;
 }

package/dist/types/interfaces/interfaces.d.ts

@@ -6,8 +6,8 @@ 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";

package/dist/types/interfaces/parameter-decorator.interface.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This interface represents the object that will contain the information for all decorator types.
+ * It's the base interface that all other decorator interfaces will extend.
+ */
 export interface ParameterDecoratorInterface {
     type: string;
 }

package/dist/types/interfaces/query-parameters-decorator.interface.d.ts

@@ -1,4 +1,8 @@
 import { ParameterDecoratorInterface } from "./parameter-decorator.interface";
+/**
+ * This interface represents the object that will contain the information required to know how to handle the
+ * @queryParameters decorator.
+ */
 export interface QueryParametersDecoratorInterface extends ParameterDecoratorInterface {
     type: "queryParameters";
 }

package/dist/types/interfaces/route-parameter-decorator.interface.d.ts

@@ -1,7 +1,7 @@
 import { ParameterDecoratorInterface } from "./parameter-decorator.interface";
 /**
  * This interface represents the object that will contain the information to know how to handle the
- * @body decorator.
+ * @routeParameter decorator.
  */
 export interface RouteParameterDecoratorInterface extends ParameterDecoratorInterface {
     type: "routeParameter";

package/dist/types/interfaces/router.interface.d.ts

@@ -4,7 +4,7 @@ import { Response } from "../models/response";
 import { Request } from "../models/request";
 import { Route } from "../models/route";
 /**
- * This method defines the interface that the router must implement.
+ * This interface defines the methods that the router must implement.
  */
 export interface RouterInterface {
     /**
@@ -18,7 +18,7 @@ export interface RouterInterface {
     register(path: string, method: HttpMethod | string, route: Route): any;
     /**
      * This method executes the request passed as a parameter. A container must also be passed since we want each
-     * request to have its own container so that memory isn't accidently shared between requests.
+     * request to have its own container so that memory isn't accidentally shared between requests.
      *
      * @param request
      * @param container

package/dist/types/models/models.d.ts

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

package/dist/types/models/request.d.ts

@@ -4,30 +4,42 @@ import { RequestInterface } from "@pristine-ts/common";
  * This Request object represents the class used internally that represents a Request.
  */
 export declare class Request implements RequestInterface {
+    /**
+     * The http method of the request.
+     */
     httpMethod: HttpMethod | string;
+    /**
+     * The url of the request.
+     */
     url: string;
+    /**
+     * The headers of the request.
+     */
     headers: {
         [key: string]: string;
     };
+    /**
+     * The body of the request.
+     */
     body: any;
     constructor(requestInterface: RequestInterface);
     /**
      * 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: string, value: string): void;
     /**
      * This method returns whether or not the header exists in the Request.
      *
-     * @param name
+     * @param name The name of the header.
      */
     hasHeader(name: string): boolean;
     /**
      * 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: string): string | undefined;
 }

package/dist/types/models/response.d.ts

@@ -1,9 +1,24 @@
 import { RequestInterface } from "@pristine-ts/common";
+/**
+ * This Response object represents the class used internally that represents a Response.
+ */
 export declare class Response {
+    /**
+     * The status code of the response. By default we return a 200.
+     */
     status: number;
+    /**
+     * The headers of the response.
+     */
     headers?: {
         [key: string]: string;
     };
+    /**
+     * The body of the response.
+     */
     body?: any;
+    /**
+     * The request that triggered this response.
+     */
     request?: RequestInterface;
 }

package/dist/types/models/route.d.ts

@@ -13,5 +13,9 @@ export declare class Route {
      * This contains the Route context for dynamic usage.
      */
     context?: any;
+    /**
+     * @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: any, methodPropertyKey: string);
 }

package/dist/types/nodes/method-router.node.d.ts

@@ -4,12 +4,24 @@ import { PathRouterNode } from "./path-router.node";
 import { Route } from "../models/route";
 /**
  * This class represents the Leaf node of the RouteTree.
+ * It will always have a parent node that will be a PathRouterNode.
  */
 export declare class MethodRouterNode extends RouterNode {
     readonly method: HttpMethod | string;
     readonly route: Route;
     readonly levelFromRoot: number;
+    /**
+     * @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: PathRouterNode, method: HttpMethod | string, route: Route, levelFromRoot: number);
+    /**
+     * 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: HttpMethod | string): boolean;
     /**
      * A MethodRouterNode is never a catch-all node.
@@ -17,19 +29,20 @@ export declare class MethodRouterNode extends RouterNode {
     isCatchAll(): boolean;
     /**
      * 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: string[], method: HttpMethod | string, route: Route): void;
     /**
-     * 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: string[], method: HttpMethod | string): RouterNode | null;
 }

package/dist/types/nodes/path-router.node.d.ts

@@ -6,13 +6,17 @@ import { Route } from "../models/route";
  */
 export declare class PathRouterNode extends RouterNode {
     readonly path: string;
+    /**
+     * @param path The path associated with the current node.
+     * @param parent The parent node of the current node.
+     */
     constructor(path: string, parent?: PathRouterNode);
     /**
      * 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: string[], method: HttpMethod | string, route: Route, levelFromRoot: number): void;
     /**
@@ -21,14 +25,14 @@ export declare 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: string[], method: HttpMethod | string): RouterNode | null;
     /**
      * 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: string[]): {
         [key: string]: string;
@@ -38,7 +42,7 @@ export declare class PathRouterNode extends RouterNode {
      */
     isCatchAll(): boolean;
     /**
-     * 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(): boolean;
     /**

package/dist/types/nodes/router.node.d.ts

@@ -20,7 +20,7 @@ export declare abstract class RouterNode {
     /**
      * This method adds all the required nodes to match the splitPaths and the method.
      *
-     * @param splitPaths
+     * @param splitPaths A list of all the parts of the paths spliced at the forward slashes.
      * @param method
      * @param route
      * @param levelFromRoot This parameter represents the number of level from the root. The root is at 0.
@@ -32,8 +32,8 @@ export declare abstract class 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.
      */
     abstract find(splitPaths: string[], method: HttpMethod | string): RouterNode | null;
     /**