@midwayjs/express 4.0.0-beta.1 → 4.0.0-beta.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -9,4 +9,4 @@ Document: [https://midwayjs.org](https://midwayjs.org)
 
 ## License
 
-[MIT]((https://github.com/midwayjs/midway/blob/master/LICENSE))
+[MIT](https://github.com/midwayjs/midway/blob/master/LICENSE)

package/dist/framework.d.ts

@@ -31,5 +31,7 @@ export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpress
     getServer(): Server;
     getPort(): string;
     getFrameworkName(): string;
+    private createVersioningMiddleware;
+    private extractVersion;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -31,6 +31,12 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
             ctx.requestContext.registerObject('res', res);
             next();
         });
+        // 版本控制配置
+        const versioningConfig = this.configurationOptions.versioning;
+        // 如果启用版本控制，添加版本处理中间件
+        if (versioningConfig?.enabled) {
+            this.app.use(this.createVersioningMiddleware(versioningConfig));
+        }
         this.defineApplicationProperties({
             useMiddleware: (routerPath, ...middleware) => {
                 if (typeof routerPath === 'string' && middleware) {
@@ -139,18 +145,27 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         }
         // register httpServer to applicationContext
         this.applicationContext.registerObject(core_1.HTTP_SERVER_KEY, this.server);
-        const customPort = process.env.MIDWAY_HTTP_PORT ?? this.configurationOptions.port;
-        if (customPort) {
+        this.configurationOptions.listenOptions = {
+            port: this.configurationOptions.port,
+            host: this.configurationOptions.hostname,
+            ...this.configurationOptions.listenOptions,
+        };
+        // set port and listen server
+        let customPort = process.env.MIDWAY_HTTP_PORT ||
+            this.configurationOptions.listenOptions.port;
+        if (customPort === 0 || customPort === '0') {
+            customPort = await (0, util_2.getFreePort)();
+            this.logger.info(`[midway:express] detect available port: ${customPort}`);
+        }
+        this.configurationOptions.listenOptions.port = Number(customPort);
+        if (this.configurationOptions.listenOptions.port) {
             new Promise(resolve => {
-                const args = [customPort];
-                if (this.configurationOptions.hostname) {
-                    args.push(this.configurationOptions.hostname);
-                }
-                args.push(() => {
+                // 使用 ListenOptions 对象启动服务器
+                this.server.listen(this.configurationOptions.listenOptions, () => {
                     resolve();
                 });
-                this.server.listen(...args);
-                process.env.MIDWAY_HTTP_PORT = String(customPort);
+                process.env.MIDWAY_HTTP_PORT = String(this.configurationOptions.listenOptions.port);
+                this.logger.debug(`[midway:express] Server listening on http://${this.configurationOptions.hostname || 'localhost'}:${customPort}`);
             });
         }
     }
@@ -221,7 +236,7 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         for (const routerInfo of routerList) {
             // bind controller first
             this.getApplicationContext().bindClass(routerInfo.routerModule);
-            this.logger.debug(`Load Controller "${routerInfo.controllerId}", prefix=${routerInfo.prefix}`);
+            this.logger.debug(`[midway:express] Load Controller "${routerInfo.controllerId}", prefix=${routerInfo.prefix}`);
             // new router
             const newRouter = this.createRouter(routerInfo.routerOptions);
             routerInfo.middleware = routerInfo.middleware ?? [];
@@ -240,9 +255,9 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
                     const routeMiddlewareFn = await this.expressMiddlewareService.compose(routeInfo.middleware, this.app);
                     routeMiddlewareList.push(routeMiddlewareFn);
                 }
-                this.logger.debug(`Load Router "${routeInfo.requestMethod.toUpperCase()} ${routeInfo.url}"`);
+                this.logger.debug(`[midway:express] Load Router "${routeInfo.requestMethod.toUpperCase()} ${routeInfo.url}"`);
                 // apply controller from request context
-                newRouter[routeInfo.requestMethod].call(newRouter, routeInfo.url, ...routeMiddlewareList, this.generateController(routeInfo));
+                newRouter[routeInfo.requestMethod.toLowerCase()].call(newRouter, routeInfo.url, ...routeMiddlewareList, this.generateController(routeInfo));
             }
             routerMiddlewares.push({
                 prefix: routerInfo.prefix,
@@ -271,7 +286,9 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         if (this.server) {
             new Promise(resolve => {
                 this.server.close(resolve);
+                process.env.MIDWAY_HTTP_PORT = '';
             });
+            this.logger.debug('[midway:express] server close');
         }
     }
     getServer() {
@@ -283,6 +300,53 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
     getFrameworkName() {
         return 'express';
     }
+    createVersioningMiddleware(config) {
+        return (req, res, next) => {
+            // 提取版本信息
+            const version = this.extractVersion(req, config);
+            req.apiVersion = version;
+            // 对于 URI 版本控制，重写路径
+            if (config.type === 'URI' && version) {
+                const versionPrefix = `/${config.prefix || 'v'}${version}`;
+                if (req.path.startsWith(versionPrefix)) {
+                    req.originalPath = req.path;
+                    // Express 中需要修改 url 而不是 path
+                    req.url = req.url.replace(versionPrefix, '') || '/';
+                }
+            }
+            next();
+        };
+    }
+    extractVersion(req, config) {
+        // 自定义提取函数优先
+        if (config.extractVersionFn) {
+            return config.extractVersionFn(req);
+        }
+        const type = config.type || 'URI';
+        switch (type) {
+            case 'HEADER': {
+                const headerName = config.header || 'x-api-version';
+                const headerValue = req.headers[headerName];
+                if (typeof headerValue === 'string') {
+                    return headerValue.replace(/^v/, '');
+                }
+                return undefined;
+            }
+            case 'MEDIA_TYPE': {
+                const accept = req.headers.accept;
+                const paramName = config.mediaTypeParam || 'version';
+                const match = accept?.match(new RegExp(`${paramName}=(\\\\d+)`));
+                return match ? match[1] : undefined;
+            }
+            case 'URI': {
+                const prefix = config.prefix || 'v';
+                const uriMatch = req.path.match(new RegExp(`^/${prefix}(\\\\d+)`));
+                return uriMatch ? uriMatch[1] : undefined;
+            }
+            default:
+                return config.defaultVersion;
+        }
+    }
 };
 exports.MidwayExpressFramework = MidwayExpressFramework;
 exports.MidwayExpressFramework = MidwayExpressFramework = __decorate([

package/dist/interface.d.ts

@@ -1,11 +1,21 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { CommonMiddlewareUnion, ContextMiddlewareManager, FunctionMiddleware, IConfigurationOptions, IMiddleware, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
 import { Application as ExpressApplication, NextFunction as ExpressNextFunction, Request as ExpressRequest, Response as ExpressResponse } from 'express';
+import { ListenOptions } from 'net';
 type Request = IMidwayContext<ExpressRequest>;
 export type Response = ExpressResponse;
 export type NextFunction = ExpressNextFunction;
 export interface Context extends Request {
+    /**
+     * API version extracted from request
+     */
+    apiVersion?: string;
+    /**
+     * Original path before version processing
+     */
+    originalPath?: string;
 }
 /**
  * @deprecated use Context
@@ -70,6 +80,43 @@ export interface IMidwayExpressConfigurationOptions extends IConfigurationOption
      * https/https/http2 server options
      */
     serverOptions?: Record<string, any>;
+    /**
+     * listen options
+     */
+    listenOptions?: ListenOptions;
+    /**
+     * API versioning configuration
+     */
+    versioning?: {
+        /**
+         * Enable versioning
+         */
+        enabled: boolean;
+        /**
+         * Versioning type
+         */
+        type?: 'URI' | 'HEADER' | 'MEDIA_TYPE' | 'CUSTOM';
+        /**
+         * Default version if none is specified
+         */
+        defaultVersion?: string;
+        /**
+         * Version prefix for URI versioning (default: 'v')
+         */
+        prefix?: string;
+        /**
+         * Header name for HEADER versioning (default: 'x-api-version')
+         */
+        header?: string;
+        /**
+         * Media type parameter name for MEDIA_TYPE versioning (default: 'version')
+         */
+        mediaTypeParam?: string;
+        /**
+         * Custom version extraction function
+         */
+        extractVersionFn?: (ctx: Context) => string | undefined;
+    };
 }
 export type Application = IMidwayExpressApplication;
 export {};

package/dist/util.d.ts

@@ -1,2 +1,3 @@
 export declare function sendData(res: any, data: any): void;
+export declare function getFreePort(): Promise<number>;
 //# sourceMappingURL=util.d.ts.map

package/dist/util.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendData = void 0;
+exports.getFreePort = exports.sendData = void 0;
+const net_1 = require("net");
 function sendData(res, data) {
     if (typeof data === 'number') {
         res.status(res.statusCode).send('' + data);
@@ -10,4 +11,20 @@ function sendData(res, data) {
     }
 }
 exports.sendData = sendData;
+async function getFreePort() {
+    return new Promise((resolve, reject) => {
+        const server = (0, net_1.createServer)();
+        server.listen(0, () => {
+            try {
+                const port = server.address().port;
+                server.close();
+                resolve(port);
+            }
+            catch (err) {
+                reject(err);
+            }
+        });
+    });
+}
+exports.getFreePort = getFreePort;
 //# sourceMappingURL=util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/express",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.3",
   "description": "Midway Web Framework for Express",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,14 +24,14 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.1",
-    "@midwayjs/mock": "^4.0.0-beta.1",
-    "@types/body-parser": "1.19.5",
-    "@types/express": "4.17.21",
+    "@midwayjs/core": "^4.0.0-beta.3",
+    "@midwayjs/mock": "^4.0.0-beta.3",
+    "@types/body-parser": "1.19.6",
+    "@types/express": "4.17.23",
     "fs-extra": "11.3.0"
   },
   "dependencies": {
-    "@midwayjs/express-session": "^4.0.0-beta.1",
+    "@midwayjs/express-session": "^4.0.0-beta.3",
     "body-parser": "1.20.3",
     "cookie-parser": "^1.4.6",
     "express": "4.21.2"
@@ -42,7 +42,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
-  "gitHead": "832961ec3aff123c033197d8c00cb2bc9bad7ff8"
+  "gitHead": "b5b7dfaafb81823cdba5fd10ad2709b3e495c6b4"
 }