@tsed/platform-params 8.11.1 → 8.12.0-rc.1

package/src/decorators/cookies.ts

@@ -1,102 +0,0 @@
-import {Type} from "@tsed/core";
-
-import {ParamOptions} from "../domain/ParamOptions.js";
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {mapParamsOptions} from "../utils/mapParamsOptions.js";
-import {UseParam} from "./useParam.js";
-
-/**
- * Cookies or CookiesParams return the value from [request.cookies](http://expressjs.com/en/4x/api.html#req.cookies) object.
- *
- * #### Example
- *
- * ```typescript
- * @Controller('/')
- * class MyCtrl {
- *    @Post('/')
- *    create(@Cookies() cookies: any) {
- *       console.log('Entire cookies', cookies);
- *    }
- *
- *    @Post('/')
- *    create(@Cookies('id') id: string) {
- *       console.log('ID', id);
- *    }
- *
- *    @Post('/')
- *    create(@Cookies('user') user: IUser) {
- *       console.log('user', user);
- *    }
- * }
- * ```
- * > For more information on deserialization see [converters](/docs/json-mapper.md) page.
- *
- * @param expression The path of the property to get.
- * @param useType The type of the class that to be used to deserialize the data.
- * @decorator
- * @operation
- * @input
- */
-export function CookiesParams(expression: string | any, useType: any): ParameterDecorator;
-export function CookiesParams(): ParameterDecorator;
-export function CookiesParams(expression: string | any): ParameterDecorator;
-export function CookiesParams(options: ParamOptions<any>): ParameterDecorator;
-export function CookiesParams(...args: any[]): ParameterDecorator {
-  const {expression, useType, useMapper = false, useValidation = false} = mapParamsOptions(args);
-
-  return UseParam({
-    paramType: ParamTypes.COOKIES,
-    expression,
-    useType,
-    useMapper,
-    useValidation
-  });
-}
-
-/**
- * Cookies or CookiesParams return the value from [request.cookies](http://expressjs.com/en/4x/api.html#req.cookies) object.
- *
- * #### Example
- *
- * ```typescript
- * @Controller('/')
- * class MyCtrl {
- *    @Post('/')
- *    create(@Cookies() body: any) {
- *       console.log('Entire body', body);
- *    }
- *
- *    @Post('/')
- *    create(@Cookies('id') id: string) {
- *       console.log('ID', id);
- *    }
- *
- *    @Post('/')
- *    create(@Cookies('user') user: User) { // with deserialization
- *       console.log('user', user);
- *    }
- *
- *    @Post('/')
- *    create(@Cookies('users', User) users: User[]) { // with deserialization
- *       console.log('users', users);
- *    }
- * }
- * ```
- * > For more information on deserialization see [converters](/docs/json-mapper.md) page.
- *
- * @param expression The path of the property to get.
- * @param useType The type of the class that to be used to deserialize the data.
- * @decorator
- * @aliasof CookiesParams
- * @operation
- * @input
- */
-export function Cookies(expression: string, useType: Type<any>): ParameterDecorator;
-export function Cookies(expression: string): ParameterDecorator;
-export function Cookies(useType: Type<any>): ParameterDecorator;
-export function Cookies(options: Partial<ParamOptions>): ParameterDecorator;
-export function Cookies(): ParameterDecorator;
-export function Cookies(...args: any[]): ParameterDecorator {
-  // @ts-ignore
-  return CookiesParams(...args);
-}

package/src/decorators/headerParams.spec.ts

@@ -1,16 +0,0 @@
-import {JsonParameterStore} from "@tsed/schema";
-
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {HeaderParams} from "./headerParams.js";
-
-describe("@HeaderParams", () => {
-  it("should call ParamFilter.useParam method with the correct parameters", () => {
-    class Ctrl {
-      test(@HeaderParams("expression") header: string) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.HEADER);
-  });
-});

package/src/decorators/headerParams.ts

