@tsed/platform-params 6.88.0 → 6.91.0

package/lib/cjs/builder/PlatformParams.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformParams = void 0;
+const tslib_1 = require("tslib");
+const di_1 = require("@tsed/di");
+const schema_1 = require("@tsed/schema");
+const ParamValidationError_1 = require("../errors/ParamValidationError");
+const ParseExpressionPipe_1 = require("../pipes/ParseExpressionPipe");
+/**
+ * Platform Params abstraction layer.
+ * @platform
+ */
+let PlatformParams = class PlatformParams {
+    async getPipes(param) {
+        const get = (pipe) => {
+            return this.injector.getProvider(pipe).priority || 0;
+        };
+        const sort = (p1, p2) => (get(p1) < get(p2) ? -1 : get(p1) > get(p2) ? 1 : 0);
+        const map = (token) => this.injector.invoke(token);
+        const promises = await Promise.all([ParseExpressionPipe_1.ParseExpressionPipe, ...param.pipes.sort(sort)].map(map));
+        return promises.filter(Boolean);
+    }
+    async compile(entity) {
+        const params = schema_1.JsonParameterStore.getParams(entity.target, entity.propertyKey);
+        const argsPipes = await Promise.all(params.map(async (param) => {
+            return {
+                param,
+                pipes: await this.getPipes(param)
+            };
+        }));
+        return (scope) => {
+            const promises = argsPipes.map(({ param, pipes }) => {
+                return this.getArg(scope, pipes, param);
+            });
+            return Promise.all(promises);
+        };
+    }
+    async getArg(scope, pipes, param) {
+        return pipes.reduce(async (value, pipe) => {
+            value = await value;
+            try {
+                return await pipe.transform(value, param);
+            }
+            catch (er) {
+                throw ParamValidationError_1.ParamValidationError.from(param, er);
+            }
+        }, scope);
+    }
+    async compileHandler(metadata) {
+        const { token, propertyKey, getCustomArgs } = metadata;
+        const provider = this.injector.getProvider(token);
+        const getArguments = getCustomArgs || (await this.compile(schema_1.JsonEntityStore.fromMethod(token, propertyKey)));
+        if (!provider || !provider.scope || provider.scope === di_1.ProviderScope.SINGLETON) {
+            const instance = await this.injector.invoke(token);
+            const handler = instance[propertyKey].bind(instance);
+            return async (scope) => {
+                const args = await getArguments(scope);
+                return handler(...args, scope.$ctx);
+            };
+        }
+        return async (scope) => {
+            const [instance, args] = await Promise.all([this.injector.invoke(token, scope.$ctx.container), getArguments(scope)]);
+            const handler = instance[propertyKey].bind(instance);
+            return handler(...args, scope.$ctx);
+        };
+    }
+};
+(0, tslib_1.__decorate)([
+    (0, di_1.Inject)(),
+    (0, tslib_1.__metadata)("design:type", di_1.InjectorService)
+], PlatformParams.prototype, "injector", void 0);
+PlatformParams = (0, tslib_1.__decorate)([
+    (0, di_1.Injectable)({
+        scope: di_1.ProviderScope.SINGLETON,
+        imports: []
+    })
+], PlatformParams);
+exports.PlatformParams = PlatformParams;
+//# sourceMappingURL=PlatformParams.js.map

