cloudcc-cli 2.3.1 → 2.3.3

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/doc.js

@@ -0,0 +1,46 @@
+/**
+ * pagelayout 文档入口：正文均在 `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 pagelayout <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 pagelayout 需要子命令：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/pagelayout/docs/devguide.md

@@ -0,0 +1,83 @@
+# CloudCC 页面布局 CLI 命令说明
+
+## 支持的命令
+
+| 操作 | 说明 |
+|------|------|
+| `get` | 查询页面布局列表 |
+| `create` | 创建/复制页面布局 |
+| `delete` | 删除页面布局 |
+
+## CLI 命令详解
+
+### 查询页面布局列表
+
+```bash
+cc get pagelayout <projectPath> <prefix>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，`.` 表示当前目录 |
+| `prefix` | 是 | 对象前缀（如 001, b25） |
+
+**示例：**
+
+```bash
+# 查询对象 b25 的页面布局列表
+cc get pagelayout . b25
+
+# 查询客户对象（001）的页面布局列表
+cc get pagelayout . 001
+```
+
+### 创建页面布局
+
+```bash
+cc create pagelayout <projectPath> <objId> <layoutName> [sourceLayoutId] [isCloneDynamic]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，`.` 表示当前目录 |
+| `objId` | 是 | 对象 ID |
+| `layoutName` | 是 | 新页面布局名称 |
+| `sourceLayoutId` | 否 | 要复制的源布局 ID，不传则使用默认第一个 |
+| `isCloneDynamic` | 否 | 是否复制动态布局规则，默认 `true` |
+
+**示例：**
+
+```bash
+# 创建页面布局（自动使用默认布局作为模板）
+cc create pagelayout . 20267D1465464C5OB6m5 "课程表2"
+
+# 指定源布局 ID 进行复制
+cc create pagelayout . 20267D1465464C5OB6m5 "课程表2" add20261DA7347CZPAUz
+
+# 不复制动态布局规则
+cc create pagelayout . 20267D1465464C5OB6m5 "课程表2" add20261DA7347CZPAUz false
+```
+
+### 删除页面布局
+
+```bash
+cc delete pagelayout <projectPath> <layoutId>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，`.` 表示当前目录 |
+| `layoutId` | 是 | 要删除的页面布局 ID |
+
+**示例：**
+
+```bash
+# 删除指定页面布局
+cc delete pagelayout . add202610BD89F09XyGT
+```

package/src/pagelayout/docs/introduction.md

@@ -0,0 +1,44 @@
+# 页面布局（Page Layout）介绍
+
+页面布局是 CloudCC 中用于定义对象详情页展示方式的重要配置。
+
+## 什么是页面布局？
+
+页面布局决定了：
+- 字段在详情页如何排列和分组
+- 哪些字段显示、哪些隐藏
+- 操作按钮的位置和顺序
+- 相关列表的展示方式
+- 动态布局规则（根据条件显示/隐藏字段）
+
+## 适用对象
+
+页面布局可以应用于：
+- **标准对象**：如 Account（客户）、Contact（联系人）等系统内置对象
+- **自定义对象**：用户根据业务需求创建的对象
+
+## 前置条件
+
+操作页面布局前，必须先**选中对象**（自定义对象或标准对象）。
+
+## 核心能力
+
+| 能力 | 说明 |
+|------|------|
+| 查询布局列表 | 查看对象下的所有页面布局 |
+| 创建布局 | 基于现有布局复制创建新布局 |
+| 复制动态规则 | 可选择是否复制源布局的动态布局规则 |
+
+## 使用场景
+
+1. **多终端适配**：为 PC 端和移动端创建不同的布局
+2. **多角色视图**：为不同角色创建差异化的详情页展示
+3. **业务场景适配**：针对特定业务流程定制字段展示
+
+## 下一步
+
+查看开发指南了解具体 CLI 命令：
+
+```bash
+cc doc pagelayout devguide
+```

package/src/pagelayout/get.js

@@ -0,0 +1,46 @@
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+const chalk = require("chalk");
+
+/**
+ * 查询页面布局列表
+ * 用法：cc get pagelayout <projectPath> <prefix>
+ */
+async function get(argvs, isMcp = false) {
+    const projectPath = argvs[2] || process.cwd();
+    const prefix = argvs[3];
+
+    if (!prefix) {
+        console.error();
+        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();
+        throw new Error("缺少必需参数: prefix");
+    }
+
+    const config = await getPackageJson(projectPath);
+
+    const res = await postClass(
+        config.setupSvc + "/api/layout/queryPageLayout",
+        {
+            prefix: prefix
+        },
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        const layouts = res.data?.layouts || [];
+        if (!isMcp) {
+            console.log(JSON.stringify(layouts));
+        }
+        return layouts;
+    }
+
+    const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    throw new Error("Get PageLayout Failed: " + msg);
+}
+
+module.exports = get;

package/src/pagelayout/index.js

@@ -0,0 +1,10 @@
+const cc = {}
+cc.create = require("./create")
+cc.get = require("./get")
+cc.delete = require("./delete")
+cc.doc = require("./doc")
+async function main(action, argvs) {
+  await cc[action](argvs)
+}
+
+module.exports = main;