cloudcc-cli 2.3.0 → 2.3.2

package/.cursor/skills/cloudcc-cli-dev/CUSTOM-SETTING-API.md

@@ -1,241 +0,0 @@
-# 自定义设置相关接口
-
-## 指导文档
-
-直接使用以下命令查看指导文档：
-
-```bash
-cc doc customSetting
-```
-
-
----
-
-## 查询自定义设置列表
-
-路径：`{服务名称}/api/customsetting/list`
-
-方法：POST
-
-接口描述：分页/查询自定义设置主列表，返回 `objList` 等。
-
-### 请求参数
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| （请求体） | object | 非必须 | {} | 当前前端传空对象 |
-
----
-
-## 新建/更新自定义设置（保存主对象）
-
-路径：`{服务名称}/api/customsetting/save`
-
-方法：POST
-
-接口描述：新建或编辑自定义设置主记录（标签、对象 API 名、类型、可见性、描述等）。
-
-### 请求参数
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| tpSysObjectVO | object | 必须 | — | 主对象载体，见下表子字段 |
-
-**tpSysObjectVO 子字段：**
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| accessable | string | 视业务 | — | 可见性（如 `"2"` 表示公用等，与表单选项一致） |
-| dataType | string | 视业务 | — | 设置类型：`L` 列表，`H` 层次结构 |
-| id | string | 视业务 | `""` | 新建传空字符串；编辑传记录 id |
-| label | string | 视业务 | — | 标签 |
-| remark | string | 非必须 | — | 描述 |
-| schemetableName | string | 视业务 | — | 对象名（编辑时前端通常禁用修改） |
-
----
-
-## 编辑前回显（自定义设置主对象）
-
-路径：`{服务名称}/api/customsetting/modify`
-
-方法：POST
-
-接口描述：根据主记录 id 拉取表单回显数据。
-
-### 请求参数
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| objid | string | 必须 | — | 记录id |
-
----
-
-## 删除自定义设置主对象
-
-路径：`{服务名称}/api/customsetting/deleteobj`
-
-方法：POST
-
-接口描述：删除一条自定义设置主记录。
-
-### 请求参数
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| objid | string | 必须 | — | 记录id |
-
----
-
-## 查询自定义设置详情（含字段列表）
-
-路径：`{服务名称}/api/customsetting/detail`
-
-方法：POST
-
-接口描述：详情页使用，返回主对象信息及 `cusFields` 字段列表。
-
-### 请求参数
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| objid | string | 必须 | — | 记录id |
-
----
-
-## 进入字段编辑（取字段编辑所需数据）
-
-路径：`{服务名称}/api/customsetting/editfile`
-
-方法：POST
-
-接口描述：点击某字段「编辑」时调用，用于打开字段编辑器。
-
-### 请求参数
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| queryrecordid | string | 必须 | — | 字段行 id |
-
----
-
-## 删除自定义字段
-
-路径：`{服务名称}/api/customsetting/deletefield`
-
-方法：POST
-
-接口描述：在详情页删除某条自定义字段。
-
-### 请求参数
-
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| id | string | 必须 | — | 字段行 id |
-| objid | string | 必须 | — | 所属自定义设置 id |
-
----
-
-
-## 自定义字段类型静态配置
-> 前端静态配置，非后端接口返回）
-```json
-[
-  {
-    "id": "0001",
-    "name": "URL",
-    "type": "U",
-    "address": "允许用户输入任何有效的网址。如果用户单击该字段，将根据用户选择的模式在浏览器的新窗口或当前窗口中打开该 URL。系统默认在浏览器的新窗口中打开该URL。"
-  },
-  {
-    "id": "0002",
-    "name": "百分比",
-    "type": "P",
-    "address": "允许用户输入百分比数字（例如，10），并自动向数字添加百分号。"
-  },
-  {
-    "id": "0003",
-    "name": "币种",
-    "type": "c",
-    "address": "币种"
-  },
-  {
-    "id": "0004",
-    "name": "电话",
-    "type": "H",
-    "address": "允许用户输入任何电话号码。自动将其转换为电话号码格式。"
-  },
-  {
-    "id": "0005",
-    "name": "电子邮件",
-    "type": "E",
-    "address": "允许用户输入电子邮件地址，对其进行验证以确保格式正确。如果对于一个联系人和潜在客户指定了此字段，则用户单击“发送电子邮件”时可以选择地址。注意，自定义电子邮件地址无法用于批量电子邮件。"
-  },
-  {
-    "id": "0006",
-    "name": "复选框",
-    "type": "B",
-    "address": "允许用户选择“真”（选取）或“假”（不选取）值。"
-  },
-  {
-    "id": "0007",
-    "name": "日期",
-    "type": "D",
-    "address": "允许用户输入日期或从弹出式日历中选择日期。"
-  },
-  {
-    "id": "0008",
-    "name": "日期和时间",
-    "type": "F",
-    "address": "允许用户输入日期和时间，或从弹出式日历中选择日期。当用户单击弹出式日历中的某个日期后，该日期和当前时间将输入到日期/时间字段。"
-  },
-  {
-    "id": "0009",
-    "name": "数字",
-    "type": "N",
-    "address": "允许用户输入任何数字。将删除前置零。"
-  },
-  {
-    "id": "0010",
-    "name": "文本",
-    "type": "S",
-    "address": "允许用户输入任何字母和数字组合。"
-  },
-  {
-    "id": "0011",
-    "name": "长文本",
-    "type": "X",
-    "address": "允许用户输入多行文本，最多可输入 4000 个字符。"
-  }
-]
-```
-
-## 保存字段（新增/编辑字段）
-路径：`{服务名称}/api/customsetting/saveField`
-方法：POST
-接口描述：在自定义设置详情页中保存字段定义（字段新建或编辑）。
-### 请求参数
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| tpSysSchemetableVO | object | 必须 | — | 字段对象，见下方子字段表 |
-| fdtype | string | 必须 | — | 字段类型代码（如 `U` 表示 URL） |
-**tpSysSchemetableVO 子字段：**
-| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
-| :--- | :--- | :--- | :--- | :--- |
-| schemetableId | string | 必须 | — | 所属自定义设置（对象）id |
-| id | string | 非必须 | — | 字段 id；编辑时传，新增可不传或传空 |
-| nameLabel | string | 必须 | — | 字段显示名称（标签） |
-| apiname | string | 必须 | — | 字段 API 名 |
-| edittype | string | 非必须 | — | 字段编辑类型（例如 URL 打开方式 `_blank`） |
-| schemefieldLength | string | 非必须 | — | 字段长度 |
-| defaultValue | string | 非必须 | — | 默认值 |
-| datafieldRef | string | 非必须 | — | 数据字段引用名 |
-| isDeleted | string | 非必须 | `"0"` | 删除标记 |
-| fieldState | string | 非必须 | `"enable"` | 字段状态 |
-| iscustom | string | 非必须 | `"1"` | 是否自定义字段 |
-| schemefieldType | string | 必须 | — | 字段类型代码（例如 `U`） |
-| schemefieldName | string | 必须 | — | 字段物理名/存储名 |
-
-
-
-
-

