@xqyz/xq-cli 0.1.3 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,85 @@
+# 版本迭代日志
+
+本项目遵循 [Semantic Versioning](https://semver.org/lang/zh-CN/)：
+
+- `MAJOR`：存在不兼容变更。
+- `MINOR`：向后兼容的新功能。
+- `PATCH`：向后兼容的修复或维护更新。
+
+发布日期以 npm 官方仓库记录为准。发布前必须先更新本文件，再执行版本发布。
+
+## [Unreleased]
+
+## [0.2.1] - 2026-08-11
+
+### 安全性
+
+- 将 Axios 升级到 `1.19.0`、Form Data 升级到 `4.0.6`，消除旧版 HTTP 与文件上传依赖的已知高危漏洞，保持现有 CLI 命令和参数兼容。
+
+## [0.2.0] - 2026-08-10
+
+### 新增
+
+- 新增 `xq-cli directory view --cid <cid>`，通过只读目录树接口查看大纲续写后的完整目录。
+- 支持完整目录的递归编号展示、节点统计、`--json` 结构化输出和 `--out <path>` UTF-8 JSON 导出。
+- 新增 `xq-cli gallery-status`，调用与最新喜鹊前端一致的图库列表接口。
+- 结构化返回 `available` 和 `totalRecords`，供 WorkBuddy 在展示“我的图库”前判断是否可选。
+
+### 文档
+
+- 建立正式版本迭代日志。
+- 增加 npm 发布、验证、清理和故障处理手册。
+- 更新 CLI 帮助、README 和 OpenCLI 使用说明。
+
+### 维护
+
+- 规范 npm `bin` 入口路径，避免发布时由 npm 自动纠正清单。
+- 增加完整目录格式化与只读 API 集成测试。
+
+## [0.1.3] - 2026-08-07
+
+### 新增
+
+- 新增 `xq-cli outline view --cid <cid>`，只读查看已有大纲，不会重新触发大纲生成。
+- 支持通过 `--json` 返回完整大纲数据。
+- 支持通过 `--out <path>` 导出可编辑的大纲 JSON。
+- 新增 `xq-cli outline update --cid <cid> --file <file>`，从完整 JSON 文件更新大纲。
+- 支持修改章节标题、主题、重点程度和章节顺序，以及新增、删除章节。
+- 新增 `--dry-run`，在写入后台前展示新增、修改、删除、排序和重点程度差异。
+
+### 安全性
+
+- 自动校验编辑文件中的任务 CID、章节 ID、重复 ID 和必填字段。
+- 自动根据服务端当前大纲计算 `updateFlag`。
+- 非交互环境必须传入 `--yes` 才能保存修改。
+- 删除已有章节必须额外传入 `--allow-delete`。
+
+### 测试与文档
+
+- 增加大纲差异处理单元测试和模拟 API 集成测试，共 7 项。
+- 更新 CLI 帮助、README 和 OpenCLI 使用说明。
+
+## [0.1.2] - 2026-04-28
+
+### 变更
+
+- 默认使用生产 API 地址 `https://ai.bidfile.qianlima.com/api`。
+- 首次使用可直接执行 `xq-cli login`，不再要求每次显式提供 `--base-url`。
+- 完善本地配置读取与默认值合并，兼容旧配置和配置文件异常场景。
+- 更新生产环境和测试环境登录示例。
+
+## [0.1.1] - 2026-04-27
+
+### 变更
+
+- 增加 npm 官方仓库安装和全局升级说明。
+- 将登录示例从本地地址调整为生产环境地址。
+- 清理示例中的真实账号信息，改为通用占位符。
+
+## [0.1.0] - 2026-04-27
+
+### 新增
+
+- `@xqyz/xq-cli` 首次公开发布。
+- 提供登录、任务初始化、文件解析、大纲生成、正文生成、状态查询和 Word 导出能力。
+- 提供 `wizard` 全流程向导和生成配置选项查询。

package/README.md

@@ -4,6 +4,11 @@ Standalone CLI project for xique brand task workflows.
 
 Project execution rules for agents live in [AGENTS.md](./AGENTS.md). That file defines the mandatory config-confirmation flow before any bid generation run.
 
+Project maintenance documents:
+
+- [Version changelog](./CHANGELOG.md)
+- [Release process](./docs/RELEASING.md)
+
 ## Install from npm
 
 Install the published package from the public npm registry:
@@ -40,7 +45,7 @@ npm pack
 That command produces a `.tgz` tarball which can be shared and installed with:
 
 ```bash
-npm install -g .\xqyz-xq-cli-0.1.3.tgz
+npm install -g .\xqyz-xq-cli-0.2.0.tgz
 ```
 
 ## Usage
@@ -58,6 +63,9 @@ xq-cli outline view --cid <cid>
 xq-cli outline view --cid <cid> --out D:\output\outline.json
 xq-cli outline update --cid <cid> --file D:\output\outline.json --dry-run --json
 xq-cli outline update --cid <cid> --file D:\output\outline.json --yes
+xq-cli directory view --cid <cid>
+xq-cli directory view --cid <cid> --out D:\output\directory.json
+xq-cli gallery-status --json
 xq-cli write --cid <cid> --wait
 xq-cli status --cid <cid> --content --json
 xq-cli export --cid <cid> --interactive --out D:\output
@@ -68,6 +76,13 @@ Fresh installs default to the production API address `https://ai.bidfile.qianlim
 
 `login` now defaults to browser authorization. If you explicitly pass `--name` and `--password`, the CLI falls back to password login.
 
+`directory view` reads the complete generated directory tree without triggering outline, directory, or content generation. Add `--json` for the raw API structure, or `--out <file-or-directory>` to save a UTF-8 JSON document.
+
+`gallery-status` checks the same `/image/library/query` endpoint as the latest
+frontend. `available=true` means “我的图库” contains at least one image and may
+be enabled for generation; an empty gallery remains unavailable until the user
+uploads an image in the Xique frontend.
+
 When `outline --wait` or `write --wait` hits a required response-basis step, the CLI will pause and ask you to choose `0/1/2` before continuing. It no longer auto-selects a default when you just press Enter.
 
 `write --wait` now also retries `sequelForOutline` when the directory phase stalls at the outline-complete step, and auto-calls `generateAllUnfinished` if the backend reports `100%` but still leaves unfinished chapters behind.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xqyz/xq-cli",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "description": "CLI for xique bid-book task workflows",
   "type": "module",
   "scripts": {
@@ -8,18 +8,19 @@
     "test": "node --test"
   },
   "bin": {
-    "xq-cli": "./bin/xq-cli.js"
+    "xq-cli": "bin/xq-cli.js"
   },
   "files": [
     "bin",
     "src",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=18"
   },
   "dependencies": {
-    "axios": "^0.27.2",
-    "form-data": "^4.0.4"
+    "axios": "^1.19.0",
+    "form-data": "^4.0.6"
   }
 }

package/src/cli.mjs

@@ -19,6 +19,10 @@ import {
     formatOutlineLines,
     prepareOutlineUpdate,
 } from './outline-edit.mjs';
+import {
+    buildDirectoryViewDocument,
+    formatDirectoryLines,
+} from './directory-view.mjs';
 
 const APP_DIR = path.join(os.homedir(), '.xq-opencli');
 const CONFIG_FILE = path.join(APP_DIR, 'config.json');
@@ -349,6 +353,16 @@ async function main() {
         case 'outline-update':
             await handleOutlineUpdate(parsed, state);
             return;
+        case 'directory':
+            if (!parsed._[1] || isOutlineAction(parsed, ['view', 'show'])) {
+                await handleDirectoryView(parsed, state);
+            } else {
+                throw new Error(`Unknown directory action: ${parsed._[1]}`);
+            }
+            return;
+        case 'directory-view':
+            await handleDirectoryView(parsed, state);
+            return;
         case 'write':
             await handleWrite(parsed, state);
             return;
@@ -361,6 +375,9 @@ async function main() {
         case 'choices':
             handleChoices(parsed);
             return;
+        case 'gallery-status':
+            await handleGalleryStatus(parsed, state);
+            return;
         case 'wizard':
             await handleWizard(parsed, state);
             return;
@@ -380,9 +397,11 @@ Commands
   outline       Pre-set task params and trigger outline generation
   outline view  View the current outline without triggering generation
   outline update Update the current outline from an edited JSON file
+  directory view View the complete generated directory tree without triggering generation
   write         Charge if needed, enter content phase, and trigger content generation
   status        Query task status
   choices       Print selectable outline/export config values
+  gallery-status Check whether My Gallery contains selectable images
   wizard        Run init -> outline -> write -> export with interactive menus
   export        Download the generated docx
 
@@ -394,6 +413,7 @@ Examples
   xq-cli parse-status --cid <cid> --uuid <uuid> --wait
   xq-cli choices
   xq-cli choices outline --json
+  xq-cli gallery-status --json
   xq-cli wizard
   xq-cli wizard --file D:\\bids\\tender.docx
   xq-cli outline --cid <cid> --wait
@@ -407,6 +427,8 @@ Examples
   xq-cli outline view --cid <cid> --out D:\\output\\outline.json
   xq-cli outline update --cid <cid> --file D:\\output\\outline.json --dry-run --json
   xq-cli outline update --cid <cid> --file D:\\output\\outline.json --yes
+  xq-cli directory view --cid <cid>
+  xq-cli directory view --cid <cid> --out D:\\output\\directory.json
   xq-cli write --cid <cid> --type 1 --wait
   xq-cli status --cid <cid> --content
   xq-cli export --cid <cid> --interactive --out D:\\output\\
@@ -665,6 +687,29 @@ function handleChoices(args) {
     return payload;
 }
 
+async function handleGalleryStatus(args, state) {
+    const client = createAuthorizedClient(args, state);
+    const response = await postJson(client, '/image/library/query', {
+        pageSize: 1,
+        pageNum: 1,
+    });
+    const rawTotal = Number(response?.data?.pageModel?.totalRecords ?? 0);
+    const totalRecords = Number.isFinite(rawTotal) && rawTotal > 0 ? rawTotal : 0;
+    const resultPayload = {
+        command: 'gallery-status',
+        available: totalRecords > 0,
+        totalRecords,
+    };
+    outputResult(args, resultPayload, [
+        `my gallery: ${resultPayload.available ? 'available' : 'unavailable'}`,
+        `totalRecords: ${totalRecords}`,
+        resultPayload.available
+            ? 'knowledge-img can be enabled.'
+            : 'upload at least one image in the Xique frontend before enabling knowledge-img.',
+    ]);
+    return resultPayload;
+}
+
 async function handleWizard(args, state) {
     const wizardArgs = await collectWizardArgs(args, state);
     writeNotice(args, `wizard config: ${buildWizardSummary(wizardArgs)}`);
@@ -903,6 +948,35 @@ async function handleOutlineUpdate(args, state) {
     return resultPayload;
 }
 
+async function handleDirectoryView(args, state) {
+    const client = createAuthorizedClient(args, state);
+    const cid = resolveCid(args, state);
+    const response = await getJson(
+        client,
+        `/task/directory/tree/${encodeURIComponent(cid)}`,
+        {},
+        { retries: DEFAULT_RETRY_COUNT },
+    );
+    const directoryDetail = response?.data || {};
+    const directoryDocument = buildDirectoryViewDocument(cid, directoryDetail);
+    const savedPath = stringOption(args, 'out')
+        ? writeDirectoryViewFile(stringOption(args, 'out'), cid, directoryDocument)
+        : null;
+
+    const resultPayload = {
+        command: 'directory-view',
+        cid,
+        directoryDetail,
+        directoryDocument: savedPath ? directoryDocument : undefined,
+        savedPath,
+    };
+    outputResult(args, resultPayload, [
+        ...formatDirectoryLines(cid, directoryDetail),
+        savedPath ? `savedPath: ${savedPath}` : 'hint: pass --out <file-or-directory> to save the complete directory JSON.',
+    ]);
+    return resultPayload;
+}
+
 async function confirmOutlineUpdate(args, cid, diff) {
     if (!supportsInteractivePrompt()) {
         throw new Error('Outline update changes server data. Review it with --dry-run, then rerun with --yes.');
@@ -940,6 +1014,16 @@ function writeOutlineEditFile(outputOption, cid, document) {
     return finalPath;
 }
 
+function writeDirectoryViewFile(outputOption, cid, document) {
+    const resolvedOutput = path.resolve(outputOption);
+    const outputIsDirectory = !path.extname(resolvedOutput);
+    const defaultName = `directory-${normalizeDownloadFileName(cid) || 'task'}.json`;
+    const finalPath = outputIsDirectory ? path.join(resolvedOutput, defaultName) : resolvedOutput;
+    fs.mkdirSync(path.dirname(finalPath), { recursive: true });
+    fs.writeFileSync(finalPath, `${JSON.stringify(document, null, 2)}\n`, 'utf8');
+    return finalPath;
+}
+
 async function handleWrite(args, state) {
     const client = createAuthorizedClient(args, state);
     const cid = resolveCid(args, state);

package/src/directory-view.mjs

@@ -0,0 +1,89 @@
+export function extractDirectoryNodes(document = {}) {
+    const candidates = [
+        document,
+        document?.directoryNodes,
+        document?.data?.directoryNodes,
+        document?.directoryDetail?.directoryNodes,
+        document?.contentDetail?.directoryNodes,
+    ];
+    for (const candidate of candidates) {
+        if (Array.isArray(candidate)) {
+            return candidate;
+        }
+    }
+    return [];
+}
+
+export function buildDirectoryViewDocument(cid, directoryDetail = {}) {
+    const detail = directoryDetail && typeof directoryDetail === 'object' && !Array.isArray(directoryDetail)
+        ? directoryDetail
+        : {};
+    return {
+        format: 'xq-cli-directory@1',
+        ...detail,
+        cid,
+        directoryNodes: extractDirectoryNodes(detail),
+    };
+}
+
+export function getDirectoryStats(document = {}) {
+    const roots = extractDirectoryNodes(document);
+    let nodes = 0;
+    let maxDepth = 0;
+
+    function visit(rows, depth) {
+        for (const row of rows) {
+            nodes += 1;
+            maxDepth = Math.max(maxDepth, depth);
+            const children = Array.isArray(row?.children) ? row.children : [];
+            visit(children, depth + 1);
+        }
+    }
+
+    visit(roots, 1);
+    return {
+        roots: roots.length,
+        nodes,
+        maxDepth,
+    };
+}
+
+export function formatDirectoryLines(cid, directoryDetail = {}) {
+    const roots = extractDirectoryNodes(directoryDetail);
+    const stats = getDirectoryStats(roots);
+    const lines = [
+        `directory: cid=${cid}`,
+        `title: ${normalizeText(directoryDetail?.title) || '-'}`,
+        `task_status: ${directoryDetail?.task_status ?? '-'}`,
+        `roots: ${stats.roots}`,
+        `nodes: ${stats.nodes}`,
+        `max_depth: ${stats.maxDepth}`,
+    ];
+
+    if (roots.length === 0) {
+        lines.push('directory tree: empty');
+        return lines;
+    }
+
+    lines.push('directory tree:');
+    appendDirectoryRows(lines, roots);
+    return lines;
+}
+
+function appendDirectoryRows(lines, rows, prefix = [], depth = 0) {
+    rows.forEach((row, index) => {
+        const position = [...prefix, index + 1];
+        const text = normalizeText(row?.text || row?.title || row?.name) || '(unnamed directory)';
+        const id = normalizeText(row?.id);
+        lines.push(`${'  '.repeat(depth)}${position.join('.')}. ${text}${id ? ` [id=${id}]` : ''}`);
+        const children = Array.isArray(row?.children) ? row.children : [];
+        appendDirectoryRows(lines, children, position, depth + 1);
+    });
+}
+
+function normalizeText(value) {
+    if (value === undefined || value === null) {
+        return '';
+    }
+    return String(value).trim();
+}