cloudcc-cli 2.3.1 → 2.3.3

package/src/recordType/docs/introduction.md

@@ -0,0 +1,53 @@
+# CloudCC 记录类型能力与适用场景说明
+
+## 1. 什么是记录类型
+
+记录类型（Record Type）是 CloudCC 平台提供的一种**按业务场景差异化展示页面布局和选项列表值**的机制。
+
+- 同一对象的不同记录可属于不同的记录类型
+- 不同记录类型可对应不同的**页面布局**（字段展示顺序、是否显示等）
+- 不同记录类型可对应不同的**选项列表可选值**（同一字段在不同记录类型下展示不同选项）
+- 可按**简档**设置哪些用户可以使用该记录类型，以及默认记录类型
+
+---
+
+## 2. 核心价值
+
+| 业务场景                         | 说明                                                       |
+|----------------------------------|------------------------------------------------------------|
+| 多业务线共用同一对象             | 如销售合同与服务合同同属"合同"对象，展示不同字段布局       |
+| 不同角色看到不同选项             | 销售人员和客服人员在同一字段看到不同的下拉选项             |
+| 简档隔离                         | 控制哪些简档用户能创建/使用某种记录类型                    |
+| 标准化业务流程                   | 强制不同业务线使用特定字段集，减少误操作                   |
+
+---
+
+## 3. 核心概念
+
+### 3.1 主记录类型（--主--）
+
+系统默认记录类型，新建记录类型时可选择继承主类型的选项列表值作为初始值集。
+
+### 3.2 简档与记录类型分配
+
+每个记录类型可分配给一个或多个简档：
+- `isActive`：该简档是否启用此记录类型
+- `isDefault`：是否将此记录类型设为该简档的默认值
+- `layoutid`：该简档下使用的页面布局
+
+### 3.3 删除替换机制
+
+删除记录类型时，系统会要求指定**替换记录类型**：
+- 所有使用被删除记录类型的现有记录将被替换为目标记录类型
+- 若不需要替换，可传 `replaceId: ""`（选择"--无--"）
+
+---
+
+## 4. 入口
+
+进入路径：`对象管理 → 选择对象 → 记录类型` 标签页
+
+主要操作：
+- **新建**：创建新的记录类型
+- **排序**：调整记录类型显示顺序
+- **页面布局分配**：批量管理简档与页面布局的对应关系

package/src/recordType/editInfo.js

