@tsed/common 8.0.0-alpha.5 → 8.0.0-alpha.6

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

@@ -1,100 +0,0 @@
-/// <reference types="node" />
-import { Type } from "@tsed/core";
-import { InjectorService, ProviderOpts, TokenProvider } from "@tsed/di";
-import { PlatformLayer } from "@tsed/platform-router";
-import type { IncomingMessage, ServerResponse } from "http";
-import { Platform } from "../services/Platform.js";
-import { PlatformAdapter, PlatformBuilderSettings } from "../services/PlatformAdapter.js";
-import { PlatformApplication } from "../services/PlatformApplication.js";
-/**
- * @platform
- */
-export declare class PlatformBuilder<App = TsED.Application> {
-    #private;
-    static adapter: Type<PlatformAdapter<any>>;
-    readonly name: string;
-    protected startedAt: Date;
-    protected current: Date;
-    protected constructor(adapter: Type<PlatformAdapter<App>> | undefined, module: Type, settings: Partial<TsED.Configuration>);
-    get injector(): InjectorService;
-    get rootModule(): any;
-    get app(): PlatformApplication<App>;
-    get platform(): Platform;
-    get adapter(): PlatformAdapter<App>;
-    /**
-     * Return the settings configured by the decorator @@Configuration@@.
-     *
-     * ```typescript
-     * @Configuration({
-     *    port: 8000,
-     *    httpsPort: 8080,
-     *    mount: {
-     *      "/rest": "${rootDir}/controllers/**\/*.js"
-     *    }
-     * })
-     * export class Server {
-     *     $onInit(){
-     *         console.log(this.settings); // {rootDir, port, httpsPort,...}
-     *     }
-     * }
-     * ```
-     *
-     * @returns {PlatformConfiguration}
-     */
-    get settings(): import("@tsed/di").DIConfiguration;
-    get logger(): import("@tsed/di").DILogger;
-    get disableBootstrapLog(): any;
-    static create<App = TsED.Application>(module: Type<any>, settings: PlatformBuilderSettings<App>): PlatformBuilder<App>;
-    static build<App = TsED.Application>(module: Type<any>, { adapter, ...settings }: PlatformBuilderSettings<App>): PlatformBuilder<App>;
-    /**
-     * Bootstrap a server application
-     * @param module
-     * @param settings
-     */
-    static bootstrap<App = TsED.Application>(module: Type<any>, settings: PlatformBuilderSettings<App>): Promise<PlatformBuilder<App>>;
-    callback(): (req: IncomingMessage, res: ServerResponse) => void;
-    callback(req: IncomingMessage, res: ServerResponse): void;
-    log(...data: any[]): any;
-    /**
-     * Add classes decorated by @@Controller@@ to components container.
-     *
-     * ### Example
-     *
-     * ```typescript
-     * @Controller('/ctrl')
-     * class MyController{
-     * }
-     *
-     * platform.addControllers('/rest', [MyController])
-     * ```
-     *
-     * ::: tip
-     * If the MyController class isn't decorated, the class will be ignored.
-     * :::
-     *
-     * @param {string} endpoint
-     * @param {any[]} controllers
-     */
-    addControllers(endpoint: string, controllers: TokenProvider | TokenProvider[]): void;
-    runLifecycle(): Promise<this>;
-    loadInjector(): Promise<void>;
-    listen(network?: boolean): Promise<void>;
-    stop(): Promise<void>;
-    ready(): Promise<void>;
-    callHook(hook: string, ...args: any[]): Promise<void>;
-    loadStatics(hook: string): void;
-    useProvider(token: Type<any>, settings?: Partial<ProviderOpts>): this;
-    bootstrap(): Promise<this>;
-    protected mapRouters(): Promise<void>;
-    protected diff(): string;
-    /**
-     * Load middlewares from configuration for the given hook
-     * @param hook
-     * @protected
-     */
-    protected loadMiddlewaresFor(hook: string): void;
-    protected createHttpServers(): void;
-    protected listenServers(): Promise<void>;
-    protected logRoutes(layers: PlatformLayer[]): Promise<void>;
-    protected mapTokenMiddlewares(): Promise<void>;
-}

package/lib/types-esm/config/interfaces/PlatformJsonMapperSettings.d.ts