package/lib/cjs/builder/PlatformParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformParams.js","sourceRoot":"","sources":["../../../src/builder/PlatformParams.ts"],"names":[],"mappings":";;;;AAAA,iCAAsG;AACtG,yCAAiE;AAEjE,yEAAoE;AACpE,sEAAiE;AAWjE;;;GAGG;AAKH,IAAa,cAAc,GAA3B,MAAa,cAAc;IAIzB,KAAK,CAAC,QAAQ,CAAC,KAAoB;QACjC,MAAM,GAAG,GAAG,CAAC,IAAmB,EAAE,EAAE;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAE,CAAC,QAAQ,IAAI,CAAC,CAAC;QACxD,CAAC,CAAC;QAEF,MAAM,IAAI,GAAG,CAAC,EAAiB,EAAE,EAAiB,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5G,MAAM,GAAG,GAAG,CAAC,KAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAc,KAAK,CAAE,CAAC;QAChF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,yCAAmB,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAE9F,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,OAAO,CAAwC,MAAuB;QAC1E,MAAM,MAAM,GAAG,2BAAkB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAE/E,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAoB,EAAE,EAAE;YACxC,OAAO;gBACL,KAAK;gBACL,KAAK,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;aAClC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,CAAC,KAAwB,EAAE,EAAE;YAClC,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,EAAC,EAAE,EAAE;gBAChD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAe,EAAE,KAAoB,EAAE,KAAoB;QACtE,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACxC,KAAK,GAAG,MAAM,KAAK,CAAC;YAEpB,IAAI;gBACF,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;aAC3C;YAAC,OAAO,EAAE,EAAE;gBACX,MAAM,2CAAoB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;aAC5C;QACH,CAAC,EAAE,KAAY,CAAC,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,QAAwC;QAExC,MAAM,EAAC,KAAK,EAAE,WAAW,EAAE,aAAa,EAAC,GAAG,QAAQ,CAAC;QAErD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,aAAa,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAU,wBAAe,CAAC,UAAU,CAAC,KAAK,EAAE,WAAY,CAAC,CAAC,CAAC,CAAC;QAErH,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,KAAK,kBAAa,CAAC,SAAS,EAAE;YAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAM,KAAK,CAAC,CAAC;YACxD,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEtD,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE;gBACrB,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;gBAEvC,OAAO,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC,CAAC;SACH;QAED,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAM,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE1H,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEtD,OAAO,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC;IACJ,CAAC;CACF,CAAA;AA1EC;IADC,IAAA,WAAM,GAAE;2CACW,oBAAe;gDAAC;AAFzB,cAAc;IAJ1B,IAAA,eAAU,EAAC;QACV,KAAK,EAAE,kBAAa,CAAC,SAAS;QAC9B,OAAO,EAAE,EAAE;KACZ,CAAC;GACW,cAAc,CA4E1B;AA5EY,wCAAc","sourcesContent":["import {DIContext, Inject, Injectable, InjectorService, ProviderScope, TokenProvider} from \"@tsed/di\";\nimport {JsonEntityStore, JsonParameterStore} from \"@tsed/schema\";\nimport {ParamMetadata, PipeMethods} from \"../domain/ParamMetadata\";\nimport {ParamValidationError} from \"../errors/ParamValidationError\";\nimport {ParseExpressionPipe} from \"../pipes/ParseExpressionPipe\";\n\nexport type ArgScope<Context extends DIContext = DIContext> = {$ctx: Context} & Record<string, any>;\nexport type HandlerWithScope<Context extends DIContext = DIContext> = (scope: ArgScope<Context>) => any;\n\nexport interface CompileHandlerOptions<Context extends DIContext = DIContext> extends Record<any, unknown> {\n  token: TokenProvider;\n  propertyKey: string | symbol;\n  getCustomArgs?: (scope: ArgScope<Context>) => Promise<any[]>;\n}\n\n/**\n * Platform Params abstraction layer.\n * @platform\n */\n@Injectable({\n  scope: ProviderScope.SINGLETON,\n  imports: []\n})\nexport class PlatformParams {\n  @Inject()\n  protected injector: InjectorService;\n\n  async getPipes(param: ParamMetadata) {\n    const get = (pipe: TokenProvider) => {\n      return this.injector.getProvider(pipe)!.priority || 0;\n    };\n\n    const sort = (p1: TokenProvider, p2: TokenProvider) => (get(p1) < get(p2) ? -1 : get(p1) > get(p2) ? 1 : 0);\n    const map = (token: TokenProvider) => this.injector.invoke<PipeMethods>(token)!;\n    const promises = await Promise.all([ParseExpressionPipe, ...param.pipes.sort(sort)].map(map));\n\n    return promises.filter(Boolean);\n  }\n\n  async compile<Context extends DIContext = DIContext>(entity: JsonEntityStore) {\n    const params = JsonParameterStore.getParams(entity.target, entity.propertyKey);\n\n    const argsPipes = await Promise.all(\n      params.map(async (param: ParamMetadata) => {\n        return {\n          param,\n          pipes: await this.getPipes(param)\n        };\n      })\n    );\n\n    return (scope: ArgScope<Context>) => {\n      const promises = argsPipes.map(({param, pipes}) => {\n        return this.getArg(scope, pipes, param);\n      });\n\n      return Promise.all(promises);\n    };\n  }\n\n  async getArg(scope: ArgScope, pipes: PipeMethods[], param: ParamMetadata) {\n    return pipes.reduce(async (value, pipe) => {\n      value = await value;\n\n      try {\n        return await pipe.transform(value, param);\n      } catch (er) {\n        throw ParamValidationError.from(param, er);\n      }\n    }, scope as any);\n  }\n\n  async compileHandler<Context extends DIContext = DIContext>(\n    metadata: CompileHandlerOptions<Context>\n  ): Promise<HandlerWithScope<Context>> {\n    const {token, propertyKey, getCustomArgs} = metadata;\n\n    const provider = this.injector.getProvider(token);\n    const getArguments = getCustomArgs || (await this.compile<Context>(JsonEntityStore.fromMethod(token, propertyKey!)));\n\n    if (!provider || !provider.scope || provider.scope === ProviderScope.SINGLETON) {\n      const instance = await this.injector.invoke<any>(token);\n      const handler = instance[propertyKey!].bind(instance);\n\n      return async (scope) => {\n        const args = await getArguments(scope);\n\n        return handler(...args, scope.$ctx);\n      };\n    }\n\n    return async (scope) => {\n      const [instance, args] = await Promise.all([this.injector.invoke<any>(token, scope.$ctx.container), getArguments(scope)]);\n\n      const handler = instance[propertyKey!].bind(instance);\n\n      return handler(...args, scope.$ctx);\n    };\n  }\n}\n"]}

package/lib/cjs/decorators/bodyParams.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawBodyParams = exports.BodyParams = void 0;
+const core_1 = require("@tsed/core");
+const ParamTypes_1 = require("../domain/ParamTypes");
+const useParam_1 = require("./useParam");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+const schema_1 = require("@tsed/schema");
+function BodyParams(...args) {
+    const { expression, useType, useConverter = true, useValidation = true } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.BODY,
+        dataPath: "$ctx.request.body",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.BodyParams = BodyParams;
+/**
+ * RawBodyParams return the value from [request.body](http://expressjs.com/en/4x/api.html#req.body) as a Buffer.
+ *
+ * #### Example
+ *
+ * ```typescript
+ * @Controller('/')
+ * class MyCtrl {
+ *    @Post('/')
+ *    create(@RawBodyParams() body: Buffer) {
+ *       console.log('Entire body', body.toString("utf8"));
+ *    }
+ * }
+ * ```
+ *
+ * @decorator
+ * @operation
+ * @input
+ */
+function RawBodyParams() {
+    return (0, core_1.useDecorators)((0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.RAW_BODY,
+        dataPath: "$ctx.request.rawBody",
+        useType: String,
+        useConverter: false,
+        useValidation: false
+    }), (0, schema_1.JsonEntityFn)((entity) => {
+        var _a;
+        (_a = entity.parent.operation) === null || _a === void 0 ? void 0 : _a.consumes(["*/*"]);
+    }));
+}
+exports.RawBodyParams = RawBodyParams;
+//# sourceMappingURL=bodyParams.js.map