package/.cursor/skills/cloudcc-cli-dev/INSTALL_AND_BOOTSTRAP.md

@@ -1,59 +0,0 @@
-## 目标
-
-让开发者（或 AI）在一台新机器上，完成 `cloudcc-cli` 的安装、模板项目创建、开发密钥配置，并能通过 `cc` 命令进行开发与发布。
-
----
-
-## 安装 cloudcc-cli
-
-### 全局安装
-
-```bash
-# Windows
-npm i -g cloudcc-cli
-
-# macOS（通常需要 sudo）
-sudo npm i -g cloudcc-cli
-```
-
-### 验证版本
-
-```bash
-cc -v
-```
-
-> 说明：`cc` 是该 CLI 的统一入口命令之一（见本仓库 `package.json` 的 bin 配置）。
-
----
-
-## 创建 CloudCC 模板项目
-
-在你的工作目录下执行：
-
-```bash
-cc create project demo1
-cd demo1
-npm i
-npm run serve
-```
-
-如果能在本地启动并访问页面，说明前端开发链路可用。
-
----
-
-## 配置开发者密钥与安全标记
-
-### 在 CloudCC CRM 后台获取
-
-你需要一个具备“代码管理/开发者权限”的账号。
-
-- **开发者密钥（CloudCCDev）**：在 CRM 后台「连接的应用程序」中新建后获取并复制。
-- **安全标记（safetyMark）**：在个人设置中重置安全标记后，通过邮箱获取。
-
-### 写入项目的 `cloudcc-cli.config.js`
-
-模板项目根目录通常会有 `cloudcc-cli.config.js`（或你们约定的同名配置文件），核心原则：
-
-- **多环境**：用 `use` 字段选择当前环境（如 `dev/uat/prod`）。
-- **不要提交真实密钥到 Git**：建议 `.gitignore` 忽略配置文件，或用本地私密文件方式管理。
-

