@tsed/common 6.95.9 → 6.95.10

package/lib/cjs/decorators/method/acceptMime.d.ts

@@ -1,19 +0,0 @@
-/**
- * Set a mime list which are acceptable and checks if the specified content types are acceptable, based on the request’s Accept HTTP header field.
- *
- * ```typescript
- *  @Controller('/mypath')
- *  export class MyCtrl {
- *
- *    @Get('/')
- *    @AcceptMime('application/json')
- *    public getResource(){}
- *  }
- * ```
- *
- * @param mimes
- * @decorator
- * @operation
- * @response
- */
-export declare function AcceptMime(...mimes: string[]): Function;

package/lib/cjs/decorators/method/endpointFn.d.ts

@@ -1,9 +0,0 @@
-import { DecoratorParameters } from "@tsed/core";
-import { EndpointMetadata } from "../../domain";
-/**
- *
- * @param fn
- * @decorator
- * @deprecated Deprecated since 2021-10-05. Use JsonEntityFn instead.
- */
-export declare function EndpointFn(fn: (endpoint: EndpointMetadata, parameters: DecoratorParameters) => void): MethodDecorator;

package/lib/cjs/decorators/method/location.d.ts

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

package/lib/cjs/decorators/method/redirect.d.ts

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

package/lib/cjs/decorators/method/route.d.ts

@@ -1 +0,0 @@
-export { Get, Post, Put, Patch, Delete, Head, Options, All } from "@tsed/schema";

package/lib/cjs/decorators/method/view.d.ts

@@ -1,25 +0,0 @@
-/**
- * Use a view and sends the rendered HTML string to the client. Optional parameter:
- *
- * * viewOptions, an object whose properties define local variables for the view.
- *
- * The view argument is a string that is the file path of the view file to render.
- * This can be an absolute path, or a path relative to the views setting.
- * If the path does not contain a file extension, then the view engine setting determines the file extension.
- * If the path does contain a file extension, then Express will load the module for the specified template engine (via require())
- * and render it using the loaded module’s __express function.
- *
- * For more information, see [Using template engines with Express](http://expressjs.com/guide/using-template-engines.html).
- *
- * > NOTE: The view argument performs file system operations like reading a file from disk and evaluating Node.js modules,
- * and as so for security reasons should not contain input from the end-user.
- *
- * @param path Relative path to the view file.
- * @param options Additional options
- * @decorator
- * @operation
- * @response
- * @ignores
- * @deprecated Use View decorator from @tsed/platform-views instead.
- */
-export declare function View(path: string, options?: Object): MethodDecorator;

package/lib/cjs/decorators/multer/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./multerFileSize";
-export * from "./multerOptions";
-export * from "./multipartFile";

package/lib/cjs/decorators/multer/multerFileSize.d.ts

@@ -1,27 +0,0 @@
-/**
- * Define file size limit.
- *
- * ```typescript
- * import {Controller, Post} from "@tsed/common";
- * import {MulterOptions, MultipartFile} from "@tsed/common";
- * import {Multer} from "@types/multer";
- *
- * type MulterFile = Express.Multer.File;
- *
- * @Controller('/')
- * class MyCtrl {
- *   @Post('/file2')
- *   @MulterFileSize(1024) // (Ko). Applied for all fields
- *   private uploadFile(@MultipartFile("file1") file: MulterFile, @MultipartFile("file2") file2: MulterFile) {
- *
- *   }
- * }
- * ```
- *
- * > See the tutorial on the [multer configuration](/tutorials/multer.md).
- * @param fileSize
- * @returns {(target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor}
- * @decorator
- * @multer
- */
-export declare function MulterFileSize(fileSize: number): MethodDecorator;

package/lib/cjs/decorators/multer/multerOptions.d.ts

@@ -1,41 +0,0 @@
-import { PlatformMulterSettings } from "../../config/interfaces/PlatformMulterSettings";
-/**
- * Define multer option for all MultipartFile
- *
- * ```typescript
- * import {Controller, Post, PlatformMulterFile, MultipartFile, MulterOptions} from "@tsed/common";
- *
- * @Controller('/')
- * class MyCtrl {
- *   @Post('/file')
- *   private uploadFile(@MultipartFile("file1") file: PlatformMulterFile) {
- *
- *   }
- *
- *   @Post('/file')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: PlatformMulterFile) {
- *
- *   }
- *
- *   @Post('/file2')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: PlatformMulterFile, @MultipartFile("file2") file2: PlatformMulterFile) {
- *
- *   }
- *
- *   @Post('/files')
- *   private uploadFile(@MultipartFile("file1") files: PlatformMulterFile[]) {
- *
- *   }
- * }
- * ```
- *
- * See the tutorial on the [multer configuration](/tutorials/multer.md).
- *
- * @param {multer.Options} options
- * @returns {(target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor}
- * @decorator
- * @multer
- */
-export declare function MulterOptions(options: PlatformMulterSettings): MethodDecorator;

