cloudcc-cli 2.3.2 → 2.3.4

package/src/menu/docs/devguide.md

@@ -1,203 +1,129 @@
-# CloudCC 菜单开发指南
+# CloudCC 菜单 CLI 命令说明
 
-## 1. 模块定位
+## 支持的命令
 
-`menu` 模块用于创建、查询、删除 CloudCC 菜单（标签页）。  
-菜单是对象、页面、脚本能力的可视化入口，也是应用导航的重要组成部分。
+| 操作 | 说明 |
+|------|------|
+| `create menu object` | 创建自定义对象菜单 |
+| `create menu page` | 创建自定义页面菜单 |
+| `create menu script` | 创建自定义脚本菜单 |
+| `create menu site` | 创建站点菜单 |
+| `get menu` | 查询菜单列表 |
+| `delete menu` | 删除菜单 |
 
-可通过以下命令查看文档：
+## CLI 命令详解
 
-```bash
-cc doc menu introduction
-cc doc menu devguide
-```
-
----
-
-## 2. 开发前准备
-
-执行菜单相关命令前，请确认：
-
-- 已完成 `cc doc project devguide` 的环境初始化
-- 项目根目录存在可用的 `cloudcc-cli.config.js`
-- 当前环境连接可用（org / token / endpoint 正确）
-- 已明确菜单所属资源（对象 ID、页面 API、脚本内容或站点 ID）
-
----
-
-## 3. 支持的命令总览
-
-```bash
-cc create menu object <path> <objectId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
-cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]
-cc create menu script <path> <tabName> <pname> [functioncode] [tabStyle] [mobileimg] [cloudccservicetab]
-cc create menu site <path> <siteId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
-
-cc get menu <projectPath> [encodedCondJson]
-cc delete menu <projectPath> <tabId>
-```
-
----
-
-## 4. 创建菜单
-
-### 4.1 创建自定义对象菜单
+### 创建自定义对象菜单
 
 ```bash
 cc create menu object <path> <objectId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径，`.` 表示当前目录
-- `objectId`：自定义对象 ID
-- `tabName`：菜单显示名称
-- `tabStyle`：PC 端图标（可选，默认 `cloudtab145`）
-- `mobileimg`：移动端图标（可选，默认 `cloudcc01`）
-- `cloudccservicetab`：服务图标（可选，默认 `cloudccservicetab_1`）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径，`.` 表示当前目录 |
+| `objectId` | 是 | 自定义对象 ID |
+| `tabName` | 是 | 菜单显示名称 |
+| `tabStyle` | 否 | PC 端图标（默认 `cloudtab145`）|
+| `mobileimg` | 否 | 移动端图标（默认 `cloudcc01`）|
+| `cloudccservicetab` | 否 | 服务图标（默认 `cloudccservicetab_1`）|
 
-示例：
+**示例：**
 
 ```bash
 cc create menu object . a0F9D000000XXXXUAI "客户管理"
 ```
 
-### 4.2 创建自定义页面菜单
+### 创建自定义页面菜单
 
 ```bash
 cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径
-- `pageApi`：自定义页面 API 名称（CLI 会追加 `#lightning`）
-- `tabName`：菜单显示名称
-- `pname`：菜单内部名称（建议字母开头，字母/数字/下划线）
-- `tabStyle` / `mobileimg` / `cloudccservicetab`：图标参数（可选）
-- `mobileurl`：移动端地址（可选）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径 |
+| `pageApi` | 是 | 自定义页面 API 名称（CLI 会追加 `#lightning`）|
+| `tabName` | 是 | 菜单显示名称 |
+| `pname` | 是 | 菜单内部名称（建议字母开头）|
+| `tabStyle` / `mobileimg` / `cloudccservicetab` | 否 | 图标参数 |
+| `mobileurl` | 否 | 移动端地址 |
 
-示例：
+**示例：**
 
 ```bash
 cc create menu page . contract-assistant "合同助手" contract_menu
 ```
 
