agent-publish-server 1.0.24 → 1.0.26

package/README.md

@@ -91,6 +91,7 @@ agent-publish-server -c ./agent_config.json
 interface AgentConfig {
   port?: number; // 服务器端口（默认：8080）
   dir?: string; // 静态文件目录（默认："./"）
+  redirect?: string; // 根路径重定向，如 "/app" 表示访问 / 时重定向到 /app
   log?: boolean; // 启用访问日志（默认：true）
   proxy?: {
     // API代理配置
@@ -114,6 +115,25 @@ interface AgentConfig {
 }
 ```
 
+### 根路径重定向
+
+通过 `redirect` 配置实现访问根路径时自动重定向到指定路径：
+
+```json
+{
+  "port": 3000,
+  "redirect": "/app",
+  "staticProxy": {
+    "/app": {
+      "target": "./dist",
+      "type": "static"
+    }
+  }
+}
+```
+
+这样配置后，访问 `http://localhost:3000/` 会自动重定向到 `http://localhost:3000/app`。
+
 ### 静态网页代理
 
 除了 API 代理外，还支持静态网页代理功能，用于代理整个网站或应用。
@@ -228,8 +248,10 @@ agent-publish-server --log false
 
 ### 版本历史
 
-- **v1.0.24**: 修复移动端兼容性问题，优化HTTP响应头设置，确保iOS和Android显示一致性
-- **v1.0.23**: 完善双语文档支持，优化package.json关键词，提升npm包曝光度
+- **v1.0.26**: 新增根路径重定向配置（redirect），支持访问 / 时自动跳转到指定路径
+- **v1.0.25**: 修复 staticProxy static 类型不支持 SPA History 路由刷新的问题，添加自动 fallback 到 index.html 支持
+- **v1.0.24**: 修复移动端兼容性问题，优化 HTTP 响应头设置，确保 iOS 和 Android 显示一致性
+- **v1.0.23**: 完善双语文档支持，优化 package.json 关键词，提升 npm 包曝光度
 - **v1.0.22**: 优化和完善 staticProxy 功能，提升稳定性
 - **v1.0.18**: 增强 staticProxy 功能，支持静态文件代理和 HTTP 服务代理两种模式
 - **v1.0.17**: 新增静态网页代理功能（staticProxy），支持与 API 代理同时使用

package/README_EN.md

@@ -77,9 +77,29 @@ agent-publish-server -c config.json
 
 - **port**: Server port (default: 3000)
 - **dir**: Static file directory (default: current directory)
+- **redirect**: Root path redirect, e.g. "/app" redirects / to /app
 - **proxy**: API proxy configuration
 - **staticProxy**: Static proxy configuration
 
+### Root Path Redirect
+
+Use `redirect` to automatically redirect root path to a specified path:
+
+```json
+{
+  "port": 3000,
+  "redirect": "/app",
+  "staticProxy": {
+    "/app": {
+      "target": "./dist",
+      "type": "static"
+    }
+  }
+}
+```
+
+With this config, accessing `http://localhost:3000/` will redirect to `http://localhost:3000/app`.
+
 #### API Proxy Configuration (ProxyConfig)
 
 ```typescript
@@ -229,6 +249,8 @@ startServer(app, config.port);
 
 ## Version History
 
+- **v1.0.26**: Added root path redirect configuration (redirect), supports automatic redirect when accessing /
+- **v1.0.25**: Fixed staticProxy static type not supporting SPA History route refresh, added automatic fallback to index.html
 - **v1.0.24**: Fixed mobile compatibility issues, optimized HTTP response headers for consistent iOS and Android display
 - **v1.0.23**: Enhanced bilingual documentation support, optimized package.json keywords for better npm exposure
 - **v1.0.22**: Optimized and improved staticProxy functionality, enhanced stability

package/dist/server.d.ts

@@ -1,3 +1,3 @@
-import { AgentConfig } from './types';
+import { AgentConfig } from "./types";
 export declare function createServer(config: AgentConfig): import("express-serve-static-core").Express;
 export declare function startServer(config: AgentConfig): Promise<void>;

package/dist/server.js

@@ -11,12 +11,12 @@ const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 function createServer(config) {
     const app = (0, express_1.default)();
-    const staticDir = config.dir || './';
+    const staticDir = config.dir || "./";
     const enableLog = config.log !== false; // 默认为true
     // 检查项目路径是否存在
     const absoluteStaticDir = path_1.default.resolve(process.cwd(), staticDir);
     if (!fs_1.default.existsSync(absoluteStaticDir)) {
-        throw new Error('项目路径错误');
+        throw new Error("项目路径错误");
     }
     // 添加日志中间件
     if (enableLog) {
@@ -24,12 +24,21 @@ function createServer(config) {
             const timestamp = new Date().toISOString();
             const method = req.method;
             const url = req.url;
-            const userAgent = req.get('User-Agent') || '-';
-            const ip = req.ip || req.connection.remoteAddress || '-';
+            const userAgent = req.get("User-Agent") || "-";
+            const ip = req.ip || req.connection.remoteAddress || "-";
             console.log(`[${timestamp}] ${ip} "${method} ${url}" "${userAgent}"`);
             next();
         });
     }
+    // 根路径重定向配置
+    if (config.redirect) {
+        app.get("/", (req, res) => {
+            const redirectPath = config.redirect.startsWith("/")
+                ? config.redirect
+                : `/${config.redirect}`;
+            res.redirect(302, redirectPath);
+        });
+    }
     // 配置API代理
     if (config.proxy) {
         Object.entries(config.proxy).forEach(([path, proxyConfig]) => {
@@ -39,41 +48,59 @@ function createServer(config) {
     // 配置静态网页代理
     if (config.staticProxy) {
         Object.entries(config.staticProxy).forEach(([proxyPath, staticProxyConfig]) => {
-            const proxyType = staticProxyConfig.type || 'http'; // 默认为http类型
-            if (proxyType === 'static') {
+            const proxyType = staticProxyConfig.type || "http"; // 默认为http类型
+            if (proxyType === "static") {
                 // 静态文件代理
                 const staticPath = path_1.default.resolve(process.cwd(), staticProxyConfig.target);
                 if (!fs_1.default.existsSync(staticPath)) {
                     console.warn(`Warning: Static proxy path does not exist: ${staticPath}`);
                     return;
                 }
+                // 静态文件服务
                 app.use(proxyPath, express_1.default.static(staticPath, {
                     setHeaders: (res, filePath, stat) => {
                         // 设置通用响应头，提升移动端兼容性
-                        res.setHeader('X-Content-Type-Options', 'nosniff');
-                        res.setHeader('X-Frame-Options', 'SAMEORIGIN');
-                        res.setHeader('X-XSS-Protection', '1; mode=block');
+                        res.setHeader("X-Content-Type-Options", "nosniff");
+                        res.setHeader("X-Frame-Options", "SAMEORIGIN");
+                        res.setHeader("X-XSS-Protection", "1; mode=block");
                         // 针对HTML文件设置移动端优化响应头
-                        if (filePath.endsWith('.html')) {
-                            res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
-                            res.setHeader('Pragma', 'no-cache');
-                            res.setHeader('Expires', '0');
-                            res.setHeader('Content-Type', 'text/html; charset=utf-8');
+                        if (filePath.endsWith(".html")) {
+                            res.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
+                            res.setHeader("Pragma", "no-cache");
+                            res.setHeader("Expires", "0");
+                            res.setHeader("Content-Type", "text/html; charset=utf-8");
                         }
                         // 针对CSS文件确保正确的Content-Type
-                        if (filePath.endsWith('.css')) {
-                            res.setHeader('Content-Type', 'text/css; charset=utf-8');
+                        if (filePath.endsWith(".css")) {
+                            res.setHeader("Content-Type", "text/css; charset=utf-8");
                         }
                         // 针对JS文件确保正确的Content-Type
-                        if (filePath.endsWith('.js')) {
-                            res.setHeader('Content-Type', 'application/javascript; charset=utf-8');
+                        if (filePath.endsWith(".js")) {
+                            res.setHeader("Content-Type", "application/javascript; charset=utf-8");
                         }
                         // 针对图片文件设置适当的缓存
                         if (filePath.match(/\.(jpg|jpeg|png|gif|webp|svg)$/i)) {
-                            res.setHeader('Cache-Control', 'public, max-age=31536000');
+                            res.setHeader("Cache-Control", "public, max-age=31536000");
                         }
-                    }
+                    },
                 }));
+                // SPA fallback：静态文件不存在时回退到 index.html
+                app.use(proxyPath, (req, res, next) => {
+                    const reqPath = req.path === "/" ? "" : req.path;
+                    const filePath = path_1.default.join(staticPath, reqPath);
+                    const indexPath = path_1.default.join(staticPath, "index.html");
+                    // 如果请求的文件存在，跳过（已被 express.static 处理）
+                    if (fs_1.default.existsSync(filePath) && fs_1.default.statSync(filePath).isFile()) {
+                        return next();
+                    }
+                    // 如果 index.html 存在，返回它（SPA fallback）
+                    if (fs_1.default.existsSync(indexPath)) {
+                        res.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
+                        res.setHeader("Content-Type", "text/html; charset=utf-8");
+                        return res.sendFile(indexPath);
+                    }
+                    next();
+                });
             }
             else {
                 // HTTP服务代理
@@ -81,8 +108,8 @@ function createServer(config) {
                     target: staticProxyConfig.target,
                     changeOrigin: staticProxyConfig.changeOrigin !== false, // 默认为true
                     pathRewrite: {
-                        [`^${proxyPath}`]: '' // 移除代理路径前缀
-                    }
+                        [`^${proxyPath}`]: "", // 移除代理路径前缀
+                    },
                 }));
             }
         });
@@ -91,39 +118,39 @@ function createServer(config) {
     app.use(express_1.default.static(staticDir, {
         setHeaders: (res, filePath, stat) => {
             // 设置通用响应头，提升移动端兼容性
-            res.setHeader('X-Content-Type-Options', 'nosniff');
-            res.setHeader('X-Frame-Options', 'SAMEORIGIN');
-            res.setHeader('X-XSS-Protection', '1; mode=block');
+            res.setHeader("X-Content-Type-Options", "nosniff");
+            res.setHeader("X-Frame-Options", "SAMEORIGIN");
+            res.setHeader("X-XSS-Protection", "1; mode=block");
             // 针对HTML文件设置移动端优化响应头
-            if (filePath.endsWith('.html')) {
-                res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
-                res.setHeader('Pragma', 'no-cache');
-                res.setHeader('Expires', '0');
+            if (filePath.endsWith(".html")) {
+                res.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
+                res.setHeader("Pragma", "no-cache");
+                res.setHeader("Expires", "0");
                 // 确保正确的Content-Type
-                res.setHeader('Content-Type', 'text/html; charset=utf-8');
+                res.setHeader("Content-Type", "text/html; charset=utf-8");
             }
             // 针对CSS文件确保正确的Content-Type
-            if (filePath.endsWith('.css')) {
-                res.setHeader('Content-Type', 'text/css; charset=utf-8');
+            if (filePath.endsWith(".css")) {
+                res.setHeader("Content-Type", "text/css; charset=utf-8");
             }
             // 针对JS文件确保正确的Content-Type
-            if (filePath.endsWith('.js')) {
-                res.setHeader('Content-Type', 'application/javascript; charset=utf-8');
+            if (filePath.endsWith(".js")) {
+                res.setHeader("Content-Type", "application/javascript; charset=utf-8");
             }
             // 针对图片文件设置适当的缓存
             if (filePath.match(/\.(jpg|jpeg|png|gif|webp|svg)$/i)) {
-                res.setHeader('Cache-Control', 'public, max-age=31536000');
+                res.setHeader("Cache-Control", "public, max-age=31536000");
             }
-        }
+        },
     }));
     // 添加移动端兼容性中间件
     app.use((req, res, next) => {
         // 检测移动端User-Agent并设置相应响应头
-        const userAgent = req.get('User-Agent') || '';
+        const userAgent = req.get("User-Agent") || "";
         const isMobile = /Mobile|Android|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(userAgent);
         if (isMobile) {
             // 为移动端设置额外的响应头
-            res.setHeader('Vary', 'User-Agent');
+            res.setHeader("Vary", "User-Agent");
         }
         next();
     });
@@ -131,7 +158,7 @@ function createServer(config) {
     // 只有当实际文件不存在时才回退到index.html
     app.use((req, res, next) => {
         // 排除API和已处理的代理请求
-        if (req.path.startsWith('/api/')) {
+        if (req.path.startsWith("/api/")) {
             return next();
         }
         // 排除静态代理路径
@@ -146,7 +173,7 @@ function createServer(config) {
         // 检查是否为目录
         if (fs_1.default.existsSync(filePath) && fs_1.default.statSync(filePath).isDirectory()) {
             // 检查目录中是否有index.html
-            const indexPath = path_1.default.join(filePath, 'index.html');
+            const indexPath = path_1.default.join(filePath, "index.html");
             if (fs_1.default.existsSync(indexPath)) {
                 return res.sendFile(indexPath);
             }
@@ -156,7 +183,7 @@ function createServer(config) {
             return res.sendFile(filePath);
         }
         // 如果路径不存在，回退到index.html
-        res.sendFile(path_1.default.join(process.cwd(), staticDir, 'index.html'));
+        res.sendFile(path_1.default.join(process.cwd(), staticDir, "index.html"));
     });
     return app;
 }
@@ -172,7 +199,7 @@ function startServer(config) {
                 });
             }
             catch (error) {
-                console.error('Failed to start server:', error);
+                console.error("Failed to start server:", error);
                 reject(error);
             }
         });

package/dist/types.d.ts

@@ -5,12 +5,13 @@ export interface ProxyConfig {
 }
 export interface StaticProxyConfig {
     target: string;
-    type?: 'http' | 'static';
+    type?: "http" | "static";
     changeOrigin?: boolean;
 }
 export interface AgentConfig {
     port?: number;
     dir?: string;
+    redirect?: string;
     proxy?: Record<string, ProxyConfig>;
     staticProxy?: Record<string, StaticProxyConfig>;
     log?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-publish-server",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "description": "A powerful frontend development server with API proxy, static file serving, and dual-mode static proxy support. Built with Node.js + Express + http-proxy-middleware. 基于 Node.js + Express + http-proxy-middleware 的强大前端开发服务器，支持API代理、静态文件服务和双模式静态代理。",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",