@d-zero/backlog-projects 0.5.6 → 0.6.1

package/README.md

@@ -6,6 +6,8 @@
 
 - `-v, --version`: バージョンを表示
 - `-a, --assign`: プロジェクトアサインモード
+- `-d, --delete`: 添付ファイル削除モード
+- `-V, --verbose`: 詳細出力
 
 ### プロジェクトアサイン
 
@@ -28,6 +30,29 @@ npx @d-zero/backlog-projects --assign
 
 逐次、課題が登録されます。
 
+### 添付ファイル削除
+
+```sh
+npx @d-zero/backlog-projects --delete
+```
+
+指定した基準日以前に最終更新された課題の添付ファイルをダウンロードしてから削除します。
+
+プロンプトに従って入力してください。
+
+```sh
+? 基準日（例: 2024-01-01） ›
+? 保存先ディレクトリ ›
+```
+
+添付ファイルは保存先ディレクトリに `プロジェクトキー/課題キー/` の階層で保存されます。各ファイルには削除結果のメタデータ（`.json`）も併せて保存されます。
+
+`-V` オプションで詳細出力を有効にできます。
+
+```sh
+npx @d-zero/backlog-projects --delete -V
+```
+
 ```sh
 ︙
 API_TEST-1190 メールフォーム 情報設計・項目定義 @DZ平尾
@@ -67,6 +92,21 @@ type Params = {
 };
 ```
 
