cloudcc-cli 2.3.2 → 2.3.3

package/.claude/settings.json

@@ -1,10 +1,20 @@
 {
   "permissions": {
     "allow": [
-      "Bash(node bin/cc.js get object .)",
+      "Bash(node bin/cc.js *)",
       "Bash(python3 -m json.tool)",
       "Bash(node bin/cc.js get pagelayout . Contact)",
-      "Bash(node bin/cc.js get pagelayout . 003)"
+      "Bash(node bin/cc.js get pagelayout . 003)",
+      "Bash(cc login:*)",
+      "Bash(cc config:*)",
+      "Bash(node bin/cc.js get pagelayout . Account)",
+      "Bash(node bin/cc.js config use dev)",
+      "Bash(node bin/cc.js get pagelayout . 001)",
+      "Bash(node bin/cc.js get pagelayout .)",
+      "Bash(. ~/.nvm/nvm.sh)",
+      "Bash(nvm use:*)",
+      "Bash(npm link:*)",
+      "Bash(cc delete:*)"
     ]
   },
   "askForConfirmation": false,

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

@@ -9,7 +9,8 @@ description: CloudCC CRM 二次开发 CLI 文档检索技能。用于在设计
 
 ### 1. 设计实现方案时
 
-- 当用户要做方案设计、实现设计、模块选型时，优先调用每个模块的 `introduction`文档。
+- 当用户要做方案设计、实现设计、模块选型时，优先调用每个模块的
+  `introduction`文档。
 - 命令格式：`cc doc <module> introduction`
 - 目标：先理解模块定位、适用场景、能力边界。
 - 然后编写详细的设计文档，包括对象，字段等。

package/README.md

@@ -22,6 +22,17 @@ sudo npm i -g cloudcc-cli
 }
 ```
 
+# ReleaseV2.3.3
+
+#### Release Date: 2026-3-26
+
+#### Release Scope: Full
+
+#### Release Content
+
+- Optimization
+  - Refined developer documentation and added CLI command usage
+
 # ReleaseV2.3.2
 
 #### Release Date: 2026-3-25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudcc-cli",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "description": "cloudcc-cli",
   "author": "cloudcc",
   "license": "ISC",
@@ -19,6 +19,7 @@
     "test-cli-one": "node --test test/globalSelectList.cli.test.js",
     "test-cli-all": "node --test ",
     "cc-pull": "git fetch --tags -f && git pull",
+    "npm-login": "npm login --registry https://registry.npmmirror.com",
     "publish-lib": "npm publish --registry https://registry.npmjs.org && git add . && git commit -m 'update' && git push && curl https://npmmirror.com/sync/cloudcc-cli",
     "package-jar": "mvn clean && mvn package",
     "fetch-dev-env": "node src/mcp/tools/dev-env/fetcher.js",

package/src/classes/docs/devguide.md

@@ -8,6 +8,93 @@
 
 ---
 
+## 0. 必须使用 CLI 管理本地类文件
+
+自定义类在本项目中的目录结构、`config.json`、主类中的 `// @SOURCE_CONTENT_START`
+… `// @SOURCE_CONTENT_END` 区域，均与 **cloudcc-cli**
+的创建、发布、拉取逻辑绑定。**必须通过下列命令**
+完成新建目录、与服务器同步、发布与删除；不要手工新建
+`classes/<类名>/`、不要复制粘贴整套类文件夹、不要私自篡改 `config.json` 里的
+`id` 或破坏版本字段，否则容易导致发布失败、拉取覆盖异常或与线上一致性不一致。
+
+**允许的做法**：在 CLI 已生成的主类 `*.java` 中，仅在上述 SOURCE
+标记之间编写与修改业务代码；其余与平台同步相关的操作一律走命令。
+
+执行命令前请确认：已完成 `cc doc project devguide`
+中的环境初始化，项目根目录配置可用且包含 `accessToken`。
+
+### 0.1 命令总览（以代码实现为准）
+
+```bash
+cc create classes <name>
+cc publish classes <name>
+cc pull classes <name>
+cc get classes [listQueryJson] [projectPath]
+cc detail classes <name>
+cc detail classes "" <id>
+cc pullList classes <id> <projectPath>
+cc delete classes <nameOrId> [projectPath]
+cc doc classes <introduction|devguide>
+```
+
+参数约定：
+
+- `name`：Java 类名，与 `classes/<name>/` 目录名一致。
+- `listQueryJson`：可选；列表查询条件的 JSON 经 `encodeURI(JSON.stringify(...))`
+  编码后传入。不传时使用默认分页参数。
+- `projectPath`：项目根路径，可选；不传则使用当前工作目录。
+- `id`：线上类 ID。`detail`
+  在仅查服务器时可将类名置空：`cc detail classes "" <id>`。`pullList` 用 ID
+  将线上类落到指定项目的 `classes/` 下。
+- `nameOrId`：本地目录名，或类 ID。若本地存在 `config.json` 且含
+  `id`，删除时会优先用其中的服务器 ID。
+
+### 0.2 命令说明摘要
+
+| 命令       | 作用                                                                                |
+| ---------- | ----------------------------------------------------------------------------------- |
+| `create`   | 在 `classes/<name>/` 生成主类、测试类、`config.json` 模板                           |
+| `publish`  | 将本地 SOURCE 区域源码提交到服务器；首次成功后会写回 `config.json` 的 `id`          |
+| `pull`     | 按本地 `config.json` 的 `id` 从服务器拉取源码，覆盖主类中 SOURCE 区域（需已发布过） |
+| `get`      | 查询线上类列表（JSON 输出）                                                         |
+| `detail`   | 按类名优先读本地；或仅按 `id` 读服务器详情                                          |
+| `pullList` | 按类 `id` 将线上类拉取到指定 `projectPath` 下的 `classes/<类名>/`                   |
+| `delete`   | 调用接口删除服务器上的类；参数可为本地类名或类 ID                                   |
+| `doc`      | 输出 `introduction` 或 `devguide`（`devguide` 含附录 SDK 速查）                     |
+
+### 0.3 推荐操作顺序
+
+```bash
+# 1) 查看线上已有类（可选，避免重名或确认 ID）
+cc get classes
+
+# 2) 新建类（仅通过 create 生成目录与文件）
+cc create classes MyClass
+
+# 3) 编辑 classes/MyClass/MyClass.java 中 SOURCE 区域后发布
+cc publish classes MyClass
+
+# 4) 需要与服务器对齐时，拉取覆盖本地 SOURCE 区域
+cc pull classes MyClass
+
+# 5) 按已知线上类 ID 拉到指定项目（迁移、批量）
+cc pullList classes <线上类ID> <projectPath>
+
+# 6) 不再使用时删除线上类
+cc delete classes MyClass
+```
+
+### 0.4 文档子命令
+
+```bash
+cc doc classes introduction
+cc doc classes devguide
+```
+
+仅支持 `introduction` 与 `devguide`，其他子命令会报错。
+
+---
+
 ## 1. 概念与使用场景
 
 ### 1.1 什么是自定义类