@@ -0,0 +1,39 @@
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * cc editInfo recordType <projectPath> <encodedBodyJson>
+ * 获取编辑记录类型的回显数据
+ *
+ * encodedBodyJson（encodeURI 编码前）示例：
+ * { "id": "2026667B898023FoKwCe", "objid": "202646FC67ACF24D39sG" }
+ *
+ * @param {string} projectPath
+ * @param {string} encodedBodyJson
+ * @param {boolean} isMcp
+ */
+async function editInfo(projectPath = process.cwd(), encodedBodyJson, isMcp = false) {
+    if (!encodedBodyJson) {
+        throw new Error("Get Edit Record Type Info Failed: encodedBodyJson is required");
+    }
+    const body = JSON.parse(decodeURI(encodedBodyJson));
+    if (!body.id || !body.objid) {
+        throw new Error("Get Edit Record Type Info Failed: id and objid are required");
+    }
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/recordType/editRecordType",
+        body,
+        config.accessToken
+    );
+    if (res && res.result) {
+        const data = res.data || {};
+        if (!isMcp) {
+            console.log(JSON.stringify(data));
+        }
+        return data;
+    }
+    throw new Error("Get Edit Record Type Info Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = editInfo;

package/src/recordType/editSave.js

@@ -0,0 +1,47 @@
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * cc editSave recordType <projectPath> <encodedBodyJson>
+ * 保存编辑后的记录类型（将 editInfo 返回的对象修改后提交）
+ *
+ * encodedBodyJson（encodeURI 编码前）为 editInfo 接口返回的 data 对象，
+ * 修改所需字段（name / description / apiCode / isenable）后提交。
+ *
+ * 只可编辑四个字段：记录类型标签(name)、描述(description)、唯一名称(apiCode)、启用(isenable)
+ *
+ * @param {string} projectPath
+ * @param {string} encodedBodyJson
+ * @param {boolean} isMcp
+ */
+async function editSave(projectPath = process.cwd(), encodedBodyJson, isMcp = false) {
+    if (!encodedBodyJson) {
+        throw new Error("Edit Save Record Type Failed: encodedBodyJson is required");
+    }
+    const body = JSON.parse(decodeURI(encodedBodyJson));
+    if (!body.id) {
+        throw new Error("Edit Save Record Type Failed: id is required");
+    }
+    const config = await getPackageJson(projectPath);
+    if (!isMcp) {
+        console.error();
+        console.error(chalk.green(`Saving record type (${body.id}), please wait...`));
+        console.error();
+    }
+    const res = await postClass(
+        config.setupSvc + "/api/recordType/editSave",
+        body,
+        config.accessToken
+    );
+    if (res && res.result) {
+        if (!isMcp) {
+            console.error(chalk.green("Success! Record type updated."));
+            console.error();
+        }
+        return res;
+    }
+    throw new Error("Edit Save Record Type Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = editSave;

package/src/recordType/getList.js

@@ -0,0 +1,31 @@
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * cc getList recordType <projectPath> <objid>
+ * 获取指定对象的记录类型列表
+ * @param {string} projectPath
+ * @param {string} objid  对象 ID
+ * @param {boolean} isMcp
+ */
+async function getList(projectPath = process.cwd(), objid, isMcp = false) {
+    if (!objid) {
+        throw new Error("Get Record Type List Failed: objid is required");
+    }
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/recordType/getRecordTypeList",
+        { id: "", profileId: "", objid },
+        config.accessToken
+    );
+    if (res && res.result) {
+        const data = res.data || {};
+        if (!isMcp) {
+            console.log(JSON.stringify(data));
+        }
+        return data;
+    }
+    throw new Error("Get Record Type List Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = getList;

package/src/recordType/index.js

@@ -1,7 +1,20 @@
-const cc = {}
-cc.get = require("./get")
+const cc = {};
+cc.get = require("./get");
+cc.getList = require("./getList");
+cc.newInfo = require("./newInfo");
+cc.create = require("./create");
+cc.editInfo = require("./editInfo");
+cc.editSave = require("./editSave");
+cc.validDelete = require("./validDelete");
+cc.delete = require("./delete");
+cc.doc = require("./doc");
+
 function main(action, argvs) {
-  cc[action](argvs[2],argvs[3])
+    if (action === "doc") {
+        cc.doc(argvs);
+        return;
+    }
+    cc[action](argvs[2], argvs[3], argvs[4]);
 }
 
 module.exports = main;

package/src/recordType/newInfo.js

@@ -0,0 +1,39 @@
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * cc newInfo recordType <projectPath> <objid>
+ * 获取新建记录类型所需的表单初始信息（现有记录类型列表、简档列表、页面布局列表）
+ * @param {string} projectPath
+ * @param {string} objid  对象 ID
+ * @param {boolean} isMcp
+ */
+async function newInfo(projectPath = process.cwd(), objid, isMcp = false) {
+    if (!objid) {
+        throw new Error("Get New Record Type Info Failed: objid is required");
+    }
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/recordType/newRecordType",
+        { objid },
+        config.accessToken
+    );
+    if (res && res.result) {
+        const data = res.data || {};
+        // 提取关键字段便于使用
+        const result = {
+            existsRectypeList: data.existsRectypeList || [],
+            profilemap: data.profilemap || {},
+            layouts: data.layouts || [],
+            profileRecordtypes: data.profileRecordtypes || {},
+            slist: data.slist || []
+        };
+        if (!isMcp) {
+            console.log(JSON.stringify(result));
+        }
+        return result;
+    }
+    throw new Error("Get New Record Type Info Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = newInfo;

package/src/recordType/validDelete.js

@@ -0,0 +1,91 @@
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * cc validDelete recordType <projectPath> <encodedBodyJson>
+ * 删除前校验：获取可替换的记录类型列表
+ *
+ * 执行逻辑：
+ * 1. 先调用 editRecordType 获取当前记录类型数据
+ * 2. 若当前为启用状态（isenable !== "false"），自动调用 editSave 将其禁用
+ * 3. 再调用 validDelete 接口获取可替换列表
+ *
+ * encodedBodyJson（encodeURI 编码前）示例：
+ * { "id": "2026667B898023FoKwCe", "objid": "202646FC67ACF24D39sG" }
+ *
+ * 返回：
+ * {
+ *   obj: { id, name, ... },         // 待删除的记录类型基本信息
+ *   recordtypes: [ { id, name } ]   // 可作为替换目标的记录类型列表（含"--无--"）
+ * }
+ *
+ * @param {string} projectPath
+ * @param {string} encodedBodyJson
+ * @param {boolean} isMcp
+ */
+async function validDelete(projectPath = process.cwd(), encodedBodyJson, isMcp = false) {
+    if (!encodedBodyJson) {
+        throw new Error("Valid Delete Record Type Failed: encodedBodyJson is required");
+    }
+    const body = JSON.parse(decodeURI(encodedBodyJson));
+    if (!body.id || !body.objid) {
+        throw new Error("Valid Delete Record Type Failed: id and objid are required");
+    }
+    const config = await getPackageJson(projectPath);
+
+    // Step 1：获取当前记录类型数据
+    const editRes = await postClass(
+        config.setupSvc + "/api/recordType/editRecordType",
+        { id: body.id, objid: body.objid },
+        config.accessToken
+    );
+    if (!editRes || !editRes.result) {
+        throw new Error("Valid Delete Record Type Failed: unable to fetch record type detail - " +
+            (editRes?.returnInfo || editRes?.message || "Unknown error"));
+    }
+    const current = editRes.data || {};
+
+    // Step 2：若当前为启用状态，先禁用
+    if (current.isenable !== "false" && current.isenable !== false && current.isenable !== "") {
+        if (!isMcp) {
+            console.error();
+            console.error(chalk.yellow(`Record type (${body.id}) is enabled, disabling before delete...`));
+            console.error();
+        }
+        const disableRes = await postClass(
+            config.setupSvc + "/api/recordType/editSave",
+            { ...current, isenable: "false" },
+            config.accessToken
+        );
+        if (!disableRes || !disableRes.result) {
+            throw new Error("Valid Delete Record Type Failed: unable to disable record type - " +
+                (disableRes?.returnInfo || disableRes?.message || "Unknown error"));
+        }
+        if (!isMcp) {
+            console.error(chalk.green("Record type disabled successfully."));
+            console.error();
+        }
+    }
+
+    // Step 3：执行删除校验
+    const res = await postClass(
+        config.setupSvc + "/api/recordType/validDelete",
+        body,
+        config.accessToken
+    );
+    if (res && res.result) {
+        const data = res.data || {};
+        const result = {
+            obj: data.obj || {},
+            recordtypes: data.recordtypes || []
+        };
+        if (!isMcp) {
+            console.log(JSON.stringify(result));
+        }
+        return result;
+    }
+    throw new Error("Valid Delete Record Type Failed: " + (res?.returnInfo || res?.message || "Unknown error"));
+}
+
+module.exports = validDelete;

package/src/res.md

@@ -0,0 +1,66 @@
+# cloudcc-cli 资源与操作
+
+`cc <action> <type> …`
+# CRM 相关
+
+## plugin
+* create,publish,get,detail,pull,delete,doc
+
+## classes
+* create,publish,pull,get,pullList,detail,delete,doc
+
+## customSetting
+* doc,get,create,detail,delete
+
+## staticResource
+* doc,get,detail,delete,count
+
+## customPage
+* create,delete,get,doc
+
+## schedule
+* create,publish,pull,get,pullList,detail,delete,doc
+
+## timer
+* create,publish,pull,get,pullList,detail,delete,doc
+
+## triggers
+* create,publish,pull,get,pullList,detail,delete,doc
+
+## script
+* create,publish,pull,get,pullList,detail,doc
+
+## token
+* get
+
+## object
+* get,create,delete
+
+## recordType
+* get
+
+## brief
+* get
+
+## fields
+* get,create,delete
+
+## menu
+* create,delete,get,doc
+
+## application
+* get,create,delete
+
+## scheduleJob
+* get,detail,delete,doc
+
+# CLI 相关
+
+## project
+* create,doc
+
+## config
+* use,get
+
+## version
+* get

package/src/role/create.js

@@ -0,0 +1,153 @@
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 创建角色
+ * 用法：cc create role <path> <roleName> [parentRoleName] [description]
+ * 流程：
+ * 1. 调用 role/addRole 获取直属上司列表
+ * 2. 交互式选择直属上司（未指定时）或自动匹配（指定时）
+ * 3. 调用 role/saveRole 保存新角色
+ * @param {Array} argvs - 命令行参数数组
+ * @returns {Promise<Object>} 创建结果
+ */
+async function create(argvs) {
+    try {
+        // 命令行参数格式：cc create role <path> <roleName> [parentRoleName] [description]
+        const projectPath = argvs[2] || process.cwd();
+        const roleName = argvs[3];
+        const parentRoleName = argvs[4] || '';
+        const description = argvs[5] || '';
+
+        if (!roleName) {
+            console.error();
+            console.error(chalk.red('Error: 缺少角色名称'));
+            console.error('用法: cc create role <path> <roleName> [parentRoleName] [description]');
+            console.error('示例:');
+            console.error('  cc create role . "销售经理"           # 交互式选择直属上司');
+            console.error('  cc create role . "销售经理" "CEO"     # 指定直属上司为 CEO');
+            console.error('  cc create role . "销售经理" "CEO" "负责销售团队管理"');
+            console.error();
+            throw new Error('缺少必需参数: roleName');
+        }
+
+        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(`Creating role (${roleName}), please wait...`));
+        console.error();
+
+        // 步骤1：调用 addRole 获取直属上司列表
+        console.error(chalk.blue('Step 1: 获取直属上司列表...'));
+        const addRoleRes = await postClass(
+            config.setupSvc + "/api/role/addRole",
+            { id: "bab2025F8B20EE4d4005" },
+            config.accessToken
+        );
+
+        if (!addRoleRes || !addRoleRes.result) {
+            const msg = addRoleRes && (addRoleRes.returnInfo || addRoleRes.message)
+                ? (addRoleRes.returnInfo || addRoleRes.message)
+                : "获取直属上司列表失败";
+            throw new Error(msg);
+        }
+
+        const supervisorList = addRoleRes.data?.flist || [];
+        if (supervisorList.length === 0) {
+            throw new Error('没有可用的直属上司角色');
+        }
+
+        let parentRoleId;
+
+        // 步骤2：确定直属上司
+        if (parentRoleName) {
+            // 通过名称自动匹配上级角色
+            const matchedSupervisor = supervisorList.find(
+                item => item.rolename === parentRoleName
+            );
+            if (!matchedSupervisor) {
+                console.error();
+                console.error(chalk.yellow(`警告: 未找到直属上司 "${parentRoleName}"`));
+                console.error(chalk.blue('可用的直属上司列表:'));
+                supervisorList.forEach(item => {
+                    console.error(`  - ${item.rolename}`);
+                });
+                console.error();
+                throw new Error(`未找到直属上司: ${parentRoleName}`);
+            }
+            parentRoleId = matchedSupervisor.id;
+            console.error(chalk.blue(`已指定直属上司: ${matchedSupervisor.rolename} (${parentRoleId})`));
+        } else {
+            // 交互式选择直属上司
+            const supervisorChoices = supervisorList.map(item => ({
+                name: `${item.rolename} (${item.id})`,
+                value: item.id,
+                short: item.rolename
+            }));
+
+            const result = await inquirer.prompt([
+                {
+                    type: 'list',
+                    name: 'parentRoleId',
+                    message: '请选择直属上司：',
+                    choices: supervisorChoices,
+                    pageSize: 10
+                }
+            ]);
+            parentRoleId = result.parentRoleId;
+            const selectedSupervisor = supervisorList.find(item => item.id === parentRoleId);
+            console.error(chalk.blue(`已选择直属上司: ${selectedSupervisor.rolename} (${parentRoleId})`));
+        }
+
+        console.error();
+
+        // 步骤3：调用 saveRole 保存角色
+        console.error(chalk.blue('Step 2: 保存新角色...'));
+        const dataJson = JSON.stringify({
+            rolename: roleName,
+            parentroleId: parentRoleId
+        });
+
+        const saveRes = await postClass(
+            config.setupSvc + "/api/role/saveRole",
+            { dataJson },
+            config.accessToken
+        );
+
+        if (saveRes && saveRes.result) {
+            console.error();
+            console.error(chalk.green('Success! Role created.'));
+            console.error(`  角色名称: ${roleName}`);
+            const selectedSupervisor = supervisorList.find(item => item.id === parentRoleId);
+            console.error(`  直属上司: ${selectedSupervisor ? selectedSupervisor.rolename : parentRoleId}`);
+            if (saveRes.data) {
+                const roleId = typeof saveRes.data === 'object'
+                    ? (saveRes.data.roleid || saveRes.data.id || JSON.stringify(saveRes.data))
+                    : saveRes.data;
+                console.error(`  角色ID: ${roleId}`);
+            }
+            console.error();
+            return saveRes;
+        }
+
+        const msg = saveRes && (saveRes.returnInfo || saveRes.message)
+            ? (saveRes.returnInfo || saveRes.message)
+            : "Unknown error";
+        throw new Error("Save Role Failed: " + msg);
+
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("角色创建失败:"), error.message || error);
+        throw error;
+    }
+}
+
+module.exports = create;

package/src/role/delete.js

@@ -0,0 +1,59 @@
+const chalk = require("chalk");
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 删除角色
+ * 用法：cc delete role <projectPath> <roleId>
+ */
+async function remove(argvs) {
+    try {
+        const projectPath = argvs[2] || process.cwd();
+        const roleId = argvs[3];
+
+        if (!roleId) {
+            console.error();
+            console.error(chalk.red("Error: 缺少角色 ID"));
+            console.error(chalk.yellow("用法: cc delete role <projectPath> <roleId>"));
+            console.error();
+            throw new Error("缺少必需参数: roleId");
+        }
+
+        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 role (${roleId}), please wait...`));
+        console.error();
+
+        const result = await postClass(
+            config.setupSvc + "/api/role/deleteRole",
+            { roleid: roleId },
+            config.accessToken
+        );
+
+        if (result && result.result) {
+            console.error();
+            console.error(chalk.green("Success! Role 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 Role Failed: " + msg);
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("角色删除失败:"), error);
+        throw error;
+    }
+}
+
+module.exports = remove;

package/src/role/doc.js

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