agent-publish-server 1.0.15 → 1.0.17

package/README.md

@@ -1,80 +1,359 @@
-## agent-publish-server
+# agent-publish-server
 
-> 这是一个基于 nodejs+express+http-proxy-middleware 的一款可支持代理的前端服务启动插件
+[English](#english) | [中文](#chinese)
+
+---
+
+## <a id="english"></a>English
+
+> A frontend service startup plugin based on nodejs+express+http-proxy-middleware with proxy support
 
-## 安装
+### Features
+
+- 🚀 **Quick Start**: One-command startup for development server
+- 🔄 **Proxy Support**: Built-in proxy middleware for API forwarding
+- 📁 **Static File Serving**: Serve static files from any directory
+- ⚙️ **Interactive Configuration**: Easy setup with interactive CLI
+- 📝 **Access Logging**: Optional request logging with timestamps
+- 🛡️ **Path Validation**: Automatic project path validation
+- 🎯 **SPA Support**: Single Page Application routing support
+
+### Installation
 
 ```bash
 npm install agent-publish-server -g
 ```
 
-## 使用步骤
+### Quick Start
 
-### 步骤 1：初始化配置文件
-
-首先，初始化配置文件：
+#### Method 1: Interactive Configuration (Recommended)
 
 ```bash
-agent-publish-server init
+agent-publish-server -wp
 ```
 
-这将在当前目录生成默认配置文件 `agent_config.json`。
+This will guide you through an interactive setup:
 
-### 步骤 2：自定义配置（可选）
+1. Enter port number
+2. Enter project directory (after build)
+3. Enter proxy configuration (format: `/api:http://localhost:3000`)
+4. Choose to continue adding proxies (1: continue, 0: finish)
+5. Generate `agent_config.json` and get startup command
 
-根据需要修改生成的 `agent_config.json` 配置文件。配置格式如下：
+#### Method 2: Manual Configuration
+
+1. **Initialize configuration file:**
+
+```bash
+agent-publish-server init
+```
+
+2. **Edit the generated `agent_config.json`:**
 
 ```json
 {
-  "port": 8080, // 端口号
-  "dir": "./", // 静态文件目录
+  "port": 8080,
+  "dir": "./",
+  "log": true,
   "proxy": {
     "/api": {
-      // 代理路径
-      "target": "URL_ADDRESS", // 代理地址
-      "changeOrigin": true, // 是否改变域名
+      "target": "http://localhost:3000",
+      "changeOrigin": true,
       "pathRewrite": {
-        // 路径重写
-        "^/api": "" // 重写后路径
+        "^/api": ""
       }
     }
+  },
+  "staticProxy": {
+    "/sub_page": {
+      "target": "http://localhost:3000",
+      "changeOrigin": true
+    }
   }
 }
 ```
 
-### 步骤 3：启动服务
+3. **Start the server:**
 
 ```bash
-agent-publish-server
+agent-publish-server -c ./agent_config.json
+```
+
+### Command Line Options
+
+| Option                | Description                     | Example                                 |
+| --------------------- | ------------------------------- | --------------------------------------- |
+| `-wp, --write-proxy`  | Interactive proxy configuration | `agent-publish-server -wp`              |
+| `-c, --config <path>` | Specify configuration file path | `agent-publish-server -c ./config.json` |
+| `-p, --port <number>` | Override port number            | `agent-publish-server -p 3000`          |
+| `-d, --dir <path>`    | Override static directory       | `agent-publish-server -d ./dist`        |
+| `--log <boolean>`     | Enable/disable access logging   | `agent-publish-server --log false`      |
+| `-v, --version`       | Show version                    | `agent-publish-server -v`               |
+| `init`                | Initialize configuration file   | `agent-publish-server init`             |
+
+### Configuration Schema
+
+```typescript
+interface AgentConfig {
+  port?: number; // Server port (default: 8080)
+  dir?: string; // Static files directory (default: "./")
+  log?: boolean; // Enable access logging (default: true)
+  proxy?: {
+    // Proxy configurations
+    [path: string]: {
+      target: string; // Target URL
+      changeOrigin?: boolean; // Change origin header
+      pathRewrite?: {
+        // Path rewrite rules
+        [pattern: string]: string;
+      };
+    };
+  };
+}
+```
+
+### Access Logging
+
+Access logging is enabled by default and shows:
+
+- Timestamp (ISO format)
+- Client IP address
+- HTTP method and URL
+- User agent string
+
+Example log output:
+
+```
+[2025-08-27T11:02:48.854Z] ::1 "GET /" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
 ```
 
-## 配置选项
+To disable logging:
+
+```bash
+agent-publish-server --log false
+```
+
+### Error Handling
+
+- **Invalid project path**: Shows "项目路径错误" (Project path error) and exits
+- **Invalid port**: Validates port numbers (1-65535)
+- **Missing configuration**: Falls back to defaults
+
+### Use Cases
+
+- **React/Vue Development**: Serve built applications with API proxying
+- **Frontend Testing**: Quick static file serving with CORS handling
+- **Local Development**: Proxy API calls to backend services
+- **SPA Deployment**: Proper routing support for single-page applications
+
+---
+
+## <a id="chinese"></a>中文
+
+> 这是一个基于 nodejs+express+http-proxy-middleware 的一款可支持代理的前端服务启动插件
+
+### 功能特性
+
+- 🚀 **快速启动**: 一键启动开发服务器
+- 🔄 **代理支持**: 内置代理中间件，支持 API 转发
+- 📁 **静态文件服务**: 支持任意目录的静态文件托管
+- ⚙️ **交互式配置**: 通过问答方式轻松配置
+- 📝 **访问日志**: 可选的请求日志记录功能
+- 🛡️ **路径验证**: 自动验证项目路径有效性
+- 🎯 **SPA 支持**: 单页应用路由支持
+
+### 安装
+
+```bash
+npm install agent-publish-server -g
+```
+
+### 快速开始
+
+#### 方式一：交互式配置（推荐）
+
+```bash
+agent-publish-server -wp
+```
+
+这将引导您完成交互式设置：
+
+1. 输入端口号
+2. 输入项目地址（打包后）
+3. 输入代理接口配置（格式：`/api:http://localhost:3000`）
+4. 选择是否继续添加代理（1：继续，0：结束）
+5. 生成 `agent_config.json` 并获得启动命令提示
+
+#### 方式二：手动配置
+
+1. **初始化配置文件：**
+
+```bash
+agent-publish-server init
+```
 
-### 指定配置文件
+2. **编辑生成的 `agent_config.json`：**
 
-你可以通过以下方式指定自定义配置文件路径：
+```json
+{
+  "port": 8080,
+  "dir": "./",
+  "log": true,
+  "proxy": {
+    "/api": {
+      "target": "http://localhost:3000",
+      "changeOrigin": true,
+      "pathRewrite": {
+        "^/api": ""
+      }
+    }
+  }
+}
+```
 
-1. 使用相对路径（相对于当前工作目录）：
+3. **启动服务：**
 
 ```bash
 agent-publish-server -c ./agent_config.json
 ```
 
-2. 使用绝对路径：
+### 命令行选项
+
+| 选项                  | 说明              | 示例                                    |
+| --------------------- | ----------------- | --------------------------------------- |
+| `-wp, --write-proxy`  | 交互式代理配置    | `agent-publish-server -wp`              |
+| `-c, --config <路径>` | 指定配置文件路径  | `agent-publish-server -c ./config.json` |
+| `-p, --port <端口>`   | 覆盖端口号        | `agent-publish-server -p 3000`          |
+| `-d, --dir <目录>`    | 覆盖静态文件目录  | `agent-publish-server -d ./dist`        |
+| `--log <布尔值>`      | 启用/禁用访问日志 | `agent-publish-server --log false`      |
+| `-v, --version`       | 显示版本          | `agent-publish-server -v`               |
+| `init`                | 初始化配置文件    | `agent-publish-server init`             |
+
+### 配置文件格式
+
+```typescript
+interface AgentConfig {
+  port?: number; // 服务器端口（默认：8080）
+  dir?: string; // 静态文件目录（默认："./"）
+  log?: boolean; // 启用访问日志（默认：true）
+  proxy?: {
+    // API代理配置
+    [path: string]: {
+      target: string; // 目标URL
+      changeOrigin?: boolean; // 更改源头
+      pathRewrite?: {
+        // 路径重写规则
+        [pattern: string]: string;
+      };
+    };
+  };
+  staticProxy?: {
+    // 静态网页代理配置
+    [path: string]: {
+      target: string; // 目标URL
+      changeOrigin?: boolean; // 更改源头（默认：true）
+    };
+  };
+}
+```
+
+### 静态网页代理
+
+除了API代理外，还支持静态网页代理功能，用于代理整个网站或应用。
+
+#### 配置示例
+
+```json
+{
+  "staticProxy": {
+    "/sub_page": {
+      "target": "http://localhost:3000",
+      "changeOrigin": true
+    }
+  }
+}
+```
+
+#### 功能特性
+
+- **路径代理**：访问 `/sub_page` 会代理到目标服务器的根路径
+- **自动路径重写**：自动移除代理路径前缀，确保目标服务器收到正确请求
+- **优先级处理**：静态代理优先于静态文件服务，避免路径冲突
+- **跨域支持**：默认启用 `changeOrigin` 选项
+
+#### 与API代理组合使用
+
+`staticProxy` 可以与 `proxy` 配置同时使用：
+
+```json
+{
+  "proxy": {
+    "/api": {
+      "target": "http://localhost:3000",
+      "changeOrigin": true,
+      "pathRewrite": { "^/api": "" }
+    }
+  },
+  "staticProxy": {
+    "/app": {
+      "target": "http://localhost:3001",
+      "changeOrigin": true
+    }
+  }
+}
+```
+
+这样配置后：
+- 访问 `/api/*` 会代理到 `http://localhost:3000/*`（API服务）
+- 访问 `/app/*` 会代理到 `http://localhost:3001/*`（前端应用）
+- 其他路径会访问本地静态文件
+
+### 访问日志
+
+访问日志默认启用，显示内容包括：
+
+- 时间戳（ISO 格式）
+- 客户端 IP 地址
+- HTTP 方法和 URL
+- 用户代理字符串
+
+日志输出示例：
+
+```
+[2025-08-27T11:02:48.854Z] ::1 "GET /" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
+```
+
+禁用日志：
 
 ```bash
-agent-publish-server -c /path/to/agent_config.json
+agent-publish-server --log false
 ```
 
-支持的配置文件参数：
+### 错误处理
+
+- **项目路径无效**：显示"项目路径错误"并退出
+- **端口号无效**：验证端口号范围（1-65535）
+- **配置缺失**：使用默认配置
+
+### 使用场景
+
+- **React/Vue 开发**：为构建后的应用提供服务并代理 API
+- **前端测试**：快速静态文件服务，处理跨域问题
+- **本地开发**：代理 API 调用到后端服务
+- **SPA 部署**：为单页应用提供正确的路由支持
+- **微前端架构**：通过静态代理整合多个前端应用
+- **开发环境整合**：将多个本地服务统一到一个端口访问
+
+### 版本历史
+
+- **v1.0.17**: 新增静态网页代理功能（staticProxy），支持与API代理同时使用
+- **v1.0.16**: 新增交互式配置、访问日志、路径验证功能
+- **v1.0.15**: 基础代理和静态文件服务功能
+
+### 许可证
 
-- `-c`
-- `--config`
-- `--cf`
-- `--config-file`
+MIT License
 
-## 其他说明
+### 贡献
 
-- 适配 React、Vue 等前端框架
-- 使用 `-v` 或 `--version` 查看当前版本
-- 默认配置文件名为 `agent_config.json`
+欢迎提交 Issue 和 Pull Request！

package/dist/cli.js

@@ -1,11 +1,116 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const config_1 = require("./config");
 const server_1 = require("./server");
 const fs_1 = require("fs");
 const path_1 = require("path");
+const readline = __importStar(require("readline"));
+// 交互式配置函数
+async function interactiveWriteProxyConfig() {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+    });
+    const question = (prompt) => {
+        return new Promise((resolve) => {
+            rl.question(prompt, resolve);
+        });
+    };
+    try {
+        // 询问端口号
+        const portInput = await question('请输入端口号: ');
+        const port = parseInt(portInput.trim(), 10);
+        if (isNaN(port) || port <= 0 || port > 65535) {
+            throw new Error('无效的端口号，请输入1-65535之间的数字');
+        }
+        // 询问项目地址
+        const dirInput = await question('请输入项目地址（打包后）: ');
+        const dir = dirInput.trim() || './';
+        const config = {
+            port,
+            dir,
+            proxy: {},
+            log: true // 默认启用日志
+        };
+        // 循环添加代理配置
+        while (true) {
+            const proxyInput = await question('请输入代理接口（格式例如：/api:http://localhost:3000）: ');
+            const proxyStr = proxyInput.trim();
+            if (proxyStr) {
+                const parts = proxyStr.split(':');
+                if (parts.length < 2) {
+                    console.log('格式错误，请按照 /api:http://localhost:3000 的格式输入');
+                    continue;
+                }
+                const path = parts[0].trim();
+                const target = parts.slice(1).join(':'); // 处理URL中的冒号
+                if (!path.startsWith('/')) {
+                    console.log('代理路径必须以 / 开头');
+                    continue;
+                }
+                if (!target.startsWith('http://') && !target.startsWith('https://')) {
+                    console.log('代理目标地址必须是完整的URL（以http://或https://开头）');
+                    continue;
+                }
+                config.proxy[path] = {
+                    target: target,
+                    changeOrigin: true,
+                    pathRewrite: {
+                        [`^${path}`]: ''
+                    }
+                };
+                console.log(`✓ 已添加代理：${path} -> ${target}`);
+            }
+            const continueInput = await question('是否继续添加代理接口：1：继续，0：结束: ');
+            if (continueInput.trim() === '0') {
+                break;
+            }
+            else if (continueInput.trim() !== '1') {
+                console.log('请输入 1 继续或 0 结束');
+                continue;
+            }
+        }
+        return config;
+    }
+    finally {
+        rl.close();
+    }
+}
 const program = new commander_1.Command();
 const packageJson = require('../package.json');
 program
