@vectorx/xhs-cloud-cli 0.6.1 → 1.0.0

package/lib/commands/fun/new.js

@@ -0,0 +1,125 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunNewCommand = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const base_1 = require("../../core/base");
+const decorators_1 = require("../../decorators");
+let FunNewCommand = class FunNewCommand extends base_1.Command {
+    execute(options, log) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { projectName, dir } = options;
+            if (!projectName) {
+                log.error("项目名称不能为空");
+                process.exit(1);
+            }
+            const targetDir = dir || process.cwd();
+            const projectDir = path_1.default.join(targetDir, projectName);
+            if (fs_1.default.existsSync(projectDir)) {
+                log.error(`项目目录已存在: ${projectDir}`);
+                process.exit(1);
+            }
+            log.breakLine();
+            console.log(chalk_1.default.bold.blue("📋 云函数项目创建信息"));
+            console.log(chalk_1.default.gray("─".repeat(40)));
+            console.log(chalk_1.default.bold("创建目录:   ") + chalk_1.default.green(projectDir));
+            console.log(chalk_1.default.bold("目录名称:   ") + chalk_1.default.cyan(projectName));
+            console.log(chalk_1.default.gray("─".repeat(40)));
+            log.breakLine();
+            const templateDir = path_1.default.join(__dirname, "../../../", "templates", "ai-cloud-functions-example");
+            if (!fs_1.default.existsSync(templateDir)) {
+                log.error(`模板目录不存在: ${templateDir}`);
+                throw new Error(`模板目录不存在: ${templateDir}`);
+            }
+            const spinnerCopy = require("ora")("复制模板文件...").start();
+            try {
+                yield this.copyTemplate(templateDir, projectDir);
+                spinnerCopy.succeed("模板文件复制完成");
+            }
+            catch (e) {
+                spinnerCopy.fail("模板文件复制失败: " + e.message);
+                throw e;
+            }
+            log.breakLine();
+            log.info(`✔️ 云函数项目创建成功: ${projectDir}`);
+            log.info("下一步操作:");
+            log.info(`  - cd ${projectDir}`);
+            log.info("  - npm install");
+            log.info("  - npm run dev");
+        });
+    }
+    copyTemplate(sourceDir, targetDir) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!fs_1.default.existsSync(targetDir)) {
+                fs_1.default.mkdirSync(targetDir, { recursive: true });
+            }
+            const files = fs_1.default.readdirSync(sourceDir);
+            for (const file of files) {
+                const sourcePath = path_1.default.join(sourceDir, file);
+                const targetPath = path_1.default.join(targetDir, file);
+                const stat = fs_1.default.statSync(sourcePath);
+                if (stat.isDirectory()) {
+                    yield this.copyTemplate(sourcePath, targetPath);
+                }
+                else {
+                    fs_1.default.copyFileSync(sourcePath, targetPath);
+                }
+            }
+        });
+    }
+    get options() {
+        return {
+            cmd: "fun",
+            childCmd: "new",
+            desc: "创建新的云函数项目",
+            usage: "rcb fun new [projectName]",
+            options: [
+                {
+                    flags: "-d, --dir <dir>",
+                    desc: "指定项目创建的目标目录，默认为当前目录",
+                },
+                {
+                    flags: "-p, --projectName <projectName>",
+                    desc: "指定项目名称，默认为当前目录名称",
+                },
+            ],
+        };
+    }
+};
+exports.FunNewCommand = FunNewCommand;
+__decorate([
+    (0, decorators_1.InjectParams)(),
+    __param(0, (0, decorators_1.ArgsOptions)()),
+    __param(1, (0, decorators_1.Log)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Function]),
+    __metadata("design:returntype", Promise)
+], FunNewCommand.prototype, "execute", null);
+exports.FunNewCommand = FunNewCommand = __decorate([
+    (0, base_1.ICommand)()
+], FunNewCommand);

package/lib/commands/index.js

@@ -16,3 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./auth"), exports);
 __exportStar(require("./agent"), exports);
+__exportStar(require("./fun"), exports);
+__exportStar(require("./env"), exports);

package/lib/constants/cmd.js

@@ -25,13 +25,13 @@ exports.ALL_COMMANDS = [
     "env domain list",
     "env domain create",
     "env domain delete",
-    "fn list",
-    "fn download",
-    "fn deploy",
-    "fn delete",
-    "fn detail",
-    "fn code update",
-    "fn invoke",
-    "fn publish-version",
-    "fn list-function-versions",
+    "fun list",
+    "fun download",
+    "fun deploy",
+    "fun delete",
+    "fun detail",
+    "fun code update",
+    "fun invoke",
+    "fun publish-version",
+    "fun list-function-versions",
 ];

