@tsed/common 6.95.9 → 6.96.2

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

@@ -1,161 +0,0 @@
-/// <reference types="node" />
-import { ServerResponse } from "http";
-import { IncomingEvent } from "../interfaces/IncomingEvent";
-import type { PlatformRequest } from "./PlatformRequest";
-import type { PlatformContext } from "../domain/PlatformContext";
-declare global {
-    namespace TsED {
-        interface Response {
-        }
-    }
-}
-export declare type HeaderValue = Array<boolean | number | string> | boolean | number | string;
-/**
- * Platform Response abstraction layer.
- * @platform
- */
-export declare class PlatformResponse<T extends Record<string, any> = any> {
-    protected $ctx: PlatformContext;
-    /**
-     * The current @@PlatformRequest@@.
-     */
-    request: PlatformRequest;
-    data: any;
-    raw: T;
-    constructor({ response }: IncomingEvent, $ctx: PlatformContext);
-    /**
-     * Get the current statusCode
-     */
-    get statusCode(): any;
-    /**
-     * An object that contains response local variables scoped to the request, and therefore available only to the view(s) rendered during that request / response cycle (if any). Otherwise, this property is identical to app.locals.
-     *
-     * This property is useful for exposing request-level information such as the request path name, authenticated user, user settings, and so on.
-     */
-    get locals(): any;
-    /**
-     * Return the original response framework instance
-     */
-    get response(): T;
-    /**
-     * Return the original response node.js instance
-     */
-    get res(): ServerResponse;
-    static onFinished(res: any, cb: Function): void;
-    /**
-     * Returns the HTTP response header specified by field. The match is case-insensitive.
-     *
-     * ```typescript
-     * response.get('Content-Type') // => "text/plain"
-     * ```
-     *
-     * @param name
-     */
-    get(name: string): any;
-    getHeaders(): Record<string, HeaderValue>;
-    /**
-     * Return the Framework response object (express, koa, etc...)
-     */
-    getResponse<Res = T>(): Res;
-    /**
-     * Return the Node.js response object
-     */
-    getRes(): ServerResponse;
-    hasStatus(): boolean;
-    /**
-     * Sets the HTTP status for the response.
-     *
-     * @param status
-     */
-    status(status: number): this;
-    /**
-     * Set header `field` to `val`, or pass
-     * an object of header fields.
-     *
-     * Examples:
-     * ```typescript
-     * response.setHeaders({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
-     * ```
-     *
-     * Aliased as `res.header()`.
-     */
-    setHeaders(headers: Record<string, HeaderValue>): this;
-    setHeader(key: string, item: any): this;
-    /**
-     * Set `Content-Type` response header with `type` through `mime.lookup()`
-     * when it does not contain "/", or set the Content-Type to `type` otherwise.
-     *
-     * Examples:
-     *
-     *     res.type('.html');
-     *     res.type('html');
-     *     res.type('json');
-     *     res.type('application/json');
-     *     res.type('png');
-     */
-    contentType(contentType: string): this;
-    contentLength(length: number): this;
-    getContentLength(): number | undefined;
-    getContentType(): any;
-    /**
-     * Sets the HTTP response Content-Disposition header field to “attachment”.
-     * If a filename is given, then it sets the Content-Type based on the extension name via res.type(), and sets the Content-Disposition “filename=” parameter.
-     *
-     * ```typescript
-     * res.attachment()
-     * // Content-Disposition: attachment
-     *
-     * res.attachment('path/to/logo.png')
-     * // Content-Disposition: attachment; filename="logo.png"
-     * // Content-Type: image/png
-     * ```
-     *
-     * @param filename
-     */
-    attachment(filename: string): this;
-    /**
-     * Redirects to the URL derived from the specified path, with specified status, a positive integer that corresponds to an [HTTP status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
-     * If not specified, status defaults to `302 Found`.
-     *
-     * @param status
-     * @param url
-     */
-    redirect(status: number, url: string): this;
-    /**
-     * Sets the response Location HTTP header to the specified path parameter.
-     *
-     * @param location
-     */
-    location(location: string): this;
-    /**
-     * Stream the given data.
-     *
-     * @param data
-     */
-    stream(data: ReadableStream | any): this;
-    /**
-     * Renders a view and sends the rendered HTML string to the client.
-     *
-     * @param path
-     * @param options
-     */
-    render(path: string, options?: any): Promise<any>;
-    /**
-     * Send any data to your consumer.
-     *
-     * This method accept a ReadableStream, a plain object, boolean, string, number, null and undefined data.
-     * It choose the better way to send the data.
-     *
-     * @param data
-     */
-    body(data: any): this;
-    getBody(): any;
-    /**
-     * Add a listener to handler the end of the request/response.
-     * @param cb
-     */
-    onEnd(cb: Function): this;
-    isDone(): boolean;
-    destroy(): void;
-    isHeadersSent(): boolean;
-}

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

