@tsed/platform-params 8.0.0-alpha.5 → 8.0.0-alpha.6

package/lib/types-esm/decorators/locals.d.ts

@@ -1,42 +0,0 @@
-/**
- * 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](http://tsed.io/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 declare function Locals(expression: string): ParameterDecorator;
-export declare function Locals(): ParameterDecorator;

package/lib/types-esm/decorators/paramFn.d.ts

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

package/lib/types-esm/decorators/pathParams.d.ts

@@ -1,70 +0,0 @@
-import { Type } from "@tsed/core";
-import { ParamOptions } from "../domain/ParamOptions.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 declare function PathParams(expression: string, useType: Type<any>): ParameterDecorator;
-export declare function PathParams(expression: string): ParameterDecorator;
-export declare function PathParams(useType: Type<any>): ParameterDecorator;
-export declare function PathParams(options: Partial<ParamOptions>): ParameterDecorator;
-export declare function PathParams(): ParameterDecorator;
-/**
- * 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 declare function RawPathParams(expression: string): ParameterDecorator;
-export declare function RawPathParams(options: Partial<ParamOptions>): ParameterDecorator;
-export declare function RawPathParams(): ParameterDecorator;

package/lib/types-esm/decorators/queryParams.d.ts

@@ -1,75 +0,0 @@
-import { Type } from "@tsed/core";
-import { ParamOptions } from "../domain/ParamOptions.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 declare function QueryParams(expression: string, useType: Type<any>): ParameterDecorator;
-export declare function QueryParams(expression: string): ParameterDecorator;
-export declare function QueryParams(useType: Type<any>): ParameterDecorator;
-export declare function QueryParams(options: Partial<ParamOptions>): ParameterDecorator;
-export declare function QueryParams(): ParameterDecorator;
-/**
- * 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 declare function RawQueryParams(expression: string): ParameterDecorator;
-export declare function RawQueryParams(options: Partial<ParamOptions>): ParameterDecorator;
-export declare function RawQueryParams(): ParameterDecorator;

package/lib/types-esm/decorators/session.d.ts

@@ -1,36 +0,0 @@
-import { ParamOptions } from "../domain/ParamOptions.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 declare function Session(expression: string): ParameterDecorator;
-export declare function Session(options: Partial<ParamOptions>): ParameterDecorator;
-export declare function Session(): ParameterDecorator;

package/lib/types-esm/decorators/useDeserialization.d.ts

@@ -1,9 +0,0 @@
-/**
- * Use JsonMapper to deserialize the data.
- *
- * @decorator
- * @operation
- * @input
- * @pipe
- */
-export declare function UseDeserialization(options?: any): ParameterDecorator;

package/lib/types-esm/decorators/useParam.d.ts

@@ -1,18 +0,0 @@
-import { ParamOptions } from "../domain/ParamOptions.js";
-/**
- * Register a new param. It uses the paramType to extract value and give it to the next pipe.
- *
- * Given options allow to enable or disable following pipes:
- *
- * - useType: Add extra type for the json mapper,
- * - expression: Get property from the returned value by the previous pipe.
- * - useValidation: Apply validation from the returned value by the previous pipe.
- * - useMapper: Apply json mapper from the returned value by the previous pipe.
- *
- * @param options
- * @decorator
- * @operation
- * @input
- * @pipe
- */
-export declare function UseParam(options: Partial<ParamOptions>): ParameterDecorator;

package/lib/types-esm/decorators/useParamExpression.d.ts

@@ -1,10 +0,0 @@
-/**
- * Get data from a path inside the given object
- *
- * @param expression
- * @decorator
- * @operation
- * @input
- * @pipe
- */
-export declare function UseParamExpression(expression?: string): ParameterDecorator;

package/lib/types-esm/decorators/useParamType.d.ts

@@ -1,10 +0,0 @@
-import { ParamOptions } from "../domain/ParamOptions.js";
-/**
- * Get the object from request (like body, params, query, etc...).
- *
- * @decorator
- * @operation
- * @input
- * @pipe
- */
-export declare function UseParamType(options: ParamOptions): any;

package/lib/types-esm/decorators/usePipe.d.ts

@@ -1,13 +0,0 @@
-import { Type } from "@tsed/core";
-import { PipeMethods } from "@tsed/schema";
-/**
- * Register a Pipe to be used with the current decorated param.
- *
- * @param token
- * @param options
- * @decorator
- * @operation
- * @input
- * @pipe
- */
-export declare function UsePipe(token: Type<PipeMethods>, options?: any): ParameterDecorator;

package/lib/types-esm/decorators/useType.d.ts

@@ -1,13 +0,0 @@
-import { Type } from "@tsed/core";
-/**
- * Set the type of the item collection.
- *
- * Prefer @@CollectionOf@@ usage.
- *
- * @param useType
- * @decorator
- * @operation
- * @input
- * @alias CollectionOf
- */
-export declare function UseType(useType: undefined | any | Type<any>): ParameterDecorator;

package/lib/types-esm/decorators/useValidation.d.ts

@@ -1,9 +0,0 @@
-/**
- * Enable validation on the decoratored parameter.
- *
- * @decorator
- * @operation
- * @input
- * @pipe
- */
-export declare function UseValidation(): ParameterDecorator;

package/lib/types-esm/domain/ParamMetadata.d.ts

@@ -1 +0,0 @@
-export { ParamMetadata } from "@tsed/schema";

package/lib/types-esm/domain/ParamOptions.d.ts

@@ -1,10 +0,0 @@
-import { Type } from "@tsed/core";
-export interface ParamOptions<T = any> {
-    dataPath: string;
-    paramType: string;
-    expression?: string;
-    useType?: Type<T>;
-    useMapper?: boolean;
-    useValidation?: boolean;
-    [key: string]: any;
-}

