cloudcc-cli 2.3.1 → 2.3.3

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,77 @@
+# 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
+```

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*

package/src/profile/get.js

@@ -0,0 +1,55 @@
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 查询简档列表
+ * 用法：cc get profile <projectPath> [encodedCondJson]
+ */
+async function get(argvs, isMcp = false) {
+    const projectPath = argvs[2] || process.cwd();
+    const condArg = argvs[3];
+
+    let body = {};
+    if (condArg) {
+        try {
+            body = JSON.parse(decodeURI(condArg));
+        } catch (e) {
+            throw new Error("Get Profile Failed: encodedCondJson 解析失败，请传 encodeURI(JSON.stringify(...))");
+        }
+    }
+
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/profile/listAll",
+        body,
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        const data = res.data;
+        let rawList = [];
+        if (data && Array.isArray(data.list)) {
+            rawList = data.list;
+        } else if (Array.isArray(data)) {
+            rawList = data;
+        } else if (data && typeof data === "object") {
+            rawList = Object.keys(data)
+                .filter((key) => /list$/i.test(key) && Array.isArray(data[key]))
+                .flatMap((key) =>
+                    data[key].map((item) => ({
+                        ...item,
+                        __group: key
+                    }))
+                );
+        }
+        if (!isMcp) {
+            console.log(JSON.stringify(rawList));
+        }
+        return rawList;
+    }
+
+    const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    throw new Error("Get Profile Failed: " + msg);
+}
+
+module.exports = get;

package/src/profile/index.js

@@ -0,0 +1,14 @@
+const cc = {}
+cc.create = require("./create")
+cc.delete = require("./delete")
+cc.get = require("./get")
+cc.doc = require("./doc")
+
+async function main(action, argvs) {
+  if (!cc[action]) {
+    throw new Error(`profile 不支持的操作: ${action}`);
+  }
+  return await cc[action](argvs)
+}
+
+module.exports = main;