cloudcc-cli 2.3.0 → 2.3.2

package/src/application/delete.js

@@ -0,0 +1,59 @@
+const chalk = require("chalk");
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 删除应用（Application）
+ * 用法：cc delete application <projectPath> <appId>
+ */
+async function remove(argvs) {
+    try {
+        const projectPath = argvs[2] || process.cwd();
+        const appId = argvs[3];
+
+        if (!appId) {
+            console.error();
+            console.error(chalk.red("Error: 缺少应用 ID"));
+            console.error(chalk.yellow("用法: cc delete application <projectPath> <appId>"));
+            console.error();
+            throw new Error("缺少必需参数: appId");
+        }
+
+        const config = await getPackageJson(projectPath);
+        if (!config || !config.accessToken) {
+            console.error();
+            console.error(chalk.red("Error: 配置未找到或 accessToken 缺失"));
+            console.error();
+            throw new Error("配置未找到或 accessToken 缺失");
+        }
+
+        console.error();
+        console.error(chalk.green(`Deleting application (${appId}), please wait...`));
+        console.error();
+
+        const result = await postClass(
+            config.setupSvc + "/api/appProgram/deleteApp",
+            { id: appId },
+            config.accessToken
+        );
+
+        if (result && result.result) {
+            console.error();
+            console.error(chalk.green("Success! Application deleted."));
+            console.error();
+            return result;
+        }
+
+        const msg = result && (result.returnInfo || result.message) ? (result.returnInfo || result.message) : "Unknown error";
+        console.error();
+        console.error(chalk.red("Error: " + msg));
+        console.error();
+        throw new Error("Delete Application Failed: " + msg);
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("应用删除失败:"), error);
+        throw error;
+    }
+}
+
+module.exports = remove;

package/src/application/doc.js

@@ -0,0 +1,46 @@
+/**
+ * application 文档入口：正文均在 `docs/` 目录。
+ */
+const fs = require("fs");
+const path = require("path");
+
+const DOCS_DIR = path.join(__dirname, "docs");
+
+function readDocFile(basename) {
+    return fs.readFileSync(path.join(DOCS_DIR, `${basename}.md`), "utf8");
+}
+
+/** 介绍文档：应用能力、定位与场景 */
+function getIntroductionDoc() {
+    return readDocFile("introduction");
+}
+
+/** 开发指导：CLI 创建/查询/删除应用 */
+function getDevGuideDoc() {
+    return readDocFile("devguide");
+}
+
+/**
+ * cc doc application <introduction|devguide>
+ * @param {string[]} argvs [doc, type, introduction|devguide, ...]
+ */
+function doc(argvs) {
+    const subType = argvs[2];
+    const key = String(subType || "").trim().toLowerCase();
+    if (!key) {
+        throw new Error("cc doc application 需要子命令：introduction 或 devguide");
+    }
+    if (key === "introduction") {
+        const content = getIntroductionDoc();
+        console.log(content);
+        return content;
+    }
+    if (key === "devguide") {
+        const content = getDevGuideDoc();
+        console.log(content);
+        return content;
+    }
+    throw new Error(`doc 不支持的子命令: ${subType}，请使用 introduction 或 devguide`);
+}
+
+module.exports = doc;

package/src/application/docs/devguide.md

