@pristine-ts/networking 0.0.164 → 0.0.165

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

@@ -11,10 +11,28 @@ require("reflect-metadata");
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const networking_module_keyname_1 = require("../networking.module.keyname");
+/**
+ * The RequestParameterDecoratorResolver resolves the value of the whole request so that it can be injected it into the
+ * parameter of the route of the controller that was annotated with the @request decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let RequestParameterDecoratorResolver = class RequestParameterDecoratorResolver {
+    /**
+     * Resolves the value of the whole 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(request !== null && request !== void 0 ? request : 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 === "request";
     }

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

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

package/dist/lib/esm/resolvers/request-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 RequestParameterDecoratorResolver resolves the value of the whole request so that it can be injected it into the
+ * parameter of the route of the controller that was annotated with the @request decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 let RequestParameterDecoratorResolver = class RequestParameterDecoratorResolver {
+    /**
+     * Resolves the value of the whole 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(request !== null && request !== void 0 ? request : 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 === "request";
     }

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

@@ -1 +1 @@
-{"version":3,"file":"request-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/request-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,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,CAAC;IAC5C,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":"request-parameter-decorator.resolver.js","sourceRoot":"","sources":["../../../../src/resolvers/request-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,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,CAAC;IAC5C,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/types/resolvers/request-parameter-decorator.resolver.d.ts

@@ -2,9 +2,29 @@ import "reflect-metadata";
 import { ControllerMethodParameterDecoratorResolverInterface } from "../interfaces/controller-method-parameter-decorator-resolver.interface";
 import { Request } from "../models/request";
 import { IdentityInterface } from "@pristine-ts/common";
+import { RequestParameterDecoratorInterface } from "../interfaces/request-parameter-decorator.interface";
+import { ParameterDecoratorInterface } from "../interfaces/parameter-decorator.interface";
+/**
+ * The RequestParameterDecoratorResolver resolves the value of the whole request so that it can be injected it into the
+ * parameter of the route of the controller that was annotated with the @request decorator.
+ * It is tagged as an MethodParameterDecoratorResolver so it can be automatically injected with the all the other MethodParameterDecoratorResolvers.
+ */
 export declare class RequestParameterDecoratorResolver implements ControllerMethodParameterDecoratorResolverInterface {
-    resolve(methodArgument: any, request: Request, routeParameters: {
+    /**
+     * Resolves the value of the whole 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: RequestParameterDecoratorInterface, request: Request, routeParameters: {
         [p: string]: string;
     }, identity?: IdentityInterface): Promise<any>;
-    supports(methodArgument: any): boolean;
+    /**
+     * 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;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pristine-ts/networking",
-  "version": "0.0.164",
+  "version": "0.0.165",
   "description": "",
   "module": "dist/lib/esm/networking.module.js",
   "main": "dist/lib/cjs/networking.module.js",
@@ -19,9 +19,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@pristine-ts/common": "^0.0.164",
-    "@pristine-ts/security": "^0.0.164",
-    "@pristine-ts/telemetry": "^0.0.164",
+    "@pristine-ts/common": "^0.0.165",
+    "@pristine-ts/security": "^0.0.165",
+    "@pristine-ts/telemetry": "^0.0.165",
     "url-parse": "^1.4.7"
   },
   "jest": {
@@ -58,5 +58,5 @@
       "src/*.{js,ts}"
     ]
   },
-  "gitHead": "c4e421eb5c60f895d6ae19d9b8c7078dd26d0fd4"
+  "gitHead": "da23f627c5a73c8b1aec0951e4b4f10ceeff44cb"
 }