@midwayjs/express 3.0.0-beta.1 → 3.0.0-beta.5

package/CHANGELOG.md

@@ -3,6 +3,46 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.5](https://github.com/midwayjs/midway/compare/v3.0.0-beta.4...v3.0.0-beta.5) (2021-11-25)
+
+**Note:** Version bump only for package @midwayjs/express
+
+
+
+
+
+# [3.0.0-beta.4](https://github.com/midwayjs/midway/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2021-11-24)
+
+
+### Features
+
+* add i18n ([#1375](https://github.com/midwayjs/midway/issues/1375)) ([bffefe0](https://github.com/midwayjs/midway/commit/bffefe07afe45777d49b5a76b9ab17fc2b9d9a55))
+* auto transform args to type ([#1372](https://github.com/midwayjs/midway/issues/1372)) ([bb3f7d2](https://github.com/midwayjs/midway/commit/bb3f7d2028a034e1926d9df554849332354c3762))
+* support global prefix url ([#1371](https://github.com/midwayjs/midway/issues/1371)) ([cc5fe44](https://github.com/midwayjs/midway/commit/cc5fe44e1d221590562dc71e1f33ae96093e0da7))
+
+
+
+
+
+# [3.0.0-beta.3](https://github.com/midwayjs/midway/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-11-18)
+
+
+### Features
+
+* add component and framework config definition ([#1367](https://github.com/midwayjs/midway/issues/1367)) ([b2fe615](https://github.com/midwayjs/midway/commit/b2fe6157f99659471ff1333eca0b86bb889f61a3))
+
+
+
+
+
+# [3.0.0-beta.2](https://github.com/midwayjs/midway/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-11-16)
+
+**Note:** Version bump only for package @midwayjs/express
+
+
+
+
+
 # [3.0.0-beta.1](https://github.com/midwayjs/midway/compare/v2.12.4...v3.0.0-beta.1) (2021-11-14)
 
 

package/dist/configuration.d.ts

@@ -1,10 +1,7 @@
-import { MidwayExpressFramework } from './framework';
 import { MidwayDecoratorService } from '@midwayjs/core';
 export declare class ExpressConfiguration {
-    framework: MidwayExpressFramework;
     decoratorService: MidwayDecoratorService;
     init(): void;
     onReady(): Promise<void>;
-    onServerReady(): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -11,23 +11,15 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExpressConfiguration = void 0;
 const decorator_1 = require("@midwayjs/decorator");
-const framework_1 = require("./framework");
 const core_1 = require("@midwayjs/core");
 let ExpressConfiguration = class ExpressConfiguration {
     init() {
         this.decoratorService.registerParameterHandler(decorator_1.WEB_ROUTER_PARAM_KEY, options => {
-            return (0, core_1.extractExpressLikeValue)(options.metadata.type, options.metadata.propertyData)(options.originArgs[0], options.originArgs[1], options.originArgs[2]);
+            return (0, core_1.extractExpressLikeValue)(options.metadata.type, options.metadata.propertyData, options.originParamType)(options.originArgs[0], options.originArgs[1], options.originArgs[2]);
         });
     }
     async onReady() { }
-    async onServerReady() {
-        await this.framework.run();
-    }
 };
-__decorate([
-    (0, decorator_1.Inject)(),
-    __metadata("design:type", framework_1.MidwayExpressFramework)
-], ExpressConfiguration.prototype, "framework", void 0);
 __decorate([
     (0, decorator_1.Inject)(),
     __metadata("design:type", core_1.MidwayDecoratorService)

package/dist/framework.d.ts

@@ -1,16 +1,12 @@
 /// <reference types="node" />
-import { BaseFramework, ContextMiddlewareManager, FunctionMiddleware, IMidwayBootstrapOptions, MiddlewareRespond, MidwayFrameworkType, ExceptionFilterManager } from '@midwayjs/core';
-import { RouterParamValue } from '@midwayjs/decorator';
+import { BaseFramework, IMidwayBootstrapOptions, MiddlewareRespond, MidwayFrameworkType, RouterInfo } from '@midwayjs/core';
 import { IMidwayExpressApplication, IMidwayExpressConfigurationOptions, IMidwayExpressContext } from './interface';
 import type { IRouter, IRouterHandler, Response, NextFunction } from 'express';
 import { Server } from 'net';
 import { MidwayExpressContextLogger } from './logger';
-export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpressApplication, IMidwayExpressContext, IMidwayExpressConfigurationOptions> {
+export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpressApplication, IMidwayExpressContext, IMidwayExpressConfigurationOptions, Response, NextFunction> {
     app: IMidwayExpressApplication;
-    private controllerIds;
     private server;
-    protected middlewareManager: ContextMiddlewareManager<IMidwayExpressContext, Response<any, Record<string, any>>, NextFunction>;
-    protected exceptionFilterManager: ExceptionFilterManager<IMidwayExpressContext, Response<any, Record<string, any>>, NextFunction>;
     private expressMiddlewareService;
     configure(): IMidwayExpressConfigurationOptions;
     applicationInitialize(options: Partial<IMidwayBootstrapOptions>): Promise<void>;
@@ -18,16 +14,9 @@ export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpress
     getFrameworkType(): MidwayFrameworkType;
     /**
      * wrap controller string to middleware function
-     * @param controllerMapping like FooController.index
-     * @param routeArgsInfo
-     * @param routerResponseData
      */
-    generateController(controllerMapping: string, routeArgsInfo?: RouterParamValue[], routerResponseData?: any[]): IRouterHandler<any>;
+    protected generateController(routeInfo: RouterInfo): IRouterHandler<any>;
     loadMidwayController(): Promise<void>;
-    /**
-     * @deprecated
-     */
-    generateMiddleware(middlewareId: string): Promise<FunctionMiddleware<IMidwayExpressContext, Response<any, Record<string, any>>, NextFunction>>;
     /**
      * @param routerOptions
      */

package/dist/framework.js

@@ -16,28 +16,11 @@ const express = require("express");
 const logger_1 = require("./logger");
 const middlewareService_1 = require("./middlewareService");
 let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFramework {
-    constructor() {
-        super(...arguments);
-        this.controllerIds = [];
-        this.middlewareManager = new core_1.ContextMiddlewareManager();
-        this.exceptionFilterManager = new core_1.ExceptionFilterManager();
-    }
     configure() {
         return this.configService.getConfiguration('express');
     }
     async applicationInitialize(options) {
         this.app = express();
-        this.defineApplicationProperties({
-            generateController: (controllerMapping) => {
-                return this.generateController(controllerMapping);
-            },
-            /**
-             * @deprecated
-             */
-            generateMiddleware: async (middlewareId) => {
-                return this.generateMiddleware(middlewareId);
-            },
-        });
         this.app.use((req, res, next) => {
             const ctx = req;
             this.app.createAnonymousContext(ctx);
@@ -46,6 +29,25 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
             ctx.requestContext.registerObject('res', res);
             next();
         });
+    }
+    async run() {
+        // use global middleware
+        const globalMiddleware = await this.getMiddleware();
+        this.app.use(globalMiddleware);
+        // load controller
+        await this.loadMidwayController();
+        // use global error handler
+        this.app.use(async (err, req, res, next) => {
+            if (err) {
+                const { result, error } = await this.filterManager.runErrorFilter(err, req, res, next);
+                if (error) {
+                    next(error);
+                }
+                else {
+                    res.send(result);
+                }
+            }
+        });
         // https config
         if (this.configurationOptions.key && this.configurationOptions.cert) {
             this.configurationOptions.key = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.key);
@@ -68,25 +70,6 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         }
         // register httpServer to applicationContext
         this.applicationContext.registerObject(core_1.HTTP_SERVER_KEY, this.server);
-    }
-    async run() {
-        // use global middleware
-        const globalMiddleware = await this.getMiddleware();
-        this.app.use(globalMiddleware);
-        // load controller
-        await this.loadMidwayController();
-        // use global error handler
-        this.app.use(async (err, req, res, next) => {
-            if (err) {
-                const { result, error } = await this.exceptionFilterManager.run(err, req, res, next);
-                if (error) {
-                    next(error);
-                }
-                else {
-                    res.send(result);
-                }
-            }
-        });
         if (this.configurationOptions.port) {
             new Promise(resolve => {
                 const args = [this.configurationOptions.port];
@@ -105,15 +88,11 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
     }
     /**
      * wrap controller string to middleware function
-     * @param controllerMapping like FooController.index
-     * @param routeArgsInfo
-     * @param routerResponseData
      */
-    generateController(controllerMapping, routeArgsInfo, routerResponseData) {
-        const [controllerId, methodName] = controllerMapping.split('.');
+    generateController(routeInfo) {
         return async (req, res, next) => {
-            const controller = await req.requestContext.getAsync(controllerId);
-            const result = await controller[methodName].call(controller, req, res, next);
+            const controller = await req.requestContext.getAsync(routeInfo.id);
+            const result = await controller[routeInfo.method].call(controller, req, res, next);
             if (res.headersSent) {
                 // return when response send
                 return;
@@ -122,8 +101,9 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
                 res.status(204);
             }
             // implement response decorator
-            if (Array.isArray(routerResponseData) && routerResponseData.length) {
-                for (const routerRes of routerResponseData) {
+            if (Array.isArray(routeInfo.responseMetadata) &&
+                routeInfo.responseMetadata.length) {
+                for (const routerRes of routeInfo.responseMetadata) {
                     switch (routerRes.type) {
                         case decorator_1.WEB_RESPONSE_HTTP_CODE:
                             res.status(routerRes.code);
@@ -140,50 +120,43 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
                     }
                 }
             }
-            res.send(result);
+            const { result: returnValue, error } = await this.filterManager.runResultFilter(result, req, res, next);
+            if (error) {
+                throw error;
+            }
+            res.send(returnValue);
         };
     }
     async loadMidwayController() {
-        const collector = new core_1.WebRouterCollector();
+        const collector = new core_1.WebRouterCollector('', {
+            globalPrefix: this.configurationOptions.globalPrefix,
+        });
         const routerTable = await collector.getRouterTable();
         const routerList = await collector.getRoutePriorityList();
         for (const routerInfo of routerList) {
             // bind controller first
             this.getApplicationContext().bindClass(routerInfo.routerModule);
-            const providerId = routerInfo.controllerId;
-            // controller id check
-            if (this.controllerIds.indexOf(providerId) > -1) {
-                throw new Error(`Controller identifier [${providerId}] already exists!`);
-            }
-            this.controllerIds.push(providerId);
-            this.logger.debug(`Load Controller "${providerId}", prefix=${routerInfo.prefix}`);
+            this.logger.debug(`Load Controller "${routerInfo.controllerId}", prefix=${routerInfo.prefix}`);
             // new router
             const newRouter = this.createRouter(routerInfo.routerOptions);
             // add router middleware
-            await this.handlerWebMiddleware(routerInfo.middleware, (middlewareImpl) => {
+            await this.handlerWebMiddleware(routerInfo.middleware, middlewareImpl => {
                 newRouter.use(middlewareImpl);
             });
             // add route
             const routes = routerTable.get(routerInfo.prefix);
             for (const routeInfo of routes) {
                 // router middleware
-                await this.handlerWebMiddleware(routeInfo.middleware, (middlewareImpl) => {
+                await this.handlerWebMiddleware(routeInfo.middleware, middlewareImpl => {
                     newRouter.use(middlewareImpl);
                 });
                 this.logger.debug(`Load Router "${routeInfo.requestMethod.toUpperCase()} ${routeInfo.url}"`);
                 // apply controller from request context
-                newRouter[routeInfo.requestMethod].call(newRouter, routeInfo.url, this.generateController(routeInfo.handlerName, routeInfo.requestMetadata, routeInfo.responseMetadata));
+                newRouter[routeInfo.requestMethod].call(newRouter, routeInfo.url, this.generateController(routeInfo));
             }
             this.app.use(routerInfo.prefix, newRouter);
         }
     }
-    /**
-     * @deprecated
-     */
-    async generateMiddleware(middlewareId) {
-        const mwIns = await this.getApplicationContext().getAsync(middlewareId);
-        return mwIns.resolve();
-    }
     /**
      * @param routerOptions
      */
@@ -197,7 +170,7 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
     async getMiddleware() {
         if (!this.composeMiddleware) {
             this.composeMiddleware = await this.expressMiddlewareService.compose(this.middlewareManager);
-            await this.exceptionFilterManager.init(this.applicationContext);
+            await this.filterManager.init(this.applicationContext);
         }
         return this.composeMiddleware;
     }

package/dist/interface.d.ts

@@ -1,16 +1,19 @@
 /// <reference types="node" />
-import { IConfigurationOptions, IMiddleware, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
-import { Application as ExpressApplication, NextFunction, Request, Response } from 'express';
-import { RouterParamValue } from "@midwayjs/decorator";
+import { CommonMiddlewareUnion, ContextMiddlewareManager, IConfigurationOptions, IMiddleware, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
+import { Application as ExpressApplication, NextFunction as ExpressNextFunction, Request, Response } from 'express';
 export declare type IMidwayExpressContext = IMidwayContext<Request>;
-export declare type IMidwayExpressMiddleware = IMiddleware<IMidwayExpressContext, Response, NextFunction>;
-export declare type IMidwayExpressApplication = IMidwayApplication<IMidwayExpressContext, ExpressApplication & {
-    generateController(controllerMapping: string, routeArgsInfo?: RouterParamValue[], routerResponseData?: any[]): IMidwayExpressMiddleware;
+export declare type IMidwayExpressMiddleware = IMiddleware<IMidwayExpressContext, Response, ExpressNextFunction>;
+export interface IMidwayExpressApplication extends IMidwayApplication<IMidwayExpressContext, ExpressApplication> {
     /**
-     * @deprecated
+     * add global middleware to app
+     * @param Middleware
      */
-    generateMiddleware(middlewareId: string): Promise<IMidwayExpressMiddleware>;
-}>;
+    useMiddleware<Response, NextFunction>(Middleware: CommonMiddlewareUnion<IMidwayExpressContext, Response, NextFunction>): void;
+    /**
+     * get global middleware
+     */
+    getMiddleware<Response, NextFunction>(): ContextMiddlewareManager<IMidwayExpressContext, Response, NextFunction>;
+}
 export interface IMidwayExpressConfigurationOptions extends IConfigurationOptions {
     /**
      * application http port
@@ -36,8 +39,18 @@ export interface IMidwayExpressConfigurationOptions extends IConfigurationOption
      * http2 support
      */
     http2?: boolean;
+    /**
+     * http global prefix
+     */
+    globalPrefix?: string;
 }
 export declare type Application = IMidwayExpressApplication;
+export declare type NextFunction = ExpressNextFunction;
 export interface Context extends IMidwayExpressContext {
 }
+declare module '@midwayjs/core/dist/interface' {
+    interface MidwayConfig {
+        express?: IMidwayExpressConfigurationOptions;
+    }
+}
 //# sourceMappingURL=interface.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/express",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.5",
   "description": "Midway Web Framework for Express",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
@@ -23,14 +23,14 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.0.0-beta.1",
-    "@midwayjs/mock": "^3.0.0-beta.1",
+    "@midwayjs/decorator": "^3.0.0-beta.5",
+    "@midwayjs/mock": "^3.0.0-beta.5",
     "@types/express": "^4.17.8",
     "fs-extra": "^8.0.1"
   },
   "dependencies": {
-    "@midwayjs/core": "^3.0.0-beta.1",
-    "@midwayjs/logger": "^3.0.0-beta.1",
+    "@midwayjs/core": "^3.0.0-beta.5",
+    "@midwayjs/logger": "^3.0.0-beta.5",
     "express": "^4.17.1"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
@@ -41,5 +41,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "72e4d20c678e65a5440c4e9a6d3b70046daa497c"
+  "gitHead": "ab0bf05ae6d13f6435db2f7223202be61d585a1b"
 }