package/.cursor/skills/cloudcc-cli-dev/OBJECTS_AND_FIELDS.md

@@ -1,120 +0,0 @@
-## 覆盖范围
-
-本篇聚焦用 `cloudcc-cli` 的 `cc` 命令完成：
-
-- 创建自定义对象（Custom Object）
-- 查询对象列表
-- 查询对象字段
-- 为对象创建字段（支持多字段类型）
--（可选）创建菜单、创建应用（把对象挂到导航中）
-
----
-
-## 自定义对象（Custom Object）
-
-### 你需要准备什么信息
-
-- **对象显示标签（label）**：例如“客户”“合同”“付款计划”
-- **项目路径（projectPath）**：模板项目根目录
-
-### CLI 命令（项目已有实现）
-
-```bash
-cc create object <projectPath> <label>
-```
-
-示例：
-
-```bash
-cc create object . 客户
-```
-
----
-
-## 查询对象列表
-
-### CLI 命令（输出 JSON）
-
-```bash
-# type 可选：standard / custom / both（默认：both）
-cc get object <projectPath> [type]
-```
-
-示例：
-
-```bash
-cc get object . both
-```
-
-用途：
-
-- 获取对象 `objprefix` / 对象 `id`（后续创建字段、触发器会用到）
-
----
-
-## 查询对象字段列表
-
-### CLI 命令（输出 JSON）
-
-```bash
-cc get fields <projectPath> <objprefix>
-```
-
-示例：
-
-```bash
-cc get fields . a01
-```
-
-用途：
-
-- 在创建字段前，先确认是否已存在同名/同含义字段，避免重复与冲突。
-
----
-
-## 创建字段（Field）
-
-### CLI 命令形态（项目已有实现）
-
-字段创建命令由工具根据字段类型拼装，典型形态：
-
-```bash
-cc create fields <projectPath> <fieldType> <objid> <nameLabel> [ptext|lookupObj]
-```
-
-### 字段类型选择建议（常用）
-
-- **S**：文本（最常用）
-- **N**：数字
-- **D / F**：日期 / 日期时间
-- **B**：复选框
-- **L / Q**：选项列表（单选/多选）
-- **Y / MR / M**：关系字段（查找/查找多选/主详）
-- **E / H / U**：邮箱/电话/URL
-
----
-
-## 菜单与应用（让对象可访问）
-
-### 创建菜单（CLI）
-
-```bash
-cc create menu <type> <projectPath> <resourceId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
-```
-
-示例：
-
-```bash
-cc create menu object . <objectId> "我的对象菜单"
-```
-
-### 创建应用（CLI）
-
-```bash
-cc create application <projectPath> <appName> <appCode> [menuIds]
-```
-
-说明：
-
-- `menuIds`：可选，多个用逗号分隔；系统会确保默认菜单 `acf000001` 被包含。
-

