agent-publish-server 1.0.26 → 1.0.28

package/README.md

@@ -92,12 +92,14 @@ interface AgentConfig {
   port?: number; // 服务器端口（默认：8080）
   dir?: string; // 静态文件目录（默认："./"）
   redirect?: string; // 根路径重定向，如 "/app" 表示访问 / 时重定向到 /app
+  fallbackRedirect?: string; // 404兜底重定向，当路由匹配不上时重定向到指定路径
   log?: boolean; // 启用访问日志（默认：true）
   proxy?: {
     // API代理配置
     [path: string]: {
       target: string; // 目标URL
       changeOrigin?: boolean; // 更改源头
+      ws?: boolean; // 启用 WebSocket 代理
       pathRewrite?: {
         // 路径重写规则
         [pattern: string]: string;
@@ -134,6 +136,30 @@ interface AgentConfig {
 
 这样配置后，访问 `http://localhost:3000/` 会自动重定向到 `http://localhost:3000/app`。
 
+### 404兜底重定向
+
+通过 `fallbackRedirect` 配置实现当路由匹配不上时自动重定向到指定路径，避免出现黑屏或404页面：
+
+```json
+{
+  "port": 3000,
+  "redirect": "/app",
+  "fallbackRedirect": "/app",
+  "staticProxy": {
+    "/app": {
+      "target": "./dist",
+      "type": "static"
+    }
+  }
+}
+```
+
+这样配置后：
+
+- 访问 `http://localhost:3000/` 会自动重定向到 `/app`
+- 访问不存在的路由（如 `/unknown`）也会重定向到 `/app`
+- 已配置的 `staticProxy` 路径仍正常访问，不受影响
+
 ### 静态网页代理
 
 除了 API 代理外，还支持静态网页代理功能，用于代理整个网站或应用。
@@ -248,6 +274,8 @@ agent-publish-server --log false
 
 ### 版本历史
 
+- **v1.0.28**: 新增 proxy.ws 配置，支持 WebSocket upgrade 代理转发
+- **v1.0.27**: 新增404兜底重定向配置（fallbackRedirect），当路由匹配不上时自动重定向到指定路径，避免黑屏或404错误
 - **v1.0.26**: 新增根路径重定向配置（redirect），支持访问 / 时自动跳转到指定路径
 - **v1.0.25**: 修复 staticProxy static 类型不支持 SPA History 路由刷新的问题，添加自动 fallback 到 index.html 支持
 - **v1.0.24**: 修复移动端兼容性问题，优化 HTTP 响应头设置，确保 iOS 和 Android 显示一致性

package/README_EN.md

@@ -106,6 +106,7 @@ With this config, accessing `http://localhost:3000/` will redirect to `http://lo
 interface ProxyConfig {
   target: string; // Target server URL
   changeOrigin?: boolean; // Change origin header
+  ws?: boolean; // Enable WebSocket proxy
   pathRewrite?: Record<string, string>; // Path rewriting rules
 }
 ```
@@ -249,6 +250,8 @@ startServer(app, config.port);
 
 ## Version History
 
+- **v1.0.28**: Added proxy.ws configuration to support WebSocket upgrade proxy forwarding
+- **v1.0.27**: Added 404 fallback redirect configuration (fallbackRedirect), automatically redirects unmatched routes to the specified path
 - **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

package/dist/server.d.ts

@@ -1,3 +1,6 @@
+import { createProxyMiddleware } from "http-proxy-middleware";
 import { AgentConfig } from "./types";
-export declare function createServer(config: AgentConfig): import("express-serve-static-core").Express;
+type ProxyMiddleware = ReturnType<typeof createProxyMiddleware>;
+export declare function createServer(config: AgentConfig, wsProxyMiddlewares?: ProxyMiddleware[]): import("express-serve-static-core").Express;
 export declare function startServer(config: AgentConfig): Promise<void>;
+export {};

package/dist/server.js

@@ -9,7 +9,7 @@ const express_1 = __importDefault(require("express"));
 const http_proxy_middleware_1 = require("http-proxy-middleware");
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
-function createServer(config) {
+function createServer(config, wsProxyMiddlewares = []) {
     const app = (0, express_1.default)();
     const staticDir = config.dir || "./";
     const enableLog = config.log !== false; // 默认为true
@@ -41,8 +41,12 @@ function createServer(config) {
     }
     // 配置API代理
     if (config.proxy) {
-        Object.entries(config.proxy).forEach(([path, proxyConfig]) => {
-            app.use(path, (0, http_proxy_middleware_1.createProxyMiddleware)(proxyConfig));
+        Object.entries(config.proxy).forEach(([proxyPath, proxyConfig]) => {
+            const proxyMiddleware = (0, http_proxy_middleware_1.createProxyMiddleware)(proxyPath, proxyConfig);
+            app.use(proxyMiddleware);
+            if (proxyConfig.ws === true) {
+                wsProxyMiddlewares.push(proxyMiddleware);
+            }
         });
     }
     // 配置静态网页代理
@@ -155,7 +159,7 @@ function createServer(config) {
         next();
     });
     // 添加SPA应用的回退路由处理
-    // 只有当实际文件不存在时才回退到index.html
+    // 只有当实际文件不存在时才回退到index.html或执行fallbackRedirect
     app.use((req, res, next) => {
         // 排除API和已处理的代理请求
         if (req.path.startsWith("/api/")) {
@@ -182,21 +186,39 @@ function createServer(config) {
         if (fs_1.default.existsSync(filePath) && fs_1.default.statSync(filePath).isFile()) {
             return res.sendFile(filePath);
         }
-        // 如果路径不存在，回退到index.html
-        res.sendFile(path_1.default.join(process.cwd(), staticDir, "index.html"));
+        // 如果配置了fallbackRedirect，则重定向到指定路径
+        if (config.fallbackRedirect) {
+            const redirectPath = config.fallbackRedirect.startsWith("/")
+                ? config.fallbackRedirect
+                : `/${config.fallbackRedirect}`;
+            return res.redirect(302, redirectPath);
+        }
+        // 如果路径不存在且未配置fallbackRedirect，回退到index.html
+        const rootIndexPath = path_1.default.join(process.cwd(), staticDir, "index.html");
+        if (fs_1.default.existsSync(rootIndexPath)) {
+            return res.sendFile(rootIndexPath);
+        }
+        // 如果index.html也不存在，返回404
+        res.status(404).send("404 Not Found");
     });
     return app;
 }
 function startServer(config) {
     try {
-        const app = createServer(config);
+        const wsProxyMiddlewares = [];
+        const app = createServer(config, wsProxyMiddlewares);
         const port = config.port || 8080;
         return new Promise((resolve, reject) => {
             try {
-                app.listen(port, () => {
+                const server = app.listen(port, () => {
                     console.log(`Server is running at http://localhost:${port}`);
                     resolve();
                 });
+                wsProxyMiddlewares.forEach((proxyMiddleware) => {
+                    if (proxyMiddleware.upgrade) {
+                        server.on("upgrade", proxyMiddleware.upgrade);
+                    }
+                });
             }
             catch (error) {
                 console.error("Failed to start server:", error);

package/dist/types.d.ts

@@ -2,6 +2,7 @@ export interface ProxyConfig {
     target: string;
     changeOrigin?: boolean;
     pathRewrite?: Record<string, string>;
+    ws?: boolean;
 }
 export interface StaticProxyConfig {
     target: string;
@@ -12,6 +13,7 @@ export interface AgentConfig {
     port?: number;
     dir?: string;
     redirect?: string;
+    fallbackRedirect?: 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.26",
+  "version": "1.0.28",
   "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",

package/test-fallback-redirect.json

@@ -0,0 +1,18 @@
+{
+  "port": 8080,
+  "dir": "./",
+  "redirect": "/sub_page",
+  "fallbackRedirect": "/sub_page",
+  "staticProxy": {
+    "/sub_page": {
+      "target": "./dist",
+      "type": "static"
+    },
+    "/app": {
+      "target": "http://localhost:3000",
+      "type": "http",
+      "changeOrigin": true
+    }
+  },
+  "log": true
+}