@tsed/common 6.95.6 → 6.95.10

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

@@ -1,97 +0,0 @@
-/// <reference types="node" />
-import { Env } from "@tsed/core";
-import { ConverterSettings } from "./ConverterSettings";
-import { EndpointDirectoriesSettings } from "./EndpointDirectoriesSettings";
-import { PlatformLoggerSettings } from "./PlatformLoggerSettings";
-import { PlatformMulterSettings } from "./PlatformMulterSettings";
-import { PlatformStaticsSettings } from "./PlatformStaticsSettings";
-import type Http from "http";
-import type Https from "https";
-declare global {
-    namespace TsED {
-        interface LoggerConfiguration extends Partial<PlatformLoggerSettings> {
-        }
-        interface Configuration {
-            /**
-             * The root directory where you build run project. By default, it's equal to `process.cwd().
-             */
-            rootDir: string;
-            /**
-             * The environment profile. By default the environment profile is equals to `NODE_ENV`.
-             */
-            env: Env;
-            /**
-             * Port number for the [HTTP.Server](https://nodejs.org/api/http.html#http_class_http_server).
-             */
-            port: string | number;
-            /**
-             * Port number for the [HTTP.Server](https://nodejs.org/api/http.html#http_class_http_server).
-             */
-            httpPort: string | number | boolean;
-            /**
-             * [Https.ServerOptions](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener)):
-             * - `key` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | &lt;Object[]&gt;: The private key of the server in PEM format. To support multiple keys using different algorithms an array can be provided either as a plain array of key strings or an array of objects in the format `{pem: key, passphrase: passphrase}`. This option is required for ciphers that make use of private keys.
-             * - `passphrase` &lt;string&gt; A string containing the passphrase for the private key or pfx.
-             * - `cert` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers containing the certificate key of the server in PEM format. (Required)
-             * - `ca` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers of trusted certificates in PEM format. If this is omitted several well known "root" CAs (like VeriSign) will be used. These are used to authorize connections.
-             */
-            httpOptions: Http.ServerOptions;
-            /**
-             * Port number for the [HTTPs.Server](https://nodejs.org/api/https.html#https_class_https_server).
-             */
-            httpsPort: string | number | boolean;
-            /**
-             * [Https.ServerOptions](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener)):
-             * - `key` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | &lt;Object[]&gt;: The private key of the server in PEM format. To support multiple keys using different algorithms an array can be provided either as a plain array of key strings or an array of objects in the format `{pem: key, passphrase: passphrase}`. This option is required for ciphers that make use of private keys.
-             * - `passphrase` &lt;string&gt; A string containing the passphrase for the private key or pfx.
-             * - `cert` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers containing the certificate key of the server in PEM format. (Required)
-             * - `ca` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers of trusted certificates in PEM format. If this is omitted several well known "root" CAs (like VeriSign) will be used. These are used to authorize connections.
-             */
-            httpsOptions: Https.ServerOptions;
-            /**
-             * Mount all controllers under a directories to an endpoint.
-             */
-            mount: EndpointDirectoriesSettings;
-            /**
-             * List of directories to scan [Services](/docs/services.md), [Middlewares](/docs/middlewares.md) or [Converters](/docs/converters.md).
-             */
-            componentsScan: (string | RegExp)[];
-            /**
-             * Disable the glob pattern. In v7 the componentsScan options will be removed in favor of external module loader.
-             */
-            disableComponentsScan: boolean;
-            /**
-             * List of glob patterns. Exclude all files which matching with this list when Server scan all components with the `mount` or `scanComponents` options.
-             */
-            exclude: string[];
-            /**
-             * Configure the mimes accepted by default by the server.
-             */
-            acceptMimes: string[];
-            /**
-             * Enable debug mode. By default debug is false.
-             */
-            debug: boolean;
-            /**
-             * Converter configuration.
-             */
-            converter: Partial<ConverterSettings>;
-            /**
-             * Logger configuration.
-             */
-            logger?: LoggerConfiguration;
-            /**
-             * Object to mount all directories under to his endpoints. See more on [Serve Static](/tutorials/serve-static-files.md).
-             */
-            statics: PlatformStaticsSettings;
-            /**
-             * Object configure Multer. See more on [Upload file](/tutorials/serve-static-files.md).
-             */
-            multer: PlatformMulterSettings;
-        }
-    }
-}
-export * from "./PlatformLoggerSettings";
-export * from "./EndpointDirectoriesSettings";
-export * from "./PlatformStaticsSettings";
-export * from "./PlatformMulterSettings";