package/lib/cjs/decorators/bodyParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bodyParams.js","sourceRoot":"","sources":["../../../src/decorators/bodyParams.ts"],"names":[],"mappings":";;;AAAA,qCAA+C;AAE/C,qDAAgD;AAChD,yCAAoC;AACpC,gEAA2D;AAC3D,yCAA0C;AA4C1C,SAAgB,UAAU,CAAC,GAAG,IAAW;IACvC,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI,EAAE,aAAa,GAAG,IAAI,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAEhG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,IAAI;QAC1B,QAAQ,EAAE,mBAAmB;QAC7B,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,gCAWC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,aAAa;IAC3B,OAAO,IAAA,oBAAa,EAClB,IAAA,mBAAQ,EAAC;QACP,SAAS,EAAE,uBAAU,CAAC,QAAQ;QAC9B,QAAQ,EAAE,sBAAsB;QAChC,OAAO,EAAE,MAAM;QACf,YAAY,EAAE,KAAK;QACnB,aAAa,EAAE,KAAK;KACrB,CAAC,EACF,IAAA,qBAAY,EAAC,CAAC,MAAM,EAAE,EAAE;;QACtB,MAAA,MAAM,CAAC,MAAM,CAAC,SAAS,0CAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAbD,sCAaC","sourcesContent":["import {Type, useDecorators} from \"@tsed/core\";\nimport {ParamOptions} from \"../domain/ParamOptions\";\nimport {ParamTypes} from \"../domain/ParamTypes\";\nimport {UseParam} from \"./useParam\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {JsonEntityFn} from \"@tsed/schema\";\n\n/**\n * BodyParams return the value from [request.body](http://expressjs.com/en/4x/api.html#req.body) object.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Post('/')\n *    create(@BodyParams() body: any) {\n *       console.log('Entire body', body);\n *    }\n *\n *    @Post('/')\n *    create(@BodyParams('id') id: string) {\n *       console.log('ID', id);\n *    }\n *\n *    @Post('/')\n *    create(@BodyParams('user') user: User) { // with deserialization\n *       console.log('user', user);\n *    }\n *\n *    @Post('/')\n *    create(@BodyParams('users', User) users: User[]) { // with deserialization\n *       console.log('users', users);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @param useType The type of the class that to be used to deserialize the data.\n * @decorator\n * @operation\n * @input\n */\nexport function BodyParams(expression: string, useType: Type<any>): ParameterDecorator;\nexport function BodyParams(expression: string): ParameterDecorator;\nexport function BodyParams(useType: Type<any>): ParameterDecorator;\nexport function BodyParams(options: Partial<ParamOptions>): ParameterDecorator;\nexport function BodyParams(): ParameterDecorator;\nexport function BodyParams(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = true, useValidation = true} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.BODY,\n    dataPath: \"$ctx.request.body\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n\n/**\n * RawBodyParams return the value from [request.body](http://expressjs.com/en/4x/api.html#req.body) as a Buffer.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Post('/')\n *    create(@RawBodyParams() body: Buffer) {\n *       console.log('Entire body', body.toString(\"utf8\"));\n *    }\n * }\n * ```\n *\n * @decorator\n * @operation\n * @input\n */\nexport function RawBodyParams(): ParameterDecorator {\n  return useDecorators(\n    UseParam({\n      paramType: ParamTypes.RAW_BODY,\n      dataPath: \"$ctx.request.rawBody\",\n      useType: String,\n      useConverter: false,\n      useValidation: false\n    }),\n    JsonEntityFn((entity) => {\n      entity.parent.operation?.consumes([\"*/*\"]);\n    })\n  );\n}\n"]}

package/lib/cjs/decorators/context.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+const ParamTypes_1 = require("../domain/ParamTypes");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+const useParam_1 = require("./useParam");
+function Context(...args) {
+    const { expression, useType, useConverter = false, useValidation = false } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.$CTX,
+        dataPath: "$ctx",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.Context = Context;
+//# sourceMappingURL=context.js.map

package/lib/cjs/decorators/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../src/decorators/context.ts"],"names":[],"mappings":";;;AACA,qDAAgD;AAChD,gEAA2D;AAC3D,yCAAoC;AA2DpC,SAAgB,OAAO,CAAC,GAAG,IAAW;IACpC,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,KAAK,EAAE,aAAa,GAAG,KAAK,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAElG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,IAAI;QAC1B,QAAQ,EAAE,MAAM;QAChB,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,0BAWC","sourcesContent":["import {BaseContext} from \"@tsed/di\";\nimport {ParamTypes} from \"../domain/ParamTypes\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {UseParam} from \"./useParam\";\n\ndeclare global {\n  namespace TsED {\n    export interface Context {}\n  }\n}\n\n/**\n * Context decorator return the @@PlatformContext@@ created by Ts.ED when request is handled by the server.\n *\n * It contains some information as following:\n *\n * - The request id,\n * - The request container used by the Ts.ED DI. It contain all services annotated with `@Scope(ProviderScope.REQUEST)`,\n * - The current @@EndpointMetadata@@ resolved by Ts.ED during the request,\n * - The data return by the previous endpoint if you use multiple handler on the same route. By default data is empty.\n *\n * ::: tip\n * The @@PlatformContext@@ inherit from Map class. So you can store any information with.\n * :::\n *\n * #### Example\n *\n * ```typescript\n * @Middleware()\n * class AuthTokenMiddleware {\n *   use(@Req() request: Req, @Context() context: PlatformContext) {\n *      if (!context.has(\"auth\")){\n *        context.set('auth', new AuthToken(request))\n *      }\n *\n *      try {\n *        context.get(\"auth\").claims() // check token\n *      } catch(er){\n *        throw new Forbidden(\"Access forbidden - Bad token\")\n *      }\n *   }\n * }\n *\n * @Controller('/')\n * @UseBefore(AuthTokenMiddleware) // protect all routes for this controller\n * class MyCtrl {\n *    @Get('/')\n *    get(@Context('auth') auth: AuthToken) {\n *       console.log('auth', auth);\n *       console.log('auth.accessToken', auth.accessToken);\n *       console.log('auth.idToken', auth.idToken);\n *    }\n * }\n * ```\n *\n * @param expression The path of the property to get.\n * @decorator\n * @operation\n * @input\n */\nexport function Context(expression: string): ParameterDecorator;\nexport function Context(): ParameterDecorator;\nexport function Context(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = false, useValidation = false} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.$CTX,\n    dataPath: \"$ctx\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n\nexport type Context = BaseContext;\n"]}

