@tsed/platform-express 6.95.7 → 6.96.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/platform-express",
-  "version": "6.95.7",
+  "version": "6.96.0",
   "description": "A TypeScript Framework on top of Express",
   "private": false,
   "source": "./src/index.ts",
@@ -54,10 +54,10 @@
     "tslib": "2.2.0"
   },
   "devDependencies": {
-    "@tsed/common": "6.95.7",
-    "@tsed/core": "6.95.7",
-    "@tsed/di": "6.95.7",
-    "@tsed/platform-test-utils": "6.95.7",
+    "@tsed/common": "6.96.0",
+    "@tsed/core": "6.96.0",
+    "@tsed/di": "6.96.0",
+    "@tsed/platform-test-utils": "6.96.0",
     "@types/body-parser": "1.19.0",
     "@types/compression": "1.7.0",
     "@types/cookie-parser": "1.4.2",
@@ -73,13 +73,13 @@
     "method-override": "3.0.0"
   },
   "peerDependencies": {
-    "@tsed/common": "^6.95.7",
-    "@tsed/core": "^6.95.7",
-    "@tsed/di": "^6.95.7",
-    "@tsed/json-mapper": "^6.95.7",
+    "@tsed/common": "^6.96.0",
+    "@tsed/core": "^6.96.0",
+    "@tsed/di": "^6.96.0",
+    "@tsed/json-mapper": "^6.96.0",
     "@tsed/logger": ">=6.0.0",
-    "@tsed/openspec": "^6.95.7",
-    "@tsed/schema": "^6.95.7",
+    "@tsed/openspec": "^6.96.0",
+    "@tsed/schema": "^6.96.0",
     "@types/multer": "^1.4.5",
     "body-parser": "1.19.0"
   }

package/lib/cjs/components/PlatformExpress.d.ts

@@ -1,42 +0,0 @@
-import Express from "express";
-import { PlatformAdapter, PlatformBuilder, PlatformHandler, PlatformRequest, PlatformResponse, PlatformRouter } from "@tsed/common";
-import { Type } from "@tsed/core";
-import { PlatformExpressHandler, PlatformExpressRequest, PlatformExpressResponse, PlatformExpressRouter } from "../services";
-/**
- * @platform
- * @express
- */
-export declare class PlatformExpress implements PlatformAdapter<Express.Application, Express.Router> {
-    private platform;
-    readonly providers: ({
-        provide: typeof PlatformRouter;
-        useClass: typeof PlatformExpressRouter;
-    } | {
-        provide: typeof PlatformHandler;
-        useClass: typeof PlatformExpressHandler;
-    } | {
-        provide: typeof PlatformResponse;
-        useClass: typeof PlatformExpressResponse;
-    } | {
-        provide: typeof PlatformRequest;
-        useClass: typeof PlatformExpressRequest;
-    })[];
-    constructor(platform: PlatformBuilder<Express.Application, Express.Router>);
-    /**
-     * Create new serverless application. In this mode, the component scan are disabled.
-     * @param module
-     * @param settings
-     */
-    static create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder<Express.Application, Express.Router>;
-    /**
-     * Bootstrap a server application
-     * @param module
-     * @param settings
-     */
-    static bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder<Express.Application, Express.Router>>;
-    useRouter(): this;
-    beforeLoadRoutes(): Promise<void>;
-    afterLoadRoutes(): Promise<void>;
-    useContext(): this;
-    private configureViewsEngine;
-}

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

@@ -1,23 +0,0 @@
-/**
- * Specify the behavior of the router controller.
- *
- * ```typescript
- * @Controller("/")
- * @CaseSensitive(true)
- * class MyCtrl {
- *
- * }
- * ```
- *
- * Property | Description | Default
- * ---|---|---
- * CaseSensitive | Enable case sensitivity. | Disabled by default, treating “/Foo” and “/foo” as the same.
- * MergeParams | Preserve the req.params values from the parent router. If the parent and the child have conflicting param names, the child’s value take precedence. | false
- * Strict | Enable strict routing. | Disabled by default, “/foo” and “/foo/” are treated the same by the router.
- *
- * @param caseSensitive
- * @returns {Function}
- * @decorator
- * @express
- */
-export declare function CaseSensitive(caseSensitive: boolean): Function;

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

@@ -1,4 +0,0 @@
-export * from "./routerSettings";
-export * from "./caseSensitive";
-export * from "./mergeParams";
-export * from "./strict";

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

