cloudcc-cli 2.3.2 → 2.3.3

package/src/profile/docs/devguide.md

@@ -1,12 +1,6 @@
-# CloudCC 简档使用总结
+# CloudCC 简档 CLI 命令说明
 
-简档（Profile）用于定义 CloudCC 系统中用户的权限集合，控制用户可以访问的对象、字段和功能。
-
----
-
-## 快速开始（CLI 命令）
-
-### 支持的简档操作
+## 支持的命令
 
 | 操作 | 说明 |
 |------|------|
@@ -14,14 +8,10 @@
 | `get` | 查询简档列表 |
 | `delete` | 删除自定义简档 |
 
----
-
 ## CLI 命令详解
 
 ### 创建简档
 
-创建一个新的自定义简档，基于现有简档复制权限配置。
-
 ```bash
 cc create profile <path> <profileName> [description]
 ```
@@ -32,7 +22,7 @@ cc create profile <path> <profileName> [description]
 |------|------|------|
 | `path` | 是 | 项目路径，`.` 表示当前目录 |
 | `profileName` | 是 | 简档名称 |
-| `description` | 否 | 简档描述（暂不支持保存到后端） |
+| `description` | 否 | 简档描述 |
 
 **示例：**
 
@@ -44,12 +34,8 @@ cc create profile . "销售经理简档"
 cc create profile . "销售代表简档" "适用于销售团队的权限配置"
 ```
 
----
-
 ### 查询简档列表
 
-获取当前环境中的所有简档列表。
-
 ```bash
 cc get profile <projectPath> [encodedCondJson]
 ```
@@ -71,12 +57,8 @@ cc get profile .
 cc get profile . '%7B%22type%22%3A%22custom%22%7D'
 ```
 
----
-
 ### 删除简档
 
-删除指定的自定义简档。
-
 ```bash
 cc delete profile <projectPath> <profileId>
 ```
@@ -91,242 +73,5 @@ cc delete profile <projectPath> <profileId>
 **示例：**
 
 ```bash
-# 删除指定简档
 cc delete profile . aaa202672F656B7VfEjL
 ```