package/lib/cjs/decorators/cookies.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cookies = exports.CookiesParams = void 0;
+const ParamTypes_1 = require("../domain/ParamTypes");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+const useParam_1 = require("./useParam");
+function CookiesParams(...args) {
+    const { expression, useType, useConverter = false, useValidation = false } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.COOKIES,
+        dataPath: "$ctx.request.cookies",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.CookiesParams = CookiesParams;
+function Cookies(...args) {
+    // @ts-ignore
+    return CookiesParams(...args);
+}
+exports.Cookies = Cookies;
+//# sourceMappingURL=cookies.js.map

package/lib/cjs/decorators/cookies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cookies.js","sourceRoot":"","sources":["../../../src/decorators/cookies.ts"],"names":[],"mappings":";;;AAEA,qDAAgD;AAChD,gEAA2D;AAC3D,yCAAoC;AAsCpC,SAAgB,aAAa,CAAC,GAAG,IAAW;IAC1C,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,KAAK,EAAE,aAAa,GAAG,KAAK,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAElG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,OAAO;QAC7B,QAAQ,EAAE,sBAAsB;QAChC,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,sCAWC;AA6CD,SAAgB,OAAO,CAAC,GAAG,IAAW;IACpC,aAAa;IACb,OAAO,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;AAChC,CAAC;AAHD,0BAGC","sourcesContent":["import {Type} from \"@tsed/core\";\nimport {ParamOptions} from \"../domain/ParamOptions\";\nimport {ParamTypes} from \"../domain/ParamTypes\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {UseParam} from \"./useParam\";\n\n/**\n * Cookies or CookiesParams return the value from [request.cookies](http://expressjs.com/en/4x/api.html#req.cookies) object.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Post('/')\n *    create(@Cookies() cookies: any) {\n *       console.log('Entire cookies', cookies);\n *    }\n *\n *    @Post('/')\n *    create(@Cookies('id') id: string) {\n *       console.log('ID', id);\n *    }\n *\n *    @Post('/')\n *    create(@Cookies('user') user: IUser) {\n *       console.log('user', user);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @param useType The type of the class that to be used to deserialize the data.\n * @decorator\n * @operation\n * @input\n */\nexport function CookiesParams(expression: string | any, useType: any): ParameterDecorator;\nexport function CookiesParams(): ParameterDecorator;\nexport function CookiesParams(expression: string | any): ParameterDecorator;\nexport function CookiesParams(options: ParamOptions<any>): ParameterDecorator;\nexport function CookiesParams(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = false, useValidation = false} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.COOKIES,\n    dataPath: \"$ctx.request.cookies\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n\n/**\n * Cookies or CookiesParams return the value from [request.cookies](http://expressjs.com/en/4x/api.html#req.cookies) object.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Post('/')\n *    create(@Cookies() body: any) {\n *       console.log('Entire body', body);\n *    }\n *\n *    @Post('/')\n *    create(@Cookies('id') id: string) {\n *       console.log('ID', id);\n *    }\n *\n *    @Post('/')\n *    create(@Cookies('user') user: User) { // with deserialization\n *       console.log('user', user);\n *    }\n *\n *    @Post('/')\n *    create(@Cookies('users', User) users: User[]) { // with deserialization\n *       console.log('users', users);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @param useType The type of the class that to be used to deserialize the data.\n * @decorator\n * @aliasof CookiesParams\n * @operation\n * @input\n */\nexport function Cookies(expression: string, useType: Type<any>): ParameterDecorator;\nexport function Cookies(expression: string): ParameterDecorator;\nexport function Cookies(useType: Type<any>): ParameterDecorator;\nexport function Cookies(options: Partial<ParamOptions>): ParameterDecorator;\nexport function Cookies(): ParameterDecorator;\nexport function Cookies(...args: any[]): ParameterDecorator {\n  // @ts-ignore\n  return CookiesParams(...args);\n}\n"]}

package/lib/cjs/decorators/headerParams.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeaderParams = void 0;
+const ParamTypes_1 = require("../domain/ParamTypes");
+const useParam_1 = require("./useParam");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+function HeaderParams(...args) {
+    const { expression, useType, useConverter = false, useValidation = false } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.HEADER,
+        dataPath: "$ctx.request.headers",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.HeaderParams = HeaderParams;
+//# sourceMappingURL=headerParams.js.map

package/lib/cjs/decorators/headerParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headerParams.js","sourceRoot":"","sources":["../../../src/decorators/headerParams.ts"],"names":[],"mappings":";;;AACA,qDAAgD;AAChD,yCAAoC;AACpC,gEAA2D;AAkC3D,SAAgB,YAAY,CAAC,GAAG,IAAW;IACzC,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,KAAK,EAAE,aAAa,GAAG,KAAK,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAElG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,MAAM;QAC5B,QAAQ,EAAE,sBAAsB;QAChC,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,oCAWC","sourcesContent":["import {Type} from \"@tsed/core\";\nimport {ParamTypes} from \"../domain/ParamTypes\";\nimport {UseParam} from \"./useParam\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {ParamOptions} from \"../domain/ParamOptions\";\n\n/**\n * HeaderParams return the value from [`request.get()`](http://expressjs.com/en/4x/api.html#req.get) method.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Get('/')\n *    get(@HeaderParams() body: any) {\n *       console.log('Entire body', body);\n *    }\n *\n *    @Get('/')\n *    get(@HeaderParams('x-token') token: string) {\n *       console.log('token', id);\n *    }\n * }\n * ```\n *\n * @param expression The path of the property to get.\n * @param useType\n * @decorator\n * @operation\n * @input\n */\nexport function HeaderParams(expression: string, useType: Type<any>): ParameterDecorator;\nexport function HeaderParams(expression: string): ParameterDecorator;\nexport function HeaderParams(useType: Type<any>): ParameterDecorator;\nexport function HeaderParams(options: Partial<ParamOptions>): ParameterDecorator;\nexport function HeaderParams(): ParameterDecorator;\nexport function HeaderParams(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = false, useValidation = false} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.HEADER,\n    dataPath: \"$ctx.request.headers\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n"]}