package/lib/cjs/config/services/PlatformConfiguration.d.ts

@@ -1,81 +0,0 @@
-/// <reference types="node" />
-import { Env, getHostInfoFromPort } from "@tsed/core";
-import { DIConfiguration } from "@tsed/di";
-import Https from "https";
-import { EndpointDirectoriesSettings, PlatformLoggerSettings } from "../interfaces";
-import { ConverterSettings } from "../interfaces/ConverterSettings";
-/**
- * `PlatformConfiguration` contains all information about your Server configuration.
- */
-export declare class PlatformConfiguration extends DIConfiguration {
-    constructor();
-    get version(): string;
-    set version(v: string);
-    get rootDir(): string;
-    set rootDir(value: string);
-    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 env(): Env;
-    set env(value: Env);
-    get mount(): EndpointDirectoriesSettings;
-    set mount(value: EndpointDirectoriesSettings);
-    get componentsScan(): string[];
-    set componentsScan(value: string[]);
-    get statics(): EndpointDirectoriesSettings;
-    set statics(value: EndpointDirectoriesSettings);
-    get acceptMimes(): string[];
-    set acceptMimes(value: string[]);
-    get debug(): boolean;
-    set debug(debug: boolean);
-    get converter(): Partial<ConverterSettings>;
-    set converter(options: Partial<ConverterSettings>);
-    get logger(): Partial<PlatformLoggerSettings>;
-    set logger(value: Partial<PlatformLoggerSettings>);
-    get exclude(): string[];
-    set exclude(exclude: string[]);
-    /**
-     *
-     * @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/cjs/constants/routerOptions.d.ts

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

package/lib/cjs/decorators/httpServer.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="node" />
-import { Type } from "@tsed/core";
-import Http from "http";
-/**
- * Inject the Http.Server instance.
- *
- * ### Example
- *
- * ```typescript
- * import {HttpServer, Service} from "@tsed/common";
- *
- * @Service()
- * export default class OtherService {
- *    constructor(@HttpServer httpServer: HttpServer) {}
- * }
- * ```
- *
- * > Note: TypeScript transform and store `HttpServer` as `Function` type in the metadata. So to inject a factory, you must use the `@Inject(type)` decorator.
- *
- * @param {Type<any>} target
- * @param {string} targetKey
- * @param {TypedPropertyDescriptor<Function> | number} descriptor
- * @returns {any}
- * @decorator
- * @deprecated Use Https.Server from "http"
- */
-export declare function HttpServer(target: Type<any>, targetKey: string, descriptor: TypedPropertyDescriptor<Function> | number): any;
-export declare type HttpServer = Http.Server;

package/lib/cjs/decorators/httpsServer.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="node" />
-import { Type } from "@tsed/core";
-import Https from "https";
-/**
- * Inject the Https.Server instance.
- *
- * ### Example
- *
- * ```typescript
- * import {HttpsServer, Service} from "@tsed/common";
- *
- * @Service()
- * export default class OtherService {
- *    constructor(@HttpsServer httpServer: HttpServer) {}
- * }
- * ```
- *
- * > Note: TypeScript transform and store `HttpsServer` as `Function` type in the metadata. So to inject a factory, you must use the `@Inject(type)` decorator.
- *
- * @param {Type<any>} target
- * @param {string} targetKey
- * @param {TypedPropertyDescriptor<Function> | number} descriptor
- * @returns {any}
- * @decorator
- * @deprecated Use Https.Server from "https"
- */
-export declare function HttpsServer(target: Type<any>, targetKey: string, descriptor: TypedPropertyDescriptor<Function> | number): any;
-export declare type HttpsServer = Https.Server;

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

@@ -1,16 +0,0 @@
-export * from "./httpServer";
-export * from "./httpsServer";
-export * from "./multer";
-export * from "./method/route";
-export * from "./method/acceptMime";
-export * from "./method/location";
-export * from "./method/redirect";
-export * from "./method/endpointFn";
-export * from "./method/view";
-export * from "./params/responseData";
-export * from "./params/response";
-export * from "./params/request";
-export * from "./params/next";
-export * from "./params/error";
-export * from "./params/endpointInfo";
-export * from "../utils/mapReturnedResponse";

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