@@ -438,6 +525,9 @@ new PageClsInvoker(userInfo).invoker("Hello", "test3", null, arglist);
 
 ## 6. 自定义类开发 Checklist
 
+- [ ] 类目录与平台同步仅通过 `cc create` / `cc pull` / `cc pullList` /
+      `cc publish` / `cc delete` 等命令操作，不手工造目录或改 `config.json` 的
+      `id`
 - [ ] 类名、方法名与调用方（按钮/触发器/组件/定时作业）约定一致
 - [ ] 构造函数正确接收 `UserInfo` 并实例化 `CCService` 等依赖
 - [ ] 所有 `CCService` 操作（`insert`/`update`/`delete`/`cquery`）使用正确的对象

package/src/globalSelectList/docs/devguide.md

@@ -1,7 +1,5 @@
 # CloudCC 全局选项列表操作指南
 
-> 参考文档：[全局选项列表值集](https://help.cloudcc.cn/product02/quan-ju-xuan-xiang-lie-biao-zhi-ji/)
-
 ---
 
 ## 1. 入口与列表页
@@ -152,61 +150,4 @@ cc doc globalSelectList introduction
 cc doc globalSelectList devguide
 ```
 
----
-
-## 7. API 参考
-
-### 7.1 查询列表
-
-- **接口**：`POST /api/globalSelectSetup/queryList`
-- **请求体**：
-
-```json
-{
-  "pageNum": "1",
-  "pageSize": "10000"
-}
-```
-
-- **响应**：`data.globalSelectList`（数组）
-
-### 7.2 新建
-
-- **接口**：`POST /api/globalSelectSetup/save`
-- **请求体**：
-
-```json
-{
-  "label": "test2",
-  "name": "test2",
-  "description": "描述",
-  "ptext": "值1\r\n值2\r\n值3",
-  "isPicklistSorted": "1",
-  "isFirstDefault": "1"
-}
-```
-
-- **响应**：`data` 为新建记录的 ID 字符串
-
-### 7.3 删除
-
-- **接口**：`POST /api/globalSelectSetup/delete`
-- **请求体**：
-
-```json
-{
-  "id": "<id>",
-  "deleteFromDisk": "false"
-}
-```
-
-| 参数             | 说明                                                   |
-|------------------|--------------------------------------------------------|
-| `id`             | 全局选项列表 ID                                        |
-| `deleteFromDisk` | `"false"` 软删除（可恢复）；`"true"` 彻底删除（不可恢复）|
-
-### 7.4 详情
 
-- **接口**：`POST /api/globalSelectSetup/detail`
-- **请求体**：`{ "id": "<id>" }`
-- **响应**：`data` 包含 `globalSelect`、`enabledList`、`disabledList`、`useList` 四个字段（详见第 4 节）

package/src/menu/docs/devguide.md

@@ -1,203 +1,129 @@
-# CloudCC 菜单开发指南
+# CloudCC 菜单 CLI 命令说明
 
-## 1. 模块定位
+## 支持的命令
 
-`menu` 模块用于创建、查询、删除 CloudCC 菜单（标签页）。  
-菜单是对象、页面、脚本能力的可视化入口，也是应用导航的重要组成部分。
+| 操作 | 说明 |
+|------|------|
+| `create menu object` | 创建自定义对象菜单 |
+| `create menu page` | 创建自定义页面菜单 |
+| `create menu script` | 创建自定义脚本菜单 |
+| `create menu site` | 创建站点菜单 |
+| `get menu` | 查询菜单列表 |
+| `delete menu` | 删除菜单 |
 
-可通过以下命令查看文档：
+## CLI 命令详解
 
-```bash
-cc doc menu introduction
-cc doc menu devguide
-```
-
----
-
-## 2. 开发前准备
-
-执行菜单相关命令前，请确认：
-
-- 已完成 `cc doc project devguide` 的环境初始化
-- 项目根目录存在可用的 `cloudcc-cli.config.js`
-- 当前环境连接可用（org / token / endpoint 正确）
-- 已明确菜单所属资源（对象 ID、页面 API、脚本内容或站点 ID）
-
----
-
-## 3. 支持的命令总览
-
-```bash
-cc create menu object <path> <objectId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
-cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]
-cc create menu script <path> <tabName> <pname> [functioncode] [tabStyle] [mobileimg] [cloudccservicetab]
-cc create menu site <path> <siteId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
-
-cc get menu <projectPath> [encodedCondJson]
-cc delete menu <projectPath> <tabId>
-```
-
----
-
-## 4. 创建菜单
-
-### 4.1 创建自定义对象菜单
+### 创建自定义对象菜单
 
 ```bash
 cc create menu object <path> <objectId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径，`.` 表示当前目录