package/lib/cjs/decorators/locals.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Locals = void 0;
+const ParamTypes_1 = require("../domain/ParamTypes");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+const useParam_1 = require("./useParam");
+function Locals(...args) {
+    const { expression, useType, useConverter = false, useValidation = false } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.LOCALS,
+        dataPath: "$ctx.response.locals",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.Locals = Locals;
+//# sourceMappingURL=locals.js.map

package/lib/cjs/decorators/locals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locals.js","sourceRoot":"","sources":["../../../src/decorators/locals.ts"],"names":[],"mappings":";;;AAAA,qDAAgD;AAChD,gEAA2D;AAC3D,yCAAoC;AA4CpC,SAAgB,MAAM,CAAC,GAAG,IAAW;IACnC,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,KAAK,EAAE,aAAa,GAAG,KAAK,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAElG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,MAAM;QAC5B,QAAQ,EAAE,sBAAsB;QAChC,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,wBAWC","sourcesContent":["import {ParamTypes} from \"../domain/ParamTypes\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {UseParam} from \"./useParam\";\n\n/**\n * Locals return the value from [response.locals](http://expressjs.com/en/4x/api.html#res.locals) object.\n *\n * ::: tip\n * Locals are generally used by express and third-party like templating engine to render a page/template.\n * See [Templating](http://tsed.io/tutorials/templating.html) section for more details.\n * :::\n *\n * #### Example\n *\n * ```typescript\n *  * @Middleware()\n * class LocalsMiddleware {\n *   use(@Locals() locals: any) {\n *      // set some on locals\n *      locals.user = \"user\"\n *   }\n * }\n *\n * @Controller('/')\n * @UseBefore(LocalsMiddleware)\n * class MyCtrl {\n *    @Get('/')\n *    @View('home.ejs') // will use locals and returned data to render the page\n *    get(@Locals('user') user: any) {\n *       console.log('user', user);\n *\n *       return {\n *         description: 'Hello world'\n *       }\n *    }\n * }\n * ```\n *\n * @param expression The path of the property to get.\n * @decorator\n * @operation\n * @input\n * @response\n */\nexport function Locals(expression: string): ParameterDecorator;\nexport function Locals(): ParameterDecorator;\nexport function Locals(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = false, useValidation = false} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.LOCALS,\n    dataPath: \"$ctx.response.locals\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n"]}

package/lib/cjs/decorators/paramFn.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParamFn = void 0;
+const core_1 = require("@tsed/core");
+const ParamMetadata_1 = require("../domain/ParamMetadata");
+/**
+ * Get the Param metadata. Use this decorator to compose your own decorator.
+ *
+ * @param fn
+ * @decorator
+ * @operation
+ * @input
+ */
+function ParamFn(fn) {
+    return (target, propertyKey, index) => {
+        if ((0, core_1.decoratorTypeOf)([target, propertyKey, index]) === core_1.DecoratorTypes.PARAM) {
+            fn(ParamMetadata_1.ParamMetadata.get(target, propertyKey, index), [target, propertyKey, index]);
+        }
+    };
+}
+exports.ParamFn = ParamFn;
+//# sourceMappingURL=paramFn.js.map

package/lib/cjs/decorators/paramFn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paramFn.js","sourceRoot":"","sources":["../../../src/decorators/paramFn.ts"],"names":[],"mappings":";;;AAAA,qCAAsF;AACtF,2DAAsD;AAEtD;;;;;;;GAOG;AACH,SAAgB,OAAO,CAAC,EAAmE;IACzF,OAAO,CAAI,MAAiB,EAAE,WAAmB,EAAE,KAAa,EAAQ,EAAE;QACxE,IAAI,IAAA,sBAAe,EAAC,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,KAAK,qBAAc,CAAC,KAAK,EAAE;YAC1E,EAAE,CAAC,6BAAa,CAAC,GAAG,CAAC,MAAO,EAAE,WAAY,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;SACnF;IACH,CAAC,CAAC;AACJ,CAAC;AAND,0BAMC","sourcesContent":["import {DecoratorParameters, decoratorTypeOf, DecoratorTypes, Type} from \"@tsed/core\";\nimport {ParamMetadata} from \"../domain/ParamMetadata\";\n\n/**\n * Get the Param metadata. Use this decorator to compose your own decorator.\n *\n * @param fn\n * @decorator\n * @operation\n * @input\n */\nexport function ParamFn(fn: (param: ParamMetadata, parameters: DecoratorParameters) => void): ParameterDecorator {\n  return <T>(target: Type<any>, propertyKey: string, index: number): void => {\n    if (decoratorTypeOf([target, propertyKey, index]) === DecoratorTypes.PARAM) {\n      fn(ParamMetadata.get(target!, propertyKey!, index), [target, propertyKey, index]);\n    }\n  };\n}\n"]}

package/lib/cjs/decorators/pathParams.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawPathParams = exports.PathParams = void 0;
+const ParamTypes_1 = require("../domain/ParamTypes");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+const useParam_1 = require("./useParam");
+function PathParams(...args) {
+    const { expression, useType, useConverter = true, useValidation = true } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.PATH,
+        dataPath: "$ctx.request.params",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.PathParams = PathParams;
+/**
+ * RawPathParams return the raw value from [request.params](http://expressjs.com/en/4x/api.html#req.params) object.
+ *
+ * Any validation and transformation are performed on the value. Use [pipes](/docs/pipes.html) to validate and/or transform the value.
+ *
+ * #### Example
+ *
+ * ```typescript
+ * @Controller('/')
+ * class MyCtrl {
+ *    @Get('/')
+ *    get(@RawPathParams() params: string) {
+ *       console.log('Entire params', params);
+ *    }
+ *
+ *    @Get('/')
+ *    get(@RawPathParams('id') id: string) {
+ *       console.log('ID', id);
+ *    }
+ * }
+ * ```
+ * > For more information on deserialization see [converters](/docs/converters.md) page.
+ *
+ * @param expression The path of the property to get.
+ * @decorator
+ * @operation
+ * @input
+ */
+function RawPathParams(expression) {
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.PATH,
+        dataPath: "$ctx.request.params",
+        expression
+    });
+}
+exports.RawPathParams = RawPathParams;
+//# sourceMappingURL=pathParams.js.map