-### 4.3 创建自定义脚本菜单
+### 创建自定义脚本菜单
 
 ```bash
 cc create menu script <path> <tabName> <pname> [functioncode] [tabStyle] [mobileimg] [cloudccservicetab]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径
-- `tabName`：菜单显示名称
-- `pname`：菜单内部名称
-- `functioncode`：脚本内容（可选，默认示例脚本）
-- `tabStyle` / `mobileimg` / `cloudccservicetab`：图标参数（可选）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径 |
+| `tabName` | 是 | 菜单显示名称 |
+| `pname` | 是 | 菜单内部名称 |
+| `functioncode` | 否 | 脚本内容（默认示例脚本）|
 
-示例：
+**示例：**
 
 ```bash
 cc create menu script . "数据导入工具" data_import_menu "ccc.alert('Hello World');"
 ```
 
-### 4.4 创建站点菜单
+### 创建站点菜单
 
 ```bash
 cc create menu site <path> <siteId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径
-- `siteId`：站点 ID
-- `tabName`：菜单显示名称
-- `tabStyle` / `mobileimg` / `cloudccservicetab`：图标参数（可选）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径 |
+| `siteId` | 是 | 站点 ID |
+| `tabName` | 是 | 菜单显示名称 |
 
-示例：
+**示例：**
 
 ```bash
 cc create menu site . a0H9D000000XXXXUAI "合作伙伴门户"
 ```
 
----
-
-## 5. 查询与删除
-
-### 5.1 查询菜单
+### 查询菜单列表
 
 ```bash
 cc get menu <projectPath> [encodedCondJson]
 ```
 
-说明：
-
-- `projectPath` 默认当前目录
-- `encodedCondJson` 为 URI 编码后的 JSON 查询条件
-
-示例：
+**示例：**
 
 ```bash
+# 查询所有菜单
 cc get menu .
+
+# 带查询条件
 cc get menu . '%7B%22type%22%3A%22page%22%7D'
 ```
 
-### 5.2 删除菜单
+### 删除菜单
 
 ```bash
 cc delete menu <projectPath> <tabId>
 ```
 
-说明：
-
-- `tabId` 为菜单 ID，建议先执行 `cc get menu .` 再删除
-
-示例：
+**示例：**
 
 ```bash
 cc delete menu . a0I9D000000XXXXUAI
 ```
-
----
-
-## 6. 与后台菜单配置流程的映射
-
-根据 CloudCC 官方菜单流程，完整上线通常包含三层动作：
-
-1. 新建菜单（对象 / 页面 / 脚本）
-2. 添加到简档（控制可见角色）
-3. 添加到应用程序（控制出现在什么应用）
-
-`cloudcc-cli` 当前主要覆盖第 1 步（菜单实体创建）。  
-因此在 CLI 创建后，建议在后台继续核验第 2-3 步，确保用户可见且出现在目标应用导航中。
-
----
-
-## 7. 常见注意事项
-
-- 菜单创建成功不等于用户可见，需检查简档权限
-- 菜单创建成功不等于出现在预期应用，需检查应用挂载
-- `page` 类型请确认页面 API 存在且可访问
-- 删除菜单前确认未被培训文档、操作手册或用户流程依赖
-- 建议先在测试环境验证，再在生产环境执行
-
----
-
-## 8. 推荐操作顺序
-
-```bash
-# 1) 查询现有菜单，避免重名
-cc get menu .
-
-# 2) 创建目标菜单（示例：页面菜单）
-cc create menu page . contract-manage "合同管理" contract_menu
-
-# 3) 再次查询确认已创建
-cc get menu .
-```
-
-创建后请在 CloudCC 后台完成简档与应用核验。
-
----

package/src/object/create.js

@@ -67,7 +67,8 @@ async function create(argvs) {
                 beginIndex: "0",
                 isquickcreated: "false",
                 islbs: "false",
-                isreportcreated: "false"
+                isreportcreated: "false",
+                remark: "auto created by cloudcc-cli ai agent"
             }
         };
 

package/src/object/docs/devguide.md

@@ -59,13 +59,9 @@ cc get object <projectPath> custom
 ### 4.1 基本命令
 
 ```bash
-cc create object <projectPath> <label> [nameLabel]
+cc create object <projectPath> <label>
 ```
 
