@tsed/common 6.95.9 → 6.96.2

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;
-}

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

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

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

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

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

@@ -1 +0,0 @@
-export declare type PathType = string | RegExp | (string | RegExp)[];

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

@@ -1,19 +0,0 @@
-import { Type } from "@tsed/core";
-import { IProvider } from "@tsed/di";
-export interface PlatformAdapter<App = TsED.Application, Router = TsED.Router> {
-    /**
-     * Load providers in top priority
-     */
-    readonly providers: IProvider[];
-    /**
-     * Called after the injector instantiation
-     */
-    onInit?: () => any;
-    beforeLoadRoutes?: () => Promise<any>;
-    afterLoadRoutes?: () => Promise<any>;
-    useRouter?: () => any;
-    useContext?: () => any;
-}
-export interface PlatformBuilderSettings<App = TsED.Application, Router = TsED.Router> extends Partial<TsED.Configuration> {
-    adapter?: Type<PlatformAdapter<App, Router>>;
-}

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

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

package/lib/cjs/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/cjs/interfaces/Route.d.ts

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

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

@@ -1,17 +0,0 @@
-export * from "./ResponseErrorObject";
-export * from "./HandlerType";
-export * from "./PlatformRouteOptions";
-export * from "./BeforeInit";
-export * from "./AfterInit";
-export * from "./AfterRoutesInit";
-export * from "./BeforeListen";
-export * from "./AfterListen";
-export * from "./BeforeRoutesInit";
-export * from "./AfterRoutesInit";
-export * from "./OnRoutesInit";
-export * from "./OnReady";
-export * from "./OnRequest";
-export * from "./OnResponse";
-export * from "./Route";
-export * from "./IncomingEvent";
-export * from "./PlatformAdapter";

package/lib/cjs/middlewares/AcceptMimesMiddleware.d.ts

@@ -1,10 +0,0 @@
-import { Context } from "@tsed/platform-params";
-import { MiddlewareMethods } from "@tsed/platform-middlewares";
-/**
- * @middleware
- * @deprecated Since 2020-11-30. Use PlatformAcceptMimesMiddleware.
- * @ignore
- */
-export declare class AcceptMimesMiddleware implements MiddlewareMethods {
-    use(ctx: Context): void;
-}

package/lib/cjs/middlewares/GlobalAcceptMimesMiddleware.d.ts

@@ -1,9 +0,0 @@
-import { MiddlewareMethods } from "@tsed/platform-middlewares";
-import { Context } from "@tsed/platform-params";
-/**
- * @deprecated Since 2020-11-30. Use PlatformAcceptMimesMiddleware.
- * @ignore
- */
-export declare class GlobalAcceptMimesMiddleware implements MiddlewareMethods {
-    use(ctx: Context): void;
-}

package/lib/cjs/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/cjs/middlewares/PlatformMulterMiddleware.d.ts

@@ -1,19 +0,0 @@
-import { MiddlewareMethods } from "@tsed/platform-middlewares";
-import { Context } from "@tsed/platform-params";
-import { PlatformMulterField, PlatformMulterSettings } from "../config";
-import { PlatformApplication } from "../services/PlatformApplication";
-export interface MulterInputOptions {
-    fields: PlatformMulterField[];
-}
-/**
- * @middleware
- */
-export declare class PlatformMulterMiddleware implements MiddlewareMethods {
-    settings: PlatformMulterSettings;
-    app: PlatformApplication;
-    use(ctx: Context): Promise<any>;
-    protected getFields(conf: MulterInputOptions): {
-        name: string;
-        maxCount: number | undefined;
-    }[];
-}

package/lib/cjs/middlewares/__mock__/FakeCtrl.d.ts

@@ -1,2 +0,0 @@
-export declare class FakeCtrl {
-}

package/lib/cjs/middlewares/bindEndpointMiddleware.d.ts

@@ -1,5 +0,0 @@
-import type { EndpointMetadata, PlatformContext } from "../domain";
-/**
- * @ignore
- */
-export declare function bindEndpointMiddleware(endpoint: EndpointMetadata): (ctx: PlatformContext) => void;

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

@@ -1,5 +0,0 @@
-export * from "./bindEndpointMiddleware";
-export * from "./PlatformMulterMiddleware";
-export * from "./GlobalAcceptMimesMiddleware";
-export * from "./PlatformAcceptMimesMiddleware";
-export * from "./AcceptMimesMiddleware";

package/lib/cjs/services/FakeRawDriver.d.ts

@@ -1,15 +0,0 @@
-/**
- * @ignore
- */
-export declare const createFakeRawDriver: () => {
-    (): void;
-    use: () => any;
-    all: () => any;
-    get: () => any;
-    patch: () => any;
-    post: () => any;
-    put: () => any;
-    head: () => any;
-    delete: () => any;
-    options: () => any;
-};

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