@@ -1,10 +0,0 @@
-import { JsonMapperGlobalOptions } from "@tsed/json-mapper";
-export interface PlatformJsonMapperSettings extends JsonMapperGlobalOptions {
-}
-declare global {
-    namespace TsED {
-        interface Configuration extends Record<string, any> {
-            jsonMapper?: PlatformJsonMapperSettings;
-        }
-    }
-}

package/lib/types-esm/config/interfaces/PlatformMulterSettings.d.ts

@@ -1,14 +0,0 @@
-import type multer from "multer";
-declare global {
-    namespace TsED {
-        type MulterFile = Express.Multer.File;
-        type MulterStorageEngine = multer.StorageEngine;
-        type MulterOptions = multer.Options;
-        type MulterField = multer.Field;
-        type Multer = multer.Multer;
-    }
-}
-export type PlatformMulter = TsED.Multer;
-export type PlatformMulterSettings = TsED.MulterOptions;
-export type PlatformMulterFile = TsED.MulterFile;
-export type PlatformMulterField = TsED.MulterField;

package/lib/types-esm/config/interfaces/PlatformRouterSettings.d.ts

@@ -1,10 +0,0 @@
-export interface PlatformRouterSettings {
-    appendChildrenRoutesFirst?: boolean;
-}
-declare global {
-    namespace TsED {
-        interface Configuration extends Record<string, any> {
-            router?: PlatformRouterSettings;
-        }
-    }
-}

package/lib/types-esm/config/interfaces/PlatformStaticsSettings.d.ts

@@ -1,17 +0,0 @@
-declare global {
-    namespace TsED {
-        interface StaticsOptions {
-            root: string;
-            hook?: "$beforeRoutesInit" | "$afterRoutesInit";
-            [key: string]: any;
-        }
-    }
-}
-export interface PlatformStaticsOptions extends TsED.StaticsOptions {
-    root: string;
-    [key: string]: any;
-}
-export type PathOrStaticsOptions = string | PlatformStaticsOptions;
-export interface PlatformStaticsSettings {
-    [endpoint: string]: PathOrStaticsOptions | PathOrStaticsOptions[];
-}

package/lib/types-esm/config/services/PlatformConfiguration.d.ts

@@ -1,67 +0,0 @@
-/// <reference types="node" />
-import { getHostInfoFromPort } from "@tsed/core";
-import { DIConfiguration, TokenProvider } from "@tsed/di";
-import Https from "https";
-import { PlatformJsonMapperSettings } from "../interfaces/PlatformJsonMapperSettings.js";
-/**
- * `PlatformConfiguration` contains all information about your Server configuration.
- */
-export declare class PlatformConfiguration extends DIConfiguration {
-    constructor();
-    get port(): string | number | false;
-    set port(value: string | number | false);
-    get httpsOptions(): Https.ServerOptions;
-    set httpsOptions(value: Https.ServerOptions);
-    get httpPort(): string | number | false;
-    set httpPort(value: string | number | false);
-    get httpsPort(): string | number | false;
-    set httpsPort(value: string | number | false);
-    get mount(): Record<string, TokenProvider[]>;
-    set mount(value: Record<string, TokenProvider[]>);
-    get statics(): Record<string, (any | string)[]>;
-    set statics(value: Record<string, (any | string)[]>);
-    get acceptMimes(): string[];
-    set acceptMimes(value: string[]);
-    get jsonMapper(): Partial<PlatformJsonMapperSettings>;
-    set jsonMapper(options: Partial<PlatformJsonMapperSettings>);
-    get additionalProperties(): boolean;
-    /**
-     *
-     * @returns {string|number}
-     */
-    getHttpPort(): ReturnType<typeof getHostInfoFromPort>;
-    /**
-     *
-     * @param settings
-     */
-    setHttpPort(settings: {
-        address: string;
-        port: number;
-    }): void;
-    /**
-     *
-     * @returns {string|number}
-     */
-    getHttpsPort(): {
-        protocol: string;
-        address: string;
-        port: number;
-        toString(): string;
-    };
-    /**
-     *
-     * @param settings
-     */
-    setHttpsPort(settings: {
-        address: string;
-        port: number;
-    }): void;
-    getBestHost(): {
-        protocol: string;
-        address: string;
-        port: number;
-        toString(): string;
-    } | {
-        toString(): string;
-    };
-}

package/lib/types-esm/constants/routerOptions.d.ts

@@ -1 +0,0 @@
-export declare const ROUTER_OPTIONS: unique symbol;

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