@@ -1,49 +0,0 @@
-import {Type} from "@tsed/core";
-
-import {ParamOptions} from "../domain/ParamOptions.js";
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {mapParamsOptions} from "../utils/mapParamsOptions.js";
-import {UseParam} from "./useParam.js";
-
-/**
- * HeaderParams return the value from [`request.get()`](http://expressjs.com/en/4x/api.html#req.get) method.
- *
- * #### Example
- *
- * ```typescript
- * @Controller('/')
- * class MyCtrl {
- *    @Get('/')
- *    get(@HeaderParams() body: any) {
- *       console.log('Entire body', body);
- *    }
- *
- *    @Get('/')
- *    get(@HeaderParams('x-token') token: string) {
- *       console.log('token', id);
- *    }
- * }
- * ```
- *
- * @param expression The path of the property to get.
- * @param useType
- * @decorator
- * @operation
- * @input
- */
-export function HeaderParams(expression: string, useType: Type<any>): ParameterDecorator;
-export function HeaderParams(expression: string): ParameterDecorator;
-export function HeaderParams(useType: Type<any>): ParameterDecorator;
-export function HeaderParams(options: Partial<ParamOptions>): ParameterDecorator;
-export function HeaderParams(): ParameterDecorator;
-export function HeaderParams(...args: any[]): ParameterDecorator {
-  const {expression, useType, useMapper = false, useValidation = false} = mapParamsOptions(args);
-
-  return UseParam({
-    paramType: ParamTypes.HEADER,
-    expression,
-    useType,
-    useMapper,
-    useValidation
-  });
-}

package/src/decorators/locals.spec.ts

@@ -1,16 +0,0 @@
-import {JsonParameterStore} from "@tsed/schema";
-
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {Locals} from "./locals.js";
-
-describe("@Locals", () => {
-  it("should call ParamFilter.useParam method with the correct parameters", () => {
-    class Ctrl {
-      test(@Locals("expression") test: any) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.LOCALS);
-  });
-});

package/src/decorators/locals.ts

@@ -1,57 +0,0 @@
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {mapParamsOptions} from "../utils/mapParamsOptions.js";
-import {UseParam} from "./useParam.js";
-
-/**
- * Locals return the value from [response.locals](http://expressjs.com/en/4x/api.html#res.locals) object.
- *
- * ::: tip
- * Locals are generally used by express and third-party like templating engine to render a page/template.
- * See [Templating](https://tsed.dev/tutorials/templating.html) section for more details.
- * :::
- *
- * #### Example
- *
- * ```typescript
- *  * @Middleware()
- * class LocalsMiddleware {
- *   use(@Locals() locals: any) {
- *      // set some on locals
- *      locals.user = "user"
- *   }
- * }
- *
- * @Controller('/')
- * @UseBefore(LocalsMiddleware)
- * class MyCtrl {
- *    @Get('/')
- *    @View('home.ejs') // will use locals and returned data to render the page
- *    get(@Locals('user') user: any) {
- *       console.log('user', user);
- *
- *       return {
- *         description: 'Hello world'
- *       }
- *    }
- * }
- * ```
- *
- * @param expression The path of the property to get.
- * @decorator
- * @operation
- * @input
- * @response
- */
-export function Locals(expression: string): ParameterDecorator;
-export function Locals(): ParameterDecorator;
-export function Locals(...args: any[]): ParameterDecorator {
-  const {expression, useType, useMapper = false, useValidation = false} = mapParamsOptions(args);
-
-  return UseParam({
-    paramType: ParamTypes.LOCALS,
-    expression,
-    useType,
-    useMapper,
-    useValidation
-  });
-}

package/src/decorators/paramFn.ts