-- `objectId`：自定义对象 ID
-- `tabName`：菜单显示名称
-- `tabStyle`：PC 端图标（可选，默认 `cloudtab145`）
-- `mobileimg`：移动端图标（可选，默认 `cloudcc01`）
-- `cloudccservicetab`：服务图标（可选，默认 `cloudccservicetab_1`）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径，`.` 表示当前目录 |
+| `objectId` | 是 | 自定义对象 ID |
+| `tabName` | 是 | 菜单显示名称 |
+| `tabStyle` | 否 | PC 端图标（默认 `cloudtab145`）|
+| `mobileimg` | 否 | 移动端图标（默认 `cloudcc01`）|
+| `cloudccservicetab` | 否 | 服务图标（默认 `cloudccservicetab_1`）|
 
-示例：
+**示例：**
 
 ```bash
 cc create menu object . a0F9D000000XXXXUAI "客户管理"
 ```
 
-### 4.2 创建自定义页面菜单
+### 创建自定义页面菜单
 
 ```bash
 cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径
-- `pageApi`：自定义页面 API 名称（CLI 会追加 `#lightning`）
-- `tabName`：菜单显示名称
-- `pname`：菜单内部名称（建议字母开头，字母/数字/下划线）
-- `tabStyle` / `mobileimg` / `cloudccservicetab`：图标参数（可选）
-- `mobileurl`：移动端地址（可选）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径 |
+| `pageApi` | 是 | 自定义页面 API 名称（CLI 会追加 `#lightning`）|
+| `tabName` | 是 | 菜单显示名称 |
+| `pname` | 是 | 菜单内部名称（建议字母开头）|
+| `tabStyle` / `mobileimg` / `cloudccservicetab` | 否 | 图标参数 |
+| `mobileurl` | 否 | 移动端地址 |
 
