@tsed/common 8.0.0-beta.2 → 8.0.0-beta.4

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

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

package/lib/types/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 type Next = TsED.NextFunction;

package/lib/types/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/types/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/types/domain/AnyToPromiseWithCtx.d.ts

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

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

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

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

@@ -1,80 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { DIContext, DIContextOptions } from "@tsed/di";
-import { PlatformHandlerMetadata } from "@tsed/platform-router";
-import { EndpointMetadata } from "@tsed/schema";
-import { IncomingMessage, ServerResponse } from "http";
-import { IncomingEvent } from "../interfaces/IncomingEvent.js";
-import { PlatformApplication } from "../services/PlatformApplication.js";
-import { PlatformRequest } from "../services/PlatformRequest.js";
-import { PlatformResponse } from "../services/PlatformResponse.js";
-declare global {
-    namespace TsED {
-        interface Context extends PlatformContext {
-        }
-    }
-}
-export interface PlatformContextOptions extends DIContextOptions {
-    event: IncomingEvent;
-    ignoreUrlPatterns?: any[];
-    endpoint?: EndpointMetadata;
-}
-export declare class PlatformContext<PReq extends PlatformRequest = PlatformRequest, PRes extends PlatformResponse = PlatformResponse> extends DIContext {
-    #private;
-    readonly PLATFORM: string;
-    event: IncomingEvent;
-    /**
-     * The data return by the previous endpoint if you use multiple handler on the same route. By default data is empty.
-     */
-    data: any;
-    /**
-     * The error caught by the current handler
-     */
-    error?: unknown;
-    /**
-     *
-     */
-    next?: any;
-    /**
-     * The current @@PlatformResponse@@.
-     */
-    readonly response: PRes;
-    /**
-     * The current @@PlatformRequest@@.
-     */
-    readonly request: PReq;
-    /**
-     * The current @@EndpointMetadata@@ resolved by Ts.ED during the request.
-     */
-    endpoint: EndpointMetadata;
-    /**
-     * The current @@PlatformHandlerMetadata@@ resolved by Ts.ED during the request.
-     */
-    handlerMetadata: PlatformHandlerMetadata;
-    constructor(options: PlatformContextOptions);
-    get url(): string;
-    get app(): PlatformApplication<TsED.Application>;
-    start(): Promise<void>;
-    finish(): Promise<void>;
-    isFinished(): boolean;
-    isDone(): any;
-    /**
-     * 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/types/domain/PlatformRouteDetails.d.ts

@@ -1,7 +0,0 @@
-export interface PlatformRouteDetails {
-    method: string;
-    name: string;
-    url: string;
-    className: string;
-    methodClassName: string;
-}

package/lib/types/exports.d.ts

@@ -1,9 +0,0 @@
-import "@tsed/logger";
-import "@tsed/logger-file";
-export * from "@tsed/di";
-export { $log, Logger } from "@tsed/logger";
-export * from "@tsed/platform-exceptions";
-export * from "@tsed/platform-middlewares";
-export * from "@tsed/platform-params";
-export * from "@tsed/platform-response-filter";
-export * from "@tsed/platform-router";

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

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

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

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

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

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

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

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

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

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

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

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

package/lib/types/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/types/interfaces/IncomingEvent.d.ts

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

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

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

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

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

package/lib/types/interfaces/OnResponse.d.ts

@@ -1,4 +0,0 @@
-import { PlatformResponse } from "../services/PlatformResponse.js";
-export interface OnResponse {
-    $onResponse(ctx: PlatformResponse): void;
-}

package/lib/types/interfaces/OnRoutesInit.d.ts

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

package/lib/types/interfaces/PlatformRouteOptions.d.ts

@@ -1,15 +0,0 @@
-import { Type } from "@tsed/core";
-import { PathType } from "@tsed/di";
-/**
- * @ignore
- */
-export interface PlatformRouteOptions {
-    token?: Type<any>;
-    path?: PathType | undefined;
-    method?: string;
-    handlers: any[];
-}
-/**
- * @ignore
- */
-export type PlatformRouteWithoutHandlers = Partial<Omit<PlatformRouteOptions, "handlers">>;

package/lib/types/interfaces/ResponseErrorObject.d.ts

@@ -1,8 +0,0 @@
-/**
- * Interface can be implemented to customize the error sent to the client.
- */
-export interface ResponseErrorObject extends Error {
-    errors?: Error[] | Error | any;
-    origin?: Error;
-    headers?: {};
-}

package/lib/types/interfaces/Route.d.ts

@@ -1,10 +0,0 @@
-import { Provider, TokenProvider } from "@tsed/di";
-export interface Route extends Record<string, any> {
-    route: string;
-    token: TokenProvider;
-}
-export interface RouteController {
-    route: string;
-    routes: Set<string>;
-    provider: Provider;
-}

package/lib/types/middlewares/PlatformAcceptMimesMiddleware.d.ts

@@ -1,10 +0,0 @@
-import { MiddlewareMethods } from "@tsed/platform-middlewares";
-import { Context } from "@tsed/platform-params";
-/**
- * @middleware
- * @platform
- */
-export declare class PlatformAcceptMimesMiddleware implements MiddlewareMethods {
-    acceptMimes: string[];
-    use(ctx: Context): void;
-}

package/lib/types/middlewares/PlatformMulterMiddleware.d.ts

@@ -1,24 +0,0 @@
-import { BadRequest } from "@tsed/exceptions";
-import { MiddlewareMethods } from "@tsed/platform-middlewares";
-import type { MulterError } from "multer";
-import { PlatformMulterField, PlatformMulterSettings } from "../config/interfaces/PlatformMulterSettings.js";
-import { PlatformContext } from "../domain/PlatformContext.js";
-import { PlatformApplication } from "../services/PlatformApplication.js";
-export interface MulterInputOptions {
-    fields: PlatformMulterField[];
-}
-export declare class MulterException extends BadRequest {
-    constructor(er: MulterError);
-}
-/**
- * @middleware
- */
-export declare class PlatformMulterMiddleware implements MiddlewareMethods {
-    protected settings: PlatformMulterSettings;
-    protected app: PlatformApplication;
-    use(ctx: PlatformContext): Promise<any>;
-    protected getFields(conf: MulterInputOptions): {
-        name: string;
-        maxCount: number | undefined;
-    }[];
-}

package/lib/types/services/FakeAdapter.d.ts

@@ -1 +0,0 @@
-export { FakeAdapter } from "./PlatformAdapter.js";

package/lib/types/services/FakeResponse.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { EventEmitter } from "node:events";
-export declare class FakeResponse extends EventEmitter {
-    headers: Record<string, unknown>;
-    locals: Record<string, unknown>;
-    statusCode: number;
-    data: any;
-    constructor(opts?: {});
-    status(code: number): this;
-    contentType(content: string): void;
-    contentLength(content: number): void;
-    redirect(status: number, path: string): void;
-    location(path: string): void;
-    get(key: string): unknown;
-    getHeaders(): Record<string, unknown>;
-    set(key: string, value: any): this;
-    setHeader(key: string, value: any): this;
-    send(data: any): void;
-    json(data: any): void;
-    write(chunk: any): void;
-    end(data: any): void;
-}

package/lib/types/services/Platform.d.ts

@@ -1,25 +0,0 @@
-import { InjectorService, TokenProvider } from "@tsed/di";
-import { PlatformLayer, PlatformRouters } from "@tsed/platform-router";
-import { Route, RouteController } from "../interfaces/Route.js";
-import { PlatformApplication } from "./PlatformApplication.js";
-/**
- * `Platform` is used to provide all routes collected by annotation `@Controller`.
- *
- * @platform
- */
-export declare class Platform {
-    #private;
-    readonly injector: InjectorService;
-    readonly platformApplication: PlatformApplication;
-    readonly platformRouters: PlatformRouters;
-    constructor(injector: InjectorService, platformApplication: PlatformApplication, platformRouters: PlatformRouters);
-    get app(): PlatformApplication<TsED.Application>;
-    addRoutes(routes: Route[]): void;
-    addRoute(route: string, token: TokenProvider): this;
-    getLayers(): PlatformLayer[];
-    /**
-     * Get all controllers mounted on the application.
-     * @returns  {RouteController[]}
-     */
-    getMountedControllers(): RouteController[];
-}

package/lib/types/services/PlatformAdapter.d.ts

@@ -1,89 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { Type } from "@tsed/core";
-import { InjectorService, ProviderOpts } from "@tsed/di";
-import { PlatformContextHandler, PlatformHandlerMetadata, PlatformLayer } from "@tsed/platform-router";
-import { IncomingMessage, ServerResponse } from "http";
-import { PlatformMulter, PlatformMulterSettings } from "../config/interfaces/PlatformMulterSettings.js";
-import { PlatformStaticsOptions } from "../config/interfaces/PlatformStaticsSettings.js";
-import { PlatformContext } from "../domain/PlatformContext.js";
-import { CreateServerReturn } from "../utils/createServer.js";
-import type { PlatformApplication } from "./PlatformApplication.js";
-export declare abstract class PlatformAdapter<App = TsED.Application> {
-    protected injector: InjectorService;
-    static readonly NAME: string;
-    /**
-     * Load providers in top priority
-     */
-    providers: ProviderOpts[];
-    constructor(injector: InjectorService);
-    get app(): PlatformApplication<App>;
-    getServers(): CreateServerReturn[];
-    onInit(): Promise<void> | void;
-    beforeLoadRoutes(): Promise<void> | void;
-    afterLoadRoutes(): Promise<void> | void;
-    /**
-     * create initial context
-     */
-    abstract useContext(): any;
-    /**
-     * Map router layer to the targeted framework
-     */
-    abstract mapLayers(layer: PlatformLayer[]): void;
-    /**
-     * Map handler to the targeted framework
-     */
-    abstract mapHandler(handler: Function, layer: PlatformHandlerMetadata): Function;
-    /**
-     * Return the app instance
-     */
-    abstract createApp(): {
-        app: App;
-        callback(): (req: IncomingMessage, res: ServerResponse) => void;
-    };
-    /**
-     * Return the statics middlewares
-     * @param endpoint
-     * @param options
-     */
-    abstract statics(endpoint: string, options: PlatformStaticsOptions): any;
-    /**
-     * Return the multipart middleware
-     * @param options
-     */
-    abstract multipart(options: PlatformMulterSettings): PlatformMulter;
-    /**
-     * Return the body parser for the given
-     * @param type
-     * @param opts
-     */
-    abstract bodyParser(type: string, opts?: Record<string, any>): any;
-}
-export interface PlatformBuilderSettings<App = TsED.Application> extends Partial<TsED.Configuration> {
-    adapter?: Type<PlatformAdapter<App>>;
-}
-export declare class FakeAdapter extends PlatformAdapter<any> {
-    providers: ProviderOpts[];
-    static readonly NAME: string;
-    static createFakeRawDriver(): {
-        (): void;
-        use: () => any;
-        all: () => any;
-        get: () => any;
-        patch: () => any;
-        post: () => any;
-        put: () => any;
-        head: () => any;
-        delete: () => any;
-        options: () => any;
-    };
-    createApp(): {
-        app: any;
-        callback(): any;
-    };
-    multipart(options: PlatformMulterSettings): PlatformMulter;
-    statics(endpoint: string, options: PlatformStaticsOptions): any;
-    bodyParser(type: string): any;
-    mapLayers(layers: PlatformLayer[]): void;
-    mapHandler(handler: PlatformContextHandler<PlatformContext>): PlatformContextHandler<PlatformContext<import("./PlatformRequest.js").PlatformRequest<any>, import("./PlatformResponse.js").PlatformResponse<any>>>;
-    useContext(): void;
-}

package/lib/types/services/PlatformApplication.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="multer" />
-/// <reference types="node" resolution-mode="require"/>
-import { InjectorService } from "@tsed/di";
-import { PlatformRouter } from "@tsed/platform-router";
-import { IncomingMessage, ServerResponse } from "http";
-import { PlatformMulterSettings } from "../config/interfaces/PlatformMulterSettings.js";
-import { PlatformAdapter } from "./PlatformAdapter.js";
-declare global {
-    namespace TsED {
-        interface Application {
-        }
-    }
-}
-/**
- * `PlatformApplication` is used to provide all routes collected by annotation `@Controller`.
- *
- * @platform
- */
-export declare class PlatformApplication<App = TsED.Application> extends PlatformRouter {
-    adapter: PlatformAdapter<App>;
-    injector: InjectorService;
-    rawApp: App;
-    rawCallback: () => any;
-    constructor(adapter: PlatformAdapter<App>, injector: InjectorService);
-    getApp(): App;
-    multer(options: PlatformMulterSettings): import("multer").Multer;
-    callback(): (req: IncomingMessage, res: ServerResponse) => any;
-    callback(req: IncomingMessage, res: ServerResponse): any;
-}

package/lib/types/services/PlatformHandler.d.ts

@@ -1,39 +0,0 @@
-import { AnyPromiseResult } from "@tsed/core";
-import { Provider } from "@tsed/di";
-import { PlatformExceptions } from "@tsed/platform-exceptions";
-import { PlatformParams, PlatformParamsCallback } from "@tsed/platform-params";
-import { PlatformResponseFilter } from "@tsed/platform-response-filter";
-import { PlatformHandlerMetadata, PlatformRouters } from "@tsed/platform-router";
-import { PlatformContext } from "../domain/PlatformContext.js";
-import { PlatformApplication } from "./PlatformApplication.js";
-import { PlatformMiddlewaresChain } from "./PlatformMiddlewaresChain.js";
-/**
- * Platform Handler abstraction layer. Wrap original class method to a pure platform handler (Express, Koa, etc...).
- * @platform
- */
-export declare class PlatformHandler {
-    protected platformRouters: PlatformRouters;
-    protected responseFilter: PlatformResponseFilter;
-    protected platformParams: PlatformParams;
-    protected platformExceptions: PlatformExceptions;
-    protected platformApplication: PlatformApplication;
-    protected platformMiddlewaresChain: PlatformMiddlewaresChain;
-    constructor(platformRouters: PlatformRouters);
-    createHandler(handlerMetadata: PlatformHandlerMetadata): any;
-    /**
-     * @param provider
-     * @param propertyKey
-     */
-    createCustomHandler(provider: Provider, propertyKey: string): any;
-    /**
-     * Call handler when a request his handle
-     */
-    onRequest(handler: PlatformParamsCallback, $ctx: PlatformContext): Promise<any>;
-    onResponse({ status, data, headers }: AnyPromiseResult, $ctx: PlatformContext): void;
-    /**
-     * Send the response to the consumer.
-     * @protected
-     * @param $ctx
-     */
-    flush($ctx: PlatformContext): Promise<void>;
-}

package/lib/types/services/PlatformMiddlewaresChain.d.ts

@@ -1,17 +0,0 @@
-import { InjectorService } from "@tsed/di";
-import { AlterEndpointHandlersArg } from "@tsed/platform-router";
-import { JsonOperationRoute } from "@tsed/schema";
-import { PlatformAdapter } from "../services/PlatformAdapter.js";
-export declare class PlatformMiddlewaresChain {
-    protected acceptMimes: string[];
-    protected adapter: PlatformAdapter;
-    protected injector: InjectorService;
-    get(handlers: AlterEndpointHandlersArg, operationRoute: JsonOperationRoute): AlterEndpointHandlersArg;
-    protected hasAcceptMimes(operationRoute: JsonOperationRoute): number;
-    protected getParamTypes(middlewares: AlterEndpointHandlersArg, operationRoute: JsonOperationRoute): {
-        ACCEPT_MIMES: number;
-        FILE: boolean;
-        RAW_BODY: boolean;
-        BODY: boolean;
-    };
-}