@cnbcool/cnb-api-generate 1.2.3 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/client/index.ts CHANGED
@@ -5,6 +5,7 @@ import path from 'path';
5
5
  import { showModuleHelp } from './modules.help';
6
6
  import { showToolHelp } from './tools.help';
7
7
  import { showShort, resolveShortcut, summarizeResponse } from './shortcuts';
8
+ import { handleUpload } from './utils/upload';
8
9
 
9
10
  const helpFileContent = fs.readFileSync(
10
11
  path.join(__dirname, 'help.json'),
@@ -182,7 +183,6 @@ function formatParams(
182
183
  if (params.help) formatted.help = true;
183
184
  if (params.short) formatted.short = true;
184
185
  if (params.verbose) formatted.verbose = true;
185
- if (params.summary) formatted.summary = true;
186
186
 
187
187
  // 旧格式兼容:--path / --query / --data 是 JSON 字符串
188
188
  if (typeof params.path === 'string') {
@@ -205,7 +205,7 @@ function formatParams(
205
205
  const pathDef = paramDefs.path || {};
206
206
  const queryDef = paramDefs.query || {};
207
207
  const reservedKeys = new Set([
208
- 'module', 'tool', 'help', 'short', 'verbose', 'summary',
208
+ 'module', 'tool', 'help', 'short', 'verbose',
209
209
  'path', 'query', 'data', 'h', 'v',
210
210
  ]);
211
211
 
@@ -288,8 +288,8 @@ function isStandardResponse(response: any): boolean {
288
288
  /**
289
289
  * 格式化 CLI 输出
290
290
  * - verbose 模式:完整 JSON(含 trace、header 等全部字段)
291
- * - summary 模式:只输出核心摘要字段(需要 --summary 显式指定)
292
- * - 默认:精简 JSON(去掉 trace、header,保留完整 data)
291
+ * - 快捷命令默认:只输出核心摘要字段
292
+ * - 非快捷命令默认:精简 JSON(去掉 trace、header,保留完整 data)
293
293
  * @param response 原始响应
294
294
  * @param verbose 是否 verbose 模式
295
295
  * @param summary 是否 summary 模式
@@ -315,7 +315,7 @@ function formatOutput(response: any, verbose: boolean, summary: boolean, toolKey
315
315
  // 精简响应
316
316
  const compact = compactResponse(response);
317
317
 
318
- // --summary 模式:对特定 tool 应用摘要提取(仅成功响应)
318
+ // summary 模式:对特定 tool 应用摘要提取(仅成功响应)
319
319
  if (summary && compact.status >= 200 && compact.status < 300) {
320
320
  const summarized = summarizeResponse(compact.data, toolKey);
321
321
  if (summarized !== null) {
@@ -370,7 +370,7 @@ ${lines.join('\n')}
370
370
  <tool> 工具名称 (如: list-issues, get-issue)
371
371
  --key value 路径或查询参数,CLI 自动识别归类
372
372
  --data 'JSON' 请求体参数,JSON 字符串
373
- --verbose 输出完整响应(含 trace、header
373
+ --verbose 输出完整原始响应(含 trace、header 等全部字段)
374
374
  --help 显示帮助文档
375
375
  --short 显示当前仓库的快捷命令
376
376
 
@@ -402,31 +402,13 @@ async function main() {
402
402
  params.tool as string | undefined,
403
403
  );
404
404
  if (shortcut) {
405
+ params.module = shortcut.module;
405
406
  params.tool = shortcut.tool;
406
407
 
407
- // 自动注入 path 参数(兼容新旧格式)
408
- // 新格式:用户可能直接传了 --repo xxx,检查扁平参数是否已存在
409
- const autoPathKeys = Object.keys(shortcut.autoPath);
410
- const hasPathAlready = params.path || autoPathKeys.some(k => params[k]);
411
-
412
- if (!hasPathAlready) {
413
- if (autoPathKeys.length > 0) {
414
- // 新格式:直接注入为扁平参数
415
- for (const [key, value] of Object.entries(shortcut.autoPath)) {
416
- if (!params[key]) {
417
- params[key] = value;
418
- }
419
- }
420
- } else {
421
- const envHint =
422
- params.module === 'issues'
423
- ? 'CNB_REPO_SLUG 和 CNB_ISSUE_IID'
424
- : 'CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID';
425
- console.error(
426
- `快捷命令需要环境变量 ${envHint},或手动传参数。\n` +
427
- `提示:运行 ${process.env.CNB_CLI_CMD || 'cnb'} --short 查看快捷命令详情。`,
428
- );
429
- process.exit(1);
408
+ // 自动注入 path 参数
409
+ for (const [key, value] of Object.entries(shortcut.autoPath)) {
410
+ if (!params[key]) {
411
+ params[key] = value;
430
412
  }
431
413
  }
432
414
 
@@ -513,13 +495,21 @@ async function main() {
513
495
  toolsParam.push(pathAndQueryParams);
514
496
  }
515
497
 
516
- if (formattedParams.data) {
517
- toolsParam.push(formattedParams.data);
498
+ // 上传快捷命令:走完整上传流程(获取 URL → PUT 文件 → 返回结果)
499
+ let data: any;
500
+ if (shortcut?.upload) {
501
+ data = await handleUpload(shortcut, formattedParams.data?.file, toolFunction, pathAndQueryParams);
502
+ } else {
503
+ if (formattedParams.data) {
504
+ toolsParam.push(formattedParams.data);
505
+ }
506
+ data = await toolFunction(...toolsParam);
518
507
  }
519
-
520
- const data = await toolFunction(...toolsParam);
521
508
  const toolKey = `${formattedParams.module}/${formattedParams.tool}`;
522
- console.log(formatOutput(data, !!formattedParams.verbose, !!formattedParams.summary, toolKey));
509
+ // 快捷命令默认输出摘要,--verbose 时输出全部信息
510
+ const isVerbose = !!formattedParams.verbose;
511
+ const isSummary = shortcut ? !isVerbose : false;
512
+ console.log(formatOutput(data, isVerbose, isSummary, toolKey));
523
513
  }
524
514
 
525
515
  main();
@@ -24,11 +24,16 @@ export function showModuleHelp(helpData: any, moduleName: string): void {
24
24
 
25
25
  const cliCmd = process.env.CNB_CLI_CMD || 'cnb';
26
26
 
27
+ const entries = Object.values(moduleHelpData).map((info: any) => ({
28
+ name: info.filename as string,
29
+ summary: trimSummary(info.summary || ''),
30
+ }));
31
+ const maxNameLen = Math.max(...entries.map((e) => e.name.length));
32
+ const pad = maxNameLen + 2;
33
+
27
34
  let toolListMsg = '';
28
- for (const [, info] of Object.entries(moduleHelpData)) {
29
- const name = (info as any).filename;
30
- const summary = (info as any).summary;
31
- toolListMsg += ` ${name.padEnd(30)} ${summary}\n`;
35
+ for (const { name, summary } of entries) {
36
+ toolListMsg += ` ${name.padEnd(pad)} ${summary}\n`;
32
37
  }
33
38
 
34
39
  const helpMsg = `
@@ -16,21 +16,29 @@ export interface ShortcutDefinition {
16
16
  shortName: string;
17
17
  /** 实际对应的 tool 文件名 */
18
18
  realTool: string;
19
+ /** 为 true 时只注入 repo,不注入 number */
20
+ repoOnly?: boolean;
21
+ /** 为 true 时表示是上传命令,走完整上传流程 */
22
+ upload?: boolean;
19
23
  /** 显示用的中文说明 */
20
24
  description: string;
21
- /** 是否需要用户传 --data,如果不为 null 则自动注入 */
25
+ /** 自动注入的 data 参数(如 close/open 的状态值) */
22
26
  autoData?: Record<string, any>;
23
27
  /** --data 的使用提示(展示用) */
24
28
  dataTip?: string;
25
29
  }
26
30
 
27
31
  export interface ResolvedShortcut {
32
+ /** 所属模块名 */
33
+ module: string;
28
34
  /** 解析后的实际 tool 名 */
29
35
  tool: string;
30
36
  /** 自动注入的 path 参数 */
31
37
  autoPath: Record<string, string>;
32
38
  /** 自动注入的 data 参数(如 close/open) */
33
39
  autoData: Record<string, any> | null;
40
+ /** 是否为上传命令 */
41
+ upload: boolean;
34
42
  }
35
43
 
36
44
  // ============================================================
@@ -69,6 +77,8 @@ const ISSUE_SHORTCUTS: ShortcutDefinition[] = [
69
77
  { shortName: 'add-labels', realTool: 'post-issue-labels', description: '添加标签', dataTip: "--data '{\"labels\":[\"bug\",\"feature\"]}'" },
70
78
  { shortName: 'list-assignees', realTool: 'list-issue-assignees', description: '查看处理人' },
71
79
  { shortName: 'add-assignees', realTool: 'post-issue-assignees', description: '添加处理人', dataTip: "--data '{\"assignees\":[\"username\"]}'" },
80
+ { shortName: 'upload-file', realTool: 'post-issue-file-asset-upload-url', description: '上传文件', upload: true, dataTip: "--data '{\"file\":\"文件路径\"}'" },
81
+ { shortName: 'upload-image', realTool: 'post-issue-image-asset-upload-url', description: '上传图片', upload: true, dataTip: "--data '{\"file\":\"图片路径\"}'" },
72
82
  ];
73
83
 
74
84
  const PR_SHORTCUTS: ShortcutDefinition[] = [
@@ -82,22 +92,60 @@ const PR_SHORTCUTS: ShortcutDefinition[] = [
82
92
  { shortName: 'check-status', realTool: 'list-pull-commit-statuses', description: '查看 CI 状态' },
83
93
  { shortName: 'list-reviews', realTool: 'list-pull-reviews', description: '查看评审列表' },
84
94
  { shortName: 'list-assignees', realTool: 'list-pull-assignees', description: '查看处理人' },
95
+ { shortName: 'upload-file', realTool: 'upload-files', description: '上传文件', repoOnly: true, upload: true, dataTip: "--data '{\"file\":\"文件路径\"}'" },
96
+ { shortName: 'upload-image', realTool: 'upload-imgs', description: '上传图片', repoOnly: true, upload: true, dataTip: "--data '{\"file\":\"图片路径\"}'" },
85
97
  ];
86
98
 
87
99
  // ============================================================
88
100
  // --short 帮助输出
89
101
  // ============================================================
90
102
 
103
+ /** 计算字符串的显示宽度(中文/全角占2,英文/半角占1) */
104
+ function displayWidth(str: string): number {
105
+ let width = 0;
106
+ for (const ch of str) {
107
+ const code = ch.codePointAt(0) || 0;
108
+ // CJK、全角字符占2宽度
109
+ width += (code >= 0x1100 && (
110
+ code <= 0x115f || code === 0x2329 || code === 0x232a ||
111
+ (code >= 0x2e80 && code <= 0x3247) ||
112
+ (code >= 0x3250 && code <= 0x4dbf) ||
113
+ (code >= 0x4e00 && code <= 0xa4c6) ||
114
+ (code >= 0xa960 && code <= 0xa97c) ||
115
+ (code >= 0xac00 && code <= 0xd7a3) ||
116
+ (code >= 0xf900 && code <= 0xfaff) ||
117
+ (code >= 0xfe10 && code <= 0xfe19) ||
118
+ (code >= 0xfe30 && code <= 0xfe6b) ||
119
+ (code >= 0xff01 && code <= 0xff60) ||
120
+ (code >= 0xffe0 && code <= 0xffe6) ||
121
+ (code >= 0x1f000 && code <= 0x1fbff) ||
122
+ (code >= 0x20000 && code <= 0x2fffd) ||
123
+ (code >= 0x30000 && code <= 0x3fffd)
124
+ )) ? 2 : 1;
125
+ }
126
+ return width;
127
+ }
128
+
129
+ /** 用全角空格将字符串补齐到指定显示宽度 */
130
+ function padToWidth(str: string, targetWidth: number): string {
131
+ const diff = targetWidth - displayWidth(str);
132
+ if (diff <= 0) return str;
133
+ // 每个全角空格占2宽度
134
+ const fullSpaces = Math.floor(diff / 2);
135
+ const halfSpace = diff % 2 === 1 ? ' ' : '';
136
+ return str + ' '.repeat(fullSpaces) + halfSpace;
137
+ }
138
+
91
139
  function formatShortcutList(
92
140
  shortcuts: ShortcutDefinition[],
93
141
  cliCmd: string,
94
142
  moduleName: string,
95
143
  ): string {
96
- const maxDescLen = Math.max(...shortcuts.map((s) => s.description.length));
144
+ const maxWidth = Math.max(...shortcuts.map((s) => displayWidth(s.description)));
97
145
 
98
146
  return shortcuts
99
147
  .map((s) => {
100
- const desc = s.description.padEnd(maxDescLen + 2, ' '); // 全角空格对齐
148
+ const desc = padToWidth(s.description, maxWidth + 2);
101
149
  const cmd = `${cliCmd} ${moduleName} ${s.shortName}`;
102
150
  const dataPart = s.dataTip ? ` ${s.dataTip}` : '';
103
151
  return ` ${desc} ${cmd}${dataPart}`;
@@ -110,52 +158,48 @@ export function showShort(): void {
110
158
  const cliCmd = process.env.CNB_CLI_CMD || 'cnb';
111
159
  const repo = getRepo();
112
160
 
113
- if (ctx === 'issue') {
114
- const number = getIssueNumber();
115
- const list = formatShortcutList(ISSUE_SHORTCUTS, cliCmd, 'issues');
116
- console.log(`
117
- 📋 当前场景: Issue 事件 (Issue #${number})
118
- 仓库: ${repo}
161
+ if (ctx === 'issue' || ctx === 'pull_request') {
162
+ const isIssue = ctx === 'issue';
163
+ const number = isIssue ? getIssueNumber() : getPRNumber();
164
+ const emoji = isIssue ? '📋' : '🔀';
165
+ const label = isIssue ? 'Issue' : 'Pull Request';
166
+ const tag = isIssue ? 'Issue' : 'PR';
167
+ const moduleName = isIssue ? 'issues' : 'pulls';
168
+ const shortcuts = isIssue ? ISSUE_SHORTCUTS : PR_SHORTCUTS;
169
+ const envVars = isIssue
170
+ ? 'CNB_REPO_SLUG 和 CNB_ISSUE_IID'
171
+ : 'CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID';
172
+ const list = formatShortcutList(shortcuts, cliCmd, moduleName);
119
173
 
120
- 常用快捷命令(path 参数已从环境变量自动获取):
121
- ${list}
122
-
123
- 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_ISSUE_IID,无需手动传 --path
124
- 添加 --summary 可只输出核心摘要字段
125
- `);
126
- } else if (ctx === 'pull_request') {
127
- const number = getPRNumber();
128
- const list = formatShortcutList(PR_SHORTCUTS, cliCmd, 'pulls');
129
174
  console.log(`
130
- 🔀 当前场景: Pull Request 事件 (PR #${number})
175
+ ${emoji} 当前场景: ${label} 事件 (${tag} #${number})
131
176
  仓库: ${repo}
132
177
 
133
178
  常用快捷命令(path 参数已从环境变量自动获取):
134
179
  ${list}
135
180
 
136
- 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID,无需手动传 --path
137
- 添加 --summary 可只输出核心摘要字段
181
+ 提示: ${tag} 相关命令会自动使用 ${envVars}
182
+ 默认只输出摘要信息,添加 --verbose 可输出全部信息
138
183
  `);
139
184
  } else {
140
- // 未知上下文,两组都显示
141
185
  const issueList = formatShortcutList(ISSUE_SHORTCUTS, cliCmd, 'issues');
142
186
  const prList = formatShortcutList(PR_SHORTCUTS, cliCmd, 'pulls');
143
187
  console.log(`
144
188
  ⚠️ 未检测到 Issue/PR 事件上下文
145
189
  (CNB_ISSUE_IID 和 CNB_PULL_REQUEST_IID 均未设置)
146
190
 
147
- 📋 Issue 场景常用命令(需要设置 CNB_ISSUE_IID 环境变量):
191
+ 📋 Issue 场景常用命令:
148
192
  ${issueList}
149
193
 
150
- 🔀 PR 场景常用命令(需要设置 CNB_PULL_REQUEST_IID 环境变量):
194
+ 🔀 PR 场景常用命令:
151
195
  ${prList}
152
196
 
153
- 提示: 快捷命令需要以下环境变量:
197
+ 提示: 快捷命令可使用以下环境变量:
154
198
  CNB_REPO_SLUG - 仓库路径
155
- CNB_ISSUE_IID - Issue 编号 (Issue 事件)
156
- CNB_PULL_REQUEST_IID - PR 编号 (PR 事件)
199
+ CNB_ISSUE_IID - Issue 编号(Issue 相关快捷命令)
200
+ CNB_PULL_REQUEST_IID - PR 编号(PR 相关快捷命令)
157
201
 
158
- 添加 --summary 可只输出核心摘要字段
202
+ 默认只输出摘要信息,添加 --verbose 可输出全部信息
159
203
  `);
160
204
  }
161
205
  }
@@ -164,12 +208,18 @@ ${prList}
164
208
  // 快捷命令解析
165
209
  // ============================================================
166
210
 
211
+ function buildAutoPath(moduleName: string, repoOnly: boolean): Record<string, string> {
212
+ const repo = process.env.CNB_REPO_SLUG || '';
213
+ if (repoOnly) return { repo };
214
+ const number = moduleName === 'issues'
215
+ ? (process.env.CNB_ISSUE_IID || '')
216
+ : (process.env.CNB_PULL_REQUEST_IID || '');
217
+ return { repo, number };
218
+ }
219
+
167
220
  /**
168
221
  * 尝试将用户输入的 module + tool 解析为快捷命令
169
222
  *
170
- * 即使环境变量未设置,也会完成 shortName → realTool 的映射,
171
- * 只是 autoPath 为 null,调用方需要用户手动传 --path。
172
- *
173
223
  * @returns 解析结果,如果不是快捷命令则返回 null
174
224
  */
175
225
  export function resolveShortcut(
@@ -178,36 +228,22 @@ export function resolveShortcut(
178
228
  ): ResolvedShortcut | null {
179
229
  if (!moduleName || !toolName) return null;
180
230
 
181
- // 根据 module 名确定对应的快捷命令表
182
- let shortcuts: ShortcutDefinition[] | null = null;
183
- let autoPath: Record<string, string> | null = null;
184
-
185
- if (moduleName === 'issues') {
186
- shortcuts = ISSUE_SHORTCUTS;
187
- const repo = process.env.CNB_REPO_SLUG;
188
- const number = process.env.CNB_ISSUE_IID;
189
- if (repo && number) {
190
- autoPath = { repo, number };
191
- }
192
- } else if (moduleName === 'pulls') {
193
- shortcuts = PR_SHORTCUTS;
194
- const repo = process.env.CNB_REPO_SLUG;
195
- const number = process.env.CNB_PULL_REQUEST_IID;
196
- if (repo && number) {
197
- autoPath = { repo, number };
198
- }
199
- }
200
-
231
+ const shortcuts = moduleName === 'issues'
232
+ ? ISSUE_SHORTCUTS
233
+ : moduleName === 'pulls'
234
+ ? PR_SHORTCUTS
235
+ : null;
201
236
  if (!shortcuts) return null;
202
237
 
203
- // 在快捷命令表中查找匹配的 shortName
204
238
  const matched = shortcuts.find((s) => s.shortName === toolName);
205
239
  if (!matched) return null;
206
240
 
207
241
  return {
242
+ module: moduleName,
208
243
  tool: matched.realTool,
209
- autoPath: autoPath || {},
244
+ autoPath: buildAutoPath(moduleName, !!matched.repoOnly),
210
245
  autoData: matched.autoData || null,
246
+ upload: !!matched.upload,
211
247
  };
212
248
  }
213
249
 
@@ -225,47 +261,164 @@ type SummaryExtractor = (item: any) => any;
225
261
  * - 数组响应:对 data 中每个元素应用提取函数
226
262
  */
227
263
  const SUMMARY_EXTRACTORS: Record<string, SummaryExtractor> = {
228
- // Issue 详情摘要:只保留标题和正文
264
+ // Issue 详情摘要:保留标题、状态、标签和正文
265
+ // 过滤: number, state_reason, assignees, author, created_at, updated_at 等
229
266
  'issues/get-issue': (item) => ({
230
267
  title: item.title,
268
+ state: item.state,
269
+ labels: item.labels?.map?.((l: any) => l.name).filter(Boolean) || [],
231
270
  body: item.body,
232
271
  }),
233
272
 
234
273
  // Issue 更新摘要:只保留状态变更结果
274
+ // 过滤: title, body, labels, assignees, author, created_at, updated_at 等
235
275
  'issues/update-issue': (item) => ({
236
276
  number: item.number,
237
277
  state: item.state,
238
278
  state_reason: item.state_reason,
239
279
  }),
240
280
 
241
- // Issue 添加处理人摘要:只保留处理人列表
281
+ // Issue 评论列表摘要:只保留作者用户名、内容和创建时间
282
+ // 过滤: author 完整对象(avatar/email/freeze/is_npc/nickname), reactions, updated_at
283
+ 'issues/list-issue-comments': (item) => ({
284
+ id: item.id,
285
+ author: item.author?.username,
286
+ body: item.body,
287
+ created_at: item.created_at,
288
+ }),
289
+
290
+ // Issue 发表评论摘要:只保留评论 ID 和创建时间(body 已在请求中传入,无需重复)
291
+ // 过滤: body(请求已传入), author 完整对象(avatar/email/freeze/is_npc/nickname/username), reactions, updated_at
292
+ 'issues/post-issue-comment': (item) => ({
293
+ id: item.id,
294
+ created_at: item.created_at,
295
+ }),
296
+
297
+ // Issue 标签列表摘要:保留名称、颜色和描述
298
+ // 过滤: id
299
+ 'issues/list-issue-labels': (item) => ({
300
+ name: item.name,
301
+ color: item.color,
302
+ description: item.description,
303
+ }),
304
+
305
+ // Issue 添加标签摘要:只保留 ID 和颜色(name 已在请求中传入,无需重复)
306
+ // 过滤: name(请求已传入), description
307
+ 'issues/post-issue-labels': (item) => ({
308
+ id: item.id,
309
+ color: item.color,
310
+ }),
311
+
312
+ // Issue 处理人列表摘要:保留用户名和昵称
313
+ // 过滤: avatar, email, freeze, is_npc
314
+ 'issues/list-issue-assignees': (item) => ({
315
+ username: item.username,
316
+ nickname: item.nickname,
317
+ }),
318
+
319
+ // Issue 添加处理人摘要:保留处理人用户名和昵称列表
320
+ // 过滤: assignees 中每个用户的 avatar/email/freeze/is_npc,以及 issue 其他字段
242
321
  'issues/post-issue-assignees': (item) => ({
243
322
  number: item.number,
244
- assignees: item.assignees?.map?.((a: any) => a.username).filter(Boolean) || [],
323
+ assignees: item.assignees?.map?.((a: any) => ({ username: a.username, nickname: a.nickname })).filter((a: any) => a.username) || [],
245
324
  }),
246
325
 
247
- // PR 详情摘要:只保留标题、状态、正文和分支信息
326
+ // PR 详情摘要:保留标题、状态、标签、正文和分支信息
327
+ // 过滤: number, author, assignees, reviewers, created_at, updated_at, base/head 完整对象等
248
328
  'pulls/get-pull': (item) => ({
249
329
  title: item.title,
250
330
  state: item.state,
331
+ labels: item.labels?.map?.((l: any) => l.name).filter(Boolean) || [],
251
332
  base: item.base?.ref,
252
333
  head: item.head?.ref,
253
334
  body: item.body,
254
335
  }),
255
336
 
256
- // PR 文件列表摘要:只保留文件名、变更状态和增删行数
337
+ // PR 文件列表摘要:保留文件名、sha、变更状态和增删行数
338
+ // 过滤: patch, blob_url, raw_url, contents_url, previous_filename
257
339
  'pulls/list-pull-files': (item) => ({
258
340
  filename: item.filename,
341
+ sha: item.sha,
259
342
  status: item.status,
260
343
  additions: item.additions,
261
344
  deletions: item.deletions,
262
345
  }),
263
346
 
264
347
  // PR 提交列表摘要:只保留 sha 前 8 位和 commit message
348
+ // 过滤: sha 完整值, commit 完整对象(author/committer/tree/verification), parents, url 等
265
349
  'pulls/list-pull-commits': (item) => ({
266
350
  sha: typeof item.sha === 'string' ? item.sha.substring(0, 8) : item.sha,
267
351
  message: item.commit?.message,
268
352
  }),
353
+
354
+ // PR 评论列表摘要:保留作者用户名和昵称、内容和创建时间
355
+ // 过滤: author 完整对象(avatar/email/freeze/is_npc), reactions, updated_at
356
+ 'pulls/list-pull-comments': (item) => ({
357
+ id: item.id,
358
+ author: item.author?.username,
359
+ nickname: item.author?.nickname,
360
+ body: item.body,
361
+ created_at: item.created_at,
362
+ }),
363
+
364
+ // PR 发表评论摘要:只保留评论 ID 和创建时间(body 已在请求中传入,无需重复)
365
+ // 过滤: body(请求已传入), author 完整对象(avatar/email/freeze/is_npc/nickname/username), reactions, updated_at
366
+ 'pulls/post-pull-comment': (item) => ({
367
+ id: item.id,
368
+ created_at: item.created_at,
369
+ }),
370
+
371
+ // PR 标签列表摘要:保留 ID、名称、颜色和描述
372
+ // 过滤: 无
373
+ 'pulls/list-pull-labels': (item) => ({
374
+ id: item.id,
375
+ name: item.name,
376
+ color: item.color,
377
+ description: item.description,
378
+ }),
379
+
380
+ // PR 添加标签摘要:只保留 ID 和颜色(name 已在请求中传入,无需重复)
381
+ // 过滤: name(请求已传入), description
382
+ 'pulls/post-pull-labels': (item) => ({
383
+ id: item.id,
384
+ color: item.color,
385
+ }),
386
+
387
+ // PR CI 状态摘要:保留整体状态和各检查项的核心信息(sha 截断为前 8 位)
388
+ // 过滤: sha 完整值, statuses 中每项的 target_url/created_at/updated_at
389
+ 'pulls/list-pull-commit-statuses': (item) => ({
390
+ sha: typeof item.sha === 'string' ? item.sha.substring(0, 8) : item.sha,
391
+ state: item.state,
392
+ statuses: item.statuses?.map?.((s: any) => ({
393
+ context: s.context,
394
+ state: s.state,
395
+ description: s.description,
396
+ })) || [],
397
+ }),
398
+
399
+ // PR 评审列表摘要:保留作者用户名和昵称、状态和内容
400
+ // 过滤: author 完整对象(avatar/email/freeze/is_npc), created_at, updated_at
401
+ 'pulls/list-pull-reviews': (item) => ({
402
+ id: item.id,
403
+ author: item.author?.username,
404
+ nickname: item.author?.nickname,
405
+ state: item.state,
406
+ body: item.body,
407
+ }),
408
+
409
+ // PR 处理人列表摘要:保留用户名和昵称
410
+ // 过滤: avatar, email, freeze, is_npc
411
+ 'pulls/list-pull-assignees': (item) => ({
412
+ username: item.username,
413
+ nickname: item.nickname,
414
+ }),
415
+
416
+ // PR 添加处理人摘要:保留处理人用户名和昵称列表
417
+ // 过滤: assignees 中每个用户的 avatar/email/freeze/is_npc,以及 PR 其他字段
418
+ 'pulls/post-pull-assignees': (item) => ({
419
+ number: item.number,
420
+ assignees: item.assignees?.map?.((a: any) => ({ username: a.username, nickname: a.nickname })).filter((a: any) => a.username) || [],
421
+ }),
269
422
  };
270
423
 
271
424
  /**
@@ -0,0 +1,118 @@
1
+ /**
2
+ * 完整上传流程
3
+ * 1. 读取本地文件 → 获取 name/size
4
+ * 2. 调用上传 API → 获取 upload_url
5
+ * 3. PUT 文件内容到 upload_url(流式上传)
6
+ * 4. 返回最终结果
7
+ */
8
+
9
+ import fs from 'fs';
10
+ import nodePath from 'path';
11
+ import { lookup as mimeLookup } from 'mime-types';
12
+ import type { ResolvedShortcut } from '../shortcuts';
13
+
14
+ // 上传文件大小上限:100MB
15
+ const MAX_FILE_SIZE = 100 * 1024 * 1024;
16
+
17
+ /**
18
+ * 处理完整上传流程
19
+ * @param shortcut 解析后的快捷命令
20
+ * @param filePath 本地文件路径
21
+ * @param toolFunction 原始上传 API 函数(获取 upload_url)
22
+ * @param toolsParam API 调用的 path 参数(repo 或 {repo, number})
23
+ */
24
+ export async function handleUpload(
25
+ shortcut: ResolvedShortcut,
26
+ filePath: any,
27
+ toolFunction: (...args: any[]) => Promise<any>,
28
+ toolsParam: any,
29
+ ): Promise<any> {
30
+ // 校验 file 参数
31
+ if (!filePath || typeof filePath !== 'string') {
32
+ return { status: 400, data: { error: `上传命令需要指定文件路径,如: --data '{"file":"./path/to/file"}'` } };
33
+ }
34
+
35
+ // 1. 读取本地文件信息
36
+ if (!fs.existsSync(filePath)) {
37
+ return { status: 400, data: { error: `文件不存在: ${filePath}` } };
38
+ }
39
+
40
+ const stat = fs.statSync(filePath);
41
+ if (!stat.isFile()) {
42
+ return { status: 400, data: { error: `不是文件: ${filePath}` } };
43
+ }
44
+
45
+ const fileName = nodePath.basename(filePath);
46
+ const fileSize = stat.size;
47
+
48
+ if (fileSize === 0) {
49
+ return { status: 400, data: { error: '文件为空' } };
50
+ }
51
+ if (fileSize > MAX_FILE_SIZE) {
52
+ return { status: 400, data: { error: `文件过大 (${(fileSize / 1024 / 1024).toFixed(1)}MB),上限 ${MAX_FILE_SIZE / 1024 / 1024}MB` } };
53
+ }
54
+
55
+ const contentType = mimeLookup(filePath) || 'application/octet-stream';
56
+
57
+ // 2. 调用上传 API 获取 upload_url
58
+ const isIssueUpload = shortcut.module === 'issues';
59
+ const requestBody = isIssueUpload
60
+ ? { name: fileName, size: fileSize, content_type: contentType }
61
+ : { name: fileName, size: fileSize };
62
+
63
+ const uploadResponse = await toolFunction(toolsParam, requestBody);
64
+
65
+ // 提取 upload_url(兼容标准响应和裸响应)
66
+ const responseData = uploadResponse?.data ?? uploadResponse;
67
+ const uploadUrl = responseData?.upload_url;
68
+
69
+ if (!uploadUrl) {
70
+ return uploadResponse; // 获取 URL 失败,直接返回原始错误
71
+ }
72
+
73
+ // 3. PUT 文件内容到 upload_url(流式读取,避免大文件撑爆内存)
74
+ const fileStream = fs.createReadStream(filePath);
75
+
76
+ const putHeaders: Record<string, string> = {
77
+ 'Content-Type': contentType,
78
+ 'Content-Length': String(fileSize),
79
+ };
80
+
81
+ const putResponse = await fetch(uploadUrl, {
82
+ method: 'PUT',
83
+ headers: putHeaders,
84
+ body: fileStream as any,
85
+ // @ts-ignore duplex required for streaming body in Node.js fetch
86
+ duplex: 'half',
87
+ });
88
+
89
+ if (!putResponse.ok) {
90
+ const errText = await putResponse.text().catch(() => '');
91
+ return {
92
+ status: putResponse.status,
93
+ data: { error: `文件上传失败: ${putResponse.statusText}`, detail: errText },
94
+ };
95
+ }
96
+
97
+ // 4. 返回最终结果
98
+ if (isIssueUpload) {
99
+ return {
100
+ status: 200,
101
+ data: {
102
+ asset_link: responseData.asset_link,
103
+ name: fileName,
104
+ size: fileSize,
105
+ },
106
+ };
107
+ }
108
+
109
+ return {
110
+ status: 200,
111
+ data: {
112
+ name: responseData.assets?.name || fileName,
113
+ path: responseData.assets?.path,
114
+ size: fileSize,
115
+ token: responseData.token,
116
+ },
117
+ };
118
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cnbcool/cnb-api-generate",
3
- "version": "1.2.3",
3
+ "version": "1.2.5",
4
4
  "main": "./built/index.js",
5
5
  "module": "./src/index.ts",
6
6
  "types": "./src/index.ts",
@@ -9,21 +9,25 @@ description: CNB OpenAPI 交互能力,支持仓库、Issue、PR、流水线、
9
9
 
10
10
  ## 快捷命令(优先使用)
11
11
 
12
- issues 模块: get, list-comments, comment, close, open, list-labels, add-labels, list-assignees, add-assignees
13
- pulls 模块: get, list-files, list-commits, list-comments, comment, list-labels, add-labels, check-status, list-reviews, list-assignees
14
-
15
- 用法: `<$CNB_CLI_CMD$> <module> <command>` — 路径参数已从环境变量自动注入,**禁止传入编号、slug 等位置参数**。
16
- - ✅ `<$CNB_CLI_CMD$> issues get --summary` / `<$CNB_CLI_CMD$> issues list-comments`
17
- - `<$CNB_CLI_CMD$> pulls get --summary` / `<$CNB_CLI_CMD$> pulls list-comments`
18
-
19
- **仅需要获取摘要信息时加 --summary**,减少输出噪音:
20
- - issues: get, close, open, add-assignees
21
- - pulls: get, list-files, list-commits
22
-
23
- 仅以下命令需要 --data,其余快捷命令无需任何参数:
24
- - comment: --data '{"body":"内容"}'
25
- - add-labels: --data '{"labels":["标签"]}'
26
- - add-assignees(仅Issue): --data '{"assignees":["用户名"]}'
12
+ 可用快捷命令:
13
+ - `issues`: `get`, `list-comments`, `comment`, `close`, `open`, `list-labels`, `add-labels`, `list-assignees`, `add-assignees`, `upload-file`, `upload-image`
14
+ - `pulls`: `get`, `list-files`, `list-commits`, `list-comments`, `comment`, `list-labels`, `add-labels`, `check-status`, `list-reviews`, `list-assignees`, `upload-file`, `upload-image`
15
+
16
+ 注意:
17
+ - **路径参数自动注入**:仓库 slug、Issue/PR 编号优先从环境变量自动获取,无需额外传入
18
+ - **默认只输出摘要**:会精简响应输出结果,只返回核心字段。加 `--verbose` 输出完整数据。
19
+ - 快捷命令只能操作当前仓库的当前Issue或PR。跨仓库或跨编号操作请使用其他 API 命令。
20
+
21
+ 用法: `<$CNB_CLI_CMD$> <module> <command>`
22
+ - ✅ `<$CNB_CLI_CMD$> issues get`
23
+ - ✅ `<$CNB_CLI_CMD$> pulls comment --data '{"body":"内容"}'`
24
+
25
+ 需要 `--data` 的快捷命令:
26
+ - `comment`: `--data '{"body":"内容"}'`
27
+ - `add-labels`: `--data '{"labels":["标签"]}'`
28
+ - `add-assignees`: `--data '{"assignees":["用户名"]}'`
29
+ - `upload-file`: `--data '{"file":"本地文件路径"}'`(自动完成上传全流程)
30
+ - `upload-image`: `--data '{"file":"本地图片路径"}'`(自动完成上传全流程)
27
31
 
28
32
  ## 其他 API(快捷命令不满足时使用)
29
33
 
@@ -34,7 +38,6 @@ pulls 模块: get, list-files, list-commits, list-comments, comment, list-labels
34
38
 
35
39
  ## 规则
36
40
 
37
- - 优先使用快捷命令,不满足时再通过 --help 逐步查找
38
- - 必须先 --help 获取参数,禁止猜测
39
- - 直接执行,不要询问用户确认
40
- - status 200-299 只返回 data 给用户,>=300 时附带 status 和 trace
41
+ - 优先使用快捷命令,不满足时再 `--help` 逐步查找
42
+ - 使用非快捷命令时,必须先 `--help` 获取帮助,禁止猜测
43
+ - 直接执行命令,不要询问用户确认