package/lib/cjs/decorators/multer/multipartFile.d.ts

@@ -1,47 +0,0 @@
-import { PlatformMulterFile } from "../../config/interfaces/PlatformMulterSettings";
-/**
- * Define a parameter as Multipart file.
- *
- * ```typescript
- * import {Controller, Post} from "@tsed/common";
- * import {MulterOptions, MultipartFile} from "@tsed/common";
- * import {Multer} from "@types/multer";
- *
- * type MulterFile = Express.Multer.File;
- *
- * @Controller('/')
- * class MyCtrl {
- *   @Post('/file')
- *   private uploadFile(@MultipartFile("file1") file: MulterFile) {
- *
- *   }
- *
- *   @Post('/file')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: MulterFile) {
- *
- *   }
- *
- *   @Post('/file2')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: MulterFile, @MultipartFile("file2") file2: MulterFile) {
- *
- *   }
- *
- *   @Post('/files')
- *   private uploadFile(@MultipartFile("file1") files: MulterFile[]) {
- *
- *   }
- * }
- * ```
- *
- * > See the tutorial on the [multer configuration](/tutorials/multer.md).
- *
- * @param name
- * @param maxCount
- * @returns Function
- * @decorator
- * @input
- */
-export declare function MultipartFile(name: string, maxCount?: number): ParameterDecorator;
-export declare type MultipartFile = PlatformMulterFile;

package/lib/cjs/decorators/params/endpointInfo.d.ts

@@ -1,13 +0,0 @@
-import { EndpointMetadata } from "../../domain/EndpointMetadata";
-/**
- * Get the current endpoint metadata.
- * @decorator
- * @operation
- * @input
- * @deprecated Use `@Context() $ctx: Context` then `$ctx.endpoint` instead.
- */
-export declare function EndpointInfo(): Function;
-/**
- * @deprecated
- */
-export declare type EndpointInfo = EndpointMetadata;

package/lib/cjs/decorators/params/error.d.ts

@@ -1,7 +0,0 @@
-/**
- * @returns {Function}
- * @decorator
- * @operation
- * @input
- */
-export declare function Err(): Function;

package/lib/cjs/decorators/params/next.d.ts

@@ -1,22 +0,0 @@
-/**
- * Get the Next function (for express application and middleware).
- *
- * @decorator
- * @operation
- * @input
- */
-export declare function Next(): ParameterDecorator;
-declare global {
-    namespace TsED {
-        interface NextFunction extends Function {
-        }
-    }
-}
-/**
- * Get the Next function (for express application and middleware).
- *
- * @decorator
- * @operation
- * @input
- */
-export declare type Next = TsED.NextFunction;

package/lib/cjs/decorators/params/request.d.ts

@@ -1,46 +0,0 @@
-import { Type } from "@tsed/core";
-import { ParamOptions } from "@tsed/platform-params";
-/**
- * Request service.
- *
- * @decorator
- * @operation
- * @input
- */
-export declare function Request(expression: string, useType: Type<any>): ParameterDecorator;
-export declare function Request(expression: string): ParameterDecorator;
-export declare function Request(useType: Type<any>): ParameterDecorator;
-export declare function Request(options: ParamOptions<any>): ParameterDecorator;
-export declare function Request(): ParameterDecorator;
-/**
- * Request service.
- *
- * @alias Request
- * @decorator
- * @operation
- * @input
- */
-export declare function Req(expression: string, useType: Type<any>): ParameterDecorator;
-export declare function Req(expression: string): ParameterDecorator;
-export declare function Req(useType: Type<any>): ParameterDecorator;
-export declare function Req(options: Partial<ParamOptions>): ParameterDecorator;
-export declare function Req(): ParameterDecorator;
-/**
- * Request service.
- *
- * @decorator
- * @operation
- * @input
- */
-export interface Request extends TsED.Request {
-}
-/**
- * Request service.
- *
- * @alias Request
- * @decorator
- * @operation
- * @input
- */
-export interface Req extends Request {
-}

