cloudcc-cli 2.3.2 → 2.3.4

package/src/pagelayout/index.js

@@ -1,6 +1,7 @@
 const cc = {}
 cc.create = require("./create")
 cc.get = require("./get")
+cc.delete = require("./delete")
 cc.doc = require("./doc")
 async function main(action, argvs) {
   await cc[action](argvs)

package/src/plugin/docs/devguide.md

@@ -5,6 +5,68 @@
 
 ---
 
+## CLI 与本地文件（必读）
+
+`plugins/<插件名>/` 目录、`config.json` 以及首次发布写回的 `id` 均与 **cloudcc-cli** 的创建、发布、拉取逻辑绑定。**必须通过下列命令** 完成新建插件目录、与云端同步、发布与删除；不要手工整包复制其他项目的 `plugins/`、不要私自篡改 `config.json` 中的 `id` 或破坏元数据，否则容易导致编译入口错误、发布失败或与云端不一致。
+
+**允许的做法**：在 CLI 已生成的目录内用 IDE 编辑 `.vue`、子组件与 `utils/` 等源码；与云端列表、详情、拉取、删除、发布相关的操作一律走命令。
+
+执行命令前请确认：已完成 `cc doc project devguide` 中的环境初始化，项目根目录配置可用且具备 `accessToken`（发布流程还会使用 `pluginToken` / 账号密钥等，以你项目配置为准）。
+
+### 命令总览（以代码实现为准）
+
+```bash
+cc create plugin <name>
+cc publish plugin <name>
+cc get plugin [projectPath]
+cc detail plugin <pluginName> [pluginId] [projectPath]
+cc detail plugin "" <pluginId> [projectPath]
+cc pull plugin <pluginNameOrId> [projectPath]
+cc delete plugin <pluginNameOrId> [projectPath]
+cc doc plugin <introduction|devguide>
+```
+
+参数约定：
+
+- `name` / `pluginName`：插件目录名，与 `plugins/<name>/` 一致。
+- `projectPath`：项目根路径；不传则使用当前工作目录。`get` 的第一个可选参数即为 `projectPath`。
+- `pluginNameOrId`：本地目录名，或云端组件 ID；若本地存在 `config.json` 且含 `id`，`pull` / `delete` 会优先使用该 `id`。
+- `pluginId`：`detail` 仅查云端时，将 `pluginName` 置空：`cc detail plugin "" <pluginId>`。
+
+### 命令作用摘要
+
+| 命令 | 作用 |
+|------|------|
+| `create` | 在 `plugins/<name>/` 生成入口 `.vue`、`components/`、`config.json` 等模板 |
+| `publish` | 使用 `vue-cli-service` 编译并上传；首次成功且接口返回 `id` 时可写回 `config.json` |
+| `get` | 拉取云端组件列表，标准输出为 JSON |
+| `detail` | 按目录名读本地；或按 `pluginId` 读云端（不传 `pluginName` 时） |
+| `pull` | 按本地 `id` 或按传入的 ID 从云端还原文件到本地 `plugins/` 等路径 |
+| `delete` | 调用接口删除云端组件 |
+| `doc` | 输出 `introduction` 或 `devguide`（`devguide` 含附录 CCDK SDK 速查） |
+
+### 推荐操作顺序
+
+```bash
+# 1) 查看云端已有组件（可选）
+cc get plugin .
+
+# 2) 仅通过 create 生成目录与模板
+cc create plugin my_plugin
+
+# 3) 本地调试后发布（勿跳过 CLI 发布流程）
+cc publish plugin my_plugin
+
+# 4) 与云端对齐或迁移机器时拉取
+cc pull plugin my_plugin
+# 或已知云端 ID：cc pull plugin <id> .
+
+# 5) 不再使用时删除云端组件
+cc delete plugin my_plugin
+```
+
+---
+
 ## 0. 自定义组件概述（能力与场景）
 
 本文节整合了仓库内实践用法，帮助你在开始编码前先判断：什么是自定义组件、能解决什么问题、何时该用。
@@ -100,7 +162,8 @@ npm run serve
 
 ### 1.2 创建组件
 
-- 新建一个组件文件，**组件名称必须满足 DOM 命名规则**，例如：`cc-com-demo.vue`
+- **使用本 CLI 时**：在项目根执行 `cc create plugin <name>`，会在 `plugins/<name>/` 生成标准模板（推荐）。
+- 或在模板工程中手动新建入口文件，**组件名称必须满足 DOM 命名规则**，例如：`cc-com-demo.vue`
   - 推荐遵循：以 `cc-` 开头，后续使用小写单词和 `-` 连接。
 
 ### 1.3 在 `App` 中引入组件
@@ -115,12 +178,15 @@ npm run serve
 
 ### 1.5 发布组件
 
-在 VS Code 中：
+**推荐（与仓库、CI 一致）**：在项目根目录执行：
+
+```bash
+cc publish plugin <与目录名一致的 name>
+```
 
-- 右键点击组件的入口文件（你的自定义组件文件）
-- 选择「发布组件」（CloudCC 插件菜单）
-- 控制台提示发布成功信息，表示组件已经上传至 CloudCC
-  平台，可在页面编辑器中使用。
+CLI 会编译 `plugins/<name>/<name>.vue` 并上传；首次成功且接口返回 `id` 时可能写回 `plugins/<name>/config.json`。
+
+也可在 VS Code 中右键组件入口文件，选择「发布组件」（CloudCC 扩展），控制台提示成功即表示已上传至平台，可在页面编辑器中使用。
 
 ---
 
@@ -847,6 +913,7 @@ componentInfo: {
 
 ## 13. 自定义组件开发 Checklist
 
+- [ ] 插件目录与云端同步仅通过 `cc create` / `cc publish` / `cc pull` / `cc delete` 等命令操作，不整包复制他人 `plugins/` 或手改 `config.json` 的 `id`
 - [ ] 组件文件名与 `componentInfo.component` 命名符合规范（小写 + `-`
       分隔，全局唯一）
 - [ ] 样式默认使用 `lang="scss" scoped`，避免样式污染
@@ -860,7 +927,9 @@ componentInfo: {
 
 ---
 
-## 14. 命令使用说明（补充）
+## 14. 命令使用说明（与实现一致）
+
+文首「CLI 与本地文件（必读）」为总览；本节按子命令列出行为细节。
 
 ### 14.1 create
 
@@ -868,7 +937,7 @@ componentInfo: {
 cc create plugin <name>
 ```
 
-- 创建 `plugins/<name>/` 目录及基础模板文件。
+- 创建 `plugins/<name>/` 目录、入口 `<name>.vue`、`components/` 与 `config.json` 模板。
 
 ### 14.2 publish
 
@@ -876,8 +945,8 @@ cc create plugin <name>
 cc publish plugin <name>
 ```
 
-- 编译并发布 `plugins/<name>/` 到云端。
-- 首次发布成功且返回 `id` 时，会写回 `plugins/<name>/config.json`。
+- 以 `plugins/<name>/<name>.vue` 为入口编译（`vue-cli-service build --target lib`），再上传到云端。
+- 首次发布成功且响应包含 `id` 时，会写回 `plugins/<name>/config.json`（若此前无 `id`）。
 
 ### 14.3 get
 
@@ -885,17 +954,19 @@ cc publish plugin <name>
 cc get plugin [projectPath]
 ```
 
-- 获取云端插件列表，输出 JSON。
+- 分页请求云端组件列表，标准输出为 JSON 数组。
+- `projectPath` 可选，用于解析项目根下的 `cloudcc-cli` 配置。
 
 ### 14.4 detail
 
 ```bash
-cc detail plugin <pluginName> [projectPath]
+cc detail plugin <pluginName> [pluginId] [projectPath]
 cc detail plugin "" <pluginId> [projectPath]
 ```
 
-- 传 `pluginName`：查本地 `plugins/<pluginName>/`。
-- 传 `pluginId`：查云端详情。
+- 提供 `pluginName`（且非空）：读取本地 `plugins/<pluginName>/` 的 `config.json` 与入口 `.vue`。
+- 将 `pluginName` 置为空并传 `pluginId`：仅从云端查询详情（`projectPath` 仍用于配置）。
+- 需要指定项目根且保留「仅本地名」时，可用占位：`cc detail plugin <pluginName> "" <projectPath>`（中间空串表示无 `pluginId`）。
 
 ### 14.5 pull
 
@@ -903,7 +974,8 @@ cc detail plugin "" <pluginId> [projectPath]
 cc pull plugin <pluginNameOrId> [projectPath]
 ```
 
-- 若本地 `config.json` 有 `id`，优先按该 `id` 拉取；否则按输入值当 `id` 拉取。
+- 若 `plugins/<输入>/config.json` 存在且含 `id`，按该 `id` 拉取。
+- 否则将输入视为云端组件 ID，拉取后在 `plugins/<归一化名称>/` 等处落盘并更新 `config.json`。
 
 ### 14.6 delete
 
@@ -911,7 +983,8 @@ cc pull plugin <pluginNameOrId> [projectPath]
 cc delete plugin <pluginNameOrId> [projectPath]
 ```
 
-- 若本地 `config.json` 有 `id`，优先按该 `id` 删除；否则按输入值当 `id` 删除。
+- 若本地 `plugins/<name>/config.json` 存在且含 `id`，优先按该 `id` 调删除接口。
+- 否则将参数视为云端 ID 直接删除。
 
 ### 14.7 doc
 
@@ -920,4 +993,4 @@ cc doc plugin introduction
 cc doc plugin devguide
 ```
 
-- 输出 plugin 模块文档内容。
+- 仅支持 `introduction` 与 `devguide`；`devguide` 会在正文后拼接附录「CCDK SDK 速查」。

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/create.js

@@ -2,6 +2,7 @@ const chalk = require('chalk');
 const inquirer = require('inquirer');
 const { postClass } = require("../../utils/http");
 const { getPackageJson } = require("../../utils/config");
+const { id } = require('zod/locales');
 
 /**
  * 创建角色
@@ -49,7 +50,7 @@ async function create(argvs) {
         console.error(chalk.blue('Step 1: 获取直属上司列表...'));
         const addRoleRes = await postClass(
             config.setupSvc + "/api/role/addRole",
-            { id: "bab2025F8B20EE4d4005" },
+            { id: config.orgId },
             config.accessToken
         );
 

package/src/role/delete.js

@@ -40,6 +40,7 @@ async function remove(argvs) {
         if (result && result.result) {
             console.error();
             console.error(chalk.green("Success! Role deleted."));
+            console.error(chalk.blue("返回结果:"), JSON.stringify(result, null, 2));
             console.error();
             return result;
         }