@@ -1,14 +0,0 @@
-import {DecoratorParameters} from "@tsed/core";
-import {JsonEntityFn, JsonParameterStore} from "@tsed/schema";
-
-/**
- * Get the Param metadata. Use this decorator to compose your own decorator.
- *
- * @param fn
- * @decorator
- * @operation
- * @input
- */
-export function ParamFn(fn: (param: JsonParameterStore, parameters: DecoratorParameters) => void): ParameterDecorator {
-  return JsonEntityFn<JsonParameterStore>(fn);
-}

package/src/decorators/pathParams.spec.ts

@@ -1,58 +0,0 @@
-import {JsonParameterStore} from "@tsed/schema";
-
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {PathParams, RawPathParams} from "./pathParams.js";
-
-describe("@PathParams", () => {
-  it("should declare a path params", () => {
-    class Test {}
-
-    class Ctrl {
-      test(@PathParams("expression", Test) header: Test) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.PATH);
-    expect(param.type).toEqual(Test);
-    expect(param.pipes).toHaveLength(2);
-  });
-  it("should declara a path params with options", () => {
-    class Test {}
-
-    class Ctrl {
-      test(@PathParams({expression: "expression", useType: Test, useValidation: false}) param: Test) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.PATH);
-    expect(param.type).toEqual(Test);
-    expect(param.pipes).toHaveLength(1);
-  });
-});
-
-describe("@RawPathParams", () => {
-  it("should declare a raw path params", () => {
-    class Ctrl {
-      test(@RawPathParams("expression") header: string) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.PATH);
-    expect(param.type).toEqual(String);
-    expect(param.pipes).toHaveLength(0);
-  });
-  it("should declare a raw path params with options", () => {
-    class Ctrl {
-      test(@RawPathParams({expression: "expression", useValidation: true, useType: String}) param: Date) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.PATH);
-    expect(param.type).toEqual(String);
-    expect(param.pipes).toHaveLength(1);
-  });
-});

package/src/decorators/pathParams.ts

@@ -1,97 +0,0 @@
-import {Type} from "@tsed/core";
-
-import {ParamOptions} from "../domain/ParamOptions.js";
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {mapParamsOptions} from "../utils/mapParamsOptions.js";
-import {UseParam} from "./useParam.js";
-
-/**
- * PathParams return the value from [request.params](http://expressjs.com/en/4x/api.html#req.params) object.
- *
- * #### Example
- *
- * ```typescript
- * @Controller('/')
- * class MyCtrl {
- *    @Get('/')
- *    get(@PathParams() params: any) {
- *       console.log('Entire params', params);
- *    }
- *
- *    @Get('/')
- *    get(@PathParams('id') id: string) {
- *       console.log('ID', id);
- *    }
- *
- *    @Get('/')
- *    get(@PathParams({expression: 'id', useType: () => new MyCustomModel() }) id: string) {
- *       console.log('ID', id);
- *    }
- * }
- * ```
- * > For more information on deserialization see [converters](/docs/json-mapper.md) page.
- *
- * @param expression The path of the property to get.
- * @param useType The type of the class that to be used to deserialize the data.
- * @decorator
- * @operation
- * @input
- */
-export function PathParams(expression: string, useType: Type<any>): ParameterDecorator;
-export function PathParams(expression: string): ParameterDecorator;
-export function PathParams(useType: Type<any>): ParameterDecorator;
-export function PathParams(options: Partial<ParamOptions>): ParameterDecorator;
-export function PathParams(): ParameterDecorator;
-export function PathParams(...args: any[]): ParameterDecorator {
-  const {expression, useType, useMapper = true, useValidation = true} = mapParamsOptions(args);
-
-  return UseParam({
-    paramType: ParamTypes.PATH,
-    expression,
-    useType,
-    useMapper,
-    useValidation
-  });
-}
-
-/**
- * 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/json-mapper.md) page.
- *
- * @param expression The path of the property to get.
- * @decorator
- * @operation
- * @input
- */
-export function RawPathParams(expression: string): ParameterDecorator;
-export function RawPathParams(options: Partial<ParamOptions>): ParameterDecorator;
-export function RawPathParams(): ParameterDecorator;
-export function RawPathParams(...args: any[]): ParameterDecorator {
-  const {expression, useType, useMapper = false, useValidation = false} = mapParamsOptions(args);
-
-  return PathParams({
-    expression,
-    useValidation,
-    useMapper,
-    useType
-  });
-}

