cloudcc-cli 2.3.0 → 2.3.2

package/src/staticResource/docs/devguide.md

@@ -0,0 +1,157 @@
+# 静态资源（Static Resource）操作指南
+
+直接查看：`cc doc staticResource`
+
+---
+
+## 1. 常见操作
+
+- 查询静态资源列表
+- 查看静态资源详情
+- 新建/编辑静态资源（上传）
+- 删除静态资源
+- 查询静态资源容量（上传前校验）
+
+---
+
+## 2. 常用 CLI 命令
+
+### 1) 查看静态资源指导文档
+
+命令：
+
+```bash
+cc doc staticResource
+```
+
+说明：输出静态资源完整操作文档，并自动附带本文件内容。
+
+### 2) 查询静态资源列表
+
+命令：
+
+```bash
+cc get staticResource <projectPath> [encodedCondJson]
+```
+
+参数说明：
+
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| projectPath | string | 非必须 | 当前目录 | 项目根目录 |
+| encodedCondJson | string | 非必须 | — | `encodeURI(JSON.stringify(body))` 后的查询条件 |
+
+请求体（decoded 后）常用字段：
+
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| label | string | 非必须 | `""` | 可用于按标签/名称筛选 |
+
+### 3) 查询静态资源详情
+
+命令：
+
+```bash
+cc detail staticResource <projectPath> <resourceId>
+```
+
+参数说明：
+
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| projectPath | string | 非必须 | 当前目录 | 项目根目录 |
+| resourceId | string | 必须 | — | 静态资源 id |
+
+### 4) 新建/编辑静态资源（上传）
+
+命令：
+
+```bash
+cc create staticResource <projectPath> <encodedBodyJson>
+```
+
+参数说明：
+
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| projectPath | string | 非必须 | 当前目录 | 项目根目录 |
+| encodedBodyJson | string | 必须 | — | `encodeURI(JSON.stringify(body))` |
+
+请求体（decoded 后）字段：
+
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| filePath | string | 视场景 | — | 新建必填；编辑不换文件可不传 |
+| label | string | 必须 | — | 标签/名称 |
+| desc | string | 非必须 | `""` | 描述 |
+| id | string | 仅编辑 | `""` | 编辑时传静态资源 id |
+| name | string | 非必须 | 文件名 | 不传则从 `filePath` 推导 |
+| type | string | 非必须 | 文件后缀 | 不传则从文件名推导 |
+
+### 5) 删除静态资源
+
+命令：
+
+```bash
+cc delete staticResource <projectPath> <resourceId>
+```
+
+参数说明：
+
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| projectPath | string | 非必须 | 当前目录 | 项目根目录 |
+| resourceId | string | 必须 | — | 静态资源 id |
+
+### 6) 统计静态资源容量（上传前校验）
+
+命令：
+
+```bash
+cc count staticResource <projectPath> [encodedCondJson]
+```
+
+参数说明：
+
+| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 |
+| :--- | :--- | :--- | :--- | :--- |
+| projectPath | string | 非必须 | 当前目录 | 项目根目录 |
+| encodedCondJson | string | 非必须 | — | 当前实现通常不传，传值时同样为 `encodeURI(JSON.stringify(body))` |
+
+---
+
+## 3. 示例
+
+### 按 label 查询列表
+
+```bash
+cc get staticResource . "$(node -e 'console.log(encodeURI(JSON.stringify({label:\"logo\"})))')"
+```
+
+### 查询容量统计
+
+```bash
+cc count staticResource .
+```
+
+### 新建静态资源（上传文件）
+
+```bash
+cc 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'})))")"
+```
+
+---
+
+## 4. Checklist
+
+- [ ] 已在正确项目目录执行命令（或显式传入 `projectPath`）
+- [ ] 列表查询条件已按 `encodeURI(JSON.stringify(...))` 传入
+- [ ] 删除前已确认资源未被页面/脚本/组件引用
+- [ ] 上传前已先执行容量统计
+