package/lib/cjs/decorators/params/response.d.ts

@@ -1,40 +0,0 @@
-/**
- * Response service.
- *
- * @decorator
- * @operation
- * @input
- * @response
- */
-export declare function Response(): ParameterDecorator;
-/**
- * Request service.
- *
- * @alias Response
- * @decorator
- * @operation
- * @input
- * @response
- */
-export declare function Res(): ParameterDecorator;
-/**
- * Response service.
- *
- * @decorator
- * @operation
- * @input
- * @response
- */
-export interface Response extends TsED.Response {
-}
-/**
- * Response service.
- *
- * @alias Response
- * @decorator
- * @operation
- * @input
- * @response
- */
-export interface Res extends Response {
-}

package/lib/cjs/decorators/params/responseData.d.ts

@@ -1,9 +0,0 @@
-/**
- * Return the current response data. Prefer the @@Context@@ decorator to get or set data.
- *
- * @decorator
- * @operation
- * @input
- * @deprecated Use `@Context() $ctx: Context` then $ctx.data.
- */
-export declare function ResponseData(): ParameterDecorator;

package/lib/cjs/domain/AnyToPromiseWithCtx.d.ts

@@ -1,18 +0,0 @@
-import { AnyPromiseResult, AnyToPromise } from "@tsed/core";
-import { PlatformContext } from "./PlatformContext";
-/**
- * @ignore
- */
-export interface HandlerContextOptions {
-    $ctx: PlatformContext;
-    err?: any;
-}
-export declare class AnyToPromiseWithCtx extends AnyToPromise {
-    $ctx: PlatformContext;
-    err: unknown;
-    constructor({ $ctx, err }: HandlerContextOptions);
-    isDone(): boolean;
-    call(cb: Function): Promise<AnyPromiseResult<any>>;
-    destroy(): void;
-    isCanceledResponse(process: any): boolean;
-}

package/lib/cjs/domain/ControllerProvider.d.ts

@@ -1,24 +0,0 @@
-import { ControllerMiddlewares, Provider, TokenProvider } from "@tsed/di";
-export declare class ControllerProvider<T = any> extends Provider<T> {
-    readonly tokenRouter: string;
-    constructor(provide: TokenProvider, options?: Partial<Provider>);
-    /**
-     *
-     */
-    get routerOptions(): any;
-    /**
-     *
-     * @param value
-     */
-    set routerOptions(value: any);
-    /**
-     *
-     * @returns {any[]}
-     */
-    get middlewares(): ControllerMiddlewares;
-    /**
-     *
-     * @param middlewares
-     */
-    set middlewares(middlewares: ControllerMiddlewares);
-}

package/lib/cjs/domain/EndpointMetadata.d.ts

@@ -1,50 +0,0 @@
-import { Type } from "@tsed/core";
-import { ParamMetadata } from "@tsed/platform-params";
-import { JsonMethodStore } from "@tsed/schema";
-export interface EndpointViewOptions {
-    path: string;
-    options: any;
-}
-export interface EndpointRedirectOptions {
-    status: number | undefined;
-    url: string;
-}
-/**
- * EndpointMetadata contains metadata about a controller and his method.
- * Each annotation (@Get, @Body...) attached to a method are stored in a endpoint.
- * EndpointMetadata convert this metadata to an array which contain arguments to call an Express method.
- *
- * Example :
- *
- *    @Controller("/my-path")
- *    provide MyClass {
- *
- *        @Get("/")
- *        @Authenticated()
- *        public myMethod(){}
- *    }
- *
- */
-export declare class EndpointMetadata extends JsonMethodStore {
-    get targetName(): string;
-    get params(): ParamMetadata[];
-    get view(): EndpointViewOptions;
-    set view(view: EndpointViewOptions);
-    get acceptMimes(): string[];
-    set acceptMimes(mimes: string[]);
-    /**
-     * Get an endpoint.
-     * @param target
-     * @param propertyKey
-     * @param descriptor
-     */
-    static get(target: Type<any>, propertyKey: string | symbol, descriptor?: PropertyDescriptor): EndpointMetadata;
-    addOperationPath(method: string, path: string | RegExp, options?: any): import("@tsed/schema").JsonOperation;
-    /**
-     * Find the a value at the controller level. Let this value be extended or overridden by the endpoint itself.
-     *
-     * @param key
-     * @returns {any}
-     */
-    get<T = any>(key: any): T;
-}

package/lib/cjs/domain/HandlerMetadata.d.ts