+### `deleteAttachments`
+
+```ts
+function deleteAttachments(
+	backlog: Backlog,
+	params: DeleteAttachmentsParams,
+): Promise<void>;
+
+type DeleteAttachmentsParams = {
+	updatedUntil: string;
+	outDir: string;
+	verbose?: boolean;
+};
+```
+
 ### `createBacklogClient`
 
 ```ts

package/dist/cli.js

@@ -6,6 +6,7 @@ import minimist from 'minimist';
 import { assign } from './assign.js';
 import { createBacklogClient } from './create-backlog-client.js';
 import { roles } from './define.js';
+import { deleteAttachments } from './delete-attachments.js';
 import { getBacklogProjectIdFromUrl } from './get-backlog-project-id-from-url.js';
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
@@ -13,7 +14,9 @@ dotenv.config();
 const cli = minimist(process.argv.slice(2), {
     alias: {
         a: 'assign',
+        d: 'delete',
         v: 'version',
+        V: 'verbose',
     },
 });
 // Handle -v / --version option
@@ -72,3 +75,23 @@ if (cli.assign) {
         },
     });
 }
+else if (cli.delete) {
+    process.stdout.write('この日以前（この日を含む）に最終更新された課題の添付ファイルが削除対象になります。\n');
+    const { updatedUntil } = await Enquirer.prompt({
+        name: 'updatedUntil',
+        message: '基準日（例: 2024-01-01）',
+        type: 'input',
+        required: true,
+    });
+    const { outDir } = await Enquirer.prompt({
+        name: 'outDir',
+        message: '保存先ディレクトリ',
+        type: 'input',
+        required: true,
+    });
+    await deleteAttachments(backlog, {
+        updatedUntil,
+        outDir,
+        verbose: !!cli.verbose,
+    });
+}

package/dist/delete-attachments.d.ts

@@ -0,0 +1,18 @@
+import type { Backlog } from 'backlog-js';
+interface DeleteAttachmentsParams {
+    /**
+     * この日付以前（この日を含む）に最終更新された課題が対象。
+     * Backlog API の updatedUntil パラメータに渡される。
+     * 例: '2024-01-01' → 2024年1月1日以前に更新された課題
+     */
+    updatedUntil: string;
+    outDir: string;
+    verbose?: boolean;
+}
+/**
+ *
+ * @param backlog
+ * @param params
+ */
+export declare function deleteAttachments(backlog: Backlog, params: DeleteAttachmentsParams): Promise<void>;
+export {};

package/dist/delete-attachments.js

@@ -0,0 +1,138 @@
+import { createWriteStream } from 'node:fs';
+import { mkdir, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { pipeline } from 'node:stream/promises';
+import { deal } from '@d-zero/dealer';
+import { delay } from '@d-zero/shared/delay';
+import { kbSize } from '@d-zero/shared/filesize';
+import { retryCall } from '@d-zero/shared/retry';
+import c from 'ansi-colors';
+import dayjs from 'dayjs';
+const BATCH_SIZE = 20;
+const ISSUES_PER_REQUEST = 100;
+const API_DELAY_MS = 1000;
+const RETRY_OPTIONS = {
+    retries: 5,
+    interval: { random: { min: 5000, max: 15_000 } },
+};
+/**
+ *
+ * @param backlog
+ * @param params
+ */
+export async function deleteAttachments(backlog, params) {
+    const { updatedUntil, outDir, verbose } = params;
+    const projectKeyCache = new Map();
+    let processedCount = 0;
+    let totalAttachments = 0;
+    let totalSize = 0;
+    let issueCount = 0;
+    let collectionDone = false;
+    const resolveProjectKey = async (projectId) => {
+        const cached = projectKeyCache.get(projectId);
+        if (cached) {
+            return cached;
+        }
+        await delay(API_DELAY_MS);
+        const project = await retryCall(() => backlog.getProject(projectId), RETRY_OPTIONS);
+        projectKeyCache.set(projectId, project.projectKey);
+        return project.projectKey;
+    };
+    await deal([{ kind: 'collector' }], (task, update, _index, setLineHeader, push) => {
+        if (task.kind === 'collector') {
+            return async () => {
+                update('%braille% プロジェクト一覧を取得中%dots%');
+                const [archivedProjects, activeProjects] = await Promise.all([
+                    retryCall(() => backlog.getProjects({ archived: true }), RETRY_OPTIONS),
+                    retryCall(() => backlog.getProjects({ archived: false }), RETRY_OPTIONS),
+                ]);
+                const allProjects = [...archivedProjects, ...activeProjects];
+                const totalBatches = Math.ceil(allProjects.length / BATCH_SIZE);
+                for (const p of allProjects) {
+                    projectKeyCache.set(p.id, p.projectKey);
+                }
+                for (let i = 0; i < allProjects.length; i += BATCH_SIZE) {
+                    const batch = allProjects.slice(i, i + BATCH_SIZE);
+                    const projectIds = batch.map((p) => p.id);
+                    const batchIndex = Math.floor(i / BATCH_SIZE) + 1;
+                    update(`%braille% ${c.gray(batch.map((p) => p.projectKey).join(', '))}: バッチ ${batchIndex}/${totalBatches} 課題を検索中%dots%`);
+                    let hasMore = true;
+                    let offset = 0;
+                    while (hasMore) {
+                        await delay(API_DELAY_MS);
+                        const issues = await retryCall(() => backlog.getIssues({
+                            projectId: projectIds,
+                            attachment: true,
+                            count: ISSUES_PER_REQUEST,
+                            offset,
+                            updatedUntil,
+                        }), RETRY_OPTIONS);
+                        if (issues.length === 0) {
+                            break;
+                        }
+                        for (const issue of issues) {
+                            if (issue.attachments.length === 0) {
+                                continue;
+                            }
+                            issueCount++;
+                            const projectKey = await resolveProjectKey(issue.projectId);
+                            for (const attachment of issue.attachments) {
+                                totalAttachments++;
+                                await push({
+                                    kind: 'attachment',
+                                    issueKey: issue.issueKey,
+                                    projectKey,
+                                    attachment,
+                                });
+                            }
+                        }
+                        offset += issues.length;
+                        if (issues.length < ISSUES_PER_REQUEST) {
+                            hasMore = false;
+                        }
+                    }
+                }
+                collectionDone = true;
+                update(`${c.green('✓')} 収集完了 | 課題: ${issueCount} | ファイル: ${totalAttachments}`);
+            };
+        }
+        return async () => {
+            setLineHeader(`${c.bgWhite(c.black(` ${task.issueKey} `))} `);
+            update(`${task.attachment.name}: ダウンロード中%dots%`);
+            const issueDir = path.join(outDir, task.projectKey, task.issueKey);
+            await mkdir(issueDir, { recursive: true });
+            const filePath = path.join(issueDir, `${dayjs(task.attachment.created).format('YYYYMMDD')}_${task.attachment.id}_${task.attachment.name}`);
+            const fileData = await retryCall(() => backlog.getIssueAttachment(task.issueKey, task.attachment.id), RETRY_OPTIONS);
+            await pipeline(fileData.body, createWriteStream(filePath));
+            totalSize += task.attachment.size;
+            update(`${task.attachment.name} (${kbSize(task.attachment.size)}): 削除中%dots%`);
+            await delay(API_DELAY_MS);
+            const deleteResult = await retryCall(() => backlog.deleteIssueAttachment(task.issueKey, String(task.attachment.id)), RETRY_OPTIONS);
+            const metaPath = `${filePath}.json`;
+            await writeFile(metaPath, JSON.stringify(deleteResult, null, 2));
+            processedCount++;
+            update(`${c.green('✓')} ${task.attachment.name} (${kbSize(task.attachment.size)})`);
+        };
+    }, {
+        limit: 6,
+        verbose,
+        interval: API_DELAY_MS,
+        header: () => {
+            if (collectionDone &&
+                processedCount === totalAttachments &&
+                totalAttachments > 0) {
+                return c.bold.green(`✓ 完了 | 課題: ${issueCount} | ファイル: ${processedCount}/${totalAttachments} | ${kbSize(totalSize)}`);
+            }
+            const pct = totalAttachments > 0
+                ? Math.round((processedCount / totalAttachments) * 100)
+                : 0;
+            if (collectionDone) {
+                return `${c.bold.cyan('処理中')} %earth% ${processedCount}/${totalAttachments} (${pct}%) | 課題: ${issueCount} | ${kbSize(totalSize)}`;
+            }
+            return `${c.bold.cyan('収集＆処理中')} %earth% ${processedCount}/${totalAttachments} (${pct}%) | 課題: ${issueCount} | ${kbSize(totalSize)}`;
+        },
+    });
+    if (totalAttachments === 0) {
+        process.stderr.write(c.bold.yellow('対象の添付ファイルはありません') + '\n');
+    }
+}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { assign } from './assign.js';
 export { createBacklogClient } from './create-backlog-client.js';
+export { deleteAttachments } from './delete-attachments.js';

package/dist/index.js

@@ -1,2 +1,3 @@
 export { assign } from './assign.js';
 export { createBacklogClient } from './create-backlog-client.js';
+export { deleteAttachments } from './delete-attachments.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/backlog-projects",
-	"version": "0.5.6",
+	"version": "0.6.1",
 	"description": "A manipulating Backlog projects library",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -26,13 +26,15 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/notion": "2.0.13",
+		"@d-zero/dealer": "1.7.0",
+		"@d-zero/notion": "2.0.14",
 		"@d-zero/shared": "0.20.1",
+		"ansi-colors": "4.1.3",
 		"backlog-js": "0.16.0",
 		"dayjs": "1.11.19",
 		"dotenv": "17.3.1",
 		"enquirer": "2.4.1",
 		"minimist": "1.2.8"
 	},
-	"gitHead": "a6b5eb0a0a327c003053f7c25be4c075ed319c76"
+	"gitHead": "866364294ddacc3095f65a9f8b488d40c4ccb904"
 }