package/src/staticResource/docs/introduction.md

@@ -0,0 +1,3 @@
+# CloudCC 静态资源介绍
+
+TODO

package/src/staticResource/get.js

@@ -0,0 +1,48 @@
+const { getPackageJson } = require("../../utils/config");
+const BaseUrl = "https://developer.apis.cloudcc.cn";
+
+/**
+ * 静态资源 - 查询列表
+ * CLI: cc get staticResource <projectPath> [encodedCondJson]
+ * 参数说明：
+ * - projectPath: 项目根目录，默认 process.cwd()
+ * - encodedCondJson(可选): encodeURI(JSON.stringify(body))
+ * - body: 查询条件对象（可为空 {}），常用字段：label
+ * 请求头说明：
+ * - accessToken: 从 cloudcc-cli.config.js 读取
+ * - source: 默认 cloudcc_cli
+ */
+async function get(projectPath = process.cwd(), encodedCondJson, isMcp = false) {
+    let body = {};
+    if (encodedCondJson) {
+        body = JSON.parse(decodeURI(encodedCondJson));
+    }
+    const config = await getPackageJson(projectPath);
+    const devSvcDispatch = config.devSvcDispatch || "/devconsole";
+    const baseUrl = config.baseUrl || BaseUrl;
+    const res = await fetch(
+        `${baseUrl}${devSvcDispatch}/staticResource/listStaticResource`,
+        {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json; charset=utf-8",
+                accessToken: config.accessToken,
+                source: config.source || "cloudcc_cli",
+            },
+            body: JSON.stringify(body),
+        }
+    );
+    const data = await res.json();
+    if (data && (data.result || String(data.returnCode) === "200" || String(data.returnCode).endsWith("-OK"))) {
+        const list = Array.isArray(data?.data)
+            ? data.data
+            : (data?.data?.objList || data?.data?.list || []);
+        if (!isMcp) {
+            console.log(JSON.stringify(list));
+        }
+        return list;
+    }
+    throw new Error("Get Static Resource Failed: " + (data?.returnInfo || data?.message || "Unknown error"));
+}
+
+module.exports = get;

package/src/staticResource/index.js

@@ -0,0 +1,13 @@
+const cc = {};
+cc.doc = require("./doc");
+cc.create = require("./create");
+cc.get = require("./get");
+cc.detail = require("./detail");
+cc.delete = require("./delete");
+cc.count = require("./count");
+function StaticResource(action, argvs) {
+    cc[action](...argvs.slice(2));
+}
+
+module.exports = StaticResource;
+

package/src/timer/create.js

@@ -4,7 +4,12 @@ const path = require("path")
 const chalk = require("chalk")
 const { getPackageJson } = require("../../utils/config.js")
 