@@ -1,32 +0,0 @@
-import { Type } from "@tsed/core";
-import { ProviderScope } from "@tsed/di";
-import { JsonParameterStore } from "@tsed/schema";
-import { HandlerType } from "../interfaces/HandlerType";
-import { PlatformRouteOptions, PlatformRouteWithoutHandlers } from "../interfaces/PlatformRouteOptions";
-export interface HandlerMetadataOptions {
-    target: (Type<any> | Function) & {
-        type?: HandlerType;
-    };
-    routeOptions?: PlatformRouteWithoutHandlers;
-    token?: Type<any>;
-    propertyKey?: string | symbol;
-    scope?: ProviderScope;
-    type?: HandlerType;
-}
-export declare class HandlerMetadata {
-    readonly target: any;
-    readonly token: Type<any>;
-    readonly propertyKey: string | symbol;
-    readonly injectable: boolean;
-    readonly type: HandlerType;
-    readonly hasNextFunction: boolean;
-    readonly routeOptions: Partial<PlatformRouteOptions>;
-    readonly scope: ProviderScope;
-    handler: any;
-    constructor(options: HandlerMetadataOptions);
-    get hasErrorParam(): boolean;
-    getParams(): JsonParameterStore[];
-    hasParamType(paramType: any): boolean;
-    isFinal(): boolean;
-    toString(): string;
-}

package/lib/cjs/domain/PlatformContext.d.ts

@@ -1,65 +0,0 @@
-/// <reference types="node" />
-import { ContextMethods, DIContext, DIContextOptions } from "@tsed/di";
-import { IncomingMessage, ServerResponse } from "http";
-import { EndpointMetadata } from "./EndpointMetadata";
-import { PlatformApplication } from "../services/PlatformApplication";
-import { PlatformRequest } from "../services/PlatformRequest";
-import { PlatformResponse } from "../services/PlatformResponse";
-declare global {
-    namespace TsED {
-        interface Context extends PlatformContext {
-        }
-    }
-}
-export interface PlatformContextOptions extends DIContextOptions {
-    event: {
-        response?: ServerResponse;
-        request?: IncomingMessage;
-    };
-    ignoreUrlPatterns?: any[];
-    endpoint?: EndpointMetadata;
-}
-export declare class PlatformContext extends DIContext implements ContextMethods {
-    /**
-     * The current @@EndpointMetadata@@ resolved by Ts.ED during the request.
-     */
-    endpoint: EndpointMetadata;
-    /**
-     * The data return by the previous endpoint if you use multiple handler on the same route. By default data is empty.
-     */
-    data: any;
-    /**
-     * The current @@PlatformResponse@@.
-     */
-    response: PlatformResponse;
-    /**
-     * The current @@PlatformRequest@@.
-     */
-    request: PlatformRequest;
-    private ignoreUrlPatterns;
-    constructor({ event, endpoint, ignoreUrlPatterns, ResponseKlass, RequestKlass, ...options }: PlatformContextOptions);
-    get url(): string;
-    get app(): PlatformApplication<TsED.Application, TsED.Router>;
-    destroy(): Promise<void>;
-    isDone(): boolean;
-    /**
-     * Return the framework request instance (Express, Koa, etc...)
-     */
-    getRequest<Req = any>(): Req;
-    /**
-     * Return the framework response instance (Express, Koa, etc...)
-     */
-    getResponse<Res = any>(): Res;
-    /**
-     * Get Node.js request
-     */
-    getReq(): IncomingMessage;
-    /**
-     * Get Node.js response
-     */
-    getRes(): ServerResponse;
-    /**
-     * Return the original application instance.
-     */
-    getApp<T = any>(): T;
-}

package/lib/cjs/domain/PlatformRouteDetails.d.ts

@@ -1,23 +0,0 @@
-import { JsonOperationRoute } from "@tsed/schema";
-import { EndpointMetadata } from "./EndpointMetadata";
-import { ControllerProvider } from "./ControllerProvider";
-export interface PlatformRouterDetailsOptions {
-    provider: ControllerProvider;
-    endpoint: EndpointMetadata;
-    method: string;
-    url: string;
-}
-export declare class PlatformRouteDetails extends JsonOperationRoute<EndpointMetadata> {
-    readonly rawBody: boolean;
-    readonly provider: ControllerProvider;
-    constructor(options?: Partial<PlatformRouteDetails>);
-    toJSON(): {
-        method: string;
-        name: string;
-        url: string;
-        className: string;
-        methodClassName: string;
-        parameters: any;
-        rawBody: boolean;
-    };
-}