package/lib/cjs/decorators/pathParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pathParams.js","sourceRoot":"","sources":["../../../src/decorators/pathParams.ts"],"names":[],"mappings":";;;AAEA,qDAAgD;AAChD,gEAA2D;AAC3D,yCAAoC;AAuCpC,SAAgB,UAAU,CAAC,GAAG,IAAW;IACvC,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI,EAAE,aAAa,GAAG,IAAI,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAEhG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,IAAI;QAC1B,QAAQ,EAAE,qBAAqB;QAC/B,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,gCAWC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,aAAa,CAAC,UAAkB;IAC9C,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,IAAI;QAC1B,QAAQ,EAAE,qBAAqB;QAC/B,UAAU;KACX,CAAC,CAAC;AACL,CAAC;AAND,sCAMC","sourcesContent":["import {Type} from \"@tsed/core\";\nimport {ParamOptions} from \"../domain/ParamOptions\";\nimport {ParamTypes} from \"../domain/ParamTypes\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {UseParam} from \"./useParam\";\n\n/**\n * PathParams return the value from [request.params](http://expressjs.com/en/4x/api.html#req.params) object.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Get('/')\n *    get(@PathParams() params: any) {\n *       console.log('Entire params', params);\n *    }\n *\n *    @Get('/')\n *    get(@PathParams('id') id: string) {\n *       console.log('ID', id);\n *    }\n *\n *    @Get('/')\n *    get(@PathParams({expression: 'id', useType: () => new MyCustomModel() }) id: string) {\n *       console.log('ID', id);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @param useType The type of the class that to be used to deserialize the data.\n * @decorator\n * @operation\n * @input\n */\nexport function PathParams(expression: string, useType: Type<any>): ParameterDecorator;\nexport function PathParams(expression: string): ParameterDecorator;\nexport function PathParams(useType: Type<any>): ParameterDecorator;\nexport function PathParams(options: Partial<ParamOptions>): ParameterDecorator;\nexport function PathParams(): ParameterDecorator;\nexport function PathParams(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = true, useValidation = true} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.PATH,\n    dataPath: \"$ctx.request.params\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n\n/**\n * RawPathParams return the raw value from [request.params](http://expressjs.com/en/4x/api.html#req.params) object.\n *\n * Any validation and transformation are performed on the value. Use [pipes](/docs/pipes.html) to validate and/or transform the value.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Get('/')\n *    get(@RawPathParams() params: string) {\n *       console.log('Entire params', params);\n *    }\n *\n *    @Get('/')\n *    get(@RawPathParams('id') id: string) {\n *       console.log('ID', id);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @decorator\n * @operation\n * @input\n */\nexport function RawPathParams(expression: string) {\n  return UseParam({\n    paramType: ParamTypes.PATH,\n    dataPath: \"$ctx.request.params\",\n    expression\n  });\n}\n"]}

package/lib/cjs/decorators/queryParams.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawQueryParams = exports.QueryParams = void 0;
+const ParamTypes_1 = require("../domain/ParamTypes");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+const useParam_1 = require("./useParam");
+function QueryParams(...args) {
+    const { expression, useType, useConverter = true, useValidation = true } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.QUERY,
+        dataPath: "$ctx.request.query",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.QueryParams = QueryParams;
+/**
+ * RawQueryParams return the value from [request.query](http://expressjs.com/en/4x/api.html#req.query) object.
+ *
+ * Any validation and transformation are performed on the value. Use [pipes](/docs/pipes.html) to validate and/or transform the value.
+ *
+ * #### Example
+ *
+ * ```typescript
+ * @Controller('/')
+ * class MyCtrl {
+ *    @Get('/')
+ *    get(@RawPathParams() params: any) {
+ *       console.log('Entire params', params);
+ *    }
+ *
+ *    @Get('/')
+ *    get(@RawPathParams('id') id: string) {
+ *       console.log('ID', id);
+ *    }
+ * }
+ * ```
+ * > For more information on deserialization see [converters](/docs/converters.md) page.
+ *
+ * @param expression The path of the property to get.
+ * @decorator
+ * @operation
+ * @input
+ */
+function RawQueryParams(expression) {
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.QUERY,
+        dataPath: "$ctx.request.query",
+        expression
+    });
+}
+exports.RawQueryParams = RawQueryParams;
+//# sourceMappingURL=queryParams.js.map

package/lib/cjs/decorators/queryParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryParams.js","sourceRoot":"","sources":["../../../src/decorators/queryParams.ts"],"names":[],"mappings":";;;AAEA,qDAAgD;AAChD,gEAA2D;AAC3D,yCAAoC;AA4CpC,SAAgB,WAAW,CAAC,GAAG,IAAW;IACxC,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI,EAAE,aAAa,GAAG,IAAI,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAEhG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,KAAK;QAC3B,QAAQ,EAAE,oBAAoB;QAC9B,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,kCAWC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,cAAc,CAAC,UAAkB;IAC/C,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,KAAK;QAC3B,QAAQ,EAAE,oBAAoB;QAC9B,UAAU;KACX,CAAC,CAAC;AACL,CAAC;AAND,wCAMC","sourcesContent":["import {Type} from \"@tsed/core\";\nimport {ParamOptions} from \"../domain/ParamOptions\";\nimport {ParamTypes} from \"../domain/ParamTypes\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {UseParam} from \"./useParam\";\n\n/**\n * QueryParams return the value from [request.query](http://expressjs.com/en/4x/api.html#req.query) object.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Get('/')\n *    get(@QueryParams() query: any) {\n *       console.log('Entire query', query);\n *    }\n *\n *    @Get('/')\n *    get(@QueryParams('id') id: string) {\n *       console.log('ID', id);\n *    }\n *\n *    @Get('/')\n *    get(@QueryParams('user') user: User) { // with deserialization\n *       console.log('user', user);\n *    }\n *\n *    @Get('/')\n *    get(@QueryParams('users', User) users: User[]) { // with deserialization\n *       console.log('users', users);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @param useType The type of the class that to be used to deserialize the data.\n * @decorator\n * @operation\n * @input\n */\nexport function QueryParams(expression: string, useType: Type<any>): ParameterDecorator;\nexport function QueryParams(expression: string): ParameterDecorator;\nexport function QueryParams(useType: Type<any>): ParameterDecorator;\nexport function QueryParams(options: Partial<ParamOptions>): ParameterDecorator;\nexport function QueryParams(): ParameterDecorator;\nexport function QueryParams(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = true, useValidation = true} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.QUERY,\n    dataPath: \"$ctx.request.query\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n\n/**\n * RawQueryParams return the value from [request.query](http://expressjs.com/en/4x/api.html#req.query) object.\n *\n * Any validation and transformation are performed on the value. Use [pipes](/docs/pipes.html) to validate and/or transform the value.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Get('/')\n *    get(@RawPathParams() params: any) {\n *       console.log('Entire params', params);\n *    }\n *\n *    @Get('/')\n *    get(@RawPathParams('id') id: string) {\n *       console.log('ID', id);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @decorator\n * @operation\n * @input\n */\nexport function RawQueryParams(expression: string) {\n  return UseParam({\n    paramType: ParamTypes.QUERY,\n    dataPath: \"$ctx.request.query\",\n    expression\n  });\n}\n"]}