-async function create(name) {
+/**
+ * cc create timer <name>
+ * @param {string[]} argvs
+ */
+async function create(argvs) {
+    const name = argvs[2]
     let res = await checkUpdate();
     if (!res) {
         let config = await getPackageJson();

package/src/timer/delete.js

@@ -0,0 +1,49 @@
+const fs = require("fs");
+const path = require("path");
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+/**
+ * cc delete timer <nameOrId> [projectPath]
+ * @param {string[]} argvs
+ */
+async function remove(argvs) {
+    const nameOrId = argvs[2]
+    const projectPath = argvs[3] != null && argvs[3] !== "" ? argvs[3] : process.cwd()
+    let scheduleId = nameOrId;
+    const schedulePath = path.join(projectPath, `schedule/${nameOrId}/`);
+    const configPath = path.join(schedulePath, "config.json");
+
+    if (fs.existsSync(configPath)) {
+        const configContent = JSON.parse(fs.readFileSync(configPath, "utf8"));
+        if (configContent.id) {
+            scheduleId = configContent.id;
+        }
+    }
+
+    if (!scheduleId) {
+        throw new Error("Delete Schedule Failed: schedule name or id is required");
+    }
+
+    const config = await getPackageJson(projectPath);
+    console.error();
+    console.error(chalk.green(`Deleting schedule (${scheduleId}), please wait...`));
+    console.error();
+
+    const res = await postClass(
+        config.setupSvc + "/api/ccPeak/delete",
+        { id: scheduleId },
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        console.error(chalk.green("Success! Schedule deleted."));
+        console.error();
+        return res;
+    }
+    const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    throw new Error("Delete Schedule Failed: " + msg);
+}
+
+module.exports = remove;

package/src/timer/detail.js

@@ -5,12 +5,12 @@ const { getPackageJson } = require("../../utils/config")
 const { postClass } = require("../../utils/http")
 
 /**
- * 获取定时类详细信息
- * @param {string} name - 定时类名称（优先从本地查询）
- * @param {string} id - 定时类ID（当没有name时从服务器查询）
- * @returns {Object} 定时类详细信息
+ * cc detail timer <name> <id>
+ * @param {string[]} argvs
  */
-async function detail(name, id) {
+async function detail(argvs) {
+    const name = argvs[2]
+    const id = argvs[3]
     // 如果有 name，优先查询本地
     if (name && name !== '') {
         const schedulePath = path.join(process.cwd(), `schedule/${name}/`);

package/src/timer/doc.js

@@ -0,0 +1,57 @@
+/**
+ * timer（定时类）文档入口：正文均在 `docs/` 目录。
+ */
+const fs = require("fs");
+const path = require("path");
+
+const DOCS_DIR = path.join(__dirname, "docs");
+const BACKEND_SDK_JAVA = path.join(__dirname, "..", "api", "backend-sdk-java.md");
+
+function readDocFile(basename) {
+    return fs.readFileSync(path.join(DOCS_DIR, `${basename}.md`), "utf8");
+}
+
+/** 介绍文档：定时类概念、能力与典型场景 */
+function getIntroductionDoc() {
+    return readDocFile("introduction");
+}
+
+/** 开发指导：定时作业/定时类实践；末尾拼接后端 Java SDK 速查 */
+function getDevGuideDoc() {
+    const base = readDocFile("devguide").trimEnd();
+    let sdk = "";
+    try {
+        sdk = fs.readFileSync(BACKEND_SDK_JAVA, "utf8").trim();
+    } catch (e) {
+        sdk = "";
+    }
+    if (!sdk) {
+        return base;
+    }
+    return [base, "", "---", "", "## 附录：后端 SDK（Java）速查", "", sdk, ""].join("\n");
+}
+
+/**
+ * cc doc timer <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 timer 需要子命令：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/timer/get.js

@@ -1,7 +1,13 @@
 const { getPackageJson } = require("../../utils/config")
 const { postClass } = require("../../utils/http")
 
-async function get(arg1, arg2, isMcp = false) {
+/**
+ * cc get timer [listQueryJson] [projectPath]
+ * @param {string[]} argvs
+ */
+async function get(argvs, isMcp = false) {
+    const arg1 = argvs[2]
+    const arg2 = argvs[3]
     let body = arg1 != null && arg1 != '' ? JSON.parse(decodeURI(arg1)) : { shownum: "2000", showpage: "1", fid: "", sname: '', rptcond: '', rptorder: '' }
     let config = await getPackageJson(arg2);
     let res = await postClass(config.setupSvc + "/api/ccPeak/list", body, config.accessToken)

package/src/timer/index.js

@@ -5,8 +5,11 @@ cc.pull = require("./pull")
 cc.get = require("./get")
 cc.pullList = require("./pullList")
 cc.detail = require("./detail")
+cc.delete = require("./delete")
+cc.doc = require("./doc")
+
 function Timer(action, argvs) {
-  cc[action](argvs[2], argvs[3])
+  cc[action](argvs)
 }
 
 module.exports = Timer;

package/src/timer/publish.js

@@ -7,7 +7,12 @@ const { javaContentRegular } = require("../../utils/utils")
 
 const { getPackageJson } = require("../../utils/config")
 const { postClass } = require("../../utils/http")
-async function publish(name) {
+/**
+ * cc publish timer <name>
+ * @param {string[]} argvs
+ */
+async function publish(argvs) {
+  const name = argvs[2]
   let res = await checkUpdate();
   if (!res) {
     console.error();

package/src/timer/pull.js

@@ -8,7 +8,12 @@ const { javaContentRegular } = require("../../utils/utils")
 const { getPackageJson } = require("../../utils/config")
 const { postClass } = require("../../utils/http")
 
-async function pull(name) {
+/**
+ * cc pull timer <name>
+ * @param {string[]} argvs
+ */
+async function pull(argvs) {
+  const name = argvs[2]
   let res = await checkUpdate();
   if (!res) {
     console.error();

package/src/timer/pullList.js

@@ -4,10 +4,12 @@ const { getPackageJson } = require("../../utils/config");
 const { postClass } = require("../../utils/http");
 
 /**
- * 批量拉取定时器详情并生成本地文件
- * @param timer id
+ * cc pullList timer <id> <projectPath>
+ * @param {string[]} argvs
  */
-async function pullList(arg1, arg2, isMcp = false) {
+async function pullList(argvs, isMcp = false) {
+    const arg1 = argvs[2]
+    const arg2 = argvs[3]
     const body = { id: arg1 };
     let config = await getPackageJson(arg2);
     const res = await postClass(config.setupSvc + "/api/ccPeak/detail", body, config.accessToken);

package/src/triggers/delete.js

@@ -0,0 +1,46 @@
+const fs = require("fs");
+const path = require("path");
+const chalk = require("chalk");
+const { getPackageJson } = require("../../utils/config");
+const { postClass } = require("../../utils/http");
+
+async function remove(argvs) {
+    const namePathOrId = argvs[2];
+    const projectPath = argvs[3] || process.cwd();
+
+    if (!namePathOrId) {
+        throw new Error("Delete Trigger Failed: trigger namePath or id is required");
+    }
+
+    let triggerId = namePathOrId;
+    const triggerPath = path.join(projectPath, `triggers/${namePathOrId}/`);
+    const configPath = path.join(triggerPath, "config.json");
+
+    if (fs.existsSync(configPath)) {
+        const configContent = JSON.parse(fs.readFileSync(configPath, "utf8"));
+        if (configContent.id) {
+            triggerId = configContent.id;
+        }
+    }
+
+    const config = await getPackageJson(projectPath);
+    console.error();
+    console.error(chalk.green(`Deleting trigger (${triggerId}), please wait...`));
+    console.error();
+
+    const res = await postClass(
+        config.setupSvc + "/api/triggerSetup/deleteTrigger",
+        { id: triggerId },
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        console.error(chalk.green("Success! Trigger deleted."));
+        console.error();
+        return res;
+    }
+    const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    throw new Error("Delete Trigger Failed: " + msg);
+}
+
+module.exports = remove;

package/src/triggers/detail.js

@@ -5,12 +5,12 @@ const { getPackageJson } = require("../../utils/config")
 const { postClass } = require("../../utils/http")
 
 /**
- * 获取触发器详细信息
- * @param {string} namePath - 触发器路径 "objectName/triggerName"（优先从本地查询）
- * @param {string} id - 触发器ID（当没有namePath时从服务器查询）
- * @returns {Object} 触发器详细信息
+ * cc detail triggers <namePath> <id>
+ * @param {string[]} argvs [detail, type, namePath?, id?]
  */
-async function detail(namePath, id) {
+async function detail(argvs) {
+    const namePath = argvs[2]
+    const id = argvs[3]
     // 如果有 namePath，优先查询本地
     if (namePath && namePath !== '') {
         const triggerPath = path.join(process.cwd(), `triggers/${namePath}/`);