@@ -1,48 +0,0 @@
-import { InjectorService, PathType } from "@tsed/di";
-import { PlatformMulter, PlatformMulterSettings, PlatformStaticsOptions } from "../config";
-import { PlatformRouteOptions, PlatformRouteWithoutHandlers } from "../interfaces";
-import { PlatformHandler } from "./PlatformHandler";
-/**
- * @ignore
- */
-export declare const PLATFORM_ROUTER_OPTIONS: unique symbol;
-declare global {
-    namespace TsED {
-        interface Router {
-        }
-    }
-}
-/**
- * Platform Router abstraction layer.
- * @platform
- */
-export declare class PlatformRouter<Router = TsED.Router> {
-    protected platformHandler: PlatformHandler;
-    rawRouter: Router;
-    raw: any;
-    isBuilt: boolean;
-    injector: InjectorService;
-    constructor(platformHandler: PlatformHandler);
-    /**
-     * Create a new instance of PlatformRouter
-     * @param injector
-     * @param routerOptions
-     */
-    static create(injector: InjectorService, routerOptions?: any): PlatformRouter<TsED.Router>;
-    protected static createRawRouter(): any;
-    callback(): any;
-    getRouter(): Router;
-    use(...handlers: any[]): this;
-    addRoute(options: Partial<PlatformRouteOptions>): this;
-    all(path: PathType, ...handlers: any[]): this;
-    get(path: PathType, ...handlers: any[]): this;
-    post(path: PathType, ...handlers: any[]): this;
-    put(path: PathType, ...handlers: any[]): this;
-    delete(path: PathType, ...handlers: any[]): this;
-    patch(path: PathType, ...handlers: any[]): this;
-    head(path: PathType, ...handlers: any[]): this;
-    options(path: PathType, ...handlers: any[]): this;
-    statics(path: string, options: PlatformStaticsOptions): this;
-    multer(options: PlatformMulterSettings): PlatformMulter;
-    protected mapHandlers(handlers: any[], options?: PlatformRouteWithoutHandlers): any[];
-}

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

@@ -1,58 +0,0 @@
-import { DITest, InjectorService } from "@tsed/di";
-import { PlatformContext, PlatformContextOptions } from "../domain/PlatformContext";
-import { PlatformAdapter, PlatformBuilderSettings } from "../interfaces/PlatformAdapter";
-import { Type } from "@tsed/core";
-/**
- * @platform
- */
-export declare class PlatformTest extends DITest {
-    static adapter: Type<PlatformAdapter>;
-    static create(settings?: Partial<TsED.Configuration>): Promise<void>;
-    /**
-     * Create a new injector with the right default services
-     */
-    static createInjector(settings?: any): InjectorService;
-    /**
-     * Load the server silently without listening port and configure it on test profile.
-     * @decorator
-     * @param mod
-     * @param listen
-     * @param settings
-     * @returns {Promise<void>}
-     */
-    static bootstrap(mod: any, { listen, ...settings }?: Partial<PlatformBuilderSettings & {
-        listen: boolean;
-    }>): () => Promise<void>;
-    /**
-     * It injects services into the test function where you can alter, spy on, and manipulate them.
-     *
-     * The inject function has two parameters
-     *
-     * * an array of Service dependency injection tokens,
-     * * a test function whose parameters correspond exactly to each item in the injection token array.
-     *
-     * @param targets
-     * @param func
-     */
-    static inject<T>(targets: any[], func: (...args: any[]) => Promise<T> | T): () => Promise<T>;
-    /**
-     * Return the raw application (express or koa).
-     * Use this callback with SuperTest.
-     *
-     * ```typescript
-     * let request: SuperTest.SuperTest<SuperTest.Test>;
-     * beforeEach(PlatformTest.bootstrap(Server, {
-     *   mount: {
-     *     "/rest": [ProductsController]
-     *   }
-     * }));
-     * beforeEach(() => {
-     *   request = SuperTest(PlatformTest.callback());
-     * });
-     * ```
-     */
-    static callback(): any;
-    static createRequest(options?: any): any;
-    static createResponse(options?: any): any;
-    static createRequestContext(options?: Partial<PlatformContextOptions & any>): PlatformContext;
-}

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

@@ -1,8 +0,0 @@
-export * from "./Platform";
-export * from "./PlatformApplication";
-export * from "./PlatformHandler";
-export * from "./PlatformRequest";
-export * from "./PlatformResponse";
-export * from "./PlatformRouter";
-export * from "./PlatformTest";
-export * from "./PlatformMiddlewaresChain";

package/lib/cjs/utils/createContext.d.ts