package/lib/core/base.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Command = exports.registrableCommands = void 0;
 exports.ICommand = ICommand;
+const cloud_toolkit_1 = require("@vectorx/cloud-toolkit");
 const commander_1 = require("commander");
 exports.registrableCommands = [];
 function ICommand() {
@@ -23,6 +24,11 @@ class Command {
     init() {
         const { cmd, childCmd, childSubCmd, deprecateCmd } = this.options;
         let instance;
+        const mainCommandDescriptions = {
+            agent: "开发与构建 AI Agent",
+            fun: "管理 Fun 云函数调试与部署",
+            env: "管理云环境（Environment）",
+        };
         if (cmdMap.has(cmd)) {
             instance = cmdMap.get(cmd);
         }
@@ -30,6 +36,9 @@ class Command {
             instance = commander_1.program.command(cmd);
             instance._helpDescription = "输出帮助信息";
             instance.addHelpCommand("help [command]", "查看命令帮助信息");
+            if (childCmd && mainCommandDescriptions[cmd]) {
+                instance.description(mainCommandDescriptions[cmd]);
+            }
             cmdMap.set(cmd, instance);
         }
         if (childCmd) {
@@ -86,9 +95,74 @@ class Command {
         instance.description(desc);
         instance.action((...args) => __awaiter(this, void 0, void 0, function* () {
             const params = args.slice(0, -1);
+            const commandObj = args[args.length - 1];
             const cmdOptions = instance.opts();
+            const normalizeCmdPath = (raw) => {
+                var _a, _b;
+                const parts = String(raw || "")
+                    .trim()
+                    .split(/\s+/)
+                    .filter(Boolean);
+                if (!parts.length)
+                    return cmd;
+                const head = (_b = (_a = parts[0]) === null || _a === void 0 ? void 0 : _a.toLowerCase) === null || _b === void 0 ? void 0 : _b.call(_a);
+                if (head === "rcb" || head === "tcb") {
+                    parts.shift();
+                }
+                return parts.join(" ");
+            };
+            const buildFullCmdPath = () => {
+                const { childCmd, childSubCmd } = this.options;
+                const cmdParts = [cmd];
+                if (childCmd) {
+                    const childCmdName = typeof childCmd === "string" ? childCmd : childCmd.cmd;
+                    cmdParts.push(childCmdName);
+                }
+                if (childSubCmd) {
+                    cmdParts.push(childSubCmd);
+                }
+                return cmdParts.join(" ");
+            };
+            const rawCmdPath = typeof (commandObj === null || commandObj === void 0 ? void 0 : commandObj.commandPath) === "function"
+                ? commandObj.commandPath()
+                :
+                    typeof (instance === null || instance === void 0 ? void 0 : instance.commandPath) === "function"
+                        ?
+                            instance.commandPath()
+                        : null;
+            let cmdPath = rawCmdPath ? normalizeCmdPath(rawCmdPath) : buildFullCmdPath();
+            const expectedParts = [cmd];
+            if (this.options.childCmd) {
+                expectedParts.push(typeof this.options.childCmd === "string" ? this.options.childCmd : this.options.childCmd.cmd);
+            }
+            if (this.options.childSubCmd) {
+                expectedParts.push(this.options.childSubCmd);
+            }
+            const cmdPathParts = cmdPath.split(/\s+/).filter(Boolean);
+            if (cmdPathParts.length < expectedParts.length) {
+                cmdPath = buildFullCmdPath();
+            }
+            const optionsKeys = Object.keys(cmdOptions || {})
+                .filter((k) => !k.startsWith("_"))
+                .filter((k) => k !== "help" && k !== "version")
+                .filter((k) => typeof (cmdOptions === null || cmdOptions === void 0 ? void 0 : cmdOptions[k]) !== "undefined");
+            const tracker = (0, cloud_toolkit_1.createCliCommandTracker)({
+                cmd_path: cmdPath,
+                cmd_root: cmd,
+                params_count: params.length,
+                options_keys: optionsKeys,
+            });
+            const startTime = Date.now();
             const ctx = { cmd, params, options: cmdOptions };
-            yield this.execute(ctx);
+            try {
+                const res = yield this.execute(ctx);
+                tracker.reportSuccess(Date.now() - startTime);
+                return res;
+            }
+            catch (err) {
+                tracker.reportFail(Date.now() - startTime, err);
+                throw err;
+            }
         }));
     }
 }

package/lib/decorators/auth.js

@@ -39,6 +39,12 @@ function AuthGuard() {
                     cloud_toolkit_1.logger.breakLine();
                     console.log(chalk_1.default.gray("🔗 获取登录秘钥：https://miniapp.xiaohongshu.com/console-panel"));
                     cloud_toolkit_1.logger.breakLine();
+                    try {
+                        (0, cloud_toolkit_1.reportCliException)("uncaughtException", new Error("Auth required: please login first"));
+                        yield new Promise((r) => setTimeout(r, 250));
+                    }
+                    catch (_a) {
+                    }
                     process.exit(1);
                 }
                 return originalExecute.call(this, ctx);

package/lib/decorators/captureError.js

@@ -20,6 +20,7 @@ const CaptureError = () => (target, key, descriptor) => {
             }
             catch (e) {
                 const errMsg = (e === null || e === void 0 ? void 0 : e.message) || (typeof (e === null || e === void 0 ? void 0 : e.toString) === "function" ? e.toString() : "") || "Unknown Error";
+                throw e;
             }
         });
     };