@@ -1,23 +0,0 @@
-/**
- * Specify the behavior of the router controller.
- *
- * ```typescript
- * @Controller("/")
- * @MergeParams(true)
- * class MyCtrl {
- *
- * }
- * ```
- *
- * Property | Description | Default
- * ---|---|---
- * CaseSensitive | Enable case sensitivity. | Disabled by default, treating “/Foo” and “/foo” as the same.
- * MergeParams | Preserve the req.params values from the parent router. If the parent and the child have conflicting param names, the child’s value take precedence. | false
- * Strict | Enable strict routing. | Disabled by default, “/foo” and “/foo/” are treated the same by the router.
- *
- * @param mergeParams
- * @returns {Function}
- * @decorator
- * @express
- */
-export declare function MergeParams(mergeParams?: boolean): Function;

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

@@ -1,24 +0,0 @@
-import { RouterOptions } from "express";
-/**
- * Specify the behavior of the router controller.
- *
- * ```typescript
- * @Controller("/")
- * @RouterSettings({mergeParams: true})
- * class MyCtrl {
- *
- * }
- * ```
- *
- * Property | Description | Default
- * ---|---|---
- * caseSensitive | Enable case sensitivity. | Disabled by default, treating “/Foo” and “/foo” as the same.
- * mergeParams | Preserve the req.params values from the parent router. If the parent and the child have conflicting param names, the child’s value take precedence. | false
- * strict | Enable strict routing. | Disabled by default, “/foo” and “/foo/” are treated the same by the router.
- *
- * @returns {(target:any)=>void}
- * @decorator
- * @param routerOptions
- * @express
- */
-export declare function RouterSettings(routerOptions: RouterOptions): Function;

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

@@ -1,23 +0,0 @@
-/**
- * Specify the behavior of the router controller.
- *
- * ```typescript
- * @Controller("/")
- * @Strict(true)
- * class MyCtrl {
- *
- * }
- * ```
- *
- * Property | Description |    Default
- * ---|---|---
- * CaseSensitive | Enable case sensitivity. | Disabled by default, treating “/Foo” and “/foo” as the same.
- * MergeParams | Preserve the req.params values from the parent router. If the parent and the child have conflicting param names, the child’s value take precedence. | false
- * Strict | Enable strict routing. | Disabled by default, “/foo” and “/foo/” are treated the same by the router.
- *
- * @param strict
- * @returns {Function}
- * @decorator
- * @express
- */
-export declare function Strict(strict: boolean): Function;

package/lib/cjs/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./interfaces";
-export * from "./decorators";
-export * from "./services";
-export * from "./components/PlatformExpress";

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

@@ -1,9 +0,0 @@
-/// <reference types="express-serve-static-core" />
-import { RouterOptions } from "express";
-export interface PlatformExpressSettings {
-    /**
-     * Global configuration for the Express.Router. See express [documentation](http://expressjs.com/en/api.html#express.router).
-     */
-    router?: RouterOptions;
-    app?: Express.Application;
-}

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

@@ -1,63 +0,0 @@
-import Express from "express";
-export interface PlatformExpressStaticsOptions {
-    /**
-     * Enable or disable setting Cache-Control response header, defaults to true.
-     * Disabling this will ignore the immutable and maxAge options.
-     */
-    cacheControl?: boolean;
-    /**
-     * Set how "dotfiles" are treated when encountered. A dotfile is a file or directory that begins with a dot (".").
-     * Note this check is done on the path itself without checking if the path actually exists on the disk.
-     * If root is specified, only the dotfiles above the root are checked (i.e. the root itself can be within a dotfile when when set to "deny").
-     * The default value is 'ignore'.
-     * 'allow' No special treatment for dotfiles
-     * 'deny' Send a 403 for any request for a dotfile
-     * 'ignore' Pretend like the dotfile does not exist and call next()
-     */
-    dotfiles?: string;
-    /**
-     * Enable or disable etag generation, defaults to true.
-     */
-    etag?: boolean;
-    /**
-     * Set file extension fallbacks. When set, if a file is not found, the given extensions will be added to the file name and search for.
-     * The first that exists will be served. Example: ['html', 'htm'].
-     * The default value is false.
-     */
-    extensions?: string[] | false;
-    /**
-     * Let client errors fall-through as unhandled requests, otherwise forward a client error.
-     * The default value is true.
-     */
-    fallthrough?: boolean;
-    /**
-     * Enable or disable the immutable directive in the Cache-Control response header.
-     * If enabled, the maxAge option should also be specified to enable caching. The immutable directive will prevent supported clients from making conditional requests during the life of the maxAge option to check if the file has changed.
-     */
-    immutable?: boolean;
-    /**
-     * By default this module will send "index.html" files in response to a request on a directory.
-     * To disable this set false or to supply a new index pass a string or an array in preferred order.
-     */
-    index?: boolean | string | string[];
-    /**
-     * Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value.
-     */
-    lastModified?: boolean;
-    /**
-     * Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module.
-     */
-    maxAge?: number | string;
-    /**
-     * Redirect to trailing "/" when the pathname is a dir. Defaults to true.
-     */
-    redirect?: boolean;
-    /**
-     * Function to set custom headers on response. Alterations to the headers need to occur synchronously.
-     * The function is called as fn(res, path, stat), where the arguments are:
-     * res the response object
-     * path the file path that is being sent
-     * stat the stat object of the file that is being sent
-     */
-    setHeaders?: (res: Express.Response, path: string, stat: any) => any;
-}

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

