cloudcc-cli 2.2.8 → 2.3.0

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 customPage list [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/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/index.js

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

package/src/plugin/delete.js

@@ -0,0 +1,91 @@
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const { getPackageJson } = require("../../utils/config");
+const { post } = require("../../utils/http");
+const BaseUrl = "https://developer.apis.cloudcc.cn";
+
+/**
+ * 删除云端自定义组件
+ * 支持通过组件名或 ID 删除：
+ * - 传组件名时：从本地 plugins/<name>/config.json 读取 id 后删除
+ * - 传 ID 时：直接通过 ID 删除
+ *
+ * 用法：cc delete plugin <pluginNameOrId> [projectPath]
+ */
+async function deletePlugin(argvs) {
+    const input = argvs[2];
+    const projectPath = argvs[3] || process.cwd();
+
+    if (!input) {
+        console.error();
+        console.error(chalk.red('Error: Plugin name or ID is required'));
+        console.error(chalk.yellow('Usage: cc delete plugin <pluginNameOrId> [projectPath]'));
+        console.error();
+        return;
+    }
+
+    // 先尝试将 input 作为组件名处理：检查本地 config.json 是否有 id
+    const configPath = path.join(projectPath, `plugins/${input}/config.json`);
+    if (fs.existsSync(configPath)) {
+        try {
+            const configContent = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+            if (configContent.id) {
+                await deleteById(configContent.id, projectPath);
+                return;
+            }
+        } catch (error) {
+            console.error(chalk.yellow(`Warning: Failed to read config.json, treating input as ID: ${error.message}`));
+        }
+    }
+
+    // 作为 ID 处理
+    await deleteById(input, projectPath);
+}
+
+/**
+ * 通过 ID 删除云端组件
+ */
+async function deleteById(pluginId, projectPath) {
+    const config = await getPackageJson(projectPath);
+    if (!config || !config.accessToken) {
+        throw new Error('Configuration not found or accessToken is missing');
+    }
+
+    const devSvcDispatch = config.devSvcDispatch || '/devconsole';
+    const baseUrl = config.baseUrl || BaseUrl;
+
+    const header = {
+        "appType": "lightning-setup",
+        "appVersion": "0.0.1",
+        "accessToken": config.accessToken,
+        "source": "lightning-setup",
+        "version": "public"
+    };
+
+    const body = {
+        "id": pluginId
+    };
+
+    console.error(chalk.green(`Deleting plugin (ID: ${pluginId}), please wait...`));
+
+    const res = await post(
+        `${baseUrl}${devSvcDispatch}/custom/pc/1.0/post/deleteCustomComp`,
+        body,
+        header
+    );
+
+    if (res && res.returnCode == 200) {
+        console.error(chalk.green(`Success! Plugin (ID: ${pluginId}) deleted from server.`));
+        console.error();
+    } else {
+        const errMsg = res?.returnInfo || 'Unknown error';
+        console.error(chalk.red(`Fail: ${errMsg}`));
+        console.error();
+        throw new Error('Delete Plugin Failed: ' + errMsg);
+    }
+
+    return res;
+}
+
+module.exports = deletePlugin;

package/src/plugin/doc.js

@@ -13,6 +13,82 @@ function generateFullMarkdownDoc() {
         "",
         "---",
         "",
+        "## 0. 自定义组件概述（能力与场景）",
+        "",
+        "本文节整合了仓库内实践用法，帮助你在开始编码前先判断：什么是自定义组件、能解决什么问题、何时该用。",
+        "",
+        "### 0.1 什么是自定义组件（本项目语境）",
+        "",
+        "在本项目中，**自定义组件**通常指以 **Vue 2 单文件组件（`.vue`）** 为入口、放在 `plugins/<插件名>/` 下，通过 `cloudccBuild` / `cloudccBuild2` 等 CLI 命令打包后，嵌入 CloudCC 页面或应用的前端能力单元。",
+        "",
+        "一个插件一般包含：",
+        "",
+        "| 内容 | 作用 |",
+        "|------|------|",
+        "| 入口 `.vue`（如 `cc-ai-chat.vue`） | 组件 UI 与业务逻辑 |",
+        "| `config.json` | 组件标识、名称、描述、分类、加载模式等元数据 |",
+        "| `components/`、`utils/` 等 | 子组件、HTTP 封装、适配器、第三方 SDK 封装 |",
+        "",
+        "入口组件中常见 `componentInfo` 对象，与 `config.json` 呼应，用于平台展示组件信息与加载策略。",
+        "",
+        "### 0.2 自定义组件能做什么",
+        "",
+        "- 扩展标准 CRM 页面：在记录页、列表页、门户中挂载专用界面",
+        "- 对接外部系统：接入 OpenAPI、Agent、地图、图可视化等复杂交互",
+        "- 使用 CloudCC 运行时能力：通过 `$CCDK` 读取用户、Token、网关、事件总线",
+        "- 实现独立数据层（按需）：对接组织允许的外部存储或服务",
+        "- 搭建实施与诊断工具：同步、调试、日志、排查面板等运营能力",
+        "",
+        "一句话：自定义组件是在 CloudCC 宿主内运行、可独立版本化的前端扩展能力。",
+        "",
+        "### 0.3 为什么要用自定义组件",
+        "",
+        "| 原因 | 说明 |",
+        "|------|------|",
+        "| 标准功能边界 | 标准布局与字段配置难覆盖甘特图、对话式 AI、复杂工作台等场景 |",
+        "| 体验与品牌 | 需要统一交互、定制视觉与复合布局体验 |",
+        "| 集成成本 | 第三方 SaaS/自研 API 更适合在前端组件中做适配封装 |",
+        "| 迭代效率 | 前端组件可独立发版，与后端逻辑解耦，支持小步快跑 |",
+        "| 复用能力 | 同一组件可复用到多个页面，通过属性配置实现差异化 |",
+        "",
+        "### 0.4 典型可解决问题",
+        "",
+        "1. 平台可配置但体验较差：通过专用 UI 优化录入、查询、可视化流程",
+        "2. 必须与外部系统实时协同：在组件内完成请求与回调闭环",
+        "3. 需要强上下文：利用 `$CCDK` 获取当前用户、视图与凭证避免重复登录",
+        "4. 需要跨模块联动：借助总线事件让多个区域同步响应",
+        "5. 需要工具化交付：建设调试与运维面板降低人工操作风险",
+        "",
+        "### 0.5 什么时候优先考虑自定义组件",
+        "",
+        "| 场景类型 | 示例 |",
+        "|----------|------|",
+        "| 复杂可视化 | 甘特图、关系图、统计大屏 |",
+        "| 对话与智能助手 | 嵌入式 AI 聊天、Agent 工具面板 |",
+        "| 行业专用工作台 | 客户 360、项目工作台、专题门户 |",
+        "| 门户与附件增强 | 文件上传下载、模板导出导入 |",
+        "| 表单 + 外部库 | 自定义流程表单 + 第三方服务 |",
+        "| 实施与运维工具 | SQL 工具、健康检查、调试面板 |",
+        "",
+        "不建议强行使用自定义组件的场景：",
+        "- 仅靠标准字段、列表、校验即可满足需求时",
+        "- 需要强安全与一致性的核心业务规则（应放在服务端）",
+        "",
+        "### 0.6 开发与构建要点（仓库实践）",
+        "",
+        "- 依赖按需引入，避免插件无关依赖膨胀",
+        "- 使用 `npm run build-plugin`（`cloudccBuild`）产出发布包",
+        "- 本地通过 `npm run serve` 快速调试组件交互",
+        "- 运行环境通过注入 `$CCDK` 提供统一账号、网关、上传、日志与事件能力",
+        "",
+        "### 0.7 结论",
+        "",
+        "- 自定义组件 = CloudCC 宿主内的 Vue 插件包 + 元数据 + 可选 `$CCDK` 集成",
+        "- 核心价值：在保持平台一致性的同时，快速交付标准配置覆盖不到的能力",
+        "- 选型建议：复杂 UI、多系统集成、强上下文、工具化需求优先；可标准配置解决则优先标准方案",
+        "",
+        "---",
+        "",
         "## 1. 快速上手：发布第一个组件",
         "",
         "### 1.1 启动项目",

package/src/plugin/index.js

@@ -4,6 +4,7 @@ cc.publish = require("./publish1")
 cc.get = require("./get")
 cc.detail = require("./detail")
 cc.pull = require("./pull")
+cc.delete = require("./delete")
 cc.doc = require("./doc")
 function Plugin(action, argvs) {
     cc[action](argvs)