package/.cursor/skills/cloudcc-cli-dev/REQUIREMENTS_BREAKDOWN.md

@@ -1,98 +0,0 @@
-## 目标
-
-把业务需求翻译成 CloudCC CRM 二开落地项，并选择“应该做什么组件”：自定义对象/字段/菜单/应用/自定义类/定时器/触发器/自定义组件/客户端脚本。
-
----
-
-## 需求拆解模板（AI 必须输出）
-
-拿到需求后，先输出以下结构（缺信息则显式标注“待确认”）：
-
-- **背景与目标**：要解决什么问题，成功标准是什么。
-- **角色与权限**：涉及哪些用户/简档/权限集，是否需要后台权限调整。
-- **对象与数据模型**：
-  - 需要哪些**自定义对象**（表）？
-  - 需要哪些**字段**（类型、必填/唯一、默认值、选项、查找/主详关系）？
-  - 是否涉及**记录类型**、**布局**、**验证规则**（若 CLI 不覆盖，需在 CRM 配置）？
-- **业务流程**：
-  - 触发时机：保存前/保存后/提交审批/批处理/定时等
-  - 需要哪些自动化：校验、自动赋值、联动更新、异步任务、定时任务
-- **界面与交互**：
-  - 是否需要自定义页面或嵌入式 UI？
-  - 是否需要列表/详情/编辑页的前端交互（客户端脚本 / 自定义组件）？
-- **集成与外部依赖**：第三方接口、鉴权方式、重试/限流、日志与审计。
-- **风险与回滚**：数据迁移、权限影响、性能与批量场景、灰度与回滚方案。
-- **交付物清单**：最终要产出哪些 CloudCC 资产（对象/字段/菜单/应用/类/触发器/定时器/组件/脚本）。
-
----
-
-## 方案选型决策表（怎么判断用什么）
-
-### 自定义对象（Custom Object）
-
-当出现以下需求时，优先考虑创建自定义对象：
-
-- 需要一个新的业务实体（类似新表），有独立的字段、权限、页面与列表
-- 需要与现有对象建立查找/主详关系
-- 需要支持审批、报表、共享规则等平台能力（通常都围绕对象展开）
-
-### 自定义字段（Field）
-
-当需求是“给已有对象补充数据结构”时：
-
-- 新增文本/数值/日期/选项/查找关系等字段
-- 需要字段级校验、默认值、必填等（部分能力可能需在 CRM 配置完成）
-
-### 触发器（Trigger）
-
-当需求是“数据写入前后做强一致业务逻辑”时：
-
-- 保存前校验/自动赋值/阻止不合法写入（before*）
-- 保存后联动更新、写日志、创建子记录（after*）
-- 批量/审批/提交后回调等特定时机（approval/batch/commitBatch 等）
-
-> 注意：触发器要考虑**批量**、幂等、递归、性能与异常处理。
-
-### 自定义类（Class）
-
-当需求是“可复用的服务逻辑/复杂计算/对外接口封装”时：
-
-- 作为触发器/定时器/页面调用的后端服务类
-- 抽取通用能力（查询封装、校验器、集成适配器）
-
-### 定时类（Scheduled Class / Timer）
-
-当需求是“按时间周期跑任务”时：
-
-- 夜间同步、定时报表、到期提醒、批量修复数据
-- 需要可控的调度表达式与运行日志
-
-### 自定义组件（Vue Custom Component）
-
-当需求是“在 CloudCC UI 中提供复杂交互 UI”时：
-
-- 自定义表单、复杂联动、可视化、批量操作 UI
-- 需要前端框架能力（Vue2.x）与更强的用户体验
-
-### 客户端脚本（Client Script）
-
-当需求是“页面级轻量交互/字段联动/保存前校验”时：
-
-- 列表/详情/编辑/新建页生命周期钩子
-- 字段变更联动、提示、轻量校验
-
-> 客户端脚本更轻量；交互复杂或需要组件化复用，建议升级为自定义组件。
-
----
-
-## 推荐落地流程（AI 执行顺序）
-
-一般建议按以下顺序落地（从“数据结构”到“业务逻辑”再到“界面”）：
-
-1. **对象与字段**：先把数据模型搭好（对象、字段、关系）
-2. **菜单与应用**：让用户能访问（菜单/应用）
-3. **后端逻辑**：自定义类 / 触发器 / 定时器
-4. **前端交互**：客户端脚本 / 自定义组件
-5. **联调与回归**：核心路径 + 批量场景 + 权限场景
-6. **发布与回滚准备**：版本记录、灰度、回滚策略
-