-规则：
-
-- 若传入 `nameLabel`，则使用传入值作为对象 API 名称
-- 若未传入 `nameLabel`，CLI 会根据 `label` 自动生成一个英文可用的 slug，并拼成对象 API 名称
 
 ### 4.2 创建过程
 

package/src/pagelayout/create.js

@@ -16,8 +16,8 @@ async function getExistingLayouts(config, objId) {
             config.accessToken
         );
 
-        if (res && res.result && res.layouts && Array.isArray(res.layouts) && res.layouts.length > 0) {
-            return res.layouts;
+        if (res && res.result && res.data && Array.isArray(res.data) && res.data.length > 0) {
+            return res.data;
         }
 
         throw new Error("未找到可用的页面布局");

package/src/pagelayout/delete.js

@@ -0,0 +1,57 @@
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+const chalk = require("chalk");
+
+/**
+ * 删除页面布局
+ * 用法：cc delete pagelayout <projectPath> <layoutId>
+ * @param {Array} argvs - 命令行参数数组
+ * @returns {Promise<Object>} 删除结果
+ */
+async function deleteLayout(argvs) {
+    try {
+        // 命令行参数格式：cc delete pagelayout <projectPath> <layoutId>
+        const projectPath = argvs[2] || process.cwd();
+        const layoutId = argvs[3];
+
+        if (!layoutId) {
+            console.error();
+            console.error(chalk.red("Error: 缺少页面布局 ID"));
+            console.error("用法: cc delete pagelayout <projectPath> <layoutId>");
+            console.error("示例:");
+            console.error("  cc delete pagelayout . add202610BD89F09XyGT");
+            console.error();
+            throw new Error("缺少必需参数: layoutId");
+        }
+
+        const config = await getPackageJson(projectPath);
+
+        console.error();
+        console.error(chalk.green(`Deleting page layout "${layoutId}"...`));
+        console.error();
+
+        const res = await postClass(
+            config.setupSvc + "/api/layout/deleteButton",
+            {
+                id: layoutId
+            },
+            config.accessToken
+        );
+
+        if (res && res.result) {
+            console.error(chalk.green("页面布局删除成功！"));
+            console.log(JSON.stringify(res.data || res));
+            return res.data || res;
+        }
+
+        const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+        throw new Error("Delete PageLayout Failed: " + msg);
+
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("页面布局删除失败:"), error.message || error);
+        throw error;
+    }
+}
+
+module.exports = deleteLayout;

package/src/pagelayout/docs/devguide.md

@@ -1,30 +1,19 @@
-# CloudCC 页面布局使用总结
+# CloudCC 页面布局 CLI 命令说明
 
-页面布局（Page Layout）用于定义对象在详情页的字段展示方式，包括字段排列、分区、按钮位置等。
-
-**前置条件**：页面布局操作需要先选中自定义对象或标准对象。
-
----
-
-## 快速开始（CLI 命令）
-
-### 支持的页面布局操作
+## 支持的命令
 
 | 操作 | 说明 |
 |------|------|
 | `get` | 查询页面布局列表 |
 | `create` | 创建/复制页面布局 |
-
----
+| `delete` | 删除页面布局 |
 
 ## CLI 命令详解
 
 ### 查询页面布局列表
 
-获取指定对象的页面布局列表。
-
 ```bash
-cc get pagelayout <projectPath> <objApiName>
+cc get pagelayout <projectPath> <prefix>
 ```
 
 **参数说明：**
@@ -32,7 +21,7 @@ cc get pagelayout <projectPath> <objApiName>
 | 参数 | 必填 | 说明 |
 |------|------|------|
 | `projectPath` | 否 | 项目路径，`.` 表示当前目录 |
-| `objApiName` | 是 | 对象 API 名称（前缀） |
+| `prefix` | 是 | 对象前缀（如 001, b25） |
 
 **示例：**
 
@@ -40,16 +29,12 @@ cc get pagelayout <projectPath> <objApiName>
 # 查询对象 b25 的页面布局列表
 cc get pagelayout . b25
 