@@ -1,9 +0,0 @@
-import { InjectorService } from "@tsed/di";
-import { PlatformContext } from "../domain/PlatformContext";
-import { IncomingEvent } from "../interfaces/IncomingEvent";
-/**
- * Create the TsED context to wrap request, response, injector, etc...
- * @param injector
- * @ignore
- */
-export declare function createContext(injector: InjectorService): (event: IncomingEvent) => Promise<PlatformContext>;

package/lib/cjs/utils/createHandlerMetadata.d.ts

@@ -1,8 +0,0 @@
-import { InjectorService } from "@tsed/di";
-import { EndpointMetadata } from "../domain/EndpointMetadata";
-import { HandlerMetadata } from "../domain/HandlerMetadata";
-import { PlatformRouteWithoutHandlers } from "../interfaces/PlatformRouteOptions";
-/**
- * @ignore
- */
-export declare function createHandlerMetadata(injector: InjectorService, obj: any | EndpointMetadata, routeOptions?: PlatformRouteWithoutHandlers): HandlerMetadata;

package/lib/cjs/utils/createHttpServer.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import { InjectorService } from "@tsed/di";
-import Http from "http";
-export declare function createHttpServer(injector: InjectorService, requestListener: Http.RequestListener): (() => Promise<void>) | undefined;

package/lib/cjs/utils/createHttpsServer.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import { InjectorService } from "@tsed/di";
-import Http from "http";
-export declare function createHttpsServer(injector: InjectorService, requestListener?: Http.RequestListener): (() => Promise<void>) | undefined;

package/lib/cjs/utils/createInjector.d.ts

@@ -1,7 +0,0 @@
-import { InjectorService, IProvider } from "@tsed/di";
-interface CreateInjectorOptions {
-    providers?: IProvider[];
-    settings?: Partial<TsED.Configuration>;
-}
-export declare function createInjector({ providers, settings }: CreateInjectorOptions): InjectorService;
-export {};

package/lib/cjs/utils/getConfiguration.d.ts

@@ -1,2 +0,0 @@
-import { Type } from "@tsed/core";
-export declare function getConfiguration(configuration?: any, module?: Type<any> | null): any;

package/lib/cjs/utils/getStaticsOptions.d.ts

@@ -1,5 +0,0 @@
-import { PlatformStaticsOptions, PlatformStaticsSettings } from "../config/interfaces/PlatformStaticsSettings";
-export declare function getStaticsOptions(statics?: PlatformStaticsSettings): {
-    path: string;
-    options: PlatformStaticsOptions;
-}[];

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

@@ -1,8 +0,0 @@
-export * from "./createInjector";
-export * from "./createHttpServer";
-export * from "./createHttpsServer";
-export * from "./loadInjector";
-export * from "./printRoutes";
-export * from "./listenServer";
-export * from "./createContext";
-export * from "./useCtxHandler";

package/lib/cjs/utils/listenServer.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="node" />
-import type Http from "http";
-import type Https from "https";
-import type Http2 from "http2";
-import { InjectorService } from "@tsed/di";
-import { getHostInfoFromPort } from "@tsed/core";
-export declare function listenServer(injector: InjectorService, server: Http.Server | Https.Server | Http2.Http2Server, hostInfo: ReturnType<typeof getHostInfoFromPort>): Promise<ReturnType<typeof getHostInfoFromPort>>;

package/lib/cjs/utils/loadInjector.d.ts

@@ -1,6 +0,0 @@
-import { Container, InjectorService, LocalsContainer } from "@tsed/di";
-/**
- * @ignore
- * @deprecated User injector.load(container, module) instead
- */
-export declare function loadInjector(injector: InjectorService, container?: Container): Promise<LocalsContainer<any>>;

package/lib/cjs/utils/mapReturnedResponse.d.ts

@@ -1,4 +0,0 @@
-/**
- * @ignore
- */
-export declare function mapReturnedResponse({ use, collection, ...options }: any): any;

package/lib/cjs/utils/printRoutes.d.ts

@@ -1,2 +0,0 @@
-import { PlatformRouteDetails } from "../domain/PlatformRouteDetails";
-export declare function printRoutes(routes: PlatformRouteDetails[]): string;

package/lib/cjs/utils/setResponseHeaders.d.ts

@@ -1,5 +0,0 @@
-import { PlatformContext } from "../domain/PlatformContext";
-/**
- * @ignore
- */
-export declare function setResponseHeaders(ctx: PlatformContext): void;

package/lib/cjs/utils/useCtxHandler.d.ts

@@ -1,13 +0,0 @@
-import { PlatformContext } from "../domain/PlatformContext";
-import { HandlerType } from "../interfaces/HandlerType";
-export declare type PlatformCtxHandler = ($ctx: PlatformContext) => any | Promise<any>;
-/**
- * Create Ts.ED context handler
- * @param fn
- * @ignore
- */
-export declare function useCtxHandler(fn: PlatformCtxHandler & {
-    type?: HandlerType;
-}): PlatformCtxHandler & {
-    type?: HandlerType | undefined;
-};