package/lib/cjs/decorators/session.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Session = void 0;
+const ParamTypes_1 = require("../domain/ParamTypes");
+const mapParamsOptions_1 = require("../utils/mapParamsOptions");
+const useParam_1 = require("./useParam");
+function Session(...args) {
+    const { expression, useType, useConverter = false, useValidation = false } = (0, mapParamsOptions_1.mapParamsOptions)(args);
+    return (0, useParam_1.UseParam)({
+        paramType: ParamTypes_1.ParamTypes.SESSION,
+        dataPath: "$ctx.request.session",
+        expression,
+        useType,
+        useConverter,
+        useValidation
+    });
+}
+exports.Session = Session;
+//# sourceMappingURL=session.js.map

package/lib/cjs/decorators/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../../../src/decorators/session.ts"],"names":[],"mappings":";;;AACA,qDAAgD;AAChD,gEAA2D;AAC3D,yCAAoC;AAqCpC,SAAgB,OAAO,CAAC,GAAG,IAAW;IACpC,MAAM,EAAC,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,KAAK,EAAE,aAAa,GAAG,KAAK,EAAC,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;IAElG,OAAO,IAAA,mBAAQ,EAAC;QACd,SAAS,EAAE,uBAAU,CAAC,OAAO;QAC7B,QAAQ,EAAE,sBAAsB;QAChC,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAXD,0BAWC","sourcesContent":["import {ParamOptions} from \"../domain/ParamOptions\";\nimport {ParamTypes} from \"../domain/ParamTypes\";\nimport {mapParamsOptions} from \"../utils/mapParamsOptions\";\nimport {UseParam} from \"./useParam\";\n\n/**\n * Session return the value from [request.session](http://expressjs.com/en/4x/api.html#req.session) object.\n *\n * #### Example\n *\n * ```typescript\n * @Controller('/')\n * class MyCtrl {\n *    @Post('/')\n *    create(@Session() session: Express.Session) {\n *       console.log('Entire session', session);\n *    }\n *\n *    @Post('/')\n *    create(@Session('id') id: string) {\n *       console.log('ID', id);\n *    }\n *\n *    @Post('/') // Example to deserialize use from session\n *    create(@Session({expression: 'user', useConverter: true}) user: User) {\n *       console.log('user', user);\n *       console.log('instanceOf user', user instanceof User);\n *    }\n * }\n * ```\n * > For more information on deserialization see [converters](/docs/converters.md) page.\n *\n * @param expression The path of the property to get.\n * @decorator\n * @operation\n * @input\n */\nexport function Session(expression: string): ParameterDecorator;\nexport function Session(options: Partial<ParamOptions>): ParameterDecorator;\nexport function Session(): ParameterDecorator;\nexport function Session(...args: any[]): ParameterDecorator {\n  const {expression, useType, useConverter = false, useValidation = false} = mapParamsOptions(args);\n\n  return UseParam({\n    paramType: ParamTypes.SESSION,\n    dataPath: \"$ctx.request.session\",\n    expression,\n    useType,\n    useConverter,\n    useValidation\n  });\n}\n"]}

package/lib/cjs/decorators/useDeserialization.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseDeserialization = void 0;
+const DeserializerPipe_1 = require("../pipes/DeserializerPipe");
+const usePipe_1 = require("./usePipe");
+/**
+ * Use JsonMapper to deserialize the data.
+ *
+ * @decorator
+ * @operation
+ * @input
+ * @pipe
+ */
+function UseDeserialization(options = {}) {
+    return (0, usePipe_1.UsePipe)(DeserializerPipe_1.DeserializerPipe, options);
+}
+exports.UseDeserialization = UseDeserialization;
+//# sourceMappingURL=useDeserialization.js.map

package/lib/cjs/decorators/useDeserialization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDeserialization.js","sourceRoot":"","sources":["../../../src/decorators/useDeserialization.ts"],"names":[],"mappings":";;;AAAA,gEAA2D;AAC3D,uCAAkC;AAElC;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,UAAe,EAAE;IAClD,OAAO,IAAA,iBAAO,EAAC,mCAAgB,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAFD,gDAEC","sourcesContent":["import {DeserializerPipe} from \"../pipes/DeserializerPipe\";\nimport {UsePipe} from \"./usePipe\";\n\n/**\n * Use JsonMapper to deserialize the data.\n *\n * @decorator\n * @operation\n * @input\n * @pipe\n */\nexport function UseDeserialization(options: any = {}) {\n  return UsePipe(DeserializerPipe, options);\n}\n"]}