package/.cursor/skills/cloudcc-cli-dev/SKILL.md

@@ -1,44 +0,0 @@
----
-name: cloudcc-cli-dev
-description: CloudCC CRM 二次开发 CLI 助手。用于需求拆解与方案选型，并通过 cloudcc-cli（cc 命令）创建/拉取/发布自定义对象、字段、菜单/应用、自定义类、定时器、触发器与 Vue 自定义组件等资产。用户提到 CloudCC、cloudcc-cli、cc 命令、对象/字段/触发器/定时器/自定义组件 时应优先使用。
----
-
-# CloudCC CLI Development Skill
-
-## cloudcc-cli
-- 需要检查全局是否安装了cloudcc-cli npm包，如果没有请先安装。
-
-## 工作目录
-- 在openclaw环境中，需要在agent的workspace中创建code文件夹，然后在code文件中使用cc create project xxx，创建一个模版项目。
-
-## 使用方式（AI 必须遵循）
-
-- 先阅读 `REQUIREMENTS_BREAKDOWN.md`，输出需求拆解与交付物清单，再进入落地步骤。
-- 需要环境/密钥 配置时，阅读 `INSTALL_AND_BOOTSTRAP.md`。
-- 需要建模时（对象/字段/菜单/应用），阅读 `OBJECTS_AND_FIELDS.md`。
-- 需要后端逻辑时（类/定时器/触发器），按主题阅读：
-  - `BACKEND_CLASS.md`
-  - `BACKEND_SCHEDULE.md`
-  - `BACKEND_TRIGGER.md`
-- 需要自定义组件时，阅读 `VUE_CUSTOM_COMPONENT.md`。
-- 需要快速对照命令与参数时，阅读 `CLI_CHEATSHEET.md`。
-
-## 强制安全边界
-
-- 不要在输出/代码/提交中包含真实密钥（`CloudCCDev`、`safetyMark`、`secretKey`、`openSecretKey`、token
-  等）。
-- 后端类/触发器/定时器遵守片段同步：仅在
-  `@SOURCE_CONTENT_START`~`@SOURCE_CONTENT_END` 内编写可发布逻辑。
-- 客户端脚本遵守片段同步：仅在 `function main($CCDK, obj) { ... }`
-  的函数体内编写可发布逻辑。
-
-## 快速入口
-
-- 安装与初始化：`INSTALL_AND_BOOTSTRAP.md`
-- 需求拆解与方案选择：`REQUIREMENTS_BREAKDOWN.md`
-- 自定义对象与字段：`OBJECTS_AND_FIELDS.md`
-- 自定义类：`BACKEND_CLASS.md`
-- 定时类：`BACKEND_SCHEDULE.md`
-- 触发器：`BACKEND_TRIGGER.md`
-- Vue 自定义组件：`VUE_CUSTOM_COMPONENT.md`
-- CLI 速查：`CLI_CHEATSHEET.md`