package/src/decorators/queryParams.spec.ts

@@ -1,58 +0,0 @@
-import {JsonParameterStore} from "@tsed/schema";
-
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {QueryParams, RawQueryParams} from "./queryParams.js";
-
-describe("@QueryParams", () => {
-  it("should declare query params", () => {
-    class Test {}
-
-    class Ctrl {
-      test(@QueryParams("expression", Test) header: Test) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.QUERY);
-    expect(param.type).toEqual(Test);
-    expect(param.pipes).toHaveLength(2);
-  });
-  it("should declare query params with options", () => {
-    class Test {}
-
-    class Ctrl {
-      test(@QueryParams({expression: "expression", useType: Test, useValidation: false}) param: Test) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.QUERY);
-    expect(param.type).toEqual(Test);
-    expect(param.pipes).toHaveLength(1);
-  });
-});
-
-describe("@RawQueryParams", () => {
-  it("should declare raw query params", () => {
-    class Ctrl {
-      test(@RawQueryParams("expression") header: string) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.QUERY);
-    expect(param.type).toEqual(String);
-    expect(param.pipes).toHaveLength(0);
-  });
-  it("should declare raw query params with options", () => {
-    class Ctrl {
-      test(@RawQueryParams({expression: "expression", useValidation: true, useType: String}) param: Date) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.QUERY);
-    expect(param.type).toEqual(String);
-    expect(param.pipes).toHaveLength(1);
-  });
-});

package/src/decorators/queryParams.ts

@@ -1,102 +0,0 @@
-import {Type} from "@tsed/core";
-
-import {ParamOptions} from "../domain/ParamOptions.js";
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {mapParamsOptions} from "../utils/mapParamsOptions.js";
-import {UseParam} from "./useParam.js";
-
-/**
- * QueryParams return the value from [request.query](http://expressjs.com/en/4x/api.html#req.query) object.
- *
- * #### Example
- *
- * ```typescript
- * @Controller('/')
- * class MyCtrl {
- *    @Get('/')
- *    get(@QueryParams() query: any) {
- *       console.log('Entire query', query);
- *    }
- *
- *    @Get('/')
- *    get(@QueryParams('id') id: string) {
- *       console.log('ID', id);
- *    }
- *
- *    @Get('/')
- *    get(@QueryParams('user') user: User) { // with deserialization
- *       console.log('user', user);
- *    }
- *
- *    @Get('/')
- *    get(@QueryParams('users', User) users: User[]) { // with deserialization
- *       console.log('users', users);
- *    }
- * }
- * ```
- * > For more information on deserialization see [converters](/docs/json-mapper.md) page.
- *
- * @param expression The path of the property to get.
- * @param useType The type of the class that to be used to deserialize the data.
- * @decorator
- * @operation
- * @input
- */
-export function QueryParams(expression: string, useType: Type<any>): ParameterDecorator;
-export function QueryParams(expression: string): ParameterDecorator;
-export function QueryParams(useType: Type<any>): ParameterDecorator;
-export function QueryParams(options: Partial<ParamOptions>): ParameterDecorator;
-export function QueryParams(): ParameterDecorator;
-export function QueryParams(...args: any[]): ParameterDecorator {
-  const {expression, useType, useMapper = true, useValidation = true} = mapParamsOptions(args);
-
-  return UseParam({
-    paramType: ParamTypes.QUERY,
-    expression,
-    useType,
-    useMapper,
-    useValidation
-  });
-}
-
-/**
- * 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/json-mapper.md) page.
- *
- * @param expression The path of the property to get.
- * @decorator
- * @operation
- * @input
- */
-export function RawQueryParams(expression: string): ParameterDecorator;
-export function RawQueryParams(options: Partial<ParamOptions>): ParameterDecorator;
-export function RawQueryParams(): ParameterDecorator;
-export function RawQueryParams(...args: any[]) {
-  const {expression, useType, useMapper = false, useValidation = false} = mapParamsOptions(args);
-
-  return QueryParams({
-    expression,
-    useType,
-    useMapper,
-    useValidation
-  });
-}

