cloudcc-cli 2.4.0 → 2.4.2

package/src/dupeCatcher/docs/devguide.md

@@ -0,0 +1,125 @@
+# CloudCC 查重过滤器（Dupe Catcher）CLI 命令说明
+
+> 对应 one-setup-web 的接口前缀：`{setupSvc}/api/duplication/*`
+
+## 1. 功能范围
+
+- 过滤器（Filter）：列表、详情、保存（新建/编辑）、删除
+- 规则（Rule）：回显详情、保存（新建/编辑）、删除
+- 辅助查询：可选对象、可选字段、条件面板字段列表
+
+## 2. 命令总览
+
+```bash
+# 过滤器列表
+cloudcc get dupeCatcher [projectPath]
+
+# 过滤器详情（含规则列表）
+cloudcc detail dupeCatcher <projectPath> <filterid>
+
+# 保存过滤器（新建/编辑）
+cloudcc create dupeCatcher <projectPath> filter <encodedBodyJson>
+
+# 删除过滤器
+cloudcc delete dupeCatcher <projectPath> filter <filterid>
+
+# 规则详情（回显）
+cloudcc detail dupeCatcher <projectPath> rule <ruleid>
+
+# 保存规则（新建/编辑）
+cloudcc create dupeCatcher <projectPath> rule <encodedBodyJson>
+
+# 删除规则
+cloudcc delete dupeCatcher <projectPath> rule <ruleid>
+
+# 新建过滤器前：查询可选对象
+cloudcc get dupeCatcher objects [projectPath]
+
+# 新建规则前：查询可选字段
+cloudcc get dupeCatcher <projectPath> fields <filterid>
+
+# 条件面板字段列表（复用工作流接口）
+cloudcc get dupeCatcher <projectPath> workflowFields <targetobjectid>
+```
+
+## 3. 参数说明
+
+### 3.1 projectPath
+
+- **可选**，项目根目录（默认当前目录）。
+
+### 3.2 encodedBodyJson
+
+- **必须**：`encodeURI(JSON.stringify(body))`
+
+### 3.3 命令参数一览
+
+| 命令 | 参数 |
+| :--- | :--- |
+| `cloudcc get dupeCatcher [projectPath]` | `projectPath` 可选 |
+| `cloudcc detail dupeCatcher <projectPath> <filterid>` | `projectPath` 可选（默认当前目录），`filterid` 必填 |
+| `cloudcc create dupeCatcher <projectPath> filter <encodedBodyJson>` | `projectPath` 可选（默认当前目录），`encodedBodyJson` 必填 |
+| `cloudcc delete dupeCatcher <projectPath> filter <filterid>` | `projectPath` 可选（默认当前目录），`filterid` 必填 |
+| `cloudcc detail dupeCatcher <projectPath> rule <ruleid>` | `projectPath` 可选（默认当前目录），`ruleid` 必填 |
+| `cloudcc create dupeCatcher <projectPath> rule <encodedBodyJson>` | `projectPath` 可选（默认当前目录），`encodedBodyJson` 必填 |
+| `cloudcc delete dupeCatcher <projectPath> rule <ruleid>` | `projectPath` 可选（默认当前目录），`ruleid` 必填 |
+| `cloudcc get dupeCatcher objects [projectPath]` | `projectPath` 可选 |
+| `cloudcc get dupeCatcher <projectPath> fields <filterid>` | `projectPath` 可选（默认当前目录），`filterid` 必填 |
+| `cloudcc get dupeCatcher <projectPath> workflowFields <targetobjectid>` | `projectPath` 可选（默认当前目录），`targetobjectid` 必填 |
+
+### 3.4 `create dupeCatcher filter` 的 body 字段
+
+| 字段 | 类型 | 是否必须 | 说明 |
+| :--- | :--- | :--- | :--- |
+| `id` | string | 否 | 编辑时传；新建可不传 |
+| `name` | string | 是 | 过滤器名称 |
+| `objid` | string | 是 | 目标对象 id |
+| `errormessage` | string | 否 | 错误提示文案 |
+| `insertoperation` | string | 是 | 新增策略：`check` / `nothing` |
+| `insertIsSave` | string/null | 条件必填 | `insertoperation=check` 时建议传 `"1"`/`"0"`，否则传 `null` |
+| `insertIsTips` | string/null | 条件必填 | `insertoperation=check` 时建议传 `"1"`/`"0"`，否则传 `null` |
+| `updateoperation` | string | 是 | 更新策略：`check` / `nothing` |
+| `updateIsSave` | string/null | 条件必填 | `updateoperation=check` 时建议传 `"1"`/`"0"`，否则传 `null` |
+| `updateIsTips` | string/null | 条件必填 | `updateoperation=check` 时建议传 `"1"`/`"0"`，否则传 `null` |
+| `isprofile` | boolean | 否 | 是否简档 |
+| `isactive` | boolean | 否 | 是否启用 |
+| `conditionVals` | string | 是 | 条件面板产出的 JSON 字符串 |
+
+### 3.5 `create dupeCatcher rule` 的 body 字段
+
+| 字段 | 类型 | 是否必须 | 说明 |
+| :--- | :--- | :--- | :--- |
+| `id` | string | 否 | 编辑时传；新建可不传 |
+| `filterid` | string | 是 | 所属过滤器 id |
+| `fieldid` | string | 是 | 匹配字段 id |
+| `matchoption` | string | 是 | `exact` / `contains` / `firstNletters` / `lastNletters` |
+| `firstletters` | string | 条件必填 | `matchoption` 为 `firstNletters/lastNletters` 时传字母数 |
+| `isblank` | number | 否 | 空值是否参与匹配，常用 `1/0` |
+
+## 4. 示例
+
+### 4.1 查询过滤器列表
+
+```bash
+cloudcc get dupeCatcher .
+```
+
+### 4.2 保存过滤器（新建）
+
+> 关键字段（与页面一致）：`name`、`objid`、`insertoperation`、`updateoperation`、`conditionVals` 等。
+
+```bash
+cloudcc create dupeCatcher . filter "$(node -e "console.log(encodeURI(JSON.stringify({name:'测试过滤器',objid:'<objid>',errormessage:'',insertoperation:'check',insertIsSave:'1',insertIsTips:'1',updateoperation:'check',updateIsSave:'1',updateIsTips:'1',isprofile:false,isactive:true,conditionVals:'{}'})))")"
+```
+
+### 4.3 保存规则（新建）
+
+```bash
+cloudcc create dupeCatcher . rule "$(node -e "console.log(encodeURI(JSON.stringify({filterid:'<filterid>',fieldid:'<fieldid>',matchoption:'exact',firstletters:'',isblank:0})))")"
+```
+
+## 5. 注意事项
+
+- `filterid` / `ruleid` / `objid` / `fieldid` 都来自平台返回数据，请先通过列表/详情接口获取。
+- `conditionVals` 是页面条件面板产出的 **json 字符串**（不是对象），请按接口要求传入字符串。
+

