cloudcc-cli 2.2.9 → 2.3.1

package/src/customPage/delete.js

@@ -0,0 +1,65 @@
+const chalk = require('chalk');
+const { getPackageJson } = require('../../utils/config');
+const { post } = require('../../utils/http');
+const BaseUrl = 'https://developer.apis.cloudcc.cn';
+
+/**
+ * 删除自定义页面
+ *
+ * 用法：cc delete customPage <id> [projectPath]
+ */
+async function deleteCustomPage(argvs) {
+    const id = argvs[2];
+    const projectPath = argvs[3] || process.cwd();
+
+    if (!id) {
+        console.error();
+        console.error(chalk.red('Error: Custom page ID is required'));
+        console.error(chalk.yellow('Usage: cc delete customPage <id> [projectPath]'));
+        console.error();
+        return;
+    }
+
+    const config = await getPackageJson(projectPath);
+    if (!config || !config.accessToken) {
+        console.error();
+        console.error(chalk.red('Error: Configuration not found or accessToken is missing'));
+        console.error();
+        return;
+    }
+
+    const devSvcDispatch = config.devSvcDispatch || '/devconsole';
+    const baseUrl = config.baseUrl || BaseUrl;
+
+    const header = {
+        appType: 'lightning-devconsole',
+        accessToken: config.accessToken,
+        source: 'lightning-devconsole',
+        version: 'public',
+    };
+
+    const body = { id };
+
+    console.error();
+    console.error(chalk.green(`Deleting custom page (ID: ${id}), please wait...`));
+
+    const res = await post(
+        `${baseUrl}${devSvcDispatch}/custom/pc/1.0/post/deleteCustomPage`,
+        body,
+        header
+    );
+
+    if (res && res.returnCode == 200) {
+        console.error(chalk.green(`Success! Custom page (ID: ${id}) deleted.`));
+        console.error();
+    } else {
+        const errMsg = res?.returnInfo || 'Unknown error';
+        console.error(chalk.red(`Fail: ${errMsg}`));
+        console.error();
+        throw new Error('Delete Custom Page Failed: ' + errMsg);
+    }
+
+    return res;
+}
+
+module.exports = deleteCustomPage;

package/src/customPage/get.js

@@ -0,0 +1,85 @@
+const chalk = require('chalk');
+const { getPackageJson } = require('../../utils/config');
+const { post } = require('../../utils/http');
+const BaseUrl = 'https://developer.apis.cloudcc.cn';
+
+/**
+ * 获取自定义页面列表
+ *
+ * 用法：cc get customPage [pageNo] [pageSize] [projectPath]
+ */
+async function listCustomPage(argvs) {
+    const pageNo = parseInt(argvs[2], 10) || 1;
+    const pageSize = parseInt(argvs[3], 10) || 20;
+    const projectPath = argvs[4] || process.cwd();
+
+    const config = await getPackageJson(projectPath);
+    if (!config || !config.accessToken) {
+        console.error();
+        console.error(chalk.red('Error: Configuration not found or accessToken is missing'));
+        console.error();
+        return;
+    }
+
+    const devSvcDispatch = config.devSvcDispatch || '/devconsole';
+    const baseUrl = config.baseUrl || BaseUrl;
+
+    const header = {
+        appType: 'lightning-devconsole',
+        accessToken: config.accessToken,
+        source: 'lightning-devconsole',
+        version: 'public',
+    };
+
+    const body = {
+        pageNo,
+        pageSize,
+        condition: {
+            pageLabel: '',
+            dtBegin: '',
+            dtEnd: '',
+            pageApi: '',
+        },
+    };
+
+    console.error();
+    console.error(chalk.green(`Fetching custom page list (page ${pageNo}, size ${pageSize})...`));
+
+    const res = await post(
+        `${baseUrl}${devSvcDispatch}/custom/pc/1.0/post/pageCustomPage`,
+        body,
+        header
+    );
+
+    if (res && res.returnCode == 200) {
+        const data = res.data || {};
+        const records = data.records || data.list || data || [];
+        const total = data.total ?? (Array.isArray(records) ? records.length : 0);
+
+        console.error(chalk.green(`Success! Total: ${total}`));
+        console.error();
+
+        if (Array.isArray(records) && records.length > 0) {
+            records.forEach((item, index) => {
+                console.log(
+                    chalk.cyan(`[${index + 1}]`) +
+                    `  ID: ${item.id || '-'}` +
+                    `  Label: ${item.pageLabel || '-'}` +
+                    `  API: ${item.pageApi || '-'}`
+                );
+            });
+        } else {
+            console.log(chalk.yellow('No custom pages found.'));
+        }
+        console.error();
+    } else {
+        const errMsg = res?.returnInfo || 'Unknown error';
+        console.error(chalk.red(`Fail: ${errMsg}`));
+        console.error();
+        throw new Error('List Custom Page Failed: ' + errMsg);
+    }
+
+    return res;
+}
+
+module.exports = listCustomPage;

package/src/customPage/index.js

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

package/src/customSetting/create.js

