@tsed/common 7.0.0-beta.2 → 7.0.0-beta.5

package/lib/types/index.d.ts

@@ -1,20 +1,68 @@
-import "@tsed/logger";
-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";
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./exports";
 export * from "./builder/PlatformBuilder";
 export * from "./builder/PlatformControllerBuilder";
-export * from "./decorators";
+export * from "./config/interfaces/ConverterSettings";
+export * from "./config/interfaces/EndpointDirectoriesSettings";
+export * from "./config/interfaces/PlatformLoggerSettings";
+export * from "./config/interfaces/PlatformMulterSettings";
+export * from "./config/interfaces/PlatformStaticsSettings";
+export * from "./config/services/PlatformConfiguration";
 export * from "./constants/routerOptions";
-export * from "./interfaces";
-export * from "./middlewares";
-export * from "./domain";
-export * from "./services";
-export * from "./utils";
+export * from "./decorators/httpServer";
+export * from "./decorators/httpsServer";
+export * from "./decorators/multer/multerFileSize";
+export * from "./decorators/multer/multerOptions";
+export * from "./decorators/multer/multipartFile";
+export * from "./decorators/params/error";
+export * from "./decorators/params/next";
+export * from "./decorators/params/request";
+export * from "./decorators/params/response";
+export * from "./domain/AnyToPromiseWithCtx";
+export * from "./domain/ControllerProvider";
+export * from "./domain/EndpointMetadata";
+export * from "./domain/HandlerMetadata";
+export * from "./domain/PlatformContext";
+export * from "./domain/PlatformRouteDetails";
+export * from "./interfaces/AfterInit";
+export * from "./interfaces/AfterListen";
+export * from "./interfaces/AfterRoutesInit";
+export * from "./interfaces/BeforeInit";
+export * from "./interfaces/BeforeListen";
+export * from "./interfaces/BeforeRoutesInit";
+export * from "./interfaces/HandlerType";
+export * from "./interfaces/IncomingEvent";
+export * from "./interfaces/OnReady";
+export * from "./interfaces/OnRequest";
+export * from "./interfaces/OnResponse";
+export * from "./interfaces/OnRoutesInit";
+export * from "./interfaces/PlatformRouteOptions";
+export * from "./interfaces/ResponseErrorObject";
+export * from "./interfaces/Route";
+export * from "./middlewares/PlatformAcceptMimesMiddleware";
+export * from "./middlewares/PlatformMulterMiddleware";
+export * from "./middlewares/bindEndpointMiddleware";
+export * from "./services/FakeAdapter";
+export * from "./services/Platform";
+export * from "./services/PlatformAdapter";
+export * from "./services/PlatformApplication";
+export * from "./services/PlatformHandler";
+export * from "./services/PlatformMiddlewaresChain";
+export * from "./services/PlatformRequest";
+export * from "./services/PlatformResponse";
+export * from "./services/PlatformRouter";
+export * from "./services/PlatformTest";
+export * from "./utils/createContext";
+export * from "./utils/createHandlerMetadata";
+export * from "./utils/createHttpServer";
+export * from "./utils/createHttpsServer";
+export * from "./utils/createInjector";
+export * from "./utils/getStaticsOptions";
+export * from "./utils/importProviders";
+export * from "./utils/listenServer";
+export * from "./utils/mapReturnedResponse";
+export * from "./utils/printRoutes";
+export * from "./utils/setResponseHeaders";
+export * from "./utils/useCtxHandler";

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

@@ -1,5 +1,5 @@
 import { Type } from "@tsed/core";
-import { PathType } from "./PathType";
+import { PathType } from "@tsed/di";
 /**
  * @ignore
  */

package/lib/types/middlewares/PlatformMulterMiddleware.d.ts

@@ -1,16 +1,21 @@
+import type { MulterError } from "multer";
+import { BadRequest } from "@tsed/exceptions";
 import { MiddlewareMethods } from "@tsed/platform-middlewares";
 import { Context } from "@tsed/platform-params";