@@ -14,11 +119,30 @@ program
     .option('--cf <path>', '配置文件路径')
     .option('--config-file <path>', '配置文件路径')
     .option('-p, --port <number>', '服务器端口号')
-    .option('-d, --dir <path>', '静态文件目录路径');
+    .option('-d, --dir <path>', '静态文件目录路径')
+    .option('-wp, --write-proxy', '交互式配置代理服务')
+    .option('--log <boolean>', '是否显示访问日志 (true/false)，默认为true');
 // 添加一个默认命令，用于处理没有指定任何子命令的情况
 program
-    .action(() => {
+    .action(async () => {
     const options = program.opts();
+    // 检查是否使用 -wp 选项
+    if (options.writeProxy) {
+        try {
+            console.log('✨ 欢迎使用交互式代理配置\n');
+            // 交互式配置
+            const config = await interactiveWriteProxyConfig();
+            const configPath = (0, path_1.join)(process.cwd(), 'agent_config.json');
+            (0, fs_1.writeFileSync)(configPath, JSON.stringify(config, null, 2));
+            console.log('\n✓ 已配置完成，请运行：agent-publish-server -c ./agent_config.json');
+            process.exit(0);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            console.error('\n✗ 配置失败:', errorMessage);
+            process.exit(1);
+        }
+    }
     // 加载配置
     const config = (0, config_1.loadConfig)(options);
     // 命令行参数优先级高于配置文件
@@ -33,6 +157,20 @@ program
     if (options.dir) {
         config.dir = options.dir;
     }
+    // 处理日志参数
+    if (options.log !== undefined) {
+        const logValue = options.log.toLowerCase();
+        if (logValue === 'true') {
+            config.log = true;
+        }
+        else if (logValue === 'false') {
+            config.log = false;
+        }
+        else {
+            console.error('日志参数必须是 true 或 false');
+            process.exit(1);
+        }
+    }
     // 启动服务器
     (0, server_1.startServer)(config).catch((error) => {
         console.error('Server failed to start:', error);

package/dist/server.js

@@ -12,12 +12,42 @@ const fs_1 = __importDefault(require("fs"));
 function createServer(config) {
     const app = (0, express_1.default)();
     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('项目路径错误');
+    }
+    // 添加日志中间件
+    if (enableLog) {
+        app.use((req, res, next) => {
+            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 || '-';
+            console.log(`[${timestamp}] ${ip} "${method} ${url}" "${userAgent}"`);
+            next();
+        });
+    }
+    // 配置API代理
     if (config.proxy) {
         Object.entries(config.proxy).forEach(([path, proxyConfig]) => {
             app.use(path, (0, http_proxy_middleware_1.createProxyMiddleware)(proxyConfig));
         });
     }
+    // 配置静态网页代理
+    if (config.staticProxy) {
+        Object.entries(config.staticProxy).forEach(([path, staticProxyConfig]) => {
+            app.use(path, (0, http_proxy_middleware_1.createProxyMiddleware)({
+                target: staticProxyConfig.target,
+                changeOrigin: staticProxyConfig.changeOrigin !== false, // 默认为true
+                pathRewrite: {
+                    [`^${path}`]: '' // 移除代理路径前缀
+                }
+            }));
+        });
+    }
     // 配置静态文件服务
     app.use(express_1.default.static(staticDir));
     // 添加SPA应用的回退路由处理
@@ -27,6 +57,14 @@ function createServer(config) {
         if (req.path.startsWith('/api/')) {
             return next();
         }
+        // 排除静态代理路径
+        if (config.staticProxy) {
+            for (const proxyPath of Object.keys(config.staticProxy)) {
+                if (req.path.startsWith(proxyPath)) {
+                    return next();
+                }
+            }
+        }
         const filePath = path_1.default.join(process.cwd(), staticDir, req.path);
         // 检查是否为目录
         if (fs_1.default.existsSync(filePath) && fs_1.default.statSync(filePath).isDirectory()) {
@@ -46,18 +84,25 @@ function createServer(config) {
     return app;
 }
 function startServer(config) {
-    const app = createServer(config);
-    const port = config.port || 8080;
-    return new Promise((resolve, reject) => {
-        try {
-            app.listen(port, () => {
-                console.log(`Server is running at http://localhost:${port}`);
-                resolve();
-            });
-        }
-        catch (error) {
-            console.error('Failed to start server:', error);
-            reject(error);
-        }
-    });
+    try {
+        const app = createServer(config);
+        const port = config.port || 8080;
+        return new Promise((resolve, reject) => {
+            try {
+                app.listen(port, () => {
+                    console.log(`Server is running at http://localhost:${port}`);
+                    resolve();
+                });
+            }
+            catch (error) {
+                console.error('Failed to start server:', error);
+                reject(error);
+            }
+        });
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        console.error(errorMessage);
+        process.exit(1);
+    }
 }

package/dist/types.d.ts

@@ -3,10 +3,16 @@ export interface ProxyConfig {
     changeOrigin?: boolean;
     pathRewrite?: Record<string, string>;
 }
+export interface StaticProxyConfig {
+    target: string;
+    changeOrigin?: boolean;
+}
 export interface AgentConfig {
     port?: number;
     dir?: string;
     proxy?: Record<string, ProxyConfig>;
+    staticProxy?: Record<string, StaticProxyConfig>;
+    log?: boolean;
 }
 export interface CommandOptions {
     config?: string;
@@ -15,4 +21,6 @@ export interface CommandOptions {
     configFile?: string;
     port?: string;
     dir?: string;
+    writeProxy?: boolean;
+    log?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-publish-server",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "基于 nodejs+express+http-proxy-middleware 的前端服务启动插件",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/test-static-proxy.json

@@ -0,0 +1,11 @@
+{
+  "port": 8080,
+  "dir": "./",
+  "staticProxy": {
+    "/fy_user_point": {
+      "target": "http://localhost:3000",
+      "changeOrigin": true
+    }
+  },
+  "log": true
+}