@@ -0,0 +1,173 @@
+# CloudCC 应用开发指南
+
+## 1. 模块定位
+
+`application` 模块用于通过 CLI 管理 CloudCC 应用，当前提供：
+
+- 创建应用：`cc create application ...`
+- 查询应用：`cc get application ...`
+- 删除应用：`cc delete application ...`
+- 文档查看：`cc doc application introduction|devguide`
+
+---
+
+## 2. 开发前准备
+
+执行命令前请确认：
+
+- 已完成 `cc doc project devguide` 的环境初始化
+- 项目根目录存在可用配置，且包含 `accessToken`
+- 已准备应用名称、应用代码
+- 若需自定义菜单挂载，已准备菜单 ID 列表
+
+---
+
+## 3. 命令总览（以代码实现为准）
+
+```bash
+cc create application <path> <p1> <p2> [duel1]
+cc get application <projectPath> [encodedCondJson]
+cc delete application <projectPath> <appId>
+cc doc application <introduction|devguide>
+```
+
+参数约定：
+
+- `path` / `projectPath`：项目路径
+- `p1`：应用名称
+- `p2`：应用代码
+- `duel1`：菜单 ID 列表（逗号分隔，可选）
+- `encodedCondJson`：URI 编码后的 JSON 查询条件
+- `appId`：应用 ID
+
+---
+
+## 4. 创建应用
+
+```bash
+cc create application <path> <p1> <p2> [duel1]
+```
+
+### 4.1 参数说明
+
+- `path`：项目路径，推荐传 `.` 表示当前目录
+- `p1`：应用名称（例如 `销售工作台`）
+- `p2`：应用代码（例如 `sales_workbench`）
+- `duel1`：菜单 ID 列表，多个 ID 以逗号分隔
+
+### 4.2 默认行为与自动补全
+
+- 若未传 `duel1`，CLI 会默认使用 `acf000001`
+- 若传入 `duel1` 但不包含 `acf000001`，CLI 会自动补入该 ID
+- 创建过程中会自动查询角色列表并注入权限参数
+
+### 4.3 示例
+
+```bash
+# 使用默认菜单 ID
+cc create application . "销售工作台" sales_workbench
+
+# 指定菜单 ID（可多个）
+cc create application . "销售工作台" sales_workbench "acf000001,a0I9D000000XXXXUAI"
+```
+
+### 4.4 常见报错
+
+- 缺少参数：
+
+```text
+Error: 缺少必需参数
+用法: cc create application <path> <p1> <p2> [duel1]
+```
+
+- 角色列表获取失败（依赖 `brief/get`）：
+
+```text
+获取角色列表失败
+```
+
+---
+
+## 5. 查询应用
+
+```bash
+cc get application <projectPath> [encodedCondJson]
+```
+
+说明：
+
+- 不传条件时，返回应用列表
+- 传条件时需使用 `encodeURI(JSON.stringify(...))` 编码
+
+示例：
+
+```bash
+# 查询全部应用
+cc get application .
+
+# 按条件查询（示例）
+cc get application . '%7B%22appType%22%3A%22app%22%7D'
+```
+
+若条件 JSON 无法解析，会报错：
+
+```text
+Get Application List Failed: encodedCondJson 解析失败，请传 encodeURI(JSON.stringify(...))
+```
+
+---
+
+## 6. 删除应用
+
+```bash
+cc delete application <projectPath> <appId>
+```
+
+参数说明：
+
+- `projectPath`：项目路径
+- `appId`：应用 ID（必填）
+
+示例：
+
+```bash
+cc delete application . a0L9D000000XXXXUAI
+```
+
+缺少 `appId` 时会报错：
+
+```text
+Error: 缺少应用 ID
+用法: cc delete application <projectPath> <appId>
+```
+
+---
+
+## 7. 文档命令
+
+```bash
+cc doc application introduction
+cc doc application devguide
+```
+
+仅支持 `introduction` 与 `devguide`，其他子命令会抛错。
+
+---
+
+## 8. 推荐操作顺序
+
+```bash
+# 1) 先查现有应用，避免重名
+cc get application .
+
+# 2) 创建应用
+cc create application . "销售工作台" sales_workbench
+
+# 3) 再次查询确认已创建
+cc get application .
+
+# 4) 如需回滚，按 appId 删除
+cc delete application . <appId>
+```
+
+---

package/src/application/docs/introduction.md