package/lib/types-esm/domain/ParamTypes.d.ts

@@ -1,25 +0,0 @@
-export declare enum ParamTypes {
-    $CTX = "$CTX",
-    BODY = "BODY",
-    PATH = "PATH",
-    QUERY = "QUERY",
-    HEADER = "HEADER",
-    RAW_BODY = "RAW_BODY",
-    COOKIES = "COOKIES",
-    LOCALS = "LOCALS",
-    SESSION = "SESSION",
-    FILES = "FILES",
-    NEXT_FN = "NEXT_FN",
-    ERR = "ERR",
-    REQUEST = "REQUEST",
-    PLATFORM_REQUEST = "PLATFORM_REQUEST",
-    NODE_REQUEST = "NODE_REQUEST",
-    RESPONSE = "RESPONSE",
-    PLATFORM_RESPONSE = "PLATFORM_RESPONSE",
-    NODE_RESPONSE = "NODE_RESPONSE",
-    RESPONSE_DATA = "RESPONSE_DATA",
-    ENDPOINT_INFO = "ENDPOINT_INFO",
-    RES = "RES",
-    REQ = "REQ"
-}
-export declare const PARAM_TYPES_DATA_PATH: Record<string, string>;

package/lib/types-esm/errors/ParamValidationError.d.ts

@@ -1,8 +0,0 @@
-import { BadRequest } from "@tsed/exceptions";
-import { JsonParameterStore } from "@tsed/schema";
-export declare class ParamValidationError extends BadRequest {
-    name: string;
-    dataPath: string;
-    requestType: string;
-    static from(metadata: JsonParameterStore, origin?: any): any;
-}

package/lib/types-esm/errors/RequiredValidationError.d.ts

@@ -1,6 +0,0 @@
-import { ValidationError } from "./ValidationError.js";
-import { JsonParameterStore } from "@tsed/schema";
-export declare class RequiredValidationError extends ValidationError {
-    name: string;
-    static from(metadata: JsonParameterStore): RequiredValidationError;
-}

package/lib/types-esm/errors/ValidationError.d.ts

@@ -1,6 +0,0 @@
-import { BadRequest } from "@tsed/exceptions";
-export declare class ValidationError extends BadRequest {
-    name: string;
-    errors: any[];
-    constructor(message: string, errors?: any[]);
-}

package/lib/types-esm/exports.d.ts

@@ -1 +0,0 @@
-export { PipeMethods } from "@tsed/schema";

package/lib/types-esm/index.d.ts

@@ -1,31 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./builder/PlatformParams.js";
-export * from "./decorators/bodyParams.js";
-export * from "./decorators/context.js";
-export * from "./decorators/cookies.js";
-export * from "./decorators/headerParams.js";
-export * from "./decorators/locals.js";
-export * from "./decorators/paramFn.js";
-export * from "./decorators/pathParams.js";
-export * from "./decorators/queryParams.js";
-export * from "./decorators/session.js";
-export * from "./decorators/useDeserialization.js";
-export * from "./decorators/useParam.js";
-export * from "./decorators/useParamExpression.js";
-export * from "./decorators/useParamType.js";
-export * from "./decorators/usePipe.js";
-export * from "./decorators/useType.js";
-export * from "./decorators/useValidation.js";
-export * from "./domain/ParamMetadata.js";
-export * from "./domain/ParamOptions.js";
-export * from "./domain/ParamTypes.js";
-export * from "./errors/ParamValidationError.js";
-export * from "./errors/RequiredValidationError.js";
-export * from "./errors/ValidationError.js";
-export * from "./exports.js";
-export * from "./pipes/DeserializerPipe.js";
-export * from "./pipes/ParseExpressionPipe.js";
-export * from "./pipes/ValidationPipe.js";
-export * from "./utils/mapParamsOptions.js";

package/lib/types-esm/pipes/DeserializerPipe.d.ts

@@ -1,4 +0,0 @@
-import { JsonParameterStore, PipeMethods } from "@tsed/schema";
-export declare class DeserializerPipe implements PipeMethods {
-    transform(value: any, param: JsonParameterStore): any;
-}

package/lib/types-esm/pipes/ParseExpressionPipe.d.ts

@@ -1,6 +0,0 @@
-import { JsonParameterStore, PipeMethods } from "@tsed/schema";
-import { PlatformParamsScope } from "../builder/PlatformParams.js";
-export declare class ParseExpressionPipe implements PipeMethods {
-    transform(scope: PlatformParamsScope, param: JsonParameterStore): any;
-    protected getKey(param: JsonParameterStore): string;
-}

package/lib/types-esm/pipes/ValidationPipe.d.ts

@@ -1,12 +0,0 @@
-import { JsonParameterStore, PipeMethods } from "@tsed/schema";
-export type ValidatorServiceMethods = {
-    validate(value: any, options: any): Promise<any>;
-};
-export declare class ValidationPipe implements PipeMethods {
-    private validator;
-    constructor(validators: ValidatorServiceMethods[]);
-    coerceTypes(value: any, metadata: JsonParameterStore): any;
-    skip(value: any, metadata: JsonParameterStore): boolean;
-    transform(value: any, metadata: JsonParameterStore): Promise<any>;
-    protected checkIsRequired(value: any, metadata: JsonParameterStore): boolean;
-}

package/lib/types-esm/utils/mapParamsOptions.d.ts

@@ -1,5 +0,0 @@
-import { ParamOptions } from "../domain/ParamOptions.js";
-/**
- * @ignore
- */
-export declare function mapParamsOptions(args: any[]): Partial<ParamOptions<any>>;