-示例：
+**示例：**
 
 ```bash
 cc create menu page . contract-assistant "合同助手" contract_menu
 ```
 
-### 4.3 创建自定义脚本菜单
+### 创建自定义脚本菜单
 
 ```bash
 cc create menu script <path> <tabName> <pname> [functioncode] [tabStyle] [mobileimg] [cloudccservicetab]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径
-- `tabName`：菜单显示名称
-- `pname`：菜单内部名称
-- `functioncode`：脚本内容（可选，默认示例脚本）
-- `tabStyle` / `mobileimg` / `cloudccservicetab`：图标参数（可选）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径 |
+| `tabName` | 是 | 菜单显示名称 |
+| `pname` | 是 | 菜单内部名称 |
+| `functioncode` | 否 | 脚本内容（默认示例脚本）|
 
-示例：
+**示例：**
 
 ```bash
 cc create menu script . "数据导入工具" data_import_menu "ccc.alert('Hello World');"
 ```
 
-### 4.4 创建站点菜单
+### 创建站点菜单
 
 ```bash
 cc create menu site <path> <siteId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
 ```
 
-参数说明：
+**参数说明：**
 
-- `path`：项目路径
-- `siteId`：站点 ID
-- `tabName`：菜单显示名称
-- `tabStyle` / `mobileimg` / `cloudccservicetab`：图标参数（可选）
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径 |
+| `siteId` | 是 | 站点 ID |
+| `tabName` | 是 | 菜单显示名称 |
 
-示例：
+**示例：**
 
 ```bash
 cc create menu site . a0H9D000000XXXXUAI "合作伙伴门户"
 ```
 
----
-
-## 5. 查询与删除
-
-### 5.1 查询菜单
+### 查询菜单列表
 
 ```bash
 cc get menu <projectPath> [encodedCondJson]
 ```
 
-说明：
-
-- `projectPath` 默认当前目录
-- `encodedCondJson` 为 URI 编码后的 JSON 查询条件
-
-示例：
+**示例：**
 
 ```bash
+# 查询所有菜单
 cc get menu .