package/lib/cjs/domain/PropertyMetadata.d.ts

@@ -1,17 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonPropertyStore } from "@tsed/schema";
-/**
- * @deprecated Since 2020-11-11. Use getProperties from @tsed/schema
- */
-export declare class PropertyMetadata extends JsonPropertyStore {
-    /**
-     * @deprecated Since 2020-11-11. Use getProperties from @tsed/schema
-     */
-    static get(target: Type<any>, propertyKey: string | symbol): PropertyMetadata;
-    /**
-     * @deprecated Since 2020-11-11. Use getProperties from @tsed/schema
-     */
-    static getProperties(target: Type<any>, options?: Partial<{
-        withIgnoredProps: boolean;
-    }>): Map<string | number | symbol, JsonPropertyStore>;
-}

package/lib/cjs/domain/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./AnyToPromiseWithCtx";
-export * from "./PlatformContext";
-export * from "./PlatformRouteDetails";
-export * from "./ControllerProvider";
-export * from "./EndpointMetadata";
-export * from "./HandlerMetadata";
-export * from "./PropertyMetadata";

package/lib/cjs/index.d.ts

@@ -1,22 +0,0 @@
-import "@tsed/logger";
-import "@tsed/logger-file";
-export * from "@tsed/di";
-export * from "@tsed/platform-params";
-export * from "@tsed/platform-exceptions";
-export * from "@tsed/platform-response-filter";
-export * from "@tsed/platform-cache";
-export * from "@tsed/platform-middlewares";
-export * from "@tsed/components-scan";
-export * from "@tsed/platform-log-middleware";
-export { $log, Logger } from "@tsed/logger";
-export * from "./config";
-export * from "./builder/PlatformBuilder";
-export * from "./builder/PlatformControllerBuilder";
-export * from "./decorators";
-export * from "./constants/routerOptions";
-export * from "./interfaces";
-export * from "./middlewares";
-export * from "./domain";
-export * from "./services";
-export * from "./utils";
-export * from "./PlatformModule";

package/lib/cjs/interfaces/AfterInit.d.ts

@@ -1,3 +0,0 @@
-export interface AfterInit {
-    $afterInit(): void | Promise<any>;
-}

package/lib/cjs/interfaces/AfterListen.d.ts

@@ -1,3 +0,0 @@
-export interface AfterListen {
-    $afterListen(): void | Promise<any>;
-}

package/lib/cjs/interfaces/AfterRoutesInit.d.ts

@@ -1,3 +0,0 @@
-export interface AfterRoutesInit {
-    $afterRoutesInit(): void | Promise<any>;
-}

package/lib/cjs/interfaces/BeforeInit.d.ts

@@ -1,3 +0,0 @@
-export interface BeforeInit {
-    $beforeInit(): void | Promise<any>;
-}

package/lib/cjs/interfaces/BeforeListen.d.ts

@@ -1,3 +0,0 @@
-export interface BeforeListen {
-    $beforeListen(): void | Promise<any>;
-}

package/lib/cjs/interfaces/BeforeRoutesInit.d.ts

@@ -1,3 +0,0 @@
-export interface BeforeRoutesInit {
-    $beforeRoutesInit(): void | Promise<any>;
-}

package/lib/cjs/interfaces/HandlerType.d.ts

@@ -1,12 +0,0 @@
-/**
- * @ignore
- */
-export declare enum HandlerType {
-    CUSTOM = "custom",
-    ENDPOINT = "endpoint",
-    MIDDLEWARE = "middleware",
-    ERR_MIDDLEWARE = "err:middleware",
-    CTX_FN = "context",
-    RAW_FN = "raw:middleware",
-    RAW_ERR_FN = "raw:err:middleware"
-}

package/lib/cjs/interfaces/IncomingEvent.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from "http";
-export interface IncomingEvent<Req = IncomingMessage, Res = ServerResponse> extends Record<string, unknown> {
-    response: Res;
-    request: Req;
-}

package/lib/cjs/interfaces/OnReady.d.ts

@@ -1,3 +0,0 @@
-export interface OnReady {
-    $onReady(): void | Promise<any>;
-}

package/lib/cjs/interfaces/OnRequest.d.ts

@@ -1,4 +0,0 @@
-import { PlatformContext } from "../domain/PlatformContext";
-export interface OnRequest {
-    $onRequest(ctx: PlatformContext): void;
-}