package/src/dupeCatcher/docs/introduction.md

@@ -0,0 +1,21 @@
+# CloudCC 查重过滤器（Dupe Catcher）介绍
+
+查重过滤器用于在**新建或编辑业务数据**时，按配置的**对象、字段与条件**检测是否与已有记录重复，从而提示或阻断保存。平台侧通过 **过滤器（Filter）** 与 **规则（Rule）** 两层建模：过滤器绑定目标对象与启用范围，规则描述具体匹配字段与逻辑。
+
+## 适用场景
+
+- 客户、联系人、线索等主数据**去重**（姓名 + 手机、邮箱等组合）。
+- 同一业务对象下**多套查重策略**（不同过滤器、不同规则集）。
+- 与 **one-setup-web** 中查重配置能力一致，CLI 面向**导出配置、脚本化维护、与本地工程联调**。
+
+## 能力边界（与开发指南的关系）
+
+- **介绍（本文）**：说明是什么、何时用、与平台概念对应关系。
+- **开发指南**：`cloudcc doc dupeCatcher devguide` — 列出 `get` / `detail` / `create` / `delete` 等 CLI 命令、参数与接口前缀 `{setupSvc}/api/duplication/*`。
+
+## 相关命令入口
+
+```bash
+cloudcc doc dupeCatcher introduction   # 本文
+cloudcc doc dupeCatcher devguide       # CLI 与接口说明
+```

