cloudcc-cli 2.2.8 → 2.3.0

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

@@ -0,0 +1,241 @@
+# 自定义设置相关接口
+
+## 指导文档
+
+直接使用以下命令查看指导文档：
+
+```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/{cloudcc-cli-dev → .cursor/skills/cloudcc-cli-dev}/SKILL.md

@@ -16,7 +16,10 @@ description: CloudCC CRM 二次开发 CLI 助手。用于需求拆解与方案
 - 先阅读 `REQUIREMENTS_BREAKDOWN.md`，输出需求拆解与交付物清单，再进入落地步骤。
 - 需要环境/密钥 配置时，阅读 `INSTALL_AND_BOOTSTRAP.md`。
 - 需要建模时（对象/字段/菜单/应用），阅读 `OBJECTS_AND_FIELDS.md`。
-- 需要后端逻辑时（类/定时器/触发器），阅读 `BACKEND_CODE.md`。
+- 需要后端逻辑时（类/定时器/触发器），按主题阅读：
+  - `BACKEND_CLASS.md`
+  - `BACKEND_SCHEDULE.md`
+  - `BACKEND_TRIGGER.md`
 - 需要自定义组件时，阅读 `VUE_CUSTOM_COMPONENT.md`。
 - 需要快速对照命令与参数时，阅读 `CLI_CHEATSHEET.md`。
 
@@ -34,6 +37,8 @@ description: CloudCC CRM 二次开发 CLI 助手。用于需求拆解与方案
 - 安装与初始化：`INSTALL_AND_BOOTSTRAP.md`
 - 需求拆解与方案选择：`REQUIREMENTS_BREAKDOWN.md`
 - 自定义对象与字段：`OBJECTS_AND_FIELDS.md`
-- 自定义类/定时器/触发器：`BACKEND_CODE.md`
+- 自定义类：`BACKEND_CLASS.md`
+- 定时类：`BACKEND_SCHEDULE.md`
+- 触发器：`BACKEND_TRIGGER.md`
 - Vue 自定义组件：`VUE_CUSTOM_COMPONENT.md`
 - CLI 速查：`CLI_CHEATSHEET.md`

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

@@ -0,0 +1,151 @@
+## 覆盖范围
+
+本篇聚焦 CloudCC Vue2.x 自定义组件（Custom Component）：
+
+- 创建组件骨架
+- 编辑与最佳实践入口
+- 编译与发布到服务器
+
+---
+
+## 创建自定义组件
+
+### CLI 命令
+
+```bash
+# 创建组件必须使用这个命令，在项目根目录执行（会生成到 plugins/<pluginName>/）
+cc create plugin <pluginName>
+```
+
+创建完成后通常会生成以下结构（以 `create1` 的骨架为准）：
+
+- `plugins/<pluginName>/<pluginName>.vue`：组件入口文件（包含
+  `componentInfo`，并默认引入一个 `HelloWorld` 子组件）
+- `plugins/<pluginName>/components/HelloWorld.vue`：示例子组件
+- `plugins/<pluginName>/config.json`：组件元数据（至少包含 `component` /
+  `compName` / `compDesc`）
+
+> 组件入口文件里的 `componentInfo.component`
+> 需要全局唯一（用于平台识别/装载组件）。
+
+---
+
+## 发布组件
+
+```bash
+cc publish plugin <pluginName>
+```
+
+> 发布会执行编译/打包/上传；如果组件依赖复杂，注意依赖收集与发布策略。
+
+### 打包/注册策略（publish1：v1 / v2）
+
+`publish1` 支持两种打包/注册方式，会根据组件里的 `componentInfo.buildVersion`
+选择：
+
+- 默认（v1，`buildVersion` 不写或不等于 `"v2"`）
+  - 使用 `vue-custom-element` 将组件注册为 Web Component/custom element
+  - 注册名来自 `componentInfo.component`
+- v2（设置 `componentInfo.buildVersion = "v2"`）
+  - 使用 `Vue.component` 的方式注册组件
+
+示例（在组件入口 `.vue` 的 `data()` 里配置）：
+
+```js
+componentInfo: {
+  component: "component-<pluginName>",
+  compName: "compName-<pluginName>",
+  compDesc: "Component description information",
+  // 选填：不填默认 v1；填 "v2" 则走 Vue.component 注册
+  buildVersion: "v2"
+}
+```
+
+### 加载模式（loadModel：lazy / start）
+
+`publish1` 会读取 `componentInfo.loadModel` 来决定组件加载时机：
+
+- `lazy`：默认，进入对应页面/区域后再加载
+- `start`：启动加载，在应用启动时即加载
+
+你可以在 `componentInfo` 中按需设置，例如：
+
+```js
+componentInfo: {
+  // ...
+  loadModel: "start";
+}
+```
+
+---
+## 同步（从云端拉取）
+
+> “同步”在本仓库中对应 `pull`：把云端的自定义组件代码/配置拉到本地 `plugins/<pluginName>/`。
+
+### CLI 命令
+
+```bash
+# 同步插件到本地（可传组件名或 id）
+cc pull plugin <pluginNameOrId> [projectPath]
+```
+
+说明：
+
+- `projectPath` 可选；不传则默认当前工作目录。
+- 传组件名时：如果本地 `plugins/<pluginName>/config.json` 存在 `id`，会用 `id` 拉取；否则会把入参当作 `id` 处理。
+- 拉取后会生成/更新 `plugins/<归一化后的pluginName>/config.json` 与相关文件（包含依赖文件）。
+---
+
+## 删除组件（云端）
+
+> 删除只影响**云端**记录，本地 `plugins/<pluginName>/` 目录不会被删除。
+
+### CLI 命令
+
+```bash
+# 传组件名（自动从本地 plugins/<pluginName>/config.json 读取 id）
+cc delete plugin <pluginName> [projectPath]
+
+# 直接传云端 ID
+cc delete plugin <pluginId> [projectPath]
+```
+
+说明：
+
+- 传组件名时：如果本地 `plugins/<pluginName>/config.json` 存在 `id`，会用 `id`
+  删除；否则把入参当作 `id` 直接请求。
+- `projectPath` 可选，不传则默认当前工作目录。
+- 删除成功后控制台会打印 `Success! Plugin (ID: xxx) deleted from server.`
+
+---
+## 批量拉取
+
+> 当前仓库没有直接提供 `cc pullList plugin ...` 这种“内置批量拉取”命令。
+
+推荐方式：先用 `get plugin` 获取线上列表（包含 `id`），再用循环批量执行 `pull plugin <id>`。
+
+### 步骤 1：获取线上列表
+
+```bash
+cc get plugin <projectPath>
+```
+
+### 步骤 2：循环拉取（示例）
+
+```bash
+# 批量拉取前 N 个线上组件（示例 N=5）
+N=5
+ids=$(cc get plugin . | node -e "const a=JSON.parse(require('fs').readFileSync(0,'utf8')); console.log(a.slice(0,${N}).map(x=>x.id).filter(Boolean).join(' '))")
+for id in $ids; do
+  cc pull plugin "$id" .
+done
+```
+---
+
+## 编辑要点（CLI 项目约束）
+
+- 组件目录通常为 `plugins/<pluginName>/`
+- 确保所有 `<style>` 标签带 `scoped`，避免全局样式污染
+- 发布通过 `cc publish plugin <pluginName>` 执行编译与上传
+
+---

package/README.md

@@ -22,6 +22,28 @@ sudo npm i -g cloudcc-cli
 }
 ```
 
+# ReleaseV2.3.0
+
+#### Release Date: 2026-3-25
+
+#### Release Scope: Full
+
+#### Release Content
+
+- Optimization
+  - Fix class management commands
+
+# ReleaseV2.2.9
+
+#### Release Date: 2026-3-25
+
+#### Release Scope: Full
+
+#### Release Content
+
+- Optimization
+  - Add delete component command
+
 # ReleaseV2.2.8
 
 #### Release Date: 2026-3-24

package/bin/index.js

@@ -6,6 +6,10 @@ cc.plugin = require("../src/plugin/index")
 
 cc.classes = require("../src/classes/index")
 
+cc.customSetting = require("../src/customSetting/index")
+
+cc.customPage = require("../src/customPage/index")
+
 cc.schedule = require("../src/timer/index")
 
 cc.triggers = require("../src/triggers/index")
@@ -34,4 +38,6 @@ cc.menu = require("../src/menu/index")
 
 cc.application = require("../src/application/index")
 
+
+
 module.exports = cc;