-
----
-
-## 完整工作流示例
-
-### 场景：为销售团队创建新的权限简档
-
-```bash
-# 1. 确认项目已初始化（有 cloudcc-cli.config.js）
-cat cloudcc-cli.config.js
-
-# 2. 查询现有简档
-cc get profile .
-
-# 3. 创建新的销售经理简档（自动复制第一个现有简档的权限）
-cc create profile . "销售经理简档" "销售团队经理级别的权限配置"
-
-# 4. 验证简档创建成功
-cc get profile .
-
-# 5. 如需删除
-# cc delete profile . <profileId>
-```
-
----
-
-## API 接口详情
-
-### 什么是简档？
-
-**简档（Profile）** 是 CloudCC 系统的权限配置单元，定义了用户对系统中各种资源的访问权限。
-
-### 核心属性
-
-| 属性 | 说明 | 示例 |
-|------|------|------|
-| **名称（name）** | 简档显示名称 | "销售经理简档" |
-| **描述（description）** | 简档功能描述 | "适用于销售团队经理" |
-| **类型（type）** | 系统简档或自定义 | `system` / `custom` |
-| **创建时间** | 简档创建时间戳 | 1757993089000 |
-
----
-
-## 简档类型
-
-CloudCC 支持两种简档类型：
-
-| 类型 | 说明 | 适用场景 |
-|------|------|----------|
-| **系统简档** | 系统预设的简档 | 标准用户、管理员等 |
-| **自定义简档** | 用户自定义创建的简档 | 特定业务角色 |
-
----
-
-## 一、查询简档
-
-### 1.1 查询简档列表
-
-**接口**: `POST /api/profile/listAll`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| keyword | string | 否 | 搜索关键词 |
-| type | string | 否 | 类型过滤：system/custom |
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "data": {
-    "list": [
-      {
-        "id": "aaa202672F656B7VfEjL",
-        "name": "系统管理员",
-        "description": "系统管理员简档",
-        "type": "system"
-      }
-    ]
-  }
-}
-```
-
----
-
-## 二、创建简档
-
-### 2.1 获取可复制的简档列表
-
-**接口**: `POST /api/profile/copyProfile`
-
-**请求参数**：无
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "data": {
-    "profileList": [
-      {
-        "id": "aaa000001",
-        "name": "系统管理员",
-        "description": "系统管理员简档"
-      }
-    ]
-  }
-}
-```
-
-### 2.2 创建新简档
-
-**接口**: `POST /api/profile/newProfile`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| newProfileName | string | 是 | 新简档名称 |
-| type | string | 否 | 简档类型（传空字符串） |
-| copyFromId | string | 是 | 复制来源简档 ID（来自 copyProfile 接口） |
-
-**请求示例**：
-
-```json
-{
-  "newProfileName": "系统管理员_test",
-  "type": "",
-  "copyFromId": "aaa000001"
-}
-```
-
----
-
-## 三、删除简档
-
-### 3.1 删除前检查
-
-- [ ] 是否有用户正在使用该简档
-- [ ] 是否是系统预设简档（系统简档不可删除）
-- [ ] 级联影响确认
-
-### 3.2 删除流程
-
-**接口**: `POST /api/profile/delProfile`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| id | string | 是 | 简档 ID |
-
-**请求示例**：
-
-```json
-{
-  "id": "aaa202672F656B7VfEjL"
-}
-```
-
----
-
-## 四、简档数据结构
-
-```javascript
-// 查询接口返回的简档数据
-{
-  id: "aaa202672F656B7VfEjL",
-  name: "销售经理简档",
-  description: "销售团队经理级别的权限配置",
-  type: "custom"
-}
-
-// copyProfile 接口返回的简档数据
-{
-  id: "aaa000001",
-  name: "系统管理员",
-  description: "系统管理员简档"
-}
-```
-
----
-
-## 五、最佳实践
-
-### 命名规范
-
-| 项目 | 规范 | 示例 |
-|------|------|------|
-| 简档名称 | 角色 + 简档 | `销售经理简档`、`客服代表简档` |
-| 描述 | 说明适用场景 | `适用于销售团队经理级别` |
-
-### 权限设计
-
-- **按需分配**：只为需要的角色分配权限
-- **最小权限原则**：用户只拥有完成工作所需的最小权限
-- **定期审查**：定期检查简档权限分配是否合理
-
-### 创建简档注意事项
-
-- 创建简档时会自动复制第一个可用简档的权限配置
-- 如需特定权限配置，创建后需在 CloudCC 控制台手动调整
-- 建议基于权限最接近的简档进行复制
-
----
-
-## 六、常见问题
-
-**Q: 简档创建后为什么不生效？**
-
-A: 检查以下几点：
-1. 简档是否已分配给相关用户
-2. 用户是否已重新登录
-3. 缓存是否已刷新
-
-**Q: 可以修改系统简档吗？**
-
-A: 系统简档不可修改，建议克隆系统简档创建自定义简档进行修改。
-
-**Q: 删除简档会影响用户吗？**
-
-A: 会。删除简档前需要确保没有用户正在使用该简档，否则这些用户将失去权限配置。
-
-**Q: 如何查看简档的完整配置信息？**
-
-A: 目前 CLI 只支持列表查询，详细配置需在 CloudCC 控制台查看。
-
-**Q: 创建简档时如何选择复制来源？**
-
-A: 当前实现自动选择第一个可用简档作为复制来源。如需特定来源，建议先调用 `cc get profile .` 查看列表顺序。
-
----
-
-*文档版本：1.1 | 最后更新：2026-03-26*

package/src/role/docs/devguide.md

@@ -1,12 +1,6 @@
-# CloudCC 角色使用总结
+# CloudCC 角色 CLI 命令说明
 
-角色（Role）是 CloudCC 系统中用于定义职能分工和业务角色的重要概念。通过角色可以对用户进行分组管理，实现权限的精细化控制。
-
----
-
-## 快速开始（CLI 命令）
-
-### 支持的角色操作
+## 支持的命令
 
 | 操作 | 说明 |
 |------|------|
@@ -14,14 +8,10 @@
 | `get` | 查询角色列表 |
 | `delete` | 删除角色 |
 
----
-
 ## CLI 命令详解
 
 ### 创建角色
 
-创建一个新的 CloudCC 角色。
-
 ```bash
 cc create role <path> <roleName> [parentRoleName] [description]
 ```
@@ -32,8 +22,8 @@ cc create role <path> <roleName> [parentRoleName] [description]
 |------|------|------|
 | `path` | 是 | 项目路径，`.` 表示当前目录 |
 | `roleName` | 是 | 角色名称 |