+
+# 带查询条件
 cc get menu . '%7B%22type%22%3A%22page%22%7D'
 ```
 
-### 5.2 删除菜单
+### 删除菜单
 
 ```bash
 cc delete menu <projectPath> <tabId>
 ```
 
-说明：
-
-- `tabId` 为菜单 ID，建议先执行 `cc get menu .` 再删除
-
-示例：
+**示例：**
 
 ```bash
 cc delete menu . a0I9D000000XXXXUAI
 ```
-
----
-
-## 6. 与后台菜单配置流程的映射
-
-根据 CloudCC 官方菜单流程，完整上线通常包含三层动作：
-
-1. 新建菜单（对象 / 页面 / 脚本）
-2. 添加到简档（控制可见角色）
-3. 添加到应用程序（控制出现在什么应用）
-
-`cloudcc-cli` 当前主要覆盖第 1 步（菜单实体创建）。  
-因此在 CLI 创建后，建议在后台继续核验第 2-3 步，确保用户可见且出现在目标应用导航中。
-
----
-
-## 7. 常见注意事项
-
-- 菜单创建成功不等于用户可见，需检查简档权限
-- 菜单创建成功不等于出现在预期应用，需检查应用挂载
-- `page` 类型请确认页面 API 存在且可访问
-- 删除菜单前确认未被培训文档、操作手册或用户流程依赖
-- 建议先在测试环境验证，再在生产环境执行
-
----
-
-## 8. 推荐操作顺序
-
-```bash
-# 1) 查询现有菜单，避免重名
-cc get menu .
-
-# 2) 创建目标菜单（示例：页面菜单）
-cc create menu page . contract-manage "合同管理" contract_menu
-
-# 3) 再次查询确认已创建
-cc get menu .
-```
-
-创建后请在 CloudCC 后台完成简档与应用核验。
-
----

package/src/pagelayout/create.js

@@ -16,8 +16,8 @@ async function getExistingLayouts(config, objId) {
             config.accessToken
         );
 
-        if (res && res.result && res.layouts && Array.isArray(res.layouts) && res.layouts.length > 0) {
-            return res.layouts;
+        if (res && res.result && res.data && Array.isArray(res.data) && res.data.length > 0) {
+            return res.data;
         }
 
         throw new Error("未找到可用的页面布局");

package/src/pagelayout/delete.js

@@ -0,0 +1,57 @@
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+const chalk = require("chalk");
+
+/**
+ * 删除页面布局
+ * 用法：cc delete pagelayout <projectPath> <layoutId>
+ * @param {Array} argvs - 命令行参数数组
+ * @returns {Promise<Object>} 删除结果
+ */
+async function deleteLayout(argvs) {
+    try {
+        // 命令行参数格式：cc delete pagelayout <projectPath> <layoutId>
+        const projectPath = argvs[2] || process.cwd();
+        const layoutId = argvs[3];
+
+        if (!layoutId) {
+            console.error();
+            console.error(chalk.red("Error: 缺少页面布局 ID"));
+            console.error("用法: cc delete pagelayout <projectPath> <layoutId>");
+            console.error("示例:");
+            console.error("  cc delete pagelayout . add202610BD89F09XyGT");
+            console.error();
+            throw new Error("缺少必需参数: layoutId");
+        }
+
+        const config = await getPackageJson(projectPath);
+
+        console.error();
+        console.error(chalk.green(`Deleting page layout "${layoutId}"...`));
+        console.error();
+
+        const res = await postClass(
+            config.setupSvc + "/api/layout/deleteButton",
+            {
+                id: layoutId
+            },
+            config.accessToken
+        );
+
+        if (res && res.result) {
+            console.error(chalk.green("页面布局删除成功！"));
+            console.log(JSON.stringify(res.data || res));
+            return res.data || res;
+        }
+
+        const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+        throw new Error("Delete PageLayout Failed: " + msg);
+
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("页面布局删除失败:"), error.message || error);
+        throw error;
+    }
+}
+
+module.exports = deleteLayout;