atl-fetch 1.0.0

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

@@ -0,0 +1,84 @@
+import type { ConfluenceVersion } from '../../types/confluence.js';
+import type { DiffOptions, DiffResult } from '../../types/diff.js';
+import type { JiraChangelogEntry } from '../../types/jira.js';
+/**
+ * 2つのテキスト間の差分を計算する
+ *
+ * unified diff 形式で差分を出力し、差分統計を計算する。
+ * diff ライブラリを使用して行単位の差分を検出する。
+ *
+ * @param oldText - 変更前のテキスト
+ * @param newText - 変更後のテキスト
+ * @param options - 差分オプション
+ * @returns 差分結果
+ *
+ * @example
+ * ```typescript
+ * // 基本的な使用例
+ * const result = diffText('Hello', 'Goodbye', { colorEnabled: false });
+ * console.log(result.formatted);
+ * // @@ -1,1 +1,1 @@
+ * // -Hello
+ * // +Goodbye
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // 差分統計の確認
+ * const result = diffText('A\nB\nC', 'A\nX\nC', { colorEnabled: false });
+ * console.log(result.stats.additions); // 1
+ * console.log(result.stats.deletions); // 1
+ * ```
+ */
+export declare function diffText(oldText: string, newText: string, options: DiffOptions): DiffResult;
+/**
+ * Jira changelog を差分形式でフォーマットする
+ *
+ * 各変更のフィールド名、変更前の値、変更後の値を表示する。
+ * カラー出力が有効な場合、追加行を緑、削除行を赤でハイライトする。
+ *
+ * @param changelog - Jira の変更履歴
+ * @param options - 差分オプション
+ * @returns フォーマットされた差分文字列
+ *
+ * @example
+ * ```typescript
+ * const changelog = [{
+ *   id: '12345',
+ *   author: 'John Doe',
+ *   created: '2024-01-15T10:30:00.000+0900',
+ *   items: [{ field: 'status', fromString: 'Open', toString: 'In Progress' }]
+ * }];
+ * const result = formatJiraChangelog(changelog, { colorEnabled: false });
+ * // Changelog #12345 by John Doe at 2024-01-15T10:30:00.000+0900
+ * //   [status]
+ * //   - status: Open
+ * //   + status: In Progress
+ * ```
+ */
+export declare function formatJiraChangelog(changelog: readonly JiraChangelogEntry[], options: DiffOptions): string;
+/**
+ * Confluence バージョン間の差分をフォーマットする
+ *
+ * 2つの Confluence バージョン間の本文差分を計算し、unified diff 形式で出力する。
+ * ヘッダーにはバージョン番号、作成者、差分統計が含まれる。
+ * カラー出力が有効な場合、追加行を緑、削除行を赤でハイライトする。
+ *
+ * @param oldVersion - 変更前のバージョン
+ * @param newVersion - 変更後のバージョン
+ * @param options - 差分オプション
+ * @returns フォーマットされた差分文字列
+ *
+ * @example
+ * ```typescript
+ * const oldVersion = { number: 1, by: 'John', when: '2024-01-15', message: null, body: 'Hello' };
+ * const newVersion = { number: 2, by: 'Jane', when: '2024-01-16', message: 'Updated', body: 'Hello, World!' };
+ * const result = formatConfluenceVersionDiff(oldVersion, newVersion, { colorEnabled: false });
+ * // v1 → v2 by Jane (+1, -1)
+ * // Updated
+ * // @@ -1,1 +1,1 @@
+ * // -Hello
+ * // +Hello, World!
+ * ```
+ */
+export declare function formatConfluenceVersionDiff(oldVersion: ConfluenceVersion, newVersion: ConfluenceVersion, options: DiffOptions): string;