cloudcc-cli 2.3.4 → 2.3.6

package/src/scheduleJob/docs/devguide.md

@@ -21,7 +21,7 @@
 ### 1) 查询作业列表
 
 ```bash
-cc get scheduleJob <projectPath> [encodedCondJson]
+cloudcc get scheduleJob <projectPath> [encodedCondJson]
 ```
 
 参数说明：
@@ -36,7 +36,7 @@ cc get scheduleJob <projectPath> [encodedCondJson]
 ### 2) 查询作业详情
 
 ```bash
-cc detail scheduleJob <jobId> [projectPath]
+cloudcc detail scheduleJob <jobId> [projectPath]
 ```
 
 参数说明：
@@ -51,7 +51,7 @@ cc detail scheduleJob <jobId> [projectPath]
 ### 3) 删除作业
 
 ```bash
-cc delete scheduleJob <jobId> [projectPath]
+cloudcc delete scheduleJob <jobId> [projectPath]
 ```
 
 参数说明：
@@ -66,14 +66,14 @@ cc delete scheduleJob <jobId> [projectPath]
 ### 4) 查看文档
 
 ```bash
-cc doc scheduleJob <introduction|devguide>
+cloudcc doc scheduleJob <introduction|devguide>
 ```
 
 ---
 
 ## 三、关联文档
 
-- `cc doc timer introduction`
-- `cc doc timer devguide`
+- `cloudcc doc timer introduction`
+- `cloudcc doc timer devguide`
 
 ---

package/src/scheduleJob/docs/introduction.md

@@ -74,20 +74,20 @@
 
 ```bash
 # 1) 查看全部定时作业
-cc get scheduleJob .
+cloudcc get scheduleJob .
 
 # 2) 带条件查询（URI 编码 JSON）
-cc get scheduleJob . '%7B%22name%22%3A%22%E6%8A%A5%E8%A1%A8%22%7D'
+cloudcc get scheduleJob . '%7B%22name%22%3A%22%E6%8A%A5%E8%A1%A8%22%7D'
 
 # 3) 查看某个作业详情
-cc detail scheduleJob a0I9D000000XXXXUAI .
+cloudcc detail scheduleJob a0I9D000000XXXXUAI .
 
 # 4) 删除作业（危险操作）
-cc delete scheduleJob a0I9D000000XXXXUAI .
+cloudcc delete scheduleJob a0I9D000000XXXXUAI .
 
 # 5) 查看文档
-cc doc scheduleJob introduction
-cc doc scheduleJob devguide
+cloudcc doc scheduleJob introduction
+cloudcc doc scheduleJob devguide
 ```
 
 ---

package/src/script/docs/devguide.md

@@ -2,7 +2,7 @@
 
 ## 客户端脚本（Script）操作指南
 
-直接查看：`cc doc script`
+直接查看：`cloudcc doc script`
 
 ---
 
@@ -24,7 +24,7 @@
 命令：
 
 ```bash
-cc doc script
+cloudcc doc script
 ```
 
 说明：输出客户端脚本文档，并自动附带本文件内容。
@@ -36,7 +36,7 @@ cc doc script
 命令：
 
 ```bash
-cc get script <encodedCondJson> <projectPath>
+cloudcc get script <encodedCondJson> <projectPath>
 ```
 
 参数说明：
@@ -67,10 +67,10 @@ cc get script <encodedCondJson> <projectPath>
 
 ```bash
 # 1) 按本地脚本路径查看（不依赖线上）
-cc detail script <objName/scriptName>
+cloudcc detail script <objName/scriptName>
 
 # 2) 按线上脚本 id 查看
-cc detail script "" <scriptId> <projectPath>
+cloudcc detail script "" <scriptId> <projectPath>
 ```
 
 说明：
@@ -85,7 +85,7 @@ cc detail script "" <scriptId> <projectPath>
 命令：
 
 ```bash
-cc create script <encodedBodyJson>
+cloudcc create script <encodedBodyJson>
 ```
 
 参数说明：
@@ -114,7 +114,7 @@ cc create script <encodedBodyJson>
 命令：
 
 ```bash
-cc publish script <objName/scriptName>
+cloudcc publish script <objName/scriptName>
 ```
 
 说明：
