@midwayjs/web 4.0.0-beta.1 → 4.0.0-beta.11

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/base.js

@@ -35,10 +35,12 @@ function getFramework() {
 const createAppWorkerLoader = () => {
     const AppWorkerLoader = require(getFramework())?.AppWorkerLoader || require('egg').AppWorkerLoader;
     class EggAppWorkerLoader extends AppWorkerLoader {
-        constructor() {
-            super(...arguments);
-            this.useEggSocketIO = false;
-        }
+        app;
+        framework;
+        bootstrap;
+        useEggSocketIO = false;
+        applicationContext;
+        lifecycleService;
         getEggPaths() {
             if (!this.appDir) {
                 // 这里的逻辑是为了兼容老 cluster 模式

package/dist/configuration.js

@@ -13,6 +13,10 @@ exports.EggConfiguration = void 0;
 const core_1 = require("@midwayjs/core");
 const path_1 = require("path");
 let EggConfiguration = class EggConfiguration {
+    baseDir;
+    appDir;
+    app;
+    decoratorService;
     init() {
         this.decoratorService.registerParameterHandler(core_1.WEB_ROUTER_PARAM_KEY, options => {
             return (0, core_1.extractKoaLikeValue)(options.metadata.type, options.metadata.propertyData, options.originParamType)(options.originArgs[0], options.originArgs[1]);

package/dist/decorator.js

@@ -1,16 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RunInEggAgent = exports.AgentApp = void 0;
+exports.AgentApp = AgentApp;
+exports.RunInEggAgent = RunInEggAgent;
 const core_1 = require("@midwayjs/core");
 const interface_1 = require("./interface");
 function AgentApp() {
     return core_1.DecoratorManager.createCustomPropertyDecorator(interface_1.EGG_AGENT_APP_KEY, {});
 }
-exports.AgentApp = AgentApp;
 function RunInEggAgent() {
     return function (target) {
         core_1.DecoratorManager.saveModule(interface_1.RUN_IN_AGENT_KEY, target);
     };
 }
-exports.RunInEggAgent = RunInEggAgent;
 //# sourceMappingURL=decorator.js.map

package/dist/framework/lifecycle.js

@@ -15,9 +15,12 @@ const functional_1 = require("@midwayjs/core/functional");
 const util_1 = require("util");
 const debug = (0, util_1.debuglog)('midway:debug');
 let MidwayWebLifeCycleService = class MidwayWebLifeCycleService {
+    applicationContext;
+    frameworkService;
+    configService;
+    lifecycleInstanceList = [];
     constructor(applicationContext) {
         this.applicationContext = applicationContext;
-        this.lifecycleInstanceList = [];
     }
     async init() {
         // run lifecycle

package/dist/framework/web.d.ts

@@ -22,5 +22,7 @@ export declare class MidwayWebFramework extends BaseFramework<Application, Conte
     generateMiddleware(middlewareId: any): Promise<any>;
     beforeStop(): Promise<void>;
     setServer(server: any): void;
+    private createVersioningMiddleware;
+    private extractVersion;
 }
 //# sourceMappingURL=web.d.ts.map

package/dist/framework/web.js

@@ -15,8 +15,11 @@ const router_1 = require("@eggjs/router");
 const logger_1 = require("@midwayjs/logger");
 const path_1 = require("path");
 const util_1 = require("util");
+const net_1 = require("net");
 const debug = (0, util_1.debuglog)('midway:debug');
 class EggControllerGenerator extends core_1.WebControllerGenerator {
+    app;
+    webRouterService;
     constructor(app, webRouterService) {
         super(app, webRouterService);
         this.app = app;
@@ -32,10 +35,13 @@ class EggControllerGenerator extends core_1.WebControllerGenerator {
     }
 }
 let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
-    constructor() {
-        super(...arguments);
-        this.isClusterMode = false;
-    }
+    loggers;
+    generator;
+    server;
+    agent;
+    isClusterMode = false;
+    webRouterService;
+    appDir;
     configure() {
         process.env.EGG_TYPESCRIPT = 'true';
         if (process.env['EGG_CLUSTER_MODE'] === 'true') {
@@ -79,9 +85,15 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
                 throw new core_1.httpError.NotFoundError(`${ctx.path} Not Found`);
             }
         };
+        const applyMiddlewares = [midwayRouterNotFound];
+        const versioningConfig = this.configurationOptions.versioning;
+        // 如果启用版本控制，添加版本处理中间件
+        if (versioningConfig?.enabled) {
+            applyMiddlewares.push(this.createVersioningMiddleware(versioningConfig));
+        }
         // insert error handler
         const midwayRootMiddleware = async (ctx, next) => {
-            await (await this.applyMiddleware(midwayRouterNotFound))(ctx, next);
+            await (await this.applyMiddleware(applyMiddlewares))(ctx, next);
         };
         this.app.use(midwayRootMiddleware);
         this.webRouterService = await this.applicationContext.getAsync(core_1.MidwayWebRouterService, [
@@ -91,6 +103,7 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
         ]);
         this.generator = new EggControllerGenerator(this.app, this.webRouterService);
         this.overwriteApplication('app');
+        this.app.loader.app = this.app;
         this.app.loader.loadOrigin();
         // 这里拦截 app.use 方法，让他可以加到 midway 的 middlewareManager 中
         this.app.originUse = this.app.use;
@@ -200,7 +213,10 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
             this.getApplicationContext().registerObject(core_1.HTTP_SERVER_KEY, this.server);
             const eggConfig = this.configService.getConfiguration('egg');
             if (!this.isClusterMode && eggConfig) {
-                const customPort = process.env.MIDWAY_HTTP_PORT ?? eggConfig.port;
+                let customPort = process.env.MIDWAY_HTTP_PORT ?? eggConfig.port;
+                if (customPort === 0) {
+                    customPort = await getFreePort();
+                }
                 if (customPort) {
                     new Promise(resolve => {
                         const args = [customPort];
@@ -251,6 +267,52 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
     setServer(server) {
         this.server = server;
     }
+    createVersioningMiddleware(config) {
+        return async (ctx, next) => {
+            // 提取版本信息
+            const version = this.extractVersion(ctx, config);
+            ctx.apiVersion = version;
+            // 对于 URI 版本控制，重写路径
+            if (config.type === 'URI' && version) {
+                const versionPrefix = `/${config.prefix || 'v'}${version}`;
+                if (ctx.path.startsWith(versionPrefix)) {
+                    ctx.originalPath = ctx.path;
+                    ctx.path = ctx.path.replace(versionPrefix, '') || '/';
+                }
+            }
+            await next();
+        };
+    }
+    extractVersion(ctx, config) {
+        // 自定义提取函数优先
+        if (config.extractVersionFn) {
+            return config.extractVersionFn(ctx);
+        }
+        const type = config.type || 'URI';
+        switch (type) {
+            case 'HEADER': {
+                const headerName = config.header || 'x-api-version';
+                const headerValue = ctx.headers[headerName];
+                if (typeof headerValue === 'string') {
+                    return headerValue.replace(/^v/, '');
+                }
+                return undefined;
+            }
+            case 'MEDIA_TYPE': {
+                const accept = ctx.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 = ctx.path.match(new RegExp(`^/${prefix}(\\\\d+)`));
+                return uriMatch ? uriMatch[1] : undefined;
+            }
+            default:
+                return config.defaultVersion;
+        }
+    }
 };
 exports.MidwayWebFramework = MidwayWebFramework;
 __decorate([
@@ -260,4 +322,19 @@ __decorate([
 exports.MidwayWebFramework = MidwayWebFramework = __decorate([
     (0, core_1.Framework)()
 ], MidwayWebFramework);
+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);
+            }
+        });
+    });
+}
 //# sourceMappingURL=web.js.map

package/dist/index.js

@@ -14,7 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startCluster = exports.Configuration = exports.Agent = exports.Application = exports.createAgentWorkerLoader = exports.createAppWorkerLoader = exports.createEggAgent = exports.createEggApplication = exports.Framework = void 0;
+exports.Configuration = exports.Agent = exports.Application = exports.createAgentWorkerLoader = exports.createAppWorkerLoader = exports.createEggAgent = exports.createEggApplication = exports.Framework = void 0;
+exports.startCluster = startCluster;
 const egg_cluster_1 = require("egg-cluster");
 const path_1 = require("path");
 __exportStar(require("./interface"), exports);
@@ -41,5 +42,4 @@ function startCluster(serverConfig, callback) {
     serverConfig['require'].push((0, path_1.join)(__dirname, 'cluster'));
     return (0, egg_cluster_1.startCluster)(serverConfig, callback);
 }
-exports.startCluster = startCluster;
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { Context as EggContext, Application as EggApplication } from 'egg';
 import { IMidwayContainer, IMidwayContext, IMidwayApplication, IConfigurationOptions, NextFunction as BaseNextFunction } from '@midwayjs/core';
 import { DefaultState, Middleware } from 'koa';
@@ -61,6 +59,14 @@ export interface Context<ResponseBodyT = unknown> extends IMidwayWebContext<Resp
         [_: string]: any;
     };
     state: State;
+    /**
+     * API version extracted from request
+     */
+    apiVersion?: string;
+    /**
+     * Original path before version processing
+     */
+    originalPath?: string;
 }
 /**
  * @deprecated since version 3.0.0
@@ -120,6 +126,39 @@ export interface IMidwayWebConfigurationOptions extends IConfigurationOptions {
      * https/https/http2 server options
      */
     serverOptions?: Record<string, any>;
+    /**
+     * 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;
+    };
 }
 /**
  * @deprecated since version 3.0.0

package/dist/logger.d.ts

@@ -34,6 +34,6 @@ declare class MidwayLoggers extends Map<string, ILogger> {
         };
     };
 }
-export declare const createLoggers: (app: Application, processType: 'agent' | 'app') => MidwayLoggers;
+export declare const createLoggers: (app: Application, processType: "agent" | "app") => MidwayLoggers;
 export {};
 //# sourceMappingURL=logger.d.ts.map

package/dist/logger.js

@@ -46,6 +46,8 @@ function cleanUndefinedProperty(obj) {
     });
 }
 class MidwayLoggers extends Map {
+    app;
+    loggerService;
     /**
      * @constructor
      * - logger

package/dist/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeAgentApplicationContext = exports.getCurrentDateString = exports.findLernaRoot = exports.parseNormalDir = void 0;
+exports.getCurrentDateString = exports.findLernaRoot = exports.parseNormalDir = void 0;
+exports.initializeAgentApplicationContext = initializeAgentApplicationContext;
 const path_1 = require("path");
 const find_up_1 = require("find-up");
 const fs_1 = require("fs");
@@ -64,10 +65,10 @@ async function initializeAgentApplicationContext(agent) {
     agentFramework['logger'] = agent.coreLogger;
     agentFramework['appLogger'] = agent.logger;
     agentFramework.app = agent;
-    agentFramework.configService = applicationContext.get(core_1.MidwayConfigService);
-    agentFramework.environmentService = applicationContext.get(core_1.MidwayEnvironmentService);
-    agentFramework.loggerService = applicationContext.get(core_1.MidwayLoggerService);
-    agentFramework.informationService = applicationContext.get(core_1.MidwayInformationService);
+    agentFramework['configService'] = applicationContext.get(core_1.MidwayConfigService);
+    agentFramework['environmentService'] = applicationContext.get(core_1.MidwayEnvironmentService);
+    agentFramework['loggerService'] = applicationContext.get(core_1.MidwayLoggerService);
+    agentFramework['informationService'] = applicationContext.get(core_1.MidwayInformationService);
     agentFramework.overwriteApplication('agent');
     // init decorator service
     const decoratorService = (0, core_1.getCurrentApplicationContext)().get(core_1.MidwayDecoratorService);
@@ -115,5 +116,4 @@ async function initializeAgentApplicationContext(agent) {
     }
     return applicationContext;
 }
-exports.initializeAgentApplicationContext = initializeAgentApplicationContext;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/web",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.11",
   "description": "Midway Web Framework for Egg.js",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -28,17 +28,17 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/logger": "^3.0.0",
-    "@midwayjs/mock": "^4.0.0-beta.1",
+    "@midwayjs/logger": "^4.0.0",
+    "@midwayjs/mock": "^4.0.0-beta.11",
     "@types/koa": "2.15.0",
-    "dayjs": "1.11.13",
+    "dayjs": "1.11.19",
     "egg-logger": "3.6.1",
     "egg-mock": "4.2.1",
     "egg-scripts": "3.1.0",
     "egg-socket.io": "4.1.6",
     "egg-view-nunjucks": "2.3.0",
     "fake-egg": "1.0.0",
-    "fs-extra": "11.3.0",
+    "fs-extra": "11.3.3",
     "is-type-of": "^2.1.0",
     "mm": "3.4.0",
     "mz-modules": "^2.1.0",
@@ -49,13 +49,13 @@
   },
   "dependencies": {
     "@eggjs/router": "^2.0.0",
-    "@midwayjs/core": "^4.0.0-beta.1",
+    "@midwayjs/core": "^4.0.0-beta.11",
     "egg": "^2.28.0",
     "egg-cluster": "^1.27.1",
     "egg-path-matching": "^2.1.0",
     "find-up": "5.0.0",
     "mkdirp": "1.0.4",
-    "qs": "6.14.0"
+    "qs": "6.14.1"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
   "repository": {
@@ -63,7 +63,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
-  "gitHead": "832961ec3aff123c033197d8c00cb2bc9bad7ff8"
+  "gitHead": "6ef05719ca6e900f1ec34aff7a5c5a9614358c50"
 }