@@ -1,37 +0,0 @@
-import { InjectorService, TokenProvider } from "@tsed/di";
-import { PlatformRouteDetails } from "../domain";
-import { Route, RouteController } from "../interfaces/Route";
-import { PlatformApplication } from "./PlatformApplication";
-/**
- * `Platform` is used to provide all routes collected by annotation `@Controller`.
- *
- * @platform
- */
-export declare class Platform {
-    readonly injector: InjectorService;
-    readonly platformApplication: PlatformApplication;
-    private _routes;
-    private _controllers;
-    constructor(injector: InjectorService, platformApplication: PlatformApplication);
-    get app(): PlatformApplication<TsED.Application, TsED.Router>;
-    get routes(): PlatformRouteDetails[];
-    addRoutes(routes: Route[]): void;
-    addRoute(basePath: string, token: TokenProvider): this | undefined;
-    /**
-     * Get all routes built by TsExpressDecorators and mounted on Express application.
-     * @returns {PlatformRouteDetails[]}
-     */
-    getRoutes(): PlatformRouteDetails[];
-    getMountedControllers(): RouteController[];
-    protected $onInit(): void;
-    /**
-     * Create routers from the collected controllers.
-     * @private
-     */
-    private createRouters;
-    /**
-     * Create controllers from DI
-     * @private
-     */
-    private buildControllers;
-}

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

@@ -1,21 +0,0 @@
-import { PlatformHandler } from "./PlatformHandler";
-import { PlatformRouter } from "./PlatformRouter";
-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, Router = TsED.Router> extends PlatformRouter<Router> {
-    raw: App;
-    rawApp: App;
-    rawRouter: Router;
-    constructor(platformHandler: PlatformHandler);
-    protected static createRawApp(): any;
-    getApp(): App;
-}

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

@@ -1,80 +0,0 @@
-import { InjectorService, Provider } from "@tsed/di";
-import { ArgScope, HandlerWithScope, PlatformParams } from "@tsed/platform-params";
-import { PlatformResponseFilter } from "@tsed/platform-response-filter";
-import { EndpointMetadata } from "../domain/EndpointMetadata";
-import { HandlerMetadata } from "../domain/HandlerMetadata";
-import { PlatformContext } from "../domain/PlatformContext";
-import { PlatformRouteWithoutHandlers } from "../interfaces/PlatformRouteOptions";
-export interface OnRequestOptions {
-    $ctx: PlatformContext;
-    metadata: HandlerMetadata;
-    handler: HandlerWithScope;
-    next?: any;
-    err?: any;
-    [key: string]: any;
-}
-/**
- * Platform Handler abstraction layer. Wrap original class method to a pure platform handler (Express, Koa, etc...).
- * @platform
- */
-export declare class PlatformHandler {
-    protected injector: InjectorService;
-    protected params: PlatformParams;
-    protected responseFilter: PlatformResponseFilter;
-    constructor(injector: InjectorService, params: PlatformParams);
-    /**
-     * Create a native middleware based on the given metadata and return an instance of AnyToPromiseWithCtx
-     * @param input
-     * @param options
-     */
-    createHandler(input: EndpointMetadata | HandlerMetadata | any, options?: PlatformRouteWithoutHandlers): any;
-    /**
-     * Create injectable handler from the given provider
-     * @param provider
-     * @param propertyKey
-     */
-    createCustomHandler(provider: Provider, propertyKey: string): ($ctx: PlatformContext, next?: any) => Promise<any>;
-    /**
-     * Send the response to the consumer.
-     * @param data
-     * @param ctx
-     * @protected
-     */
-    flush(data: any, ctx: PlatformContext): Promise<void>;
-    compileHandler(metadata: HandlerMetadata): (scope: Record<string, any>) => Promise<any>;
-    protected onCtxRequest(requestOptions: OnRequestOptions): Promise<any>;
-    /**
-     * Call handler when a request his handle
-     * @param requestOptions
-     */
-    protected onRequest(requestOptions: OnRequestOptions): Promise<any>;
-    protected onError(er: Error, requestOptions: OnRequestOptions): Promise<any>;
-    /**
-     * Manage success scenario
-     * @param data
-     * @param requestOptions
-     * @protected
-     */
-    protected onSuccess(data: any, requestOptions: OnRequestOptions): Promise<any>;
-    /**
-     * Call the returned middleware by the handler.
-     * @param middleware
-     * @param ctx
-     * @param next
-     * @protected
-     */
-    protected callReturnedMiddleware(middleware: any, ctx: PlatformContext, next: any): any;
-    /**
-     * create Raw handler
-     * @param metadata
-     */
-    protected createRawHandler(metadata: HandlerMetadata): any;
-    /**
-     * Set response headers
-     * @param ctx
-     * @protected
-     */
-    protected setHeaders(ctx: PlatformContext): void;
-    protected next(requestOptions: OnRequestOptions): any;
-    protected getDefaultArgs(metadata: HandlerMetadata): (scope: ArgScope<PlatformContext>) => Promise<any[]>;
-}

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