@@ -1,16 +0,0 @@
-import Express from "express";
-import { PlatformExpressSettings } from "./PlatformExpressSettings";
-export * from "./PlatformExpressSettings";
-export * from "./PlatformExpressStaticsOptions";
-declare global {
-    namespace TsED {
-        interface Configuration {
-            /**
-             * Configuration related to Express platform application.
-             */
-            express: PlatformExpressSettings;
-        }
-        interface NextFunction extends Express.NextFunction {
-        }
-    }
-}

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

@@ -1,4 +0,0 @@
-import { Request } from "express";
-export declare function rawBodyMiddleware(request: Request & {
-    rawBody: string;
-}, response: any, next: any): void;

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

@@ -1,4 +0,0 @@
-/**
- * @ignore
- */
-export declare function staticsMiddleware(directory: string, options?: any): (request: any, response: any, next: any) => void;

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

@@ -1,24 +0,0 @@
-import { Configuration, PlatformApplication, PlatformHandler } from "@tsed/common";
-import Express from "express";
-import { PlatformExpressStaticsOptions } from "../interfaces/PlatformExpressStaticsOptions";
-import { PlatformExpressRouter } from "./PlatformExpressRouter";
-declare global {
-    namespace TsED {
-        interface Application extends Express.Application {
-        }
-        interface StaticsOptions extends PlatformExpressStaticsOptions {
-        }
-    }
-}
-/**
- * @platform
- * @express
- */
-export declare class PlatformExpressApplication extends PlatformExpressRouter implements PlatformApplication<Express.Application, Express.Router> {
-    app: Express.Application;
-    rawApp: Express.Application;
-    rawRouter: Express.Router;
-    constructor(platformHandler: PlatformHandler, configuration: Configuration);
-    getApp(): Express.Application;
-    callback(): Express.Application;
-}

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

@@ -1,9 +0,0 @@
-import { HandlerMetadata, OnRequestOptions, PlatformHandler } from "@tsed/common";
-/**
- * @platform
- * @express
- */
-export declare class PlatformExpressHandler extends PlatformHandler {
-    protected createRawHandler(metadata: HandlerMetadata): Function;
-    protected onCtxRequest(requestOptions: OnRequestOptions): Promise<any>;
-}

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

@@ -1,22 +0,0 @@
-import { PlatformContext, PlatformRequest } from "@tsed/common";
-import type Express from "express";
-declare module "express" {
-    interface Request {
-        id: string;
-        $ctx: PlatformContext;
-    }
-}
-declare global {
-    namespace TsED {
-        interface Request extends Express.Request {
-            id: string;
-            $ctx: PlatformContext;
-        }
-    }
-}
-/**
- * @platform
- * @express
- */
-export declare class PlatformExpressRequest extends PlatformRequest<Express.Request> {
-}

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

@@ -1,14 +0,0 @@
-import { PlatformResponse } from "@tsed/common";
-import type Express from "express";
-declare global {
-    namespace TsED {
-        interface Response extends Express.Response {
-        }
-    }
-}
-/**
- * @platform
- * @express
- */
-export declare class PlatformExpressResponse extends PlatformResponse<Express.Response> {
-}

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

@@ -1,18 +0,0 @@
-import { PlatformHandler, PlatformRouter, PlatformStaticsOptions } from "@tsed/common";
-import { Configuration } from "@tsed/di";
-import Express from "express";
-import { RouterOptions } from "express";
-declare global {
-    namespace TsED {
-        interface Router extends Express.Router {
-        }
-    }
-}
-/**
- * @platform
- * @express
- */
-export declare class PlatformExpressRouter extends PlatformRouter<Express.Router> {
-    constructor(platform: PlatformHandler, configuration: Configuration, routerOptions?: Partial<RouterOptions>);
-    statics(endpoint: string, options: PlatformStaticsOptions): this;
-}

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

@@ -1,5 +0,0 @@
-export * from "./PlatformExpressApplication";
-export * from "./PlatformExpressHandler";
-export * from "./PlatformExpressResponse";
-export * from "./PlatformExpressRequest";
-export * from "./PlatformExpressRouter";