@tsed/platform-params 7.79.3 → 7.80.0

package/lib/types-esm/builder/PlatformParams.d.ts

@@ -0,0 +1,25 @@
+import { DIContext, InjectorService } from "@tsed/di";
+import { JsonMethodStore, JsonParameterStore, PipeMethods } from "@tsed/schema";
+export type PlatformParamsScope<Context extends DIContext = DIContext> = {
+    $ctx: Context;
+} & Record<string, any>;
+export type PlatformParamsCallback<Context extends DIContext = DIContext> = (scope: PlatformParamsScope<Context>) => Promise<any>;
+/**
+ * Platform Params abstraction layer.
+ * @platform
+ */
+export declare class PlatformParams {
+    protected injector: InjectorService;
+    getPipes(param: JsonParameterStore): PipeMethods<any, any>[];
+    /**
+     * Return a handler with injectable parameters
+     * @param handlerMetadata
+     */
+    compileHandler<Context extends DIContext = DIContext>({ propertyKey, token, handler }: {
+        propertyKey?: string | symbol;
+        token?: any;
+        handler?: any;
+    }): PlatformParamsCallback<Context>;
+    compile<Context extends DIContext = DIContext>(entity: JsonMethodStore): PlatformParamsCallback<Context>;
+    getArg<Context extends DIContext = DIContext>(scope: PlatformParamsScope, pipes: PipeMethods[], param: JsonParameterStore): Promise<any>;
+}

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

@@ -0,0 +1,66 @@
+import { Type } from "@tsed/core";
+import { ParamOptions } from "../domain/ParamOptions.js";
+/**
+ * BodyParams return the value from [request.body](http://expressjs.com/en/4x/api.html#req.body) object.
+ *
+ * #### Example
+ *
+ * ```typescript
+ * @Controller('/')
+ * class MyCtrl {
+ *    @Post('/')
+ *    create(@BodyParams() body: any) {
+ *       console.log('Entire body', body);
+ *    }
+ *
+ *    @Post('/')
+ *    create(@BodyParams('id') id: string) {
+ *       console.log('ID', id);
+ *    }
+ *
+ *    @Post('/')
+ *    create(@BodyParams('user') user: User) { // with deserialization
+ *       console.log('user', user);
+ *    }
+ *
+ *    @Post('/')
+ *    create(@BodyParams('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 BodyParams(expression: string, useType: Type<any>): ParameterDecorator;
+export declare function BodyParams(expression: string): ParameterDecorator;
+export declare function BodyParams(useType: Type<any>): ParameterDecorator;
+export declare function BodyParams(options: Partial<ParamOptions>): ParameterDecorator;
+export declare function BodyParams(): ParameterDecorator;
+/**
+ * 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
+ * @alias BodyParams Example: @BodyParams() payload: Buffer
+ */
+export declare function RawBodyParams(options: Partial<Omit<ParamOptions, "expression">>): ParameterDecorator;
+export declare function RawBodyParams(): ParameterDecorator;

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

@@ -0,0 +1,53 @@
+import { BaseContext } from "@tsed/di";
+/**
+ * Context decorator return the @@PlatformContext@@ created by Ts.ED when request is handled by the server.
+ *
+ * It contains some information as following:
+ *
+ * - The request id,
+ * - The request container used by the Ts.ED DI. It contain all services annotated with `@Scope(ProviderScope.REQUEST)`,
+ * - The current @@EndpointMetadata@@ resolved by Ts.ED during the request,
+ * - The data return by the previous endpoint if you use multiple handler on the same route. By default data is empty.
+ *
+ * ::: tip
+ * The @@PlatformContext@@ inherit from Map class. So you can store any information with.
+ * :::
+ *
+ * #### Example
+ *
+ * ```typescript
+ * @Middleware()
+ * class AuthTokenMiddleware {
+ *   use(@Req() request: Req, @Context() context: PlatformContext) {
+ *      if (!context.has("auth")){
+ *        context.set('auth', new AuthToken(request))
+ *      }
+ *
+ *      try {
+ *        context.get("auth").claims() // check token
+ *      } catch(er){
+ *        throw new Forbidden("Access forbidden - Bad token")
+ *      }
+ *   }
+ * }
+ *
+ * @Controller('/')
+ * @UseBefore(AuthTokenMiddleware) // protect all routes for this controller
+ * class MyCtrl {
+ *    @Get('/')
+ *    get(@Context('auth') auth: AuthToken) {
+ *       console.log('auth', auth);
+ *       console.log('auth.accessToken', auth.accessToken);
+ *       console.log('auth.idToken', auth.idToken);
+ *    }
+ * }
+ * ```
+ *
+ * @param expression The path of the property to get.
+ * @decorator
+ * @operation
+ * @input
+ */
+export declare function Context(expression: string): ParameterDecorator;
+export declare function Context(): ParameterDecorator;
+export type Context = BaseContext;

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

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

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

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

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