@@ -1,6 +0,0 @@
-import { JsonOperationRoute } from "@tsed/schema";
-import { ControllerProvider } from "../domain/ControllerProvider";
-import { EndpointMetadata } from "../domain/EndpointMetadata";
-export declare class PlatformMiddlewaresChain {
-    get(provider: ControllerProvider, operationRoute: JsonOperationRoute<EndpointMetadata>): any[];
-}

package/lib/cjs/services/PlatformRequest.d.ts

@@ -1,112 +0,0 @@
-/// <reference types="node" />
-import { IncomingHttpHeaders, IncomingMessage } from "http";
-import type { PlatformContext } from "../domain/PlatformContext";
-import { IncomingEvent } from "../interfaces/IncomingEvent";
-import type { PlatformResponse } from "./PlatformResponse";
-declare global {
-    namespace TsED {
-        interface Request {
-            id: string;
-            $ctx: PlatformContext;
-        }
-    }
-}
-/**
- * Platform Request abstraction layer.
- * @platform
- */
-export declare class PlatformRequest<T extends {
-    [key: string]: any;
-} = any> {
-    protected $ctx: PlatformContext;
-    raw: T;
-    /**
-     * The current @@PlatformResponse@@.
-     */
-    response: PlatformResponse;
-    constructor({ request }: IncomingEvent, $ctx: PlatformContext);
-    get secure(): boolean;
-    get host(): string;
-    get protocol(): string;
-    /**
-     * Get the url of the request.
-     *
-     * Is equivalent of `express.response.originalUrl || express.response.url`.
-     */
-    get url(): string;
-    get headers(): IncomingHttpHeaders;
-    get method(): string;
-    /**
-     * Contains key-value pairs of data submitted in the request body. By default, it is `undefined`, and is populated when you use
-     * `body-parsing` middleware such as `express.json()` or `express.urlencoded()`.
-     */
-    get body(): any;
-    get rawBody(): any;
-    /**
-     * When using `cookie-parser` middleware, this property is an object that contains cookies sent by the request.
-     * If the request contains no cookies, it defaults to `{}`.
-     */
-    get cookies(): {
-        [key: string]: any;
-    };
-    /**
-     * This property is an object containing properties mapped to the named route `parameters`.
-     * For example, if you have the route `/user/:name`, then the `name` property is available as `req.params.name`.
-     * This object defaults to `{}`.
-     */
-    get params(): {
-        [key: string]: any;
-    };
-    /**
-     * This property is an object containing a property for each query string parameter in the route.
-     * When query parser is set to disabled, it is an empty object `{}`, otherwise it is the result of the configured query parser.
-     */
-    get query(): {
-        [key: string]: any;
-    };
-    /**
-     * This property is an object containing a property for each session attributes set by any code.
-     * It require to install a middleware like express-session to work.
-     */
-    get session(): {
-        [key: string]: any;
-    };
-    get files(): any;
-    /**
-     * Return the original request framework instance
-     */
-    get request(): T;
-    /**
-     * Return the original request node.js instance
-     */
-    get req(): IncomingMessage;
-    /**
-     * Returns the HTTP request header specified by field. The match is case-insensitive.
-     *
-     * ```typescript
-     * request.get('Content-Type') // => "text/plain"
-     * ```
-     *
-     * @param name
-     */
-    get(name: string): any;
-    /**
-     * Checks if the specified content types are acceptable, based on the request’s Accept HTTP header field. The method returns the best match, or if none of the specified content types is acceptable, returns false (in which case, the application should respond with 406 "Not Acceptable").
-     *
-     * The type value may be a single MIME type string (such as “application/json”), an extension name such as “json”, a comma-delimited list, or an array. For a list or array, the method returns the best match (if any).
-     *
-     * @param mime
-     */
-    accepts(mime: string): string | false;
-    accepts(mime: string[]): string[] | false;
-    isAborted(): any;
-    destroy(): void;
-    /**
-     * Return the Framework response object (express, koa, etc...)
-     */
-    getRequest<Req = T>(): Req;
-    /**
-     * Return the Node.js response object
-     */
-    getReq(): IncomingMessage;
-}