@@ -0,0 +1,81 @@
+# CloudCC 应用模块介绍
+
+## 1. 模块定位
+
+`application` 模块用于在 CloudCC 中创建和管理应用程序（Application）。
+
+应用是菜单与功能入口的承载容器。对象菜单、页面菜单、脚本菜单通常需要归属于某个应用，业务用户才会在对应导航中看到完整功能集合。
+
+---
+
+## 2. 应用能做什么
+
+通过 `application` 模块，你可以：
+
+- 创建新应用并设置应用名称、代码
+- 绑定菜单集合（支持多菜单 ID）
+- 获取当前组织内应用列表
+- 删除指定应用
+
+---
+
+## 3. 应用在平台中的作用
+
+应用解决的是“功能编排与入口组织”问题：
+
+- 将零散菜单按业务域组织为统一导航体验
+- 给不同业务线提供独立的应用入口
+- 配合简档权限，控制不同角色可见的应用能力
+
+---
+
+## 4. 典型使用流程
+
+在 CloudCC 中，应用相关流程通常如下：
+
+1. 准备对象、页面、脚本等能力
+2. 创建或确认对应菜单入口
+3. 创建应用并绑定菜单
+4. 验证应用在目标角色下的可见性与可用性
+
+`cloudcc-cli` 主要覆盖第 3 步（应用创建/查询/删除），建议结合菜单与权限配置一同验收。
+
+---
+
+## 5. 适用场景
+
+以下场景建议使用 `application` 模块：
+
+- 新项目上线，需要快速搭建业务导航应用
+- 多业务线并行，需要拆分不同应用入口
+- 现有菜单较多，需要按业务域重新归类到应用
+- 自动化脚本中需要批量创建和清理测试应用
+
+---
+
+## 6. 与其他模块的关系
+
+`application` 常与以下模块协同：
+
+- `menu`：应用通过菜单承载具体入口
+- `object`：对象能力常通过对象菜单进入应用
+- `customPage`：页面能力可通过页面菜单加入应用
+- `script`：脚本能力可通过脚本菜单加入应用
+
+---
+
+## 7. 建议实践
+
+- 应用命名与编码遵循统一规范（如业务域前缀）
+- 创建前先梳理菜单清单，避免重复或遗漏入口
+- 先在测试环境验证应用可见性，再推广到生产环境
+- 变更应用菜单后，回归验证关键业务流程是否可达
+
+---
+
+## 8. 相关文档与命令
+
+```bash
+cc doc application introduction
+cc doc application devguide
+```

package/src/application/get.js