package/lib/cjs/decorators/useParam.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseParam = void 0;
+const core_1 = require("@tsed/core");
+const schema_1 = require("@tsed/schema");
+const paramFn_1 = require("./paramFn");
+const useDeserialization_1 = require("./useDeserialization");
+const useParamType_1 = require("./useParamType");
+const useType_1 = require("./useType");
+const useValidation_1 = require("./useValidation");
+/**
+ * @ignore
+ * @param options
+ */
+function mapPipes(options) {
+    const { paramType, useType, expression, useValidation, useConverter, ...props } = options;
+    return [
+        useType
+            ? (0, useType_1.UseType)(useType)
+            : (0, paramFn_1.ParamFn)((entity, parameters) => {
+                if (entity.isCollection && entity.type === Object) {
+                    (0, schema_1.Any)()(...parameters);
+                }
+            }),
+        useValidation && (0, useValidation_1.UseValidation)(),
+        useConverter && (0, useDeserialization_1.UseDeserialization)(props)
+    ];
+}
+function UseParam(...args) {
+    const options = {
+        dataPath: "$ctx",
+        ...(((0, core_1.isString)(args[0]) ? args[1] : args[0]) || {}),
+        paramType: (0, core_1.isString)(args[0]) ? args[0] : args[0].paramType
+    };
+    return (0, core_1.useDecorators)((0, useParamType_1.UseParamType)(options), ...mapPipes(options));
+}
+exports.UseParam = UseParam;
+//# sourceMappingURL=useParam.js.map

package/lib/cjs/decorators/useParam.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useParam.js","sourceRoot":"","sources":["../../../src/decorators/useParam.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AACnD,yCAAuC;AAEvC,uCAAkC;AAClC,6DAAwD;AAExD,iDAA4C;AAC5C,uCAAkC;AAClC,mDAA8C;AAE9C;;;GAGG;AACH,SAAS,QAAQ,CAAC,OAA8B;IAC9C,MAAM,EAAC,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,KAAK,EAAC,GAAG,OAAO,CAAC;IAExF,OAAO;QACL,OAAO;YACL,CAAC,CAAC,IAAA,iBAAO,EAAC,OAAO,CAAC;YAClB,CAAC,CAAC,IAAA,iBAAO,EAAC,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE;gBAC7B,IAAI,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE;oBACjD,IAAA,YAAG,GAAE,CAAC,GAAG,UAAU,CAAC,CAAC;iBACtB;YACH,CAAC,CAAC;QACN,aAAa,IAAI,IAAA,6BAAa,GAAE;QAChC,YAAY,IAAI,IAAA,uCAAkB,EAAC,KAAK,CAAC;KAC1C,CAAC;AACJ,CAAC;AAuBD,SAAgB,QAAQ,CAAC,GAAG,IAAW;IACrC,MAAM,OAAO,GAAG;QACd,QAAQ,EAAE,MAAM;QAChB,GAAG,CAAC,CAAC,IAAA,eAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAClD,SAAS,EAAE,IAAA,eAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;KAC3D,CAAC;IAEF,OAAO,IAAA,oBAAa,EAAC,IAAA,2BAAY,EAAC,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAuB,CAAC;AAC1F,CAAC;AARD,4BAQC","sourcesContent":["import {isString, useDecorators} from \"@tsed/core\";\nimport {Any, Name} from \"@tsed/schema\";\nimport {ParamOptions} from \"../domain/ParamOptions\";\nimport {ParamFn} from \"./paramFn\";\nimport {UseDeserialization} from \"./useDeserialization\";\nimport {UseParamExpression} from \"./useParamExpression\";\nimport {UseParamType} from \"./useParamType\";\nimport {UseType} from \"./useType\";\nimport {UseValidation} from \"./useValidation\";\n\n/**\n * @ignore\n * @param options\n */\nfunction mapPipes(options: Partial<ParamOptions>) {\n  const {paramType, useType, expression, useValidation, useConverter, ...props} = options;\n\n  return [\n    useType\n      ? UseType(useType)\n      : ParamFn((entity, parameters) => {\n          if (entity.isCollection && entity.type === Object) {\n            Any()(...parameters);\n          }\n        }),\n    useValidation && UseValidation(),\n    useConverter && UseDeserialization(props)\n  ];\n}\n\n/**\n * Register a new param. It use the paramType to extract value and give it to the next pipe.\n *\n * Given options allow to enable or disable following pipes:\n *\n * - useType: Add extra type for the json mapper,\n * - expression: Get property from the returned value by the previous pipe.\n * - useValidation: Apply validation from the returned value by the previous pipe.\n * - useConverter: Apply json mapper from the returned value by the previous pipe.\n *\n * @param options\n * @decorator\n * @operation\n * @input\n * @pipe\n */\nexport function UseParam(options: Partial<ParamOptions>): ParameterDecorator;\n/**\n * @deprecated Since v6\n */\nexport function UseParam(paramType: string, options?: Partial<ParamOptions>): ParameterDecorator;\nexport function UseParam(...args: any[]): ParameterDecorator {\n  const options = {\n    dataPath: \"$ctx\",\n    ...((isString(args[0]) ? args[1] : args[0]) || {}),\n    paramType: isString(args[0]) ? args[0] : args[0].paramType\n  };\n\n  return useDecorators(UseParamType(options), ...mapPipes(options)) as ParameterDecorator;\n}\n"]}

package/lib/cjs/decorators/useParamExpression.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseParamExpression = void 0;
+const paramFn_1 = require("./paramFn");
+/**
+ * Get data from a path inside the given object
+ *
+ * @param expression
+ * @decorator
+ * @operation
+ * @input
+ * @pipe
+ */
+function UseParamExpression(expression) {
+    return (0, paramFn_1.ParamFn)((param) => {
+        param.expression = expression || "";
+    });
+}
+exports.UseParamExpression = UseParamExpression;
+//# sourceMappingURL=useParamExpression.js.map

package/lib/cjs/decorators/useParamExpression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useParamExpression.js","sourceRoot":"","sources":["../../../src/decorators/useParamExpression.ts"],"names":[],"mappings":";;;AAAA,uCAAkC;AAElC;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAAC,UAAmB;IACpD,OAAO,IAAA,iBAAO,EAAC,CAAC,KAAK,EAAE,EAAE;QACvB,KAAK,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,gDAIC","sourcesContent":["import {ParamFn} from \"./paramFn\";\n\n/**\n * Get data from a path inside the given object\n *\n * @param expression\n * @decorator\n * @operation\n * @input\n * @pipe\n */\nexport function UseParamExpression(expression?: string) {\n  return ParamFn((param) => {\n    param.expression = expression || \"\";\n  });\n}\n"]}