-| `parentRoleName` | 否 | 直属上司角色名称（不传则交互式选择） |
-| `description` | 否 | 角色描述（暂不支持保存到后端） |
+| `parentRoleName` | 否 | 直属上司角色名称（不传则交互式选择）|
+| `description` | 否 | 角色描述 |
 
 **示例：**
 
@@ -41,24 +31,15 @@ cc create role <path> <roleName> [parentRoleName] [description]
 # 交互式选择直属上司
 cc create role . "销售经理"
 
-# 指定直属上司为 CEO（非交互式）
+# 指定直属上司（非交互式）
 cc create role . "销售经理" "CEO"
 
 # 指定直属上司并添加描述
 cc create role . "市场专员" "销售总监" "负责市场推广工作"
 ```
 
-**创建流程说明：**
-1. 调用 `role/addRole` 获取可用直属上司列表
-2. 如果指定了 `parentRoleName`，自动匹配对应角色；否则进入交互式选择
-3. 调用 `role/saveRole` 创建新角色
-
----
-
 ### 查询角色列表
 
-获取当前环境中的所有角色列表。
-
 ```bash
 cc get role <projectPath> [encodedCondJson]
 ```
@@ -80,12 +61,8 @@ cc get role .
 cc get role . '%7B%22name%22%3A%22%E9%94%80%E5%94%AE%22%7D'
 ```
 
----
-
 ### 删除角色
 
-删除指定的角色。
-
 ```bash
 cc delete role <projectPath> <roleId>
 ```
@@ -100,288 +77,5 @@ cc delete role <projectPath> <roleId>
 **示例：**
 
 ```bash
-# 删除指定角色
 cc delete role . a0I9D000000XXXXUAI
 ```