@@ -130,7 +130,7 @@ cc publish script <objName/scriptName>
 命令：
 
 ```bash
-cc pull script <objName/scriptName>
+cloudcc pull script <objName/scriptName>
 ```
 
 说明：要求本地 `config.json` 内已存在 `id`（先发布一次）。
@@ -142,7 +142,7 @@ cc pull script <objName/scriptName>
 命令：
 
 ```bash
-cc pullList script <scriptId> <projectPath>
+cloudcc pullList script <scriptId> <projectPath>
 ```
 
 说明：会在 `<projectPath>/script/<objName>/<scriptName>/` 下生成 `config.json` 与脚本文件。
@@ -155,10 +155,10 @@ cc pullList script <scriptId> <projectPath>
 
 ```bash
 # 1) 直接按 scriptId 删除
-cc delete script <scriptId> <projectPath>
+cloudcc delete script <scriptId> <projectPath>
 
 # 2) 按 "objName/scriptName" 删除（会先查询解析出 id，再删除）
-cc delete script <objName/scriptName> <projectPath>
+cloudcc delete script <objName/scriptName> <projectPath>
 ```
 
 ---
@@ -168,37 +168,37 @@ cc delete script <objName/scriptName> <projectPath>
 ### 查询客户端脚本列表（默认条件）
 
 ```bash
-cc get script "$(node -e "console.log(encodeURI(JSON.stringify({pageSize:50,pageNo:1,condition:{scriptName:'',pageLabel:'',objName:''}})))")" .
+cloudcc get script "$(node -e "console.log(encodeURI(JSON.stringify({pageSize:50,pageNo:1,condition:{scriptName:'',pageLabel:'',objName:''}})))")" .
 ```
 
 ### 按脚本名筛选（例如：test）
 
 ```bash
-cc get script "$(node -e "console.log(encodeURI(JSON.stringify({pageSize:50,pageNo:1,condition:{scriptName:'test',pageLabel:'',objName:''}})))")" .
+cloudcc get script "$(node -e "console.log(encodeURI(JSON.stringify({pageSize:50,pageNo:1,condition:{scriptName:'test',pageLabel:'',objName:''}})))")" .
 ```
 
 ### 新建脚本（本地）
 
 ```bash
-cc create script "$(node -e "console.log(encodeURI(JSON.stringify({objName:'contact',scriptName:'hello_script'})))")"
+cloudcc create script "$(node -e "console.log(encodeURI(JSON.stringify({objName:'contact',scriptName:'hello_script'})))")"
 ```
 
 ### 发布脚本（上线）
 
 ```bash
-cc publish script contact/hello_script
+cloudcc publish script contact/hello_script
 ```
 
 ### 拉取脚本（从线上覆盖本地）
 
 ```bash
-cc pull script contact/hello_script
+cloudcc pull script contact/hello_script
 ```
 
 ### 删除脚本（按 id）
 
 ```bash
-cc delete script <scriptId> .
+cloudcc delete script <scriptId> .
 ```
 
 ---
@@ -206,7 +206,7 @@ cc delete script <scriptId> .
 ## 4. Checklist
 
 - [ ] 已在正确项目目录执行命令（或显式传入 `projectPath`）
-- [ ] `cc get script` 的条件已按 `encodeURI(JSON.stringify(...))` 传入
+- [ ] `cloudcc get script` 的条件已按 `encodeURI(JSON.stringify(...))` 传入
 - [ ] 发布前脚本文件包含 `function main($CCDK, obj) { ... }`
 - [ ] 首次发布后确认 `config.json` 已写入 `id`
 - [ ] 拉取/删除前确认目标 `id` 正确（避免误删）

package/src/singleSignOn/delete.js