@@ -2,12 +2,38 @@ const { postClass } = require("../../utils/http")
 const { getPackageJson } = require("../../utils/config")
 
 async function get(argvs, isMcp = false) {
-    // TODO: 实现获取应用列表的功能
-    let res = [];
-    if (!isMcp) {
-        console.log(JSON.stringify(res));
+    const projectPath = argvs[2] || process.cwd();
+    const condArg = argvs[3];
+
+    let body = {};
+    if (condArg) {
+        try {
+            body = JSON.parse(decodeURI(condArg));
+        } catch (e) {
+            throw new Error("Get Application List Failed: encodedCondJson 解析失败，请传 encodeURI(JSON.stringify(...))");
+        }
     }
-    return res
+
+    const config = await getPackageJson(projectPath);
+    const result = await postClass(
+        config.setupSvc + "/api/appProgram/queryAppList",
+        body,
+        config.accessToken
+    );
+
+    if (result && result.result) {
+        const data = result.data;
+        const rawList = Array.isArray(data)
+            ? data
+            : (data && Array.isArray(data.list) ? data.list : []);
+        if (!isMcp) {
+            console.log(JSON.stringify(rawList));
+        }
+        return rawList;
+    }
+
+    const msg = result && (result.returnInfo || result.message) ? (result.returnInfo || result.message) : "Unknown error";
+    throw new Error("Get Application List Failed: " + msg);
 }
 
 module.exports = get;

package/src/application/index.js

@@ -1,6 +1,8 @@
 const cc = {}
 cc.get = require("./get")
 cc.create = require("./create")
+cc.delete = require("./delete")
+cc.doc = require("./doc")
 function main(action, argvs) {
   cc[action](argvs)
 }

package/src/brief/get.js

@@ -6,7 +6,7 @@ async function get(argvs) {
         let path = argvs[2]
         let config = await getPackageJson(path);
 
-        // 调用接口获取自定义对象页面信息
+        // 获取简档列表
         let response = await postClass(
             config.setupSvc + "/api/customObject/newPage",
             {

package/src/classes/create.js

@@ -4,7 +4,12 @@ const path = require("path")
 const chalk = require("chalk")
 const { getPackageJson } = require("../../utils/config.js")
 
-async function create(name) {
+/**
+ * cc create classes <name>
+ * @param {string[]} argvs [action, type, name, ...]
+ */
+async function create(argvs) {
+    const name = argvs[2]
     let res = await checkUpdate();
     if (!res) {
         let config = await getPackageJson();

package/src/classes/delete.js

@@ -0,0 +1,49 @@
+const fs = require("fs");
+const path = require("path");
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * cc delete classes <nameOrId> [projectPath]
+ * @param {string[]} argvs [action, type, nameOrId, projectPath?]
+ */
+async function remove(argvs) {
+    const nameOrId = argvs[2]
+    const projectPath = argvs[3] != null && argvs[3] !== '' ? argvs[3] : process.cwd()
+    let classId = nameOrId;
+    const classPath = path.join(projectPath, `classes/${nameOrId}/`);
+    const configPath = path.join(classPath, "config.json");
+
+    if (fs.existsSync(configPath)) {
+        const configContent = JSON.parse(fs.readFileSync(configPath, "utf8"));
+        if (configContent.id) {
+            classId = configContent.id;
+        }
+    }
+
+    if (!classId) {
+        throw new Error("Delete Class Failed: class name or id is required");
+    }
+
+    const config = await getPackageJson(projectPath);
+    console.error();
+    console.error(chalk.green(`Deleting class (${classId}), please wait...`));
+    console.error();
+
+    const res = await postClass(
+        config.setupSvc + "/api/ccfag/delete",
+        { id: classId },
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        console.error(chalk.green("Success! Class deleted."));
+        console.error();
+        return res;
+    }
+    const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    throw new Error("Delete Class Failed: " + msg);
+}
+
+module.exports = remove;

package/src/classes/detail.js

@@ -4,7 +4,21 @@ const path = require("path")
 const { getPackageJson } = require("../../utils/config")
 const { postClass } = require("../../utils/http")
 
-async function detail(name, id) {
+function outputResult(result, isMcp) {
+    if (!isMcp) {
+        console.log(JSON.stringify(result));
+    }
+    return result;
+}
+
+/**
+ * cc detail classes <name> <id>
+ * @param {string[]} argvs [action, type, name?, id?, isMcp?]
+ */
+async function detail(argvs) {
+    const name = argvs[2]
+    const id = argvs[3]
+    const isMcp = Boolean(argvs[4])
     // 如果有 name，优先查询本地
     if (name && name !== '') {
         const classPath = path.join(process.cwd(), `classes/${name}/`);
@@ -15,14 +29,14 @@ async function detail(name, id) {
         if (fs.existsSync(configPath) && fs.existsSync(javaFilePath)) {
             let configContent = JSON.parse(fs.readFileSync(configPath, 'utf8'));
             let javaContent = fs.readFileSync(javaFilePath, 'utf8');
-            return {
+            return outputResult({
                 name: configContent.name,
                 version: configContent.version,
                 id: configContent.id || null,
                 source: javaContent,
                 published: !!configContent.id,
                 fromLocal: true
-            };
+            }, isMcp);
         }
 
         // 本地文件不完整，从服务器拉取
@@ -44,10 +58,10 @@ async function detail(name, id) {
         let res = await postClass(config.setupSvc + "/api/ccfag/detail", body, config.accessToken)
 
         if (res.result) {
-            return {
+            return outputResult({
                 ...res.data.trigger,
                 fromLocal: false
-            };
+            }, isMcp);
         } else {
             throw new Error('Get Class Details Failed: ' + res.returnInfo);
         }
@@ -62,10 +76,10 @@ async function detail(name, id) {
         let res = await postClass(config.setupSvc + "/api/ccfag/detail", body, config.accessToken)
 
         if (res.result) {
-            return {
+            return outputResult({
                 ...res.data.trigger,
                 fromLocal: false
-            };
+            }, isMcp);
         } else {
             throw new Error('Get Class Details Failed: ' + res.returnInfo);
         }