-
----
-
-## 完整工作流示例
-
-### 场景：为新部门创建 CloudCC 角色
-
-```bash
-# 1. 确认项目已初始化（有 cloudcc-cli.config.js）
-cat cloudcc-cli.config.js
-
-# 2. 查询现有角色
-cc get role .
-
-# 3. 创建新角色（交互式选择直属上司）
-cc create role . "销售经理"
-cc create role . "销售代表" "初级销售人员"
-
-# 4. 验证角色创建成功
-cc get role .
-
-# 5. 如需删除
-# cc delete role . <roleId>
-```
-
-### 创建角色流程说明
-
-创建角色的完整流程包含以下步骤：
-
-1. **获取直属上司列表** - 调用 `role/addRole` 接口获取可选的上级角色
-2. **选择直属上司** - 通过交互式选择确定新角色的上级
-3. **保存角色** - 调用 `role/saveRole` 接口创建角色
-
----
-
-## API 接口详情
-
-### 什么是角色？
-
-**角色（Role）** 是 CloudCC 系统中用于定义职能分工的概念。角色与简档（Profile）结合使用，共同控制用户的系统访问权限。
-
-### 核心属性
-
-| 属性 | 说明 | 示例 |
-|------|------|------|
-| **名称（rolename）** | 角色显示名称 | "销售经理" |
-| **描述（description）** | 角色描述 | "负责销售团队管理" |
-| **父角色（parentroleId）** | 上级角色 ID | "2025238BCF0D98D52xUF" |
-| **角色ID（roleid）** | 角色唯一标识 | "202608C20F87C90KRqZr" |
-| **创建时间** | 角色创建时间戳 | 1757993089000 |
-
----
-
-## 一、查询角色
-
-### 1.1 查询角色列表
-
-**接口**: `POST /api/role/queryRole`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| display | string | 否 | 显示模式，传 `"list"` 返回列表数据 |
-
-**请求示例**：
-
-```json
-{
-  "display": "list"
-}
-```
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "data": {
-    "list": [
-      {
-        "id": "202608C20F87C90KRqZr",
-        "rolename": "销售经理",
-        "parentroleId": "2025238BCF0D98D52xUF"
-      }
-    ]
-  }
-}
-```
-
----
-
-## 二、创建角色
-
-### 2.1 获取直属上司列表
-
-**接口**: `POST /api/role/addRole`
-
-**说明**：创建角色前需要调用此接口获取可选的直属上司（上级角色）列表。
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| id | string | 是 | 固定值 `"bab2025F8B20EE4d4005"` |
-
-**请求示例**：
-
-```json
-{
-  "id": "bab2025F8B20EE4d4005"
-}
-```
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "data": {
-    "flist": [
-      {
-        "id": "2025238BCF0D98D52xUF",
-        "name": "总经理"
-      },
-      {
-        "id": "2025238BCF0D98D52xUG",
-        "name": "销售总监"
-      }
-    ]
-  }
-}
-```
-
-### 2.2 保存新角色
-
-**接口**: `POST /api/role/saveRole`
-
-**说明**：选择直属上司后，调用此接口创建新角色。
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| dataJson | string | 是 | JSON 字符串，包含 rolename 和 parentroleId |
-
-**dataJson 结构**：
-
-| 字段 | 类型 | 必填 | 说明 |
-|------|------|------|------|
-| rolename | string | 是 | 新角色名称 |
-| parentroleId | string | 是 | 直属上司角色 ID |
-
-**请求示例**：
-
-```json
-{
-  "dataJson": "{\"rolename\":\"新角色\",\"parentroleId\":\"2025238BCF0D98D52xUF\"}"
-}
-```
-
-**返回数据**：
-
-```javascript
-{
-  "result": true,
-  "data": "202608C20F87C90KRqZr"  // 新创建的角色 ID
-}
-```
-
-### 2.3 创建流程总结
-
-```
-┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
-│ 1. 调用 addRole │────▶│ 2. 选择直属上司 │────▶│ 3. 调用 saveRole│
-│   获取上司列表   │     │  (交互式选择)   │     │   创建新角色    │
-└─────────────────┘     └─────────────────┘     └─────────────────┘
-```
-
----
-
-## 三、删除角色
-
-### 3.1 删除前检查
-
-- [ ] 是否有用户关联此角色
-- [ ] 是否有下级角色依赖此角色
-- [ ] 级联影响确认
-
-### 3.2 删除流程
-
-**接口**: `POST /api/role/deleteRole`
-
-**请求参数**：
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| roleid | string | 是 | 角色 ID（注意是小写） |
-
-**请求示例**：
-
-```json
-{
-  "roleid": "202608C20F87C90KRqZr"
-}
-```
-
----
-
-## 四、角色数据结构
-
-### 4.1 查询接口返回的角色数据
-
-```javascript
-{
-  id: "202608C20F87C90KRqZr",
-  rolename: "销售经理",
-  parentroleId: "2025238BCF0D98D52xUF"
-}
-```
-
-### 4.2 addRole 接口返回的上司数据
-
-```javascript
-{
-  id: "2025238BCF0D98D52xUF",
-  name: "总经理"
-}
-```
-
----
-
-## 五、最佳实践
-
-### 命名规范
-
-| 项目 | 规范 | 示例 |
-|------|------|------|
-| 角色名 | 使用职能名称 | `销售经理`、`市场专员` |
-| 描述 | 简洁说明职责 | `负责华东区销售管理` |
-
-### 角色层级设计
-
-- **合理分层**：根据组织架构设计角色层级
-- **避免循环**：确保角色层级无循环依赖
-- **权限继承**：上级角色自动继承下级角色的权限
-
-### 创建角色注意事项
-
-- 创建角色时必须选择一个直属上司
-- 直属上司决定了角色在组织架构中的位置
-- 建议先规划好组织架构再批量创建角色
-
----
-
-## 六、常见问题
-
-**Q: 角色和简档的区别？**
-
-A:
-- **简档（Profile）**：控制用户的系统功能访问权限，决定用户能做什么
-- **角色（Role）**：定义用户的组织架构位置，用于数据共享和审批流程
-
-**Q: 创建角色时如何选择直属上司？**
-
-A: 当前实现会自动调用 `addRole` 接口获取可用的直属上司列表，并通过交互式命令行让用户选择。如需特定来源，建议先调用 `cc get role .` 查看现有角色。
-
-**Q: 删除角色会影响用户吗？**
-
-A: 如果角色已被用户关联，删除前需要先解除关联或转移用户到其他角色。
-
-**Q: 可以修改角色的父级吗？**
-
-A: 可以，调用角色更新接口修改 `parentroleId` 字段，注意检查循环依赖。
-
-**Q: addRole 接口中的 id 参数是什么？**
-
-A: 这是固定值 `"bab2025F8B20EE4d4005"`，用于获取直属上司列表的上下文标识。
-
----
-
-*文档版本：1.1 | 最后更新：2026-03-26*