package/src/dupeCatcher/get.js

@@ -0,0 +1,88 @@
+const { getPackageJson } = require("../../utils/config")
+const { postClass } = require("../../utils/http")
+
+/**
+ * Dupe Catcher (Duplication) queries.
+ *
+ * Supported:
+ * - cloudcc get dupeCatcher [projectPath]
+ *   -> /api/duplication/getList
+ *
+ * - cloudcc get dupeCatcher objects [projectPath]
+ *   -> /api/duplication/insetNewfilter
+ *
+ * - cloudcc get dupeCatcher fields <filterid> [projectPath]
+ *   -> /api/duplication/insetNewrule
+ *
+ * - cloudcc get dupeCatcher workflowFields <targetobjectid> [projectPath]
+ *   -> /api/workFlowSetup/newWorkflow
+ */
+function isPathLikeToken(v) {
+  if (typeof v !== "string" || !v) return false
+  return v === "." || v === ".." || /[\\/]/.test(v) || /:/.test(v)
+}
+
+async function request(projectPath, apiPath, body) {
+  const config = await getPackageJson(projectPath)
+  return await postClass(config.setupSvc + apiPath, body || {}, config.accessToken)
+}
+
+async function get(projectPath = process.cwd(), sub, subArg, isMcp = false) {
+  // compatibility: cloudcc get dupeCatcher objects [projectPath]
+  if (!isPathLikeToken(projectPath) && (projectPath === "objects" || projectPath === "fields" || projectPath === "workflowFields")) {
+    subArg = sub
+    sub = projectPath
+    projectPath = process.cwd()
+  }
+
+  if (!sub) {
+    const res = await request(projectPath, "/api/duplication/getList", {})
+    if (res && res.result) {
+      const list = res.data || res.list || []
+      if (!isMcp) console.log(JSON.stringify(list))
+      return list
+    }
+    throw new Error("Get DupeCatcher filter list failed: " + (res?.returnInfo || res?.message || "Unknown error"))
+  }
+
+  if (sub === "objects") {
+    const res = await request(projectPath, "/api/duplication/insetNewfilter", {})
+    if (res && res.result) {
+      const data = res.data || res
+      if (!isMcp) console.log(JSON.stringify(data))
+      return data
+    }
+    throw new Error("Get DupeCatcher objects failed: " + (res?.returnInfo || res?.message || "Unknown error"))
+  }
+
+  if (sub === "fields") {
+    const filterid = subArg
+    if (!filterid) throw new Error("Missing filterid. Usage: cloudcc get dupeCatcher fields <filterid> [projectPath]")
+    const res = await request(projectPath, "/api/duplication/insetNewrule", { filterid })
+    if (res && res.result) {
+      const data = res.data || res
+      if (!isMcp) console.log(JSON.stringify(data))
+      return data
+    }
+    throw new Error("Get DupeCatcher fields failed: " + (res?.returnInfo || res?.message || "Unknown error"))
+  }
+
+  if (sub === "workflowFields") {
+    const targetobjectid = subArg
+    if (!targetobjectid) {
+      throw new Error("Missing targetobjectid. Usage: cloudcc get dupeCatcher workflowFields <targetobjectid> [projectPath]")
+    }
+    const res = await request(projectPath, "/api/workFlowSetup/newWorkflow", { targetobjectid })
+    if (res && res.result) {
+      const data = res.data || res
+      if (!isMcp) console.log(JSON.stringify(data))
+      return data
+    }
+    throw new Error("Get DupeCatcher workflowFields failed: " + (res?.returnInfo || res?.message || "Unknown error"))
+  }
+
+  throw new Error(`Unknown subcommand for get dupeCatcher: ${sub}`)
+}
+
+module.exports = get
+

package/src/dupeCatcher/index.js

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

package/src/html/doc.js