package/lib/main.js

@@ -11,10 +11,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerCommands = registerCommands;
 require("reflect-metadata");
+const cloud_toolkit_1 = require("@vectorx/cloud-toolkit");
 const base_1 = require("./core/base");
 require("./commands");
 function registerCommands() {
     return __awaiter(this, void 0, void 0, function* () {
+        try {
+            (0, cloud_toolkit_1.initCliApm)({ cliVersion: (process === null || process === void 0 ? void 0 : process.CLI_VERSION) || "unknown" });
+        }
+        catch (e) {
+        }
         base_1.registrableCommands.forEach(({ Command }) => new Command().init());
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vectorx/xhs-cloud-cli",
-  "version": "0.6.1",
+  "version": "1.0.0",
   "description": "xhs-cloud-cli 主要用于如下场景：  - agent 调试、发布  - cloud 云函数的调试、部署",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -16,9 +16,10 @@
   ],
   "dependencies": {
     "@koa/router": "^12.0.1",
-    "@vectorx/agent-simulator": "0.8.1",
-    "@vectorx/cloud-toolkit": "0.5.1",
-    "@vectorx/functions-framework": "0.8.1",
+    "@vectorx/agent-simulator": "1.0.0",
+    "@vectorx/cloud-toolkit": "1.0.0",
+    "@vectorx/function-debugger": "1.0.0",
+    "@vectorx/functions-framework": "1.0.0",
     "address": "^1.1.2",
     "archiver": "^6.0.1",
     "camelcase-keys": "^7.0.2",
@@ -34,7 +35,7 @@
     "execa": "^4.0.3",
     "fs-extra": "^8.1.0",
     "https-proxy-agent": "^5.0.1",
-    "inquirer": "^6.5.0",
+    "inquirer": "^6.5.2",
     "inversify": "^7.5.2",
     "json-schema-to-typescript": "^14.0.5",
     "koa": "^2.16.1",
@@ -70,7 +71,7 @@
   "devDependencies": {
     "@types/archiver": "^5.3.2",
     "@types/fs-extra": "^11.0.4",
-    "@types/inquirer": "^9.0.8",
+    "@types/inquirer": "^9.0.9",
     "@types/jest": "^27",
     "@types/koa": "^2.13.12",
     "@types/koa-bodyparser": "^4.3.12",

package/templates/ai-cloud-functions-example/.env.template

@@ -0,0 +1 @@
+# key

package/templates/ai-cloud-functions-example/README.md

@@ -0,0 +1,277 @@
+# 云函数测试项目
+
+这是一个云函数服务端的测试项目，用于测试和演示云函数在不同 Content-Type 和 HTTP 方法下的处理能力。
+
+## 项目结构
+
+```
+src/
+├── json/          # JSON 请求处理函数
+├── form/          # 表单提交处理函数
+├── multipart/     # 文件上传处理函数
+├── binary/        # 二进制数据处理函数
+├── text/          # 文本数据处理函数
+└── user/          # 用户相关函数
+```
+
+## 函数目录说明
+
+### 1. JSON 请求处理 (`src/json/`)
+
+**覆盖场景：**
+- `Content-Type: application/json`
+- `Content-Type: application/vnd.api+json` (带 +json 后缀)
+
+**业务场景：** 用户数据查询和创建（模拟数据库操作）
+
+#### 函数列表
+
+| 函数名 | 路由路径 | HTTP 方法 | 功能说明 |
+|--------|---------|----------|---------|
+| `jsonUsersList` | `/json/users` | GET | 查询用户列表（支持分页） |
+| `jsonUsersCreate` | `/json/users/create` | POST | 创建用户（JSON Body） |
+| `jsonUsersBatch` | `/json/users/batch` | POST | 批量查询用户（支持 +json content-type） |
+
+**示例请求：**
+```bash
+# GET 查询用户列表
+GET /json/users?page=1&limit=10
+
+# POST 创建用户
+POST /json/users/create
+Content-Type: application/json
+Body: { "name": "王五", "email": "wangwu@example.com", "age": 28 }
+
+# POST 批量查询
+POST /json/users/batch
+Content-Type: application/vnd.api+json
+Body: { "userIds": ["u001", "u002"] }
+```
+
+---
+
+### 2. 表单提交处理 (`src/form/`)
+
+**覆盖场景：**
+- `Content-Type: application/x-www-form-urlencoded`
+
+**业务场景：** 表单数据提交和处理（模拟表单提交到数据库）
+
+#### 函数列表
+
+| 函数名 | 路由路径 | HTTP 方法 | 功能说明 |
+|--------|---------|----------|---------|
+| `formSubmit` | `/form/submit` | POST | 提交表单数据 |
+| `formSubmissions` | `/form/submissions` | GET | 查询表单提交记录 |
+
+**示例请求：**
+```bash
+# POST 提交表单
+POST /form/submit
+Content-Type: application/x-www-form-urlencoded
+Body: name=张三&email=zhangsan@example.com&message=这是一条留言
+
+# GET 查询提交记录
+GET /form/submissions?email=zhangsan@example.com
+```
+
+---
+
+### 3. 文件上传处理 (`src/multipart/`)
+
+**覆盖场景：**
+- `Content-Type: multipart/form-data`
+
+**业务场景：** 文件上传，模拟保存到数据库或 OSS
+
+#### 函数列表
+
+| 函数名 | 路由路径 | HTTP 方法 | 功能说明 |
+|--------|---------|----------|---------|
+| `multipartUpload` | `/multipart/upload` | POST | 上传文件（multipart/form-data） |
+| `multipartFiles` | `/multipart/files` | GET | 查询文件列表 |
+
+**功能特性：**
+- 支持多种文件格式（Buffer、base64 字符串、包装对象）
+- 模拟保存文件元数据到数据库
+- 模拟上传文件到 OSS
+- 返回文件访问 URL
+
+**示例请求：**
+```bash
+# POST 上传文件
+POST /multipart/upload
+Content-Type: multipart/form-data
+Body: FormData with file field
+
+# GET 查询文件列表
+GET /multipart/files?fileType=image/png
+```
+
+---
+
+### 4. 二进制数据处理 (`src/binary/`)
+
+**覆盖场景：**
+- `Content-Type: application/octet-stream`
+
+**业务场景：** 处理二进制文件（图片、文档等），模拟保存到数据库或 OSS
+
+#### 函数列表
+
+| 函数名 | 路由路径 | HTTP 方法 | 功能说明 |
+|--------|---------|----------|---------|
+| `binaryUpload` | `/binary/upload` | POST | 上传二进制文件 |
+| `binaryFiles` | `/binary/files` | GET | 查询二进制文件信息 |
+
+**功能特性：**
+- 自动检测文件类型（JPEG、PNG、PDF 等）
+- 通过文件头（Magic Number）识别文件格式
+- 模拟保存到 OSS
+- 图片文件自动生成缩略图（模拟）
+- 保存文件元数据到数据库
+
+**示例请求：**
+```bash
+# POST 上传二进制文件
+POST /binary/upload
+Content-Type: application/octet-stream
+Body: <binary data>
+
+# GET 查询文件信息
+GET /binary/files?fileType=image/jpeg
+```
+
+---
+
+### 5. 文本数据处理 (`src/text/`)
+
+**覆盖场景：**
+- `Content-Type: text/plain`
+- `Content-Type: text/html`
+- `Content-Type: text/xml`
+- 默认 text（未指定 content-type）
+
+**业务场景：** 处理文本数据，模拟日志记录、文本分析等
+
+#### 函数列表
+
+| 函数名 | 路由路径 | HTTP 方法 | 功能说明 |
+|--------|---------|----------|---------|
+| `textSubmit` | `/text/submit` | POST | 提交文本内容 |
+| `textLogs` | `/text/logs` | GET | 查询文本日志 |
+| `textHtml` | `/text/html` | POST | 处理 HTML 内容 |
+
+**功能特性：**
+- 文本分析（字数统计、字符统计、行数统计）
+- 关键词提取
+- HTML 解析（提取标题、链接）
+- 日志记录和查询
+
+**示例请求：**
+```bash
+# POST 提交文本
+POST /text/submit
+Content-Type: text/plain
+Body: "这是一段文本内容"
+
+# GET 查询日志
+GET /text/logs?contentType=text/plain&limit=10
+
+# POST 处理 HTML
+POST /text/html
+Content-Type: text/html
+Body: "<html><body><h1>Hello</h1></body></html>"
+```
+
+---
+
+### 6. 用户相关 (`src/user/`)
+
+**业务场景：** 用户基本信息查询
+
+#### 函数列表
+
+| 函数名 | 路由路径 | HTTP 方法 | 功能说明 |
+|--------|---------|----------|---------|
+| `userProfile` | `/user/profile` | POST | 查询用户基本信息 |
+
+**示例请求：**
+```bash
+# POST 查询用户信息
+POST /user/profile
+Body: { "userId": "u10001" }
+```
+
+---
+
+## Content-Type 覆盖情况
+
+本项目完整覆盖了以下 Content-Type 场景：
+
+| Content-Type | 处理函数目录 | 说明 |
+|-------------|------------|------|
+| `application/json` | `json/` | JSON 数据请求 |
+| `application/vnd.api+json` | `json/` | 带 +json 后缀的 JSON |
+| `application/x-www-form-urlencoded` | `form/` | URL 编码表单数据 |
+| `multipart/form-data` | `multipart/` | 多部分表单数据（文件上传） |
+| `application/octet-stream` | `binary/` | 二进制数据流 |
+| `text/plain` | `text/` | 纯文本 |
+| `text/html` | `text/` | HTML 文本 |
+| `text/xml` | `text/` | XML 文本 |
+| 默认（未指定） | `text/` | 默认按 text/plain 处理 |
+
+## HTTP 方法覆盖
+
+- **GET**: 用于查询操作（列表查询、详情查询）
+- **POST**: 用于创建操作（数据提交、文件上传）
+
+## 日志功能
+
+所有函数都包含详细的日志输出，包括：
+
+- **函数调用开始日志**：记录函数调用时间、上下文 ID、事件 ID
+- **参数日志**：记录请求参数和查询条件
+- **处理过程日志**：记录数据处理的关键步骤
+- **结果日志**：记录处理结果和返回数据
+- **错误日志**：记录错误信息和失败原因
+
+日志格式统一使用 `[函数名]` 前缀，便于日志过滤和追踪。
+
+## 业务逻辑模拟
+
+所有函数都模拟了真实的业务场景：
+
+1. **数据库操作**：使用内存数组模拟数据库的增删改查
+2. **文件存储**：模拟文件上传到 OSS，生成访问 URL
+3. **数据验证**：参数校验、格式检查、业务规则验证
+4. **错误处理**：统一的错误响应格式
+5. **数据分析**：文本分析、文件类型检测等
+
+## 配置说明
+
+函数配置在 `agent-cloudbase-functions.json` 中定义，遵循以下规则：
+
+- 每个函数一个目录
+- 使用 `source: "index.js"` 映射函数入口
+- 通过 `triggerPath` 定义路由路径
+- 支持单实例多函数框架
+
+## 使用说明
+
+1. **启动开发服务器**：
+   ```bash
+   npm run dev
+   ```
+
+2. **测试函数**：
+   使用 HTTP 客户端（如 Postman、curl）或云函数调试器调用各个路由
+
+3. **查看日志**：
+   函数执行时会输出详细的日志信息，便于调试和追踪
+
+## 注意事项
+
+- 本项目仅用于测试和演示，所有数据存储在内存中，重启后会丢失
+- 文件上传功能仅模拟保存元数据，实际文件内容不会持久化存储
+- 所有业务逻辑都是模拟实现，不包含真实的数据库或 OSS 操作