@@ -0,0 +1,61 @@
+const chalk = require("chalk");
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 删除单点登录记录
+ * 接口: /spconfig/delete
+ * 用法：cloudcc delete singleSignOn <projectPath> <id>
+ */
+async function remove(argvs) {
+    try {
+        const projectPath = argvs[2] || process.cwd();
+        const id = argvs[3];
+
+        if (!id) {
+            console.error();
+            console.error(chalk.red("Error: 缺少单点登录记录 id"));
+            console.error(chalk.yellow("用法: cloudcc delete singleSignOn <projectPath> <id>"));
+            console.error(chalk.yellow("示例: cloudcc delete singleSignOn . 20246DB16F11EDF4KHWd"));
+            console.error();
+            throw new Error("缺少必需参数: id");
+        }
+
+        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 single sign on record (${id}), please wait...`));
+        console.error();
+
+        const result = await postClass(
+            config.setupSvc + "/api/spconfig/delete",
+            { id: id },
+            config.accessToken
+        );
+
+        if (result && result.result) {
+            console.error();
+            console.error(chalk.green("Success! Single sign on record 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 SingleSignOn Failed: " + msg);
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("单点登录记录删除失败:"), error);
+        throw error;
+    }
+}
+
+module.exports = remove;

package/src/singleSignOn/doc.js

@@ -0,0 +1,46 @@
+/**
+ * singleSignOn 文档入口：正文均在 `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");
+}
+
+/**
+ * cloudcc doc singleSignOn <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("cloudcc doc singleSignOn 需要子命令：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/singleSignOn/docs/devguide.md

@@ -0,0 +1,61 @@
+# CloudCC 单点登录 CLI 命令说明
+
+## 支持的命令
+
+| 操作 | 说明 |
+|------|------|
+| `get` | 查询单点登录配置列表 |
+| `delete` | 删除单点登录记录 |
+
+## CLI 命令详解
+
+### 查询单点登录配置列表
+
+```bash
+cloudcc get singleSignOn <projectPath> [encodedCondJson]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `encodedCondJson` | 否 | URI 编码后的查询条件 JSON |
+
+**查询条件参数：**
+
+| 参数名 | 类型 | 说明 |
+|--------|------|------|
+| `start` | number | 起始位置，默认 0 |
+| `limit` | number | 每页条数，默认 30 |
+| `keyword` | string | 搜索关键词 |
+
+**示例：**
+
+```bash
+# 获取所有单点登录配置
+cloudcc get singleSignOn .
+
+# 带查询条件（搜索关键词）
+cloudcc get singleSignOn . '%7B%22keyword%22%3A%22test%22%2C%22limit%22%3A50%7D'
+```
+
+### 删除单点登录记录
+
+```bash
+cloudcc delete singleSignOn <projectPath> <id>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `id` | 是 | 单点登录记录 id（从列表接口获取）|
+
+**示例：**
+
+```bash
+# 删除单点登录记录
+cloudcc delete singleSignOn . 20246DB16F11EDF4KHWd
+```

package/src/singleSignOn/docs/introduction.md

@@ -0,0 +1,3 @@
+# CloudCC 单点登录（SingleSignOn）
+
+单点登录（SSO）设置用于管理 CloudCC 平台中的服务提供商（SP）配置，支持查看和删除 SP 配置记录。

package/src/singleSignOn/get.js

@@ -0,0 +1,70 @@
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+const chalk = require("chalk");
+
+/**
+ * 查询单点登录配置列表
+ * 接口: /spconfig/list
+ * 用法：cloudcc get singleSignOn <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) {
+            try {
+                body = JSON.parse(condArg);
+            } catch (e2) {
+                throw new Error("Get SingleSignOn Failed: encodedCondJson 解析失败，请传 encodeURI(JSON.stringify(...))");
+            }
+        }
+    }
+
+    const config = await getPackageJson(projectPath);
+
+    const res = await postClass(
+        config.setupSvc + "/api/spconfig/list",
+        {
+            start: 0,
+            limit: 30,
+            keyword: "",
+            ...body
+        },
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        const data = res.data;
+        let rawList = [];
+        if (Array.isArray(data)) {
+            rawList = data;
+        } else if (data && Array.isArray(data.list)) {
+            rawList = data.list;
+        } else if (data && Array.isArray(data.data)) {
+            rawList = data.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, null, 2));
+        }
+        return rawList;
+    }
+
+    const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    throw new Error("Get SingleSignOn Failed: " + msg);
+}
+
+module.exports = get;

package/src/singleSignOn/index.js

@@ -0,0 +1,10 @@
+const cc = {}
+cc.delete = require("./delete")
+cc.get = require("./get")
+cc.doc = require("./doc")
+
+function main(action, argvs) {
+    cc[action](argvs)
+}
+
+module.exports = main;

package/src/staticResource/count.js

@@ -3,7 +3,7 @@ const BaseUrl = "https://developer.apis.cloudcc.cn";
 
 /**
  * 静态资源 - 容量统计
- * CLI: cc count staticResource <projectPath> [encodedCondJson]
+ * CLI: cloudcc count staticResource <projectPath> [encodedCondJson]
  * 参数说明：
  * - projectPath: 项目根目录，默认 process.cwd()
  * - encodedCondJson(可选): encodeURI(JSON.stringify(body))

package/src/staticResource/create.js

@@ -1,6 +1,6 @@
 /**
  * 静态资源 - 新建/编辑（上传）
- * CLI: cc create staticResource <projectPath> <encodedBodyJson>
+ * CLI: cloudcc create staticResource <projectPath> <encodedBodyJson>
  * 参数说明：
  * - projectPath: 项目根目录
  * - encodedBodyJson: encodeURI(JSON.stringify(body))

package/src/staticResource/delete.js

@@ -4,7 +4,7 @@ const BaseUrl = "https://developer.apis.cloudcc.cn";
 
 /**
  * 静态资源 - 删除
- * CLI: cc delete staticResource <projectPath> <resourceId>
+ * CLI: cloudcc delete staticResource <projectPath> <resourceId>
  * 参数说明：
  * - projectPath: 项目根目录，默认 process.cwd()
  * - id(resourceId): 静态资源 id（必填）

package/src/staticResource/detail.js

@@ -3,7 +3,7 @@ const BaseUrl = "https://developer.apis.cloudcc.cn";
 
 /**
  * 静态资源 - 查询详情
- * CLI: cc detail staticResource <projectPath> <resourceId>
+ * CLI: cloudcc detail staticResource <projectPath> <resourceId>
  * 参数说明：
  * - projectPath: 项目根目录，默认 process.cwd()
  * - id(resourceId): 静态资源 id（必填）

package/src/staticResource/docs/devguide.md

@@ -1,6 +1,6 @@
 # 静态资源（Static Resource）操作指南
 
-直接查看：`cc doc staticResource`
+直接查看：`cloudcc doc staticResource`
 
 ---
 
@@ -21,7 +21,7 @@
 命令：
 
 ```bash
-cc doc staticResource
+cloudcc doc staticResource
 ```
 
 说明：输出静态资源完整操作文档，并自动附带本文件内容。
@@ -31,7 +31,7 @@ cc doc staticResource
 命令：
 
 ```bash
-cc get staticResource <projectPath> [encodedCondJson]
+cloudcc get staticResource <projectPath> [encodedCondJson]
 ```
 
 参数说明：
@@ -52,7 +52,7 @@ cc get staticResource <projectPath> [encodedCondJson]
 命令：
 
 ```bash
-cc detail staticResource <projectPath> <resourceId>
+cloudcc detail staticResource <projectPath> <resourceId>
 ```
 
 参数说明：
@@ -67,7 +67,7 @@ cc detail staticResource <projectPath> <resourceId>
 命令：
 
 ```bash
-cc create staticResource <projectPath> <encodedBodyJson>
+cloudcc create staticResource <projectPath> <encodedBodyJson>
 ```
 
 参数说明：
@@ -93,7 +93,7 @@ cc create staticResource <projectPath> <encodedBodyJson>
 命令：
 
 ```bash
-cc delete staticResource <projectPath> <resourceId>
+cloudcc delete staticResource <projectPath> <resourceId>
 ```
 
 参数说明：
@@ -108,7 +108,7 @@ cc delete staticResource <projectPath> <resourceId>
 命令：
 
 ```bash
-cc count staticResource <projectPath> [encodedCondJson]
+cloudcc count staticResource <projectPath> [encodedCondJson]
 ```
 
 参数说明：
@@ -125,25 +125,25 @@ cc count staticResource <projectPath> [encodedCondJson]
 ### 按 label 查询列表
 
 ```bash
-cc get staticResource . "$(node -e 'console.log(encodeURI(JSON.stringify({label:\"logo\"})))')"
+cloudcc get staticResource . "$(node -e 'console.log(encodeURI(JSON.stringify({label:\"logo\"})))')"
 ```
 
 ### 查询容量统计
 
 ```bash
-cc count staticResource .
+cloudcc count staticResource .
 ```
 
 ### 新建静态资源（上传文件）
 
 ```bash
-cc create staticResource . "$(node -e "console.log(encodeURI(JSON.stringify({filePath:'./assets/logo.png',label:'logo_png',desc:'cli upload'})))")"
+cloudcc create staticResource . "$(node -e "console.log(encodeURI(JSON.stringify({filePath:'./assets/logo.png',label:'logo_png',desc:'cli upload'})))")"
 ```
 
 ### 编辑静态资源（不替换文件）
 
 ```bash
-cc create staticResource . "$(node -e "console.log(encodeURI(JSON.stringify({id:'69c4f469ec9eb4d5c8a1b76d',label:'logo_png_v2',desc:'rename only'})))")"
+cloudcc create staticResource . "$(node -e "console.log(encodeURI(JSON.stringify({id:'69c4f469ec9eb4d5c8a1b76d',label:'logo_png_v2',desc:'rename only'})))")"
 ```
 
 ---

package/src/staticResource/docs/introduction.md

@@ -1,3 +1,46 @@
 # CloudCC 静态资源介绍
 
-TODO
+## 1. 模块定位
+
+静态资源用于统一托管前端开发中需要复用的文件资源（如图片、字体、JS/CSS 文件、压缩包等）。
+当资源不适合直接内嵌在代码中时，可上传到静态资源库，再通过平台提供的访问链接在组件、页面、脚本中引用。
+
+## 2. 典型使用场景
+
+- 自定义组件引用公共图片、图标、字体文件
+- 自定义页面加载第三方前端库（如工具函数、样式文件）
+- 多个业务功能共享同一份资源，避免重复上传与多处维护
+
+## 3. 控制台入口
+
+1. 登录 CloudCC 系统
+2. 点击右上角头像，进入「开发者平台」（当前仅管理员简档可见）
+3. 在左侧菜单进入：`扩展 -> 静态资源`
+
+## 4. 核心操作流程
+
+### 4.1 新建静态资源
+
+1. 点击「新建」
+2. 填写必要信息（名称/标签、描述等）
+3. 上传资源文件并保存
+
+### 4.2 获取访问链接并应用
+
+1. 在资源列表中找到目标资源
+2. 点击复制图标获取资源访问链接
+3. 在组件/页面/脚本中使用该链接
+
+## 5. 关键约束与注意事项
+
+- 单个上传文件大小上限为 `5MB`
+- 建议使用可读性强、可维护的命名规范，便于检索和复用
+- 发布前应验证访问链接可用性，避免页面出现 404 或加载失败
+- 建议在团队内约定资源分类（如 `img/`、`font/`、`vendor/`）与版本策略
+
+## 6. 设计建议（面向实施）
+
+- **先复用后新增**：优先检查资源库中是否已有同类资源，减少冗余
+- **按用途分层管理**：将业务资源与公共资源分开，降低变更影响
+- **关注性能**：对图片进行压缩，避免引入过大的静态文件影响加载速度
+- **建立变更记录**：重大资源替换建议记录版本和影响范围，便于回滚与排查

package/src/staticResource/get.js

@@ -3,7 +3,7 @@ const BaseUrl = "https://developer.apis.cloudcc.cn";
 
 /**
  * 静态资源 - 查询列表
- * CLI: cc get staticResource <projectPath> [encodedCondJson]
+ * CLI: cloudcc get staticResource <projectPath> [encodedCondJson]
  * 参数说明：
  * - projectPath: 项目根目录，默认 process.cwd()
  * - encodedCondJson(可选): encodeURI(JSON.stringify(body))

package/src/timer/create.js

@@ -5,7 +5,7 @@ const chalk = require("chalk")
 const { getPackageJson } = require("../../utils/config.js")
 
 /**
- * cc create timer <name>
+ * cloudcc create timer <name>
  * @param {string[]} argvs
  */
 async function create(argvs) {

package/src/timer/delete.js

@@ -5,7 +5,7 @@ const { getPackageJson } = require("../../utils/config");
 const { postClass } = require("../../utils/http");
 
 /**
- * cc delete timer <nameOrId> [projectPath]
+ * cloudcc delete timer <nameOrId> [projectPath]
  * @param {string[]} argvs
  */
 async function remove(argvs) {