cloudcc-cli 2.3.0 → 2.3.2

package/src/plugin/publish1.js

@@ -108,9 +108,9 @@ class Builder {
 
         if (!data.style) {
             data.style = {
-                unit: "px",
-                width: 72,
-                height: 38,
+                unit: "%",
+                width: 100,
+                height: 100,
                 top: 0,
                 left: 0,
                 rotate: 0,

package/src/profile/create.js

@@ -0,0 +1,108 @@
+const chalk = require('chalk');
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 创建简档
+ * 用法：cc create profile <path> <profileName> [description]
+ * 流程：1. 调用 /profile/copyProfile 获取现有简档列表
+ *      2. 选择第一个简档作为复制来源
+ *      3. 调用 /profile/newProfile 创建新简档
+ * @param {Array} argvs - 命令行参数数组
+ * @returns {Promise<Object>} 创建结果
+ */
+async function create(argvs) {
+    try {
+        // 命令行参数格式：cc create profile <path> <profileName> [description]
+        const projectPath = argvs[2] || process.cwd();
+        const profileName = argvs[3];
+        const description = argvs[4] || '';
+
+        if (!profileName) {
+            console.error();
+            console.error(chalk.red('Error: 缺少简档名称'));
+            console.error('用法: cc create profile <path> <profileName> [description]');
+            console.error('示例:');
+            console.error('  cc create profile . "销售经理简档"');
+            console.error('  cc create profile . "销售代表简档" "适用于销售团队的权限配置"');
+            console.error();
+            throw new Error('缺少必需参数: profileName');
+        }
+
+        const config = await getPackageJson(projectPath);
+        if (!config || !config.accessToken) {
+            console.error();
+            console.error(chalk.red("Error: 配置未找到或 accessToken 缺失"));
+            console.error();
+            throw new Error("配置未找到或 accessToken 缺失");
+        }
+
+        console.error();
+        console.error(chalk.green(`Creating profile (${profileName}), please wait...`));
+        console.error();
+
+        // 步骤1：调用 copyProfile 获取现有简档列表
+        console.error(chalk.blue('Step 1: 获取现有简档列表...'));
+        const copyRes = await postClass(
+            config.setupSvc + "/api/profile/copyProfile",
+            {},
+            config.accessToken
+        );
+
+        if (!copyRes || !copyRes.result) {
+            const msg = copyRes && (copyRes.returnInfo || copyRes.message) ? (copyRes.returnInfo || copyRes.message) : "Unknown error";
+            console.error();
+            console.error(chalk.red("Error: 获取简档列表失败 - " + msg));
+            console.error();
+            throw new Error("Get Profile List Failed: " + msg);
+        }
+
+        const profileList = copyRes.data && copyRes.data.profileList ? copyRes.data.profileList : [];
+        if (!profileList.length) {
+            console.error();
+            console.error(chalk.red("Error: 没有找到可用的简档作为复制来源"));
+            console.error();
+            throw new Error("No available profile to copy from");
+        }
+
+        // 查找"系统管理员"简档作为复制来源，如果不存在则使用第一个
+        let sourceProfile = profileList.find(p => p.name === '系统管理员' || p.profilename === '系统管理员');
+        if (!sourceProfile) {
+            sourceProfile = profileList[0];
+            console.error(chalk.yellow('警告: 未找到"系统管理员"简档，将使用第一个可用简档作为复制来源'));
+        }
+        console.error(chalk.blue(`选择复制来源简档: ${sourceProfile.name || sourceProfile.profilename || sourceProfile.id} (${sourceProfile.id})`));
+
+        // 步骤2：调用 newProfile 创建新简档
+        console.error(chalk.blue('Step 2: 创建新简档...'));
+        const result = await postClass(
+            config.setupSvc + "/api/profile/newProfile",
+            {
+                newProfileName: profileName,
+                type: "",
+                copyFromId: sourceProfile.id
+            },
+            config.accessToken
+        );
+
+        if (result && result.result) {
+            console.error();
+            console.error(chalk.green("Success! Profile created."));
+            console.error();
+            return result;
+        }
+
+        const msg = result && (result.returnInfo || result.message) ? (result.returnInfo || result.message) : "Unknown error";
+        console.error();
+        console.error(chalk.red("Error: " + msg));
+        console.error();
+        throw new Error("Create Profile Failed: " + msg);
+
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("简档创建失败:"), error);
+        throw error;
+    }
+}
+
+module.exports = create;

package/src/profile/delete.js

@@ -0,0 +1,59 @@
+const chalk = require("chalk");
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 删除简档
+ * 用法：cc delete profile <projectPath> <profileId>
+ */
+async function remove(argvs) {
+    try {
+        const projectPath = argvs[2] || process.cwd();
+        const profileId = argvs[3];
+
+        if (!profileId) {
+            console.error();
+            console.error(chalk.red("Error: 缺少简档 ID"));
+            console.error(chalk.yellow("用法: cc delete profile <projectPath> <profileId>"));
+            console.error();
+            throw new Error("缺少必需参数: profileId");
+        }
+
+        const config = await getPackageJson(projectPath);
+        if (!config || !config.accessToken) {
+            console.error();
+            console.error(chalk.red("Error: 配置未找到或 accessToken 缺失"));
+            console.error();
+            throw new Error("配置未找到或 accessToken 缺失");
+        }
+
+        console.error();
+        console.error(chalk.green(`Deleting profile (${profileId}), please wait...`));
+        console.error();
+
+        const result = await postClass(
+            config.setupSvc + "/api/profile/delProfile",
+            { id: profileId },
+            config.accessToken
+        );
+
+        if (result && result.result) {
+            console.error();
+            console.error(chalk.green("Success! Profile deleted."));
+            console.error();
+            return result;
+        }
+
+        const msg = result && (result.returnInfo || result.message) ? (result.returnInfo || result.message) : "Unknown error";
+        console.error();
+        console.error(chalk.red("Error: " + msg));
+        console.error();
+        throw new Error("Delete Profile Failed: " + msg);
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("简档删除失败:"), error);
+        throw error;
+    }
+}
+
+module.exports = remove;

package/src/profile/doc.js

@@ -0,0 +1,46 @@
+/**
+ * profile 文档入口：正文均在 `docs/` 目录。
+ */
+const fs = require("fs");
+const path = require("path");
+
+const DOCS_DIR = path.join(__dirname, "docs");
+
+function readDocFile(basename) {
+    return fs.readFileSync(path.join(DOCS_DIR, `${basename}.md`), "utf8");
+}
+
+/** 介绍文档：简档能力、类型与入口 */
+function getIntroductionDoc() {
+    return readDocFile("introduction");
+}
+
+/** 开发指导：CLI 创建/查询/删除等 */
+function getDevGuideDoc() {
+    return readDocFile("devguide");
+}
+
+/**
+ * cc doc profile <introduction|devguide>
+ * @param {string[]} argvs [doc, type, introduction|devguide, ...]
+ */
+function doc(argvs) {
+    const subType = argvs[2];
+    const key = String(subType || "").trim().toLowerCase();
+    if (!key) {
+        throw new Error("cc doc profile 需要子命令：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/profile/docs/devguide.md

@@ -0,0 +1,332 @@
+# CloudCC 简档使用总结
+
+简档（Profile）用于定义 CloudCC 系统中用户的权限集合，控制用户可以访问的对象、字段和功能。
+
+---
+
+## 快速开始（CLI 命令）
+
+### 支持的简档操作
+
+| 操作 | 说明 |
+|------|------|
+| `create` | 创建自定义简档 |
+| `get` | 查询简档列表 |
+| `delete` | 删除自定义简档 |
+
+---
+
+## CLI 命令详解
+
+### 创建简档
+
+创建一个新的自定义简档，基于现有简档复制权限配置。
+
+```bash
+cc create profile <path> <profileName> [description]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径，`.` 表示当前目录 |
+| `profileName` | 是 | 简档名称 |
+| `description` | 否 | 简档描述（暂不支持保存到后端） |
+
+**示例：**
+
+```bash
+# 创建简档
+cc create profile . "销售经理简档"
+
+# 创建带描述的简档
+cc create profile . "销售代表简档" "适用于销售团队的权限配置"
+```
+
+---
+
+### 查询简档列表
+
+获取当前环境中的所有简档列表。
+
+```bash
+cc get profile <projectPath> [encodedCondJson]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `encodedCondJson` | 否 | URI 编码后的查询条件 JSON |
+
+**示例：**
+
+```bash
+# 获取所有简档
+cc get profile .
+
+# 带查询条件
+cc get profile . '%7B%22type%22%3A%22custom%22%7D'
+```
+
+---
+
+### 删除简档
+
+删除指定的自定义简档。
+
+```bash
+cc delete profile <projectPath> <profileId>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `profileId` | 是 | 简档 ID |
+
+**示例：**
+
+```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/profile/docs/introduction.md

@@ -0,0 +1,123 @@
+# CloudCC 简档使用总结
+
+简档（Profile）用于定义 CloudCC 系统中用户的权限集合，包括对象访问权限、字段权限、功能权限等。
+
+---
+
+## 快速开始（CLI 命令）
+
+### 支持的简档操作
+
+| 操作 | 说明 |
+|------|------|
+| `create` | 创建自定义简档 |
+| `get` | 查询简档列表 |
+| `delete` | 删除自定义简档 |
+
+---
+
+## CLI 命令详解
+
+### 创建简档
+
+创建一个新的自定义简档，基于现有简档进行克隆。
+
+```bash
+cc create profile <path> <profileName> [description]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径，`.` 表示当前目录 |
+| `profileName` | 是 | 简档名称 |
+| `description` | 否 | 简档描述 |
+
+**示例：**
+
+```bash
+# 创建简档
+cc create profile . "销售经理简档"
+
+# 创建带描述的简档
+cc create profile . "销售代表简档" "适用于销售团队的权限配置"
+```
+
+---
+
+### 查询简档列表
+
+获取当前环境中的所有简档列表。
+
+```bash
+cc get profile <projectPath> [encodedCondJson]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `encodedCondJson` | 否 | URI 编码后的查询条件 JSON |
+
+**示例：**
+
+```bash
+# 获取所有简档
+cc get profile .
+
+# 带查询条件
+cc get profile . '%7B%22type%22%3A%22custom%22%7D'
+```
+
+---
+
+### 删除简档
+
+删除指定的自定义简档。
+
+```bash
+cc delete profile <projectPath> <profileId>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `profileId` | 是 | 简档 ID |
+
+**示例：**
+
+```bash
+# 删除指定简档
+cc delete profile . a0I9D000000XXXXUAI
+```
+
+---
+
+## 完整工作流示例
+
+### 场景：为销售团队创建新的权限简档
+
+```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>
+```
+
+---
+
+*文档版本：1.0 | 最后更新：2026-03-26*