@@ -0,0 +1,35 @@
+const fs = require("fs");
+const path = require("path");
+
+const DOCS_DIR = path.join(__dirname, "docs");
+
+function getIntroductionDoc() {
+  return fs.readFileSync(path.join(DOCS_DIR, "introduction.md"), "utf8");
+}
+
+function getDevGuideDoc() {
+  return fs.readFileSync(path.join(DOCS_DIR, "devguide.md"), "utf8");
+}
+
+function doc(argvs) {
+  const subType = argvs[2];
+  const key = String(subType || "").trim().toLowerCase();
+  if (!key) {
+    throw new Error("cloudcc doc html 需要子命令：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/html/docs/devguide.md

@@ -0,0 +1,67 @@
+# CloudCC 自定义 HTML 组件开发指南
+
+## 1. 适用范围
+
+- 本文用于在 CloudCC 相关项目中编写单个 HTML 入口页（通常为 `html/index.html`），适合 CloudCC 内嵌页面或独立打开的轻量页面场景。
+- 静态依赖（样式、脚本、字体等）优先使用线上绝对地址（`https://...`）引入；公有云推荐使用中国大陆可稳定访问的源（如 BootCDN）。
+- 私有云或内网环境可先下载依赖并上传为组织静态资源，再替换为静态资源 URL。
+
+## 2. 推荐前端依赖组合
+
+推荐组合：Tailwind CSS + Alpine.js + ECharts。
+
+### 2.1 Tailwind CSS（浏览器端编译）
+
+```html
+<script src="https://cdn.bootcdn.net/ajax/libs/tailwindcss-browser/4.1.13/index.global.min.js"></script>
+```
+
+### 2.2 Alpine.js（交互层）
+
+```html
+<script defer src="https://cdn.bootcdn.net/ajax/libs/alpinejs/3.15.0/cdn.min.js"></script>
+```
+
+建议放在 `head`，并在同页组合时保持 Tailwind 在前、Alpine 在后。
+
+### 2.3 ECharts（图表）
+
+```html
+<script src="https://cdn.bootcdn.net/ajax/libs/echarts/6.0.0/echarts.min.js"></script>
+```
+
+建议在 Tailwind 与 Alpine 之后加载，并在图表初始化脚本之前引入。
+
+## 3. CloudCC 运行环境能力（CCDK）
+
+- 在 CloudCC 运行环境（如自定义页面、内嵌 HTML）中，可通过 `window.$CCDK` 使用平台能力。
+- 本地直接用浏览器打开 HTML 文件时通常不存在 `$CCDK`，请先做存在性判断，避免运行时报错。
+- 业务接口与平台能力细节以各模块文档为准：`cloudcc doc <module> introduction|devguide`。
+
+## 4. 最小可用模板
+
+```html
+<!doctype html>
+<html lang="zh-CN">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>CloudCC HTML Page</title>
+    <script src="https://cdn.bootcdn.net/ajax/libs/tailwindcss-browser/4.1.13/index.global.min.js"></script>
+    <script defer src="https://cdn.bootcdn.net/ajax/libs/alpinejs/3.15.0/cdn.min.js"></script>
+  </head>
+  <body class="p-4">
+    <div x-data="{ ready: true }">
+      <h1 class="text-xl font-semibold">CloudCC HTML 页面</h1>
+      <p class="mt-2 text-gray-600" x-show="ready">页面已初始化</p>
+    </div>
+
+    <script>
+      const cc = window.$CCDK || null;
+      if (!cc) {
+        console.warn("$CCDK 不可用，当前可能是本地浏览器环境。");
+      }
+    </script>
+  </body>
+</html>
+```

package/src/html/docs/introduction.md

@@ -0,0 +1,4 @@
+# CloudCC HTML 组件开发简介
+
+- HTML 组件开发必须使用单 HTML 文件作为入口（建议 `html/index.html`）。
+- 页面中引用的 JS、CSS、图片等资源，可以放入 CloudCC 静态资源后再通过静态资源 URL 引用。

package/src/html/index.js

@@ -0,0 +1,11 @@
+const cc = {};
+cc.doc = require("./doc");
+
+async function main(action, argvs) {
+  if (!cc[action]) {
+    throw new Error(`html 不支持的动作: ${action}`);
+  }
+  return cc[action](argvs);
+}
+
+module.exports = main;