cloudcc-cli 2.3.1 → 2.3.3

package/src/customSetting/doc.js

@@ -1,193 +1,36 @@
 /**
- * customSetting 文档统一入口（全量一次性输出）
+ * customSetting 文档入口：仅读取 docs/devguide.md。
  */
 const fs = require("fs");
 const path = require("path");
 
-function generateFullMarkdownDoc() {
-    const lines = [
-        "# CloudCC 自定义设置操作指南",
-        "",
-        "> 本文档按实际页面操作顺序整理，覆盖你提供的 7 个步骤图：",
-        "> 列表 -> 新建 -> 编辑 -> 详情建字段 -> 字段类型选择 -> 字段属性填写 -> 字段编辑。",
-        "",
-        "直接查看 CLI 文档：`cc doc customSetting`",
-        "",
-        "---",
-        "",
-        "## 1. 入口与列表页（图一）",
-        "",
-        "进入路径：`设置 -> 开发者空间 -> 自定义设置`。",
-        "",
-        "在列表页可看到：",
-        "- 标签",
-        "- 可见性",
-        "- 设置类型",
-        "- 描述",
-        "",
-        "右上角点击「新建」进入自定义设置创建弹窗。",
-        "",
-        "---",
-        "",
-        "## 2. 新建自定义设置（图二）",
-        "",
-        "点击图一右上角「新建」，弹出「自定义设置:新建」窗口，需要填写：",
-        "",
-        "- `标签`（必填）",
-        "- `对象名`（必填）",
-        "- `设置类型`（如：列表）",
-        "- `可见性`（如：公用）",
-        "- `描述`（可选）",
-        "",
-        "填写后保存，返回列表可看到新建记录。",
-        "",
-        "---",
-        "",
-        "## 3. 编辑自定义设置基础信息（图三）",
-        "",
-        "在列表中选择一条记录进入编辑弹窗「自定义设置:编辑」。",
-        "",
-        "常见行为：",
-        "- 可编辑：标签、可见性、描述等",
-        "- 对象名、设置类型通常按产品规则受限（常见为不可改）",
-        "",
-        "保存后回到列表，确认信息更新成功。",
-        "",
-        "---",
-        "",
-        "## 4. 进入详情并管理字段（图四）",
-        "",
-        "点击某条自定义设置后进入详情页，页面分为两块：",
-        "",
-        "1. 自定义设置详细信息（头部）",
-        "2. 自定义设置字段列表（下半区）",
-        "",
-        "在字段列表区域可点击「新建」，为当前自定义设置新增字段。",
-        "",
-        "---",
-        "",
-        "## 5. 新建字段 - 选择数据类型（图五）",
-        "",
-        "点击图四的「新建」后，进入「自定义字段」向导第一步：",
-        "",
-        "- 选择字段数据类型（如 URL、百分比、货币、电话、电子邮件、文本、日期等）",
-        "- 该步骤决定下一步字段属性表单内容",
-        "",
-        "选择完成后点击「下一步」。",
-        "",
-        "---",
-        "",
-        "## 6. 新建字段 - 填写字段属性并保存（图六）",
-        "",
-        "在第二步填写字段属性（示例为文本字段）：",
-        "",
-        "- 字段标签（必填）",
-        "- 长度（如文本长度 255）",
-        "- 字段名 / API 名称（必填）",
-        "- 独有配置（如不允许重复值，按需开启）",
-        "",
-        "点击「保存」后，即在当前自定义设置下创建了一个新字段。",
-        "",
-        "---",
-        "",
-        "## 7. 编辑已有字段（图七）",
-        "",
-        "保存成功后回到字段列表，可看到新字段。点击某字段的操作菜单（如「...」）可进行：",
-        "",
-        "- 编辑：修改字段属性（可修改范围受字段类型和系统规则限制）",
-        "- 删除：移除该字段（建议先确认是否已有业务依赖）",
-        "",
-        "编辑保存后，字段列表会展示最新结果。",
-        "",
-        "---",
-        "",
-        "## 8. 新建字段支持的所有字段类型",
-        "",
-        "自定义设置详情页「新建字段」当前支持以下字段类型（与前端字段类型选择一致）：",
-        "",
-        "| 类型代码（fdtype） | 类型名称 | 说明 |",
-        "|---|---|---|",
-        "| `U` | URL | 允许输入有效网址；点击后按打开方式在新/当前窗口打开 |",
-        "| `P` | 百分比 | 输入数字并自动添加百分号（如 10 -> 10%） |",
-        "| `c` | 币种 | 金额/币种类型字段 |",
-        "| `H` | 电话 | 输入电话号码并按电话格式展示 |",
-        "| `E` | 电子邮件 | 输入邮箱并校验格式（可用于“发送电子邮件”选择地址） |",
-        "| `B` | 复选框 | 布尔值（真/假） |",
-        "| `D` | 日期 | 输入或选择日期 |",
-        "| `F` | 日期和时间 | 输入或选择日期时间 |",
-        "| `N` | 数字 | 输入数字（会删除前置零） |",
-        "| `S` | 文本 | 字母数字组合文本 |",
-        "| `X` | 长文本 | 多行文本，最多 4000 字符 |",
-        "",
-        "在接口层面：新建/编辑字段使用 `POST /api/customsetting/saveField`，其中 `fdtype` 与 `tpSysSchemetableVO.schemefieldType` 建议保持一致（例如文本为 `S`，百分比为 `P`）。",
-        "",
-        "---",
-        "",
-        "## 9. Java 侧读取自定义设置（CCService）",
-        "",
-        "### 9.1 列表类型（List）",
-        "",
-        "```java",
-        "// 某 API 名称下的全部数据",
-        "Map listSettings = cs.getListCustomSetting(\"MyListSettingApiName\");",
-        "",
-        "// 指定 Name 的单条",
-        "Map singleSetting = cs.getListCustomSetting(\"MyListSettingApiName\", \"SomeName\");",
-        "```",
-        "",
-        "### 9.2 层次结构类型（Hierarchy）",
-        "",
-        "```java",
-        "// id 为简档 ID 或用户 ID",
-        "Map hiSetting = cs.getCustomSetting(\"MyHierarchySettingApiName\", profileOrUserId);",
-        "```",
-        "",
-        "---",
-        "",
-        "## 10. 操作 Checklist",
-        "",
-        "- [ ] 已在列表页确认目标自定义设置（标签/对象名）",
-        "- [ ] 新建时已正确选择设置类型与可见性",
-        "- [ ] 进入详情后通过字段向导完成字段新增",
-        "- [ ] 字段 `标签`、`API 名称`、`长度` 等配置符合规范",
-        "- [ ] 保存后已在字段列表验证新增或编辑结果",
-        "- [ ] 代码侧读取时，API 名称与平台配置保持一致",
-        "",
-    ];
+const DOCS_DIR = path.join(__dirname, "docs");
+const INTRODUCTION = path.join(DOCS_DIR, "introduction.md");
+const DEVGUIDE = path.join(DOCS_DIR, "devguide.md");
 
-    const base = lines.join("\n");
-    const apiPath = path.join(
-        __dirname,
-        "..",
-        "..",
-        "cloudcc-cli-dev",
-        "CUSTOM-SETTING-API.md"
-    );
-    let apiContent = "";
+function generateFullMarkdownDoc() {
+    let content = "";
     try {
-        apiContent = fs.readFileSync(apiPath, "utf8");
+        content = fs.readFileSync(DEVGUIDE, "utf8").trim();
     } catch (e) {
-        apiContent = `# 自定义设置相关接口\n\n（未找到文件：${apiPath}）\n`;
+        content = `# CloudCC 自定义设置操作指南\n\n（未找到文件：${DEVGUIDE}）\n`;
     }
-
-    return [
-        base,
-        "",
-        "---",
-        "",
-        "## 附录：自定义设置 Setup 接口速查",
-        "",
-        "> 来源：`cloudcc-cli-dev/CUSTOM-SETTING-API.md`",
-        "",
-        apiContent.trim(),
-        "",
-    ].join("\n");
+    return content;
 }
 
-function doc() {
-    const content = generateFullMarkdownDoc();
-    console.log(content);
-    return content;
+function doc(argvs = []) {
+    const subType = String(argvs[2] || "").trim().toLowerCase();
+    if (!subType || subType === "devguide") {
+        const content = generateFullMarkdownDoc();
+        console.log(content);
+        return content;
+    }
+    if (subType === "introduction") {
+        const content = getIntroductionDoc();
+        console.log(content);
+        return content;
+    }
+    throw new Error(`doc 不支持的子命令: ${argvs[2]}，请使用 introduction 或 devguide`);
 }
 
 doc.getClassEditorDoc = doc;

package/src/customSetting/docs/devguide.md

@@ -0,0 +1,181 @@
+# CloudCC 自定义设置操作指南
+
+直接查看 CLI 文档：`cc doc customSetting`
+
+---
+
+## 1. 入口与列表页
+
+进入路径：`设置 -> 开发者空间 -> 自定义设置`。
+
+列表页可查看标签、可见性、设置类型、描述等信息，并支持新建、编辑、删除。
+
+---
+
+## 2. 新建/编辑主对象
+
+主对象常见输入项：
+
+- 标签
+- 对象名
+- 设置类型（列表/层次结构）
+- 可见性
+- 描述
+
+保存后会回到列表页并显示最新结果。
+
+---
+
+## 3. 详情页与字段管理
+
+进入详情页后通常包含两块：
+
+1. 自定义设置主对象信息
+2. 自定义设置字段列表
+
+在字段列表区域可完成新增、编辑、删除字段。
+
+---
+
+## 4. 字段类型（新建字段）
+
+当前常用字段类型代码：
+
+- `U` URL
+- `P` 百分比
+- `c` 币种
+- `H` 电话
+- `E` 电子邮件
+- `B` 复选框
+- `D` 日期
+- `F` 日期和时间
+- `N` 数字
+- `S` 文本
+- `X` 长文本
+
+---
+
+## 5. 常用 CLI 命令
+
+### 主对象
+
+#### 1) 查询自定义设置列表
+命令：
+```bash
+cc get customSetting <projectPath> [encodedCondJson]
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| body | object | 非必须 | `{}` | `encodedCondJson` 解码后的请求体 |
+
+#### 2) 查询自定义设置详情（含字段列表）
+命令：
+```bash
+cc detail customSetting <projectPath> <settingId>
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| objid | string | 必须 | — | 对应命令中的 `settingId` |
+
+#### 3) 新建/更新自定义设置主对象
+命令：
+```bash
+cc create customSetting <projectPath> <encodedBodyJson>
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| tpSysObjectVO | object | 必须 | — | 主对象载体，见下表子字段 |
+**tpSysObjectVO 子字段：**
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| accessable | string | 视业务 | — | 可见性（如 `"2"` 表示公用） |
+| dataType | string | 视业务 | — | 设置类型：`L` 列表，`H` 层次结构 |
+| id | string | 视业务 | `""` | 新建传空；编辑传记录 id |
+| label | string | 视业务 | — | 标签 |
+| remark | string | 非必须 | — | 描述 |
+| schemetableName | string | 视业务 | — | 对象名 |
+
+#### 4) 编辑前回显主对象表单数据
+命令：
+```bash
+cc modify customSetting <projectPath> <settingId>
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| objid | string | 必须 | — | 对应命令中的 `settingId` |
+
+#### 5) 删除自定义设置主对象
+命令：
+```bash
+cc delete customSetting <projectPath> <settingId>
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| objid | string | 必须 | — | 对应命令中的 `settingId` |
+
+### 字段
+
+#### 6) 进入字段编辑（取字段编辑所需数据）
+命令：
+```bash
+cc editCustomSettingField customSetting <projectPath> <queryrecordid>
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| queryrecordid | string | 必须 | — | 字段行 id |
+
+#### 7) 保存字段（新增/编辑字段）
+命令：
+```bash
+cc saveCustomSettingField customSetting <projectPath> <encodedBodyJson>
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| tpSysSchemetableVO | object | 必须 | — | 字段对象，见下方子字段表 |
+| fdtype | string | 必须 | — | 字段类型代码（如 `U` 表示 URL） |
+**tpSysSchemetableVO 子字段：**
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| schemetableId | string | 必须 | — | 所属自定义设置 id |
+| id | string | 非必须 | — | 字段 id；编辑时传 |
+| nameLabel | string | 必须 | — | 字段显示名称 |
+| apiname | string | 必须 | — | 字段 API 名 |
+| edittype | string | 非必须 | — | 字段编辑类型（如 URL 打开方式） |
+| schemefieldLength | string | 非必须 | — | 字段长度 |
+| defaultValue | string | 非必须 | — | 默认值 |
+| datafieldRef | string | 非必须 | — | 数据字段引用名 |
+| isDeleted | string | 非必须 | `"0"` | 删除标记 |
+| fieldState | string | 非必须 | `"enable"` | 字段状态 |
+| iscustom | string | 非必须 | `"1"` | 是否自定义字段 |
+| schemefieldType | string | 必须 | — | 字段类型代码（如 `U`） |
+| schemefieldName | string | 必须 | — | 字段物理名/存储名 |
+
+#### 8) 删除自定义字段
+命令：
+```bash
+cc deleteCustomSettingField customSetting <projectPath> <fieldId> <settingId>
+```
+请求参数：
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| id | string | 必须 | — | 对应命令中的 `fieldId` |
+| objid | string | 必须 | — | 对应命令中的 `settingId` |
+
+---
+
+## 6. Checklist
+
+- [ ] 已确认目标自定义设置（标签/对象名）
+- [ ] 保存主对象前已校验设置类型与可见性
+- [ ] 字段新增/编辑时已校验字段类型与 API 名
+- [ ] 删除前已确认字段/主对象无业务依赖
+
+---
+

package/src/customSetting/docs/introduction.md

@@ -0,0 +1,3 @@
+# CloudCC 自定义设置介绍
+
+使用自定义设置创建并管理组织、简档和用户级的自定义数据。自定义设置数据存储在应用程序缓存中。这意味着您可以有效地访问它，而不必进行重复的查询

package/src/customSetting/editCustomSettingField.js

@@ -0,0 +1,34 @@
+/**
+ * 自定义设置字段 - 进入字段编辑（取字段编辑所需数据）
+ * API: POST {setupSvc}/api/customsetting/editfile
+ * CLI: cc editCustomSettingField customSetting <projectPath> <queryrecordid>
+ * 参数说明：
+ * - projectPath: 项目根目录
+ * - queryrecordid: 字段行 id
+ * - 请求体: { queryrecordid }
+ */
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+async function editfile(projectPath = process.cwd(), queryrecordid, isMcp = false) {
+    if (!queryrecordid) {
+        throw new Error("Custom Setting editfile Failed: queryrecordid is required");
+    }
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/customsetting/editfile",
+        { queryrecordid },
+        config.accessToken
+    );
+    if (res && res.result) {
+        const data = res.data || {};
+        if (!isMcp) {
+            console.log(JSON.stringify(data));
+        }
+        return data;
+    }
+    throw new Error("Custom Setting editfile Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = editfile;
+

package/src/customSetting/get.js

@@ -1,3 +1,12 @@
+/**
+ * 自定义设置 - 查询列表
+ * API: POST {setupSvc}/api/customsetting/list
+ * CLI: cc get customSetting <projectPath> [encodedCondJson]
+ * 参数说明：
+ * - projectPath: 项目根目录
+ * - encodedCondJson(可选): encodeURI(JSON.stringify(body))
+ * - body: 查询条件对象（可为空 {}）
+ */
 const { getPackageJson } = require("../../utils/config");
 const { postClass } = require("../../utils/http");
 

package/src/customSetting/index.js

@@ -4,8 +4,13 @@ cc.get = require("./get");
 cc.create = require("./create");
 cc.detail = require("./detail");
 cc.delete = require("./delete");
+cc.modify = require("./modify");
+cc.editCustomSettingField = require("./editCustomSettingField");
+cc.saveCustomSettingField = require("./saveCustomSettingField");
+cc.deleteCustomSettingField = require("./deleteCustomSettingField");
 function CustomSetting(action, argvs) {
-    cc[action](argvs[2], argvs[3]);
+    // 兼容字段类接口（例如 deletefield 需要 id + objid）
+    cc[action](argvs[2], argvs[3], argvs[4]);
 }
 
 module.exports = CustomSetting;

package/src/customSetting/modify.js

@@ -0,0 +1,30 @@
+/**
+ * 自定义设置 - 编辑前回显（主对象）
+ * API: POST {setupSvc}/api/customsetting/modify
+ * CLI: cc modify customSetting <projectPath> <settingId>
+ * 参数说明：
+ * - projectPath: 项目根目录
+ * - objid(命令参数名 settingId): 自定义设置 id
+ * - 请求体: { objid }
+ */
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+async function modify(projectPath = process.cwd(), objid, isMcp = false) {
+    if (!objid) {
+        throw new Error("Custom Setting modify Failed: objid is required");
+    }
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(config.setupSvc + "/api/customsetting/modify", { objid }, config.accessToken);
+    if (res && res.result) {
+        const data = res.data || {};
+        if (!isMcp) {
+            console.log(JSON.stringify(data));
+        }
+        return data;
+    }
+    throw new Error("Custom Setting modify Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = modify;
+

package/src/customSetting/saveCustomSettingField.js

@@ -0,0 +1,46 @@
+/**
+ * 自定义设置字段 - 保存字段（新增/编辑）
+ * API: POST {setupSvc}/api/customsetting/saveField
+ * CLI: cc saveCustomSettingField customSetting <projectPath> <encodedBodyJson>
+ * 参数说明：
+ * - projectPath: 项目根目录
+ * - encodedBodyJson: encodeURI(JSON.stringify(body))
+ * - body: { fdtype, tpSysSchemetableVO }
+ * - tpSysSchemetableVO 常用子字段：
+ *   schemetableId, id, nameLabel, apiname, edittype, schemefieldLength,
+ *   defaultValue, datafieldRef, isDeleted, fieldState, iscustom,
+ *   schemefieldType, schemefieldName
+ */
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * 保存字段（新增/编辑）
+ * 入参约定：encodedBodyJson 使用 CLI 约定的 encodeURI(JSON.stringify(obj)) 透传
+ */
+async function saveField(projectPath = process.cwd(), encodedBodyJson, isMcp = false) {
+    if (!encodedBodyJson) {
+        throw new Error("Custom Setting saveField Failed: encodedBodyJson is required");
+    }
+
+    const body = typeof encodedBodyJson === "string" ? JSON.parse(decodeURI(encodedBodyJson)) : encodedBodyJson;
+    const config = await getPackageJson(projectPath);
+
+    const res = await postClass(
+        config.setupSvc + "/api/customsetting/saveField",
+        body,
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        if (!isMcp) {
+            console.error(chalk.green("Success! Custom setting field saved."));
+        }
+        return res;
+    }
+    throw new Error("Custom Setting saveField Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = saveField;
+

package/src/fields/doc.js

@@ -0,0 +1,45 @@
+const fs = require("fs");
+const path = require("path");
+
+const DOCS_DIR = path.join(__dirname, "docs");
+const INTRODUCTION = path.join(DOCS_DIR, "introduction.md");
+const DEVGUIDE = path.join(DOCS_DIR, "devguide.md");
+
+function readDocOrFallback(filePath, fallback) {
+    try {
+        return fs.readFileSync(filePath, "utf8").trim();
+    } catch (e) {
+        return fallback;
+    }
+}
+
+function getIntroductionDoc() {
+    return readDocOrFallback(
+        INTRODUCTION,
+        `# CloudCC 字段介绍\n\n（未找到文件：${INTRODUCTION}）\n`
+    );
+}
+
+function getDevGuideDoc() {
+    return readDocOrFallback(
+        DEVGUIDE,
+        `# CloudCC 字段开发指南\n\n（未找到文件：${DEVGUIDE}）\n`
+    );
+}
+
+function doc(argvs = []) {
+    const subType = String(argvs[2] || "").trim().toLowerCase();
+    if (!subType || subType === "devguide") {
+        const content = getDevGuideDoc();
+        console.log(content);
+        return content;
+    }
+    if (subType === "introduction") {
+        const content = getIntroductionDoc();
+        console.log(content);
+        return content;
+    }
+    throw new Error(`doc 不支持的子命令: ${argvs[2]}，请使用 introduction 或 devguide`);
+}
+
+module.exports = doc;