-import { PlatformMulterField, PlatformMulterSettings } from "../config";
+import { PlatformMulterField, PlatformMulterSettings } from "../config/interfaces/PlatformMulterSettings";
 import { PlatformApplication } from "../services/PlatformApplication";
 export interface MulterInputOptions {
     fields: PlatformMulterField[];
 }
+export declare class MulterException extends BadRequest {
+    constructor(er: MulterError);
+}
 /**
  * @middleware
  */
 export declare class PlatformMulterMiddleware implements MiddlewareMethods {
-    settings: PlatformMulterSettings;
-    app: PlatformApplication;
+    protected settings: PlatformMulterSettings;
+    protected app: PlatformApplication;
     use(ctx: Context): Promise<any>;
     protected getFields(conf: MulterInputOptions): {
         name: string;

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

@@ -1,4 +1,5 @@
-import type { EndpointMetadata, PlatformContext } from "../domain";
+import type { EndpointMetadata } from "../domain/EndpointMetadata";
+import type { PlatformContext } from "../domain/PlatformContext";
 /**
  * @ignore
  */

package/lib/types/services/FakeAdapter.d.ts

@@ -0,0 +1,30 @@
+import { ProviderOpts } from "@tsed/di";
+import { PlatformAdapter } from "./PlatformAdapter";
+import { PlatformMulter, PlatformMulterSettings } from "../config/interfaces/PlatformMulterSettings";
+import { PlatformStaticsOptions } from "../config/interfaces/PlatformStaticsSettings";
+export declare class FakeAdapter implements PlatformAdapter<any, any> {
+    providers: ProviderOpts[];
+    static createFakeRawDriver(): {
+        (): void;
+        use: () => any;
+        all: () => any;
+        get: () => any;
+        patch: () => any;
+        post: () => any;
+        put: () => any;
+        head: () => any;
+        delete: () => any;
+        options: () => any;
+    };
+    app(): {
+        app: any;
+        callback(): any;
+    };
+    multipart(options: PlatformMulterSettings): PlatformMulter;
+    router(routerOptions: any): {
+        router: any;
+        callback(): any;
+    };
+    statics(endpoint: string, options: PlatformStaticsOptions): any;
+    bodyParser(type: string): any;
+}

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

@@ -1,5 +1,5 @@
 import { InjectorService, TokenProvider } from "@tsed/di";
-import { PlatformRouteDetails } from "../domain";
+import { PlatformRouteDetails } from "../domain/PlatformRouteDetails";
 import { Route, RouteController } from "../interfaces/Route";
 import { PlatformApplication } from "./PlatformApplication";
 /**
@@ -22,6 +22,10 @@ export declare class Platform {
      * @returns {PlatformRouteDetails[]}
      */
     getRoutes(): PlatformRouteDetails[];
+    /**
+     * Get all controllers mounted on the application.
+     * @returns  {RouteController[]}
+     */
     getMountedControllers(): RouteController[];
     protected $onInit(): void;
     /**
@@ -29,6 +33,11 @@ export declare class Platform {
      * @private
      */
     private createRouters;
+    /**
+     * Get all router controllers from the controller token.
+     * @private
+     */
+    private getAllControllers;
     /**
      * Create controllers from DI
      * @private

package/lib/types/services/PlatformAdapter.d.ts

@@ -0,0 +1,47 @@
+import { Type } from "@tsed/core";
+import { ProviderOpts } from "@tsed/di";
+import { PlatformMulter, PlatformMulterSettings } from "../config/interfaces/PlatformMulterSettings";
+import { PlatformStaticsOptions } from "../config/interfaces/PlatformStaticsSettings";
+import { RouterOptions } from "express";
+export declare abstract class PlatformAdapter<App = TsED.Application, Router = TsED.Router> {
+    /**
+     * Load providers in top priority
+     */
+    providers: ProviderOpts[];
+    /**
+     * Called after the injector instantiation
+     */
+    onInit?: () => any;
+    beforeLoadRoutes?: () => Promise<any>;
+    afterLoadRoutes?: () => Promise<any>;
+    useRouter?: () => any;
+    useContext?: () => any;
+    abstract app(): {
+        app: App;
+        callback(): any;
+    };
+    abstract router(routerOptions?: Partial<RouterOptions>): {
+        router: Router;
+        callback(): any;
+    };
+    /**
+     * Return the statics middlewares
+     * @param endpoint
+     * @param options
+     */
+    abstract statics(endpoint: string, options: PlatformStaticsOptions): any;
+    /**
+     * Return the multipart middleware
+     * @param options
+     */
+    abstract multipart(options: PlatformMulterSettings): PlatformMulter;
+    /**
+     * Return the body parser for the given
+     * @param type
+     * @param opts
+     */
+    abstract bodyParser(type: string, opts?: Record<string, any>): any;
+}
+export interface PlatformBuilderSettings<App = TsED.Application, Router = TsED.Router> extends Partial<TsED.Configuration> {
+    adapter?: Type<PlatformAdapter<App, Router>>;
+}

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

@@ -1,5 +1,6 @@
 import { PlatformHandler } from "./PlatformHandler";
 import { PlatformRouter } from "./PlatformRouter";
+import { PlatformAdapter } from "./PlatformAdapter";
 declare global {
     namespace TsED {
         interface Application {
@@ -11,11 +12,10 @@ declare global {
  *
  * @platform
  */
-export declare class PlatformApplication<App = TsED.Application, Router = TsED.Router> extends PlatformRouter<Router> {
+export declare class PlatformApplication<App = TsED.Application, Router = TsED.Router> extends PlatformRouter<App, Router> {
     raw: App;
     rawApp: App;
     rawRouter: Router;
-    constructor(platformHandler: PlatformHandler);
-    protected static createRawApp(): any;
+    constructor(platformHandler: PlatformHandler, adapter: PlatformAdapter<App, Router>);
     getApp(): App;
 }

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

@@ -1,7 +1,7 @@
 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 { EndpointMetadata } from "@tsed/schema";
 import { HandlerMetadata } from "../domain/HandlerMetadata";
 import { PlatformContext } from "../domain/PlatformContext";
 import { PlatformRouteWithoutHandlers } from "../interfaces/PlatformRouteOptions";

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

@@ -1,6 +1,10 @@
 import { JsonOperationRoute } from "@tsed/schema";
 import { ControllerProvider } from "../domain/ControllerProvider";
-import { EndpointMetadata } from "../domain/EndpointMetadata";
+import { PlatformAdapter } from "../services/PlatformAdapter";
 export declare class PlatformMiddlewaresChain {
-    get(provider: ControllerProvider, operationRoute: JsonOperationRoute<EndpointMetadata>): any[];
+    protected acceptMimes: string[];
+    protected adapter: PlatformAdapter;
+    get(provider: ControllerProvider, operationRoute: JsonOperationRoute, parentMiddlewares?: any[]): any[];
+    protected hasAcceptMimes(operationRoute: JsonOperationRoute): number;
+    protected getParamTypes(middlewares: any[], operationRoute: JsonOperationRoute): any;
 }

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { ServerResponse } from "http";
+import { OutgoingHttpHeaders, ServerResponse } from "http";
 import { IncomingEvent } from "../interfaces/IncomingEvent";
 import type { PlatformRequest } from "./PlatformRequest";
 import type { PlatformContext } from "../domain/PlatformContext";
@@ -41,7 +41,7 @@ export declare class PlatformResponse<T extends Record<string, any> = any> {
      * Return the original response node.js instance
      */
     get res(): ServerResponse;
-    static onFinished(res: any, cb: Function): void;
+    static onFinished(res: any, cb: (er: Error | null, message: string) => void): void;
     /**
      * Returns the HTTP response header specified by field. The match is case-insensitive.
      *
@@ -52,7 +52,7 @@ export declare class PlatformResponse<T extends Record<string, any> = any> {
      * @param name
      */
     get(name: string): any;
-    getHeaders(): Record<string, HeaderValue>;
+    getHeaders(): OutgoingHttpHeaders;
     /**
      * Return the Framework response object (express, koa, etc...)
      */
@@ -79,7 +79,7 @@ export declare class PlatformResponse<T extends Record<string, any> = any> {
      *
      * Aliased as `res.header()`.
      */
-    setHeaders(headers: Record<string, HeaderValue>): this;
+    setHeaders(headers: OutgoingHttpHeaders): this;
     setHeader(key: string, item: any): this;
     /**
      * Set `Content-Type` response header with `type` through `mime.lookup()`
@@ -132,7 +132,7 @@ export declare class PlatformResponse<T extends Record<string, any> = any> {
      *
      * @param data
      */
-    stream(data: ReadableStream | any): this;
+    stream(data: any): this;
     /**
      * Renders a view and sends the rendered HTML string to the client.
      *
@@ -154,7 +154,7 @@ export declare class PlatformResponse<T extends Record<string, any> = any> {
      * Add a listener to handler the end of the request/response.
      * @param cb
      */
-    onEnd(cb: Function): this;
+    onEnd(cb: (er: Error | null, message: string) => void): this;
     isDone(): boolean;
     destroy(): void;
     isHeadersSent(): boolean;

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

@@ -1,7 +1,10 @@
 import { InjectorService, PathType } from "@tsed/di";
-import { PlatformMulter, PlatformMulterSettings, PlatformStaticsOptions } from "../config";
-import { PlatformRouteOptions, PlatformRouteWithoutHandlers } from "../interfaces";
 import { PlatformHandler } from "./PlatformHandler";
+import { PlatformRouteOptions, PlatformRouteWithoutHandlers } from "../interfaces/PlatformRouteOptions";
+import { PlatformStaticsOptions } from "../config/interfaces/PlatformStaticsSettings";
+import { PlatformMulter, PlatformMulterSettings } from "../config/interfaces/PlatformMulterSettings";
+import { PlatformAdapter } from "./PlatformAdapter";
+import { RouterOptions } from "express";
 /**
  * @ignore
  */
@@ -16,21 +19,21 @@ declare global {
  * Platform Router abstraction layer.
  * @platform
  */
-export declare class PlatformRouter<Router = TsED.Router> {
+export declare class PlatformRouter<App = TsED.Application, Router = TsED.Router> {
     protected platformHandler: PlatformHandler;
+    readonly adapter: PlatformAdapter<App, Router>;
     rawRouter: Router;
     raw: any;
     isBuilt: boolean;
     injector: InjectorService;
-    constructor(platformHandler: PlatformHandler);
+    callback: () => any;
+    constructor(platformHandler: PlatformHandler, adapter: PlatformAdapter<App, Router>, routerOptions?: Partial<RouterOptions>);
     /**
      * 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;
+    static create(injector: InjectorService, routerOptions?: any): PlatformRouter<TsED.Application, TsED.Router>;
     getRouter(): Router;
     use(...handlers: any[]): this;
     addRoute(options: Partial<PlatformRouteOptions>): this;

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

@@ -1,7 +1,7 @@
 import { DITest, DITestOptions, InjectorService } from "@tsed/di";
-import { PlatformContext, PlatformContextOptions } from "../domain/PlatformContext";
-import { PlatformAdapter, PlatformBuilderSettings } from "../interfaces/PlatformAdapter";
 import { Type } from "@tsed/core";
+import { PlatformContext, PlatformContextOptions } from "../domain/PlatformContext";
+import { PlatformAdapter, PlatformBuilderSettings } from "./PlatformAdapter";
 /**
  * @platform
  */

package/lib/types/utils/__mock__/Test1.d.ts

@@ -0,0 +1,3 @@
+export declare const value1 = "value";
+export declare class Test1 {
+}

package/lib/types/utils/__mock__/Test2.d.ts

@@ -0,0 +1,3 @@
+export declare const value2 = "value";
+export declare class Test2 {
+}

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

@@ -1,5 +1,5 @@
 import { InjectorService } from "@tsed/di";
-import { EndpointMetadata } from "../domain/EndpointMetadata";
+import { EndpointMetadata } from "@tsed/schema";
 import { HandlerMetadata } from "../domain/HandlerMetadata";
 import { PlatformRouteWithoutHandlers } from "../interfaces/PlatformRouteOptions";
 /**

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

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

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

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

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

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

package/lib/types/utils/importProviders.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Import providers from given patterns.
+ *
+ * @param settings
+ * @param properties
+ */
+export declare function importProviders(settings: Partial<TsED.Configuration>, properties?: string[]): Promise<{
+    token: string;
+    route?: string;
+}[]>;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@tsed/common",
-  "version": "7.0.0-beta.2",
+  "version": "7.0.0-beta.5",
   "description": "A TypeScript Framework on top of Express",
   "private": false,
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     "types": "./lib/types/index.d.ts",
@@ -13,9 +14,10 @@
     "default": "./lib/esm/index.js"
   },
   "scripts": {
-    "build": "yarn run build:esm && yarn run build:cjs",
+    "build": "yarn barrels && yarn run build:esm && yarn run build:cjs",
     "build:cjs": "tsc --build tsconfig.compile.json",
-    "build:esm": "tsc --build tsconfig.compile.esm.json"
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\" -e \"getConfiguration\""
   },
   "keywords": [
     "Express",
@@ -46,7 +48,7 @@
   "bugs": {
     "url": "https://github.com/tsedio/tsed/issues"
   },
-  "homepage": "https://github.com/tsedio/tsed/tree/alpha/packages/platform/common",
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/platform/common",
   "repository": "https://github.com/tsedio/tsed",
   "funding": [
     {
@@ -59,29 +61,39 @@
     }
   ],
   "dependencies": {
-    "@tsed/components-scan": "7.0.0-beta.2",
-    "@tsed/core": "7.0.0-beta.2",
-    "@tsed/di": "7.0.0-beta.2",
-    "@tsed/exceptions": "7.0.0-beta.2",
-    "@tsed/json-mapper": "7.0.0-beta.2",
-    "@tsed/logger": "^6.0.0",
-    "@tsed/logger-file": "^6.0.0",
-    "@tsed/perf": "7.0.0-beta.2",
-    "@tsed/platform-cache": "7.0.0-beta.2",
-    "@tsed/platform-exceptions": "7.0.0-beta.2",
-    "@tsed/platform-log-middleware": "7.0.0-beta.2",
-    "@tsed/platform-middlewares": "7.0.0-beta.2",
-    "@tsed/platform-params": "7.0.0-beta.2",
-    "@tsed/platform-response-filter": "7.0.0-beta.2",
-    "@tsed/platform-views": "7.0.0-beta.2",
-    "@tsed/schema": "7.0.0-beta.2",
-    "@types/json-schema": "7.0.7",
-    "on-finished": "2.3.0",
-    "tslib": "2.2.0",
+    "@tsed/components-scan": "7.0.0-beta.5",
+    "@tsed/core": "7.0.0-beta.5",
+    "@tsed/di": "7.0.0-beta.5",
+    "@tsed/exceptions": "7.0.0-beta.5",
+    "@tsed/json-mapper": "7.0.0-beta.5",
+    "@tsed/logger": ">=6.1.1",
+    "@tsed/logger-file": ">=6.1.0",
+    "@tsed/perf": "7.0.0-beta.5",
+    "@tsed/platform-cache": "7.0.0-beta.5",
+    "@tsed/platform-exceptions": "7.0.0-beta.5",
+    "@tsed/platform-log-middleware": "7.0.0-beta.5",
+    "@tsed/platform-middlewares": "7.0.0-beta.5",
+    "@tsed/platform-params": "7.0.0-beta.5",
+    "@tsed/platform-response-filter": "7.0.0-beta.5",
+    "@tsed/platform-views": "7.0.0-beta.5",
+    "@tsed/schema": "7.0.0-beta.5",
+    "@types/json-schema": "7.0.11",
+    "@types/on-finished": "2.3.1",
+    "on-finished": "2.4.1",
+    "tslib": "2.3.1",
     "uuid": "8.3.2"
   },
-  "devDependencies": {
-    "rxjs": "^6.5.2"
+  "peerDependencies": {
+    "@tsed/logger": ">=6.1.1",
+    "@tsed/logger-file": ">=6.1.0"
   },
-  "peerDependencies": {}
+  "peerDependenciesMeta": {
+    "@tsed/logger": {
+      "optional": false
+    },
+    "@tsed/logger-file": {
+      "optional": false
+    }
+  },
+  "devDependencies": {}
 }