-# 使用完整 API 名称
-cc get pagelayout . Account
+# 查询客户对象（001）的页面布局列表
+cc get pagelayout . 001
 ```
 
----
-
 ### 创建页面布局
 
-基于现有布局创建新的页面布局。
-
 ```bash
 cc create pagelayout <projectPath> <objId> <layoutName> [sourceLayoutId] [isCloneDynamic]
 ```
@@ -77,219 +62,22 @@ cc create pagelayout . 20267D1465464C5OB6m5 "课程表2" add20261DA7347CZPAUz
 cc create pagelayout . 20267D1465464C5OB6m5 "课程表2" add20261DA7347CZPAUz false
 ```
 
----
-
-## 完整工作流示例
-
-### 场景：为自定义对象创建新的页面布局
+### 删除页面布局
 
 ```bash
-# 1. 确认项目已初始化（有 cloudcc-cli.config.js）
-cat cloudcc-cli.config.js
-
-# 2. 查询对象的页面布局列表
-cc get pagelayout . b25
-
-# 3. 根据对象 ID 创建新布局
-cc create pagelayout . 20267D1465464C5OB6m5 "新的布局名称"
-
-# 4. 验证创建成功，再次查询列表
-cc get pagelayout . b25
+cc delete pagelayout <projectPath> <layoutId>
 ```
 
----
-
-## API 接口详情
-
-### 什么是页面布局？
-
-**页面布局（Page Layout）** 定义了对象在详情页的展示方式，包括：
-- 字段的排列和分组
-- 相关列表的显示
-- 操作按钮的位置
-- 动态布局规则
-
-### 核心属性
-
-| 属性 | 说明 | 示例 |
-|------|------|------|
-| **ID（id）** | 页面布局唯一标识 | `add20261DA7347CZPAUz` |
-| **名称（layoutName）** | 页面布局显示名称 | `课程表布局` |
-| **对象 ID（objid）** | 关联的对象 ID | `20267D1465464C5OB6m5` |
-
----
-
-## 一、查询页面布局列表
-
-### 1.1 接口说明
-
-**接口**: `POST /api/layout/queryPageLayout`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| `prefix` | string | 是 | 对象 API 名称前缀 |
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "returnInfo": "操作成功",
-  "layouts": [
-    {
-      "id": "add20261DA7347CZPAUz",
-      "layoutName": "默认布局",
-      "objid": "20267D1465464C5OB6m5",
-      // ... 其他字段
-    }
-  ]
-}
-```
-
-**返回字段说明**：
+**参数说明：**
 
-| 字段 | 类型 | 说明 |
+| 参数 | 必填 | 说明 |
 |------|------|------|
-| `layouts` | array | 页面布局数组 |
-| `layouts[].id` | string | 布局 ID |
-| `layouts[].layoutName` | string | 布局名称 |
-| `layouts[].objid` | string | 关联对象 ID |
-
----
-
-## 二、创建页面布局
-
-创建页面布局是一个两步流程：
-
-1. **获取现有布局列表**：调用 `layout/newpage` 接口获取可用于复制的布局
-2. **复制创建新布局**：调用 `layout/cloneLayout` 接口基于选定布局创建新布局
-
-### 2.1 获取现有布局列表
-
-**接口**: `POST /api/layout/newpage`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| `objid` | string | 是 | 对象 ID |
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "returnInfo": "操作成功",
-  "layouts": [
-    {
-      "id": "add20261DA7347CZPAUz",
-      "layoutName": "默认布局",
-      "objid": "20267D1465464C5OB6m5"
-    }
-  ]
-}
-```
-
-**默认布局选择逻辑**：
-
-- 返回列表中的第一个布局作为默认复制源
-
-### 2.2 复制创建新布局
-
-**接口**: `POST /api/layout/cloneLayout`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| `layoutId` | string | 是 | 要复制的源布局 ID |
-| `layoutName` | string | 是 | 新布局名称 |
-| `objid` | string | 是 | 对象 ID |
-| `isCloneDynamic` | string | 否 | 是否复制动态布局规则，默认 `"true"` |
-
-**请求示例**：
-
-```javascript
-{
-  "layoutId": "add20261DA7347CZPAUz",
-  "layoutName": "课程表2",
-  "objid": "20267D1465464C5OB6m5",
-  "isCloneDynamic": "true"
-}
-```
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "returnInfo": "操作成功",
-  "data": {
-    "id": "add2026XXXXXXXXXXXXX",
-    "layoutName": "课程表2"
-  }
-}
-```
-
----
-
-## 三、页面布局数据结构
+| `projectPath` | 否 | 项目路径，`.` 表示当前目录 |
+| `layoutId` | 是 | 要删除的页面布局 ID |
 
-### 3.1 列表数据格式
+**示例：**
 
-```javascript
-{
-  id: "add20261DA7347CZPAUz",
-  layoutName: "默认布局",
-  objid: "20267D1465464C5OB6m5"
-}
+```bash
+# 删除指定页面布局
+cc delete pagelayout . add202610BD89F09XyGT
 ```