package/src/decorators/session.spec.ts

@@ -1,47 +0,0 @@
-import {JsonParameterStore} from "@tsed/schema";
-
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {Session} from "./session.js";
-
-describe("@Session", () => {
-  it("should declare a session params", () => {
-    class Test {}
-
-    class Ctrl {
-      test(@Session() body: any) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual(undefined);
-    expect(param.paramType).toEqual(ParamTypes.SESSION);
-    expect(param.type).toEqual(Object);
-    expect(param.pipes).toHaveLength(0);
-  });
-  it("should declare a session params with options", () => {
-    class Test {}
-
-    class Ctrl {
-      test(@Session({expression: "expression", useType: Test}) body: Test) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.SESSION);
-    expect(param.type).toEqual(Test);
-    expect(param.pipes).toHaveLength(0);
-  });
-
-  it("should declare a session params with options (validation + mapping)", () => {
-    class Test {}
-
-    class Ctrl {
-      test(@Session({expression: "expression", useType: Test, useValidation: true, useMapper: true}) body: Test) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.expression).toEqual("expression");
-    expect(param.paramType).toEqual(ParamTypes.SESSION);
-    expect(param.type).toEqual(Test);
-    expect(param.pipes).toHaveLength(2);
-  });
-});

package/src/decorators/session.ts

@@ -1,51 +0,0 @@
-import {ParamOptions} from "../domain/ParamOptions.js";
-import {ParamTypes} from "../domain/ParamTypes.js";
-import {mapParamsOptions} from "../utils/mapParamsOptions.js";
-import {UseParam} from "./useParam.js";
-
-/**
- * Session return the value from [request.session](http://expressjs.com/en/4x/api.html#req.session) object.
- *
- * #### Example
- *
- * ```typescript
- * @Controller('/')
- * class MyCtrl {
- *    @Post('/')
- *    create(@Session() session: Express.Session) {
- *       console.log('Entire session', session);
- *    }
- *
- *    @Post('/')
- *    create(@Session('id') id: string) {
- *       console.log('ID', id);
- *    }
- *
- *    @Post('/') // Example to deserialize use from session
- *    create(@Session({expression: 'user', useMapper: true}) user: User) {
- *       console.log('user', user);
- *       console.log('instanceOf user', user instanceof User);
- *    }
- * }
- * ```
- * > For more information on deserialization see [converters](/docs/json-mapper.md) page.
- *
- * @param expression The path of the property to get.
- * @decorator
- * @operation
- * @input
- */
-export function Session(expression: string): ParameterDecorator;
-export function Session(options: Partial<ParamOptions>): ParameterDecorator;
-export function Session(): ParameterDecorator;
-export function Session(...args: any[]): ParameterDecorator {
-  const {expression, useType, useMapper = false, useValidation = false} = mapParamsOptions(args);
-
-  return UseParam({
-    paramType: ParamTypes.SESSION,
-    expression,
-    useType,
-    useMapper,
-    useValidation
-  });
-}

package/src/decorators/useDeserialization.ts

@@ -1,14 +0,0 @@
-import {DeserializerPipe} from "../pipes/DeserializerPipe.js";
-import {UsePipe} from "./usePipe.js";
-
-/**
- * Use JsonMapper to deserialize the data.
- *
- * @decorator
- * @operation
- * @input
- * @pipe
- */
-export function UseDeserialization(options: any = {}) {
-  return UsePipe(DeserializerPipe, options);
-}