@@ -1,3 +0,0 @@
-import { Type } from "@tsed/core";
-import { PlatformAdapter } from "../services/PlatformAdapter.js";
-export declare function PlatformProvider(): (klass: Type<PlatformAdapter>) => void;

package/lib/types-esm/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/types-esm/decorators/multer/multerOptions.d.ts

@@ -1,41 +0,0 @@
-import { PlatformMulterSettings } from "../../config/interfaces/PlatformMulterSettings.js";
-/**
- * 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/types-esm/decorators/multer/multipartFile.d.ts

@@ -1,47 +0,0 @@
-import { PlatformMulterFile } from "../../config/interfaces/PlatformMulterSettings.js";
-/**
- * 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 type MultipartFile = PlatformMulterFile;

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

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

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

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

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

@@ -1,80 +0,0 @@
-/// <reference types="node" />
-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-esm/domain/PlatformRouteDetails.d.ts

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

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

@@ -1,11 +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-middlewares";
-export * from "@tsed/platform-log-middleware";
-export * from "@tsed/platform-router";
-export { $log, Logger } from "@tsed/logger";
-export { AcceptMime, Location, Redirect, View, Get, Post, Put, Patch, Delete, Head, Options, All } from "@tsed/schema";

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

@@ -1,63 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./builder/PlatformBuilder.js";
-export * from "./config/interfaces/PlatformJsonMapperSettings.js";
-export * from "./config/interfaces/PlatformMulterSettings.js";
-export * from "./config/interfaces/PlatformRouterSettings.js";
-export * from "./config/interfaces/PlatformStaticsSettings.js";
-export * from "./config/services/PlatformConfiguration.js";
-export * from "./constants/routerOptions.js";
-export * from "./decorators/multer/multerFileSize.js";
-export * from "./decorators/multer/multerOptions.js";
-export * from "./decorators/multer/multipartFile.js";
-export * from "./decorators/params/error.js";
-export * from "./decorators/params/next.js";
-export * from "./decorators/params/request.js";
-export * from "./decorators/params/response.js";
-export * from "./decorators/PlatformProvider.js";
-export * from "./domain/AnyToPromiseWithCtx.js";
-export * from "./domain/EndpointMetadata.js";
-export * from "./domain/PlatformContext.js";
-export * from "./domain/PlatformRouteDetails.js";
-export * from "./exports.js";
-export * from "./interfaces/AfterInit.js";
-export * from "./interfaces/AfterListen.js";
-export * from "./interfaces/AfterRoutesInit.js";
-export * from "./interfaces/BeforeInit.js";
-export * from "./interfaces/BeforeListen.js";
-export * from "./interfaces/BeforeRoutesInit.js";
-export * from "./interfaces/HandlerType.js";
-export * from "./interfaces/IncomingEvent.js";
-export * from "./interfaces/OnReady.js";
-export * from "./interfaces/OnRequest.js";
-export * from "./interfaces/OnResponse.js";
-export * from "./interfaces/OnRoutesInit.js";
-export * from "./interfaces/PlatformRouteOptions.js";
-export * from "./interfaces/ResponseErrorObject.js";
-export * from "./interfaces/Route.js";
-export * from "./middlewares/PlatformAcceptMimesMiddleware.js";
-export * from "./middlewares/PlatformMulterMiddleware.js";
-export * from "./services/FakeAdapter.js";
-export * from "./services/FakeResponse.js";
-export * from "./services/Platform.js";
-export * from "./services/PlatformAdapter.js";
-export * from "./services/PlatformApplication.js";
-export * from "./services/PlatformHandler.js";
-export * from "./services/PlatformMiddlewaresChain.js";
-export * from "./services/PlatformRequest.js";
-export * from "./services/PlatformResponse.js";
-export * from "./services/PlatformTest.js";
-export * from "./utils/closeServer.js";
-export * from "./utils/createContext.js";
-export * from "./utils/createHttpServer.js";
-export * from "./utils/createHttpsServer.js";
-export * from "./utils/createInjector.js";
-export * from "./utils/createServer.js";
-export * from "./utils/ensureContext.js";
-export * from "./utils/getStaticsOptions.js";
-export * from "./utils/listenServer.js";
-export * from "./utils/mapReturnedResponse.js";
-export * from "./utils/printRoutes.js";
-export * from "./utils/registerPlatformAdapter.js";
-export * from "./utils/setResponseHeaders.js";

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

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

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

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

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

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

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

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