-
----
-
-## 四、最佳实践
-
-### 命名规范
-
-| 项目 | 规范 | 示例 |
-|------|------|------|
-| 布局名称 | 使用描述性名称 | `标准详情页布局`、`移动端布局` |
-| 复制源选择 | 选择结构最相近的布局作为复制源 | - |
-
-### 布局设计建议
-
-- **按需复制动态布局规则**：如果源布局有复杂的动态规则，确认是否需要复制到新布局
-- **避免重复创建**：创建前先查询现有布局，避免重复
-
-### 推荐操作流程
-
-1. 查看对象现有布局：`cc get pagelayout . <apiName>`
-2. 确定复制源布局 ID
-3. 创建新布局：`cc create pagelayout . <objId> <layoutName> [sourceLayoutId]`
-4. 验证创建结果
-
----
-
-## 五、常见问题
-
-**Q: 为什么查询页面布局需要先选中对象？**
-
-A: 页面布局是绑定到具体对象的，不同对象有不同的字段和关联关系，因此必须先确定对象才能操作其页面布局。
-
-**Q: 如何获取对象 ID？**
-
-A: 可以通过对象 API 名称查询对象信息获取 ID，或从管理后台的对象管理页面获取。
-
-**Q: isCloneDynamic 参数的作用是什么？**
-
-A: 该参数控制是否复制源布局的动态布局规则。设置为 `"true"` 时会复制动态规则，设置为 `"false"` 则只复制静态布局。
-
-**Q: 创建页面布局时报错 "对象不存在"？**
-
-A: 请确认传入的 `objId` 是正确的对象 ID，且该对象在当前环境中存在。
-
----
-
-*文档版本：1.0 | 最后更新：2026-03-26*

package/src/pagelayout/get.js

@@ -4,21 +4,21 @@ const chalk = require("chalk");
 
 /**
  * 查询页面布局列表
- * 用法：cc get pagelayout <projectPath> <objApiName>
+ * 用法：cc get pagelayout <projectPath> <prefix>
  */
 async function get(argvs, isMcp = false) {
     const projectPath = argvs[2] || process.cwd();
-    const objApiName = argvs[3];
+    const prefix = argvs[3];
 
-    if (!objApiName) {
+    if (!prefix) {
         console.error();
-        console.error(chalk.red("Error: 缺少对象 API 名称"));
-        console.error("用法: cc get pagelayout <projectPath> <objApiName>");
+        console.error(chalk.red("Error: 缺少对象前缀"));
+        console.error("用法: cc get pagelayout <projectPath> <prefix>");
         console.error("示例:");
+        console.error("  cc get pagelayout . 001");
         console.error("  cc get pagelayout . b25");
-        console.error("  cc get pagelayout . Account");
         console.error();
-        throw new Error("缺少必需参数: objApiName");
+        throw new Error("缺少必需参数: prefix");
     }
 
     const config = await getPackageJson(projectPath);
@@ -26,13 +26,13 @@ async function get(argvs, isMcp = false) {
     const res = await postClass(
         config.setupSvc + "/api/layout/queryPageLayout",
         {
-            prefix: objApiName
+            prefix: prefix
         },
         config.accessToken
     );
 
     if (res && res.result) {
-        const layouts = res.layouts || [];
+        const layouts = res.data?.layouts || [];
         if (!isMcp) {
             console.log(JSON.stringify(layouts));
         }