@@ -0,0 +1,42 @@
+/**
+ * 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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,70 @@
+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

@@ -0,0 +1,75 @@
+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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,9 @@
+/**
+ * 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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,10 @@
+/**
+ * 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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,13 @@
+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

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

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

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

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,6 @@
+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

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

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

@@ -0,0 +1,31 @@
+/**
+ * @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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,12 @@
+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

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

package/package.json

@@ -1,43 +1,47 @@
 {
   "name": "@tsed/platform-params",
-  "version": "7.79.3",
   "description": "Params module for Ts.ED Framework",
+  "type": "commonjs",
+  "version": "7.80.0",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
-    "types": "./lib/types/index.d.ts",
-    "import": "./lib/esm/index.js",
-    "require": "./lib/cjs/index.js",
-    "default": "./lib/esm/index.js"
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/cjs/index.js"
+    }
   },
   "scripts": {
     "build": "yarn barrels && yarn build:ts",
     "barrels": "barrels",
-    "test": "jest --max-workers=2 && jest-coverage-thresholds-bumper",
-    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json"
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
     "tslib": "2.6.1"
   },
   "devDependencies": {
-    "@tsed/barrels": "7.79.3",
-    "@tsed/core": "7.79.3",
-    "@tsed/di": "7.79.3",
-    "@tsed/exceptions": "7.79.3",
-    "@tsed/json-mapper": "7.79.3",
-    "@tsed/schema": "7.79.3",
-    "@tsed/typescript": "7.79.3",
+    "@tsed/barrels": "7.80.0",
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/exceptions": "7.80.0",
+    "@tsed/json-mapper": "7.80.0",
+    "@tsed/schema": "7.80.0",
+    "@tsed/typescript": "7.80.0",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0"
+    "typescript": "4.9.5",
+    "vitest": "2.0.4"
   },
   "peerDependencies": {
-    "@tsed/core": "7.79.3",
-    "@tsed/di": "7.79.3",
-    "@tsed/exceptions": "7.79.3",
-    "@tsed/json-mapper": "7.79.3",
-    "@tsed/schema": "7.79.3"
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/exceptions": "7.80.0",
+    "@tsed/json-mapper": "7.80.0",
+    "@tsed/schema": "7.80.0"
   },
   "peerDependenciesMeta": {
     "@tsed/core": {

package/vitest.config.mts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import {presets} from "@tsed/vitest/presets";
+import {defineConfig} from "vitest/config";
+
+export default defineConfig(
+  {
+    ...presets,
+    test: {
+      ...presets.test,
+      coverage: {
+        ...presets.test.coverage,
+        thresholds: {
+          statements: 0,
+          branches: 0,
+          functions: 0,
+          lines: 0
+        }
+      }
+    }
+  }
+);

package/jest.config.js

@@ -1,14 +0,0 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-
-module.exports = {
-  ...require("@tsed/jest-config"),
-  coverageThreshold: {
-    global: {
-      statements: 99.81,
-      branches: 92.37,
-      functions: 100,
-      lines: 99.81
-    }
-  }
-};

package/lib/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/tsconfig.esm.json

@@ -1,45 +0,0 @@
-{
-  "extends": "@tsed/typescript/tsconfig.node.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "module": "ES2020",
-    "rootDir": "src",
-    "outDir": "./lib/esm",
-    "declaration": true,
-    "declarationDir": "./lib/types",
-    "composite": true,
-    "noEmit": false
-  },
-  "include": ["src", "src/**/*.json"],
-  "exclude": [
-    "node_modules",
-    "test",
-    "lib",
-    "benchmark",
-    "coverage",
-    "spec",
-    "**/*.benchmark.ts",
-    "**/*.spec.ts",
-    "keys",
-    "jest.config.js",
-    "**/__mock__/**",
-    "webpack.config.js"
-  ],
-  "references": [
-    {
-      "path": "../../core"
-    },
-    {
-      "path": "../../di"
-    },
-    {
-      "path": "../../specs/exceptions"
-    },
-    {
-      "path": "../../specs/json-mapper"
-    },
-    {
-      "path": "../../specs/schema"
-    }
-  ]
-}