@@ -0,0 +1,27 @@
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+async function create(projectPath = process.cwd(), encodedBodyJson) {
+    if (!encodedBodyJson) {
+        throw new Error("Create Custom Setting Failed: encodedBodyJson is required");
+    }
+    const body = JSON.parse(decodeURI(encodedBodyJson));
+    const config = await getPackageJson(projectPath);
+    console.error();
+    console.error(chalk.green("Creating custom setting, please wait..."));
+    console.error();
+    const res = await postClass(
+        config.setupSvc + "/api/customsetting/save",
+        body,
+        config.accessToken
+    );
+    if (res && res.result) {
+        console.error(chalk.green("Success! Custom setting saved."));
+        console.error();
+        return res;
+    }
+    throw new Error("Create Custom Setting Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = create;

package/src/customSetting/delete.js

@@ -0,0 +1,26 @@
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+async function remove(projectPath = process.cwd(), id) {
+    if (!id) {
+        throw new Error("Delete Custom Setting Failed: id is required");
+    }
+    const config = await getPackageJson(projectPath);
+    console.error();
+    console.error(chalk.green(`Deleting custom setting (${id}), please wait...`));
+    console.error();
+    const res = await postClass(
+        config.setupSvc + "/api/customsetting/deleteobj",
+        { id },
+        config.accessToken
+    );
+    if (res && res.result) {
+        console.error(chalk.green("Success! Custom setting deleted."));
+        console.error();
+        return res;
+    }
+    throw new Error("Delete Custom Setting Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = remove;

package/src/customSetting/detail.js

@@ -0,0 +1,24 @@
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+async function detail(projectPath = process.cwd(), id, isMcp = false) {
+    if (!id) {
+        throw new Error("Custom Setting detail requires id");
+    }
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/customsetting/detail",
+        { id },
+        config.accessToken
+    );
+    if (res && res.result) {
+        const data = res.data || {};
+        if (!isMcp) {
+            console.log(JSON.stringify(data));
+        }
+        return data;
+    }
+    throw new Error("Get Custom Setting Detail Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = detail;

package/src/customSetting/doc.js

@@ -0,0 +1,196 @@
+/**
+ * customSetting 文档统一入口（全量一次性输出）
+ */
+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 base = lines.join("\n");
+    const apiPath = path.join(
+        __dirname,
+        "..",
+        "..",
+        "cloudcc-cli-dev",
+        "CUSTOM-SETTING-API.md"
+    );
+    let apiContent = "";
+    try {
+        apiContent = fs.readFileSync(apiPath, "utf8");
+    } catch (e) {
+        apiContent = `# 自定义设置相关接口\n\n（未找到文件：${apiPath}）\n`;
+    }
+
+    return [
+        base,
+        "",
+        "---",
+        "",
+        "## 附录：自定义设置 Setup 接口速查",
+        "",
+        "> 来源：`cloudcc-cli-dev/CUSTOM-SETTING-API.md`",
+        "",
+        apiContent.trim(),
+        "",
+    ].join("\n");
+}
+
+function doc() {
+    const content = generateFullMarkdownDoc();
+    console.log(content);
+    return content;
+}
+
+doc.getClassEditorDoc = doc;
+doc.getEditGuide = doc;
+
+module.exports = doc;

package/src/customSetting/get.js

@@ -0,0 +1,25 @@
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+async function get(projectPath = process.cwd(), encodedCondJson, isMcp = false) {
+    let body = {};
+    if (encodedCondJson) {
+        body = JSON.parse(decodeURI(encodedCondJson));
+    }
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/customsetting/list",
+        body,
+        config.accessToken
+    );
+    if (res && res.result) {
+        const list = res?.data?.objList || [];
+        if (!isMcp) {
+            console.log(JSON.stringify(list));
+        }
+        return list;
+    }
+    throw new Error("Get Custom Setting Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = get;

package/src/customSetting/index.js

@@ -0,0 +1,11 @@
+const cc = {};
+cc.doc = require("./doc");
+cc.get = require("./get");
+cc.create = require("./create");
+cc.detail = require("./detail");
+cc.delete = require("./delete");
+function CustomSetting(action, argvs) {
+    cc[action](argvs[2], argvs[3]);
+}
+
+module.exports = CustomSetting;

package/src/fields/delete.js

@@ -0,0 +1,52 @@
+const chalk = require("chalk");
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 删除字段（彻底删除）
+ * 用法：cc delete fields <projectPath> <fieldId> <objid>
+ */
+async function remove(argvs) {
+    const projectPath = argvs[2] || process.cwd();
+    const id = argvs[3];
+    const objid = argvs[4];
+
+    if (!id || !objid) {
+        console.error();
+        console.error(chalk.red("Error: fieldId and objid are required"));
+        console.error(chalk.yellow("Usage: cc delete fields <projectPath> <fieldId> <objid>"));
+        console.error();
+        return;
+    }
+
+    const config = await getPackageJson(projectPath);
+    if (!config || !config.accessToken) {
+        console.error();
+        console.error(chalk.red("Error: Configuration not found or accessToken is missing"));
+        console.error();
+        return;
+    }
+
+    console.error();
+    console.error(chalk.green(`Deleting field (${id}) from object (${objid}), please wait...`));
+    console.error();
+
+    const res = await postClass(
+        config.setupSvc + "/api/fieldSetup/deleteFieldCompletely",
+        { id, objid },
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        console.error(chalk.green("Success! Field deleted."));
+        console.error();
+        return res;
+    }
+
+    const errMsg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    console.error(chalk.red(`Fail: ${errMsg}`));
+    console.error();
+    throw new Error("Delete Field Failed: " + errMsg);
+}
+
+module.exports = remove;

package/src/fields/index.js

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

package/src/menu/create-page.js

@@ -11,22 +11,25 @@ const { buildCommonMenuFields } = require('./common');
  */
 async function createPageMenu(argvs) {
     try {
-        // 命令行参数格式：cc create menu page <path> <pageId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
-        // argvs: ['create', 'menu', 'page', '.', 'pageId', 'tabName', ...]
+        // 命令行参数格式：cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]
+        // argvs: ['create', 'menu', 'page', '.', 'contract-assistant', '标签名', '菜单名称', ...]
         let path = argvs[3];           // 路径 (argvs[3])
-        let pageId = argvs[4];        // 页面ID (p1)
+        let pageApi = argvs[4];        // 自定义页面 pageApi，例如 contract-assistant
         let tabName = argvs[5];       // 标签名称
-        let tabStyle = argvs[6] || "cloudtab145";  // 标签样式图标，默认 cloudtab145
-        let mobileimg = argvs[7] || "cloudcc01";   // 移动端图标，默认 cloudcc01
-        let cloudccservicetab = argvs[8] || "cloudccservicetab_1";  // 服务标签图标，默认 cloudccservicetab_1
+        let pname = argvs[6];         // 菜单名称
+        let tabStyle = argvs[7] || "cloudtab145";  // 标签样式图标，默认 cloudtab145
+        let mobileimg = argvs[8] || "cloudcc01";   // 移动端图标，默认 cloudcc01
+        let cloudccservicetab = argvs[9] || "cloudccservicetab_1";  // 服务标签图标，默认 cloudccservicetab_1
+        let mobileurl = argvs[10] || ""; // 移动端地址，默认空字符串
 
-        if (!pageId || !tabName) {
+        if (!pageApi || !tabName || !pname) {
             console.error();
             console.error(chalk.red('Error: 缺少必需参数'));
-            console.error('用法: cc create menu page <path> <pageId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]');
+            console.error('用法: cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]');
             console.error();
-            throw new Error('缺少必需参数: pageId 和 tabName');
+            throw new Error('缺少必需参数: pageApi、tabName 和 pname');
         }
+        const lightningPage = pageApi.endsWith("#lightning") ? pageApi : `${pageApi}#lightning`;
 
         let config = await getPackageJson(path);
 
@@ -54,22 +57,10 @@ async function createPageMenu(argvs) {
             visited_2: "1",
             allOrSome: "some",
             type: "page",
-            p1: pageId,
-            p1_origin: {
-                label: "label.import.index.page",
-                fieldKey: "p1",
-                field: "Select",
-                required: "right",
-                hint: "label.customer.tab.step1.selectonepage",
-                rules: [
-                    {
-                        required: true,
-                        message: "请选择页面",
-                        trigger: "blur"
-                    }
-                ],
-                value: pageId
-            },
+            pageType: "customPage",
+            lightningPage: lightningPage,
+            mobileurl: mobileurl,
+            pname: pname,
             ...commonFields,
             profileIds: profileIds,
         };

package/src/menu/create.js

@@ -7,7 +7,9 @@ const createSiteMenu = require('./create-site');
 /**
  * 创建自定义菜单（标签页）
  * 支持类型：object（自定义对象）、page（自定义页面）、script（自定义脚本）、site（站点）
- * 命令格式：cc create menu <type> <path> <resourceId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
+ * 命令格式：
+ *   - object/script/site: cc create menu <type> <path> <resourceId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
+ *   - page: cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]
  * @param {Array} argvs - 命令行参数数组
  * @returns {Promise<Object>} 创建结果
  */
@@ -24,10 +26,14 @@ async function create(argvs) {
             console.error();
             console.error(chalk.red('Error: 无效的菜单类型'));
             console.error(`支持的菜单类型: ${validTypes.join(', ')}`);
-            console.error('用法: cc create menu <type> <path> <resourceId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]');
+            console.error('用法:');
+            console.error('  cc create menu object <path> <objectId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]');
+            console.error('  cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]');
+            console.error('  cc create menu script <path> <scriptId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]');
+            console.error('  cc create menu site <path> <siteId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]');
             console.error('示例:');
             console.error('  cc create menu object . <objectId> "我的对象菜单"');
-            console.error('  cc create menu page . <pageId> "我的页面菜单"');
+            console.error('  cc create menu page . contract-assistant "我的页面标签" my_page_menu');
             console.error('  cc create menu script . <scriptId> "我的脚本菜单"');
             console.error('  cc create menu site . <siteId> "我的站点菜单"');
             console.error();