atl-fetch 1.0.0

package/dist/services/storage/storage-service.d.ts

@@ -0,0 +1,77 @@
+/**
+ * ストレージサービス
+ *
+ * Jira Issue / Confluence ページをディレクトリ構造で保存する。
+ * design.md の Output Directory Structure に従って保存する。
+ */
+import { type Result } from 'neverthrow';
+import type { ConfluenceVersion } from '../../types/confluence.js';
+import type { ConfluenceSaveData, ConfluenceSaveResult, ConfluenceStorageOptions, JiraSaveData, JiraSaveResult, JiraStorageOptions, StorageError } from '../../types/storage.js';
+/**
+ * Jira Issue をディレクトリ構造で保存する
+ *
+ * 以下のディレクトリ構造で保存する:
+ * ```
+ * {baseDir}/jira/{ISSUE-KEY}/
+ * ├── manifest.json          # 取得メタデータ
+ * ├── issue.json             # Issue 全データ（JSON 形式）
+ * ├── description.txt        # 説明文のプレーンテキスト
+ * ├── content.md             # Markdown 形式
+ * ├── changelog.json         # 変更履歴
+ * ├── comments.json          # コメント一覧
+ * ├── attachments.json       # 添付ファイル一覧メタデータ
+ * └── attachments/           # 添付ファイル実体
+ *     └── {id}_{filename}
+ * ```
+ *
+ * @param data 保存データ
+ * @param options 保存オプション
+ * @returns 成功時は Ok(JiraSaveResult)、失敗時は Err(StorageError)
+ */
+export declare const saveJiraIssue: (data: JiraSaveData, options: JiraStorageOptions) => Promise<Result<JiraSaveResult, StorageError>>;
+/**
+ * Confluence ページをディレクトリ構造で保存する
+ *
+ * 以下のディレクトリ構造で保存する:
+ * ```
+ * {baseDir}/confluence/{PAGE-ID}/
+ * ├── manifest.json          # 取得メタデータ
+ * ├── page.json              # ページ全データ（JSON 形式）
+ * ├── content.txt            # 本文のプレーンテキスト（最新版）
+ * ├── versions.json          # バージョン一覧メタデータ
+ * ├── attachments.json       # 添付ファイル一覧メタデータ
+ * └── attachments/           # 添付ファイル実体
+ *     └── {id}_{filename}
+ * ```
+ *
+ * @param data 保存データ
+ * @param options 保存オプション
+ * @returns 成功時は Ok(ConfluenceSaveResult)、失敗時は Err(StorageError)
+ */
+export declare const saveConfluencePage: (data: ConfluenceSaveData, options: ConfluenceStorageOptions) => Promise<Result<ConfluenceSaveResult, StorageError>>;
+/**
+ * Confluence ページの各バージョンをディレクトリ構造で保存する
+ *
+ * 以下のディレクトリ構造で保存する:
+ * ```
+ * {pageDir}/versions/
+ * ├── v1/
+ * │   ├── content.json   # v1 の全データ
+ * │   └── content.txt    # v1 のプレーンテキスト
+ * ├── v2/
+ * │   ├── content.json   # v2 の全データ
+ * │   ├── content.txt    # v2 のプレーンテキスト
+ * │   ├── diff.txt       # v1 → v2 の差分（unified diff形式）
+ * │   └── diff.json      # v1 → v2 の差分メタデータ
+ * └── v3/
+ *     ├── content.json
+ *     ├── content.txt
+ *     ├── diff.txt       # v2 → v3 の差分
+ *     └── diff.json
+ * ```
+ *
+ * @param versions バージョン配列（バージョン番号順にソートされていることを期待）
+ * @param pageDir 保存先のページディレクトリ
+ * @returns 成功時は Ok(void)、失敗時は Err(StorageError)
+ */
+export declare const saveConfluenceVersions: (versions: readonly ConfluenceVersion[], pageDir: string) => Promise<Result<void, StorageError>>;