atl-fetch 1.0.0

package/dist/types/jira.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Jira Issue のコメントの型
+ */
+export interface JiraComment {
+    /** コメント ID */
+    readonly id: string;
+    /** 作成者の表示名 */
+    readonly author: string;
+    /** コメント本文 */
+    readonly body: string;
+    /** 作成日時（ISO 8601 形式） */
+    readonly created: string;
+    /** 更新日時（ISO 8601 形式） */
+    readonly updated: string;
+}
+/**
+ * Jira Issue の変更履歴アイテムの型
+ */
+export interface JiraChangelogItem {
+    /** 変更されたフィールド名 */
+    readonly field: string;
+    /** 変更前の値（null の場合は新規追加） */
+    readonly fromString: string | null;
+    /** 変更後の値（null の場合は削除） */
+    readonly toString: string | null;
+}
+/**
+ * Jira Issue の変更履歴エントリの型
+ */
+export interface JiraChangelogEntry {
+    /** 変更履歴 ID */
+    readonly id: string;
+    /** 変更者の表示名 */
+    readonly author: string;
+    /** 変更日時（ISO 8601 形式） */
+    readonly created: string;
+    /** 変更アイテムのリスト */
+    readonly items: readonly JiraChangelogItem[];
+}
+/**
+ * Jira Issue の添付ファイルの型
+ */
+export interface JiraAttachment {
+    /** 添付ファイル ID */
+    readonly id: string;
+    /** ファイル名 */
+    readonly filename: string;
+    /** MIME タイプ */
+    readonly mimeType: string;
+    /** ファイルサイズ（バイト） */
+    readonly size: number;
+    /** コンテンツダウンロード URL */
+    readonly contentUrl: string;
+}
+/**
+ * Jira Issue の型
+ */
+export interface JiraIssue {
+    /** Issue キー（例: PROJECT-123） */
+    readonly key: string;
+    /** Issue タイトル（要約） */
+    readonly summary: string;
+    /** Issue 説明（null の場合は説明なし） */
+    readonly description: string | null;
+    /** コメント一覧 */
+    readonly comments: readonly JiraComment[];
+    /** 変更履歴一覧 */
+    readonly changelog: readonly JiraChangelogEntry[];
+    /** 添付ファイル一覧 */
+    readonly attachments: readonly JiraAttachment[];
+}
+/**
+ * Jira サービスのエラーの型
+ */
+export type JiraError = {
+    kind: 'NOT_FOUND';
+    message: string;
+} | {
+    kind: 'FORBIDDEN';
+    message: string;
+} | {
+    kind: 'AUTH_FAILED';
+    message: string;
+} | {
+    kind: 'NETWORK_ERROR';
+    message: string;
+} | {
+    kind: 'PARSE_ERROR';
+    message: string;
+};

package/dist/types/jira.js

@@ -0,0 +1 @@
+export {};

package/dist/types/output.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 出力サービスに関する型定義
+ *
+ * OutputService で使用する型を定義する。
+ * JSON / Markdown / YAML 形式での出力に対応。
+ */
+import type { Result } from 'neverthrow';
+/**
+ * 出力形式
+ */
+export type OutputFormat = 'json' | 'markdown' | 'yaml';
+/**
+ * 出力オプション
+ *
+ * 出力時の設定を指定する。
+ */
+export interface OutputOptions {
+    /** 出力形式 */
+    readonly format: OutputFormat;
+    /** 出力先ファイルパス（指定時はファイル出力、未指定時は標準出力） */
+    readonly outputPath?: string;
+    /** カラー出力を有効にするか */
+    readonly colorEnabled: boolean;
+}
+/**
+ * 出力サービスのエラーの型
+ */
+export type OutputError = {
+    kind: 'WRITE_FAILED';
+    message: string;
+} | {
+    kind: 'INVALID_FORMAT';
+    message: string;
+};
+/**
+ * 出力サービスのインターフェース
+ */
+export interface OutputServiceInterface {
+    /**
+     * Jira Issue を指定形式でフォーマットする
+     *
+     * @param issue Jira Issue
+     * @param options 出力オプション
+     * @returns フォーマット済み文字列
+     */
+    formatJiraIssue(issue: import('./jira.js').JiraIssue, options: Pick<OutputOptions, 'format'>): Result<string, OutputError>;
+    /**
+     * Confluence ページを指定形式でフォーマットする
+     *
+     * @param page Confluence ページ
+     * @param options 出力オプション
+     * @returns フォーマット済み文字列
+     */
+    formatConfluencePage(page: import('./confluence.js').ConfluencePage, options: Pick<OutputOptions, 'format'>): Result<string, OutputError>;
+}

package/dist/types/output.js

@@ -0,0 +1,7 @@
+/**
+ * 出力サービスに関する型定義
+ *
+ * OutputService で使用する型を定義する。
+ * JSON / Markdown / YAML 形式での出力に対応。
+ */
+export {};

package/dist/types/result.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Result 型 - 成功または失敗を表現する discriminated union
+ *
+ * @example
+ * ```typescript
+ * function divide(a: number, b: number): Result<number, DivisionError> {
+ *   if (b === 0) {
+ *     return err({ kind: 'DIVISION_BY_ZERO', message: 'Cannot divide by zero' });
+ *   }
+ *   return ok(a / b);
+ * }
+ * ```
+ */
+/**
+ * 成功を表す型
+ */
+export interface Ok<T> {
+    readonly success: true;
+    readonly value: T;
+}
+/**
+ * 失敗を表す型
+ */
+export interface Err<E> {
+    readonly success: false;
+    readonly error: E;
+}
+/**
+ * Result 型 - 成功（Ok）または失敗（Err）のどちらかを表す
+ */
+export type Result<T, E> = Ok<T> | Err<E>;
+/**
+ * 成功 Result を作成する
+ *
+ * @param value - 成功値
+ * @returns 成功 Result
+ */
+export declare function ok<T>(value: T): Ok<T>;
+/**
+ * 失敗 Result を作成する
+ *
+ * @param error - エラー値
+ * @returns 失敗 Result
+ */
+export declare function err<E>(error: E): Err<E>;
+/**
+ * Result が成功かどうかを判定する型ガード
+ *
+ * @param result - 判定対象の Result
+ * @returns 成功の場合 true
+ */
+export declare function isOk<T, E>(result: Result<T, E>): result is Ok<T>;
+/**
+ * Result が失敗かどうかを判定する型ガード
+ *
+ * @param result - 判定対象の Result
+ * @returns 失敗の場合 true
+ */
+export declare function isErr<T, E>(result: Result<T, E>): result is Err<E>;
+/**
+ * 成功 Result から値を取り出す
+ * 失敗 Result の場合はエラーをスローする
+ *
+ * @param result - 対象の Result
+ * @returns 成功値
+ * @throws 失敗 Result の場合
+ */
+export declare function unwrap<T, E>(result: Result<T, E>): T;
+/**
+ * 失敗 Result からエラー値を取り出す
+ * 成功 Result の場合はエラーをスローする
+ *
+ * @param result - 対象の Result
+ * @returns エラー値
+ * @throws 成功 Result の場合
+ */
+export declare function unwrapErr<T, E>(result: Result<T, E>): E;
+/**
+ * 成功 Result から値を取り出す
+ * 失敗 Result の場合はデフォルト値を返す
+ *
+ * @param result - 対象の Result
+ * @param defaultValue - 失敗時のデフォルト値
+ * @returns 成功値またはデフォルト値
+ */
+export declare function unwrapOr<T, E>(result: Result<T, E>, defaultValue: T): T;
+/**
+ * 成功 Result の値を変換する
+ * 失敗 Result の場合はそのまま返す
+ *
+ * @param result - 対象の Result
+ * @param fn - 変換関数
+ * @returns 変換された Result
+ */
+export declare function mapResult<T, U, E>(result: Result<T, E>, fn: (value: T) => U): Result<U, E>;
+/**
+ * 失敗 Result のエラー値を変換する
+ * 成功 Result の場合はそのまま返す
+ *
+ * @param result - 対象の Result
+ * @param fn - 変換関数
+ * @returns 変換された Result
+ */
+export declare function mapErr<T, E, F>(result: Result<T, E>, fn: (error: E) => F): Result<T, F>;

package/dist/types/result.js

@@ -0,0 +1,119 @@
+/**
+ * Result 型 - 成功または失敗を表現する discriminated union
+ *
+ * @example
+ * ```typescript
+ * function divide(a: number, b: number): Result<number, DivisionError> {
+ *   if (b === 0) {
+ *     return err({ kind: 'DIVISION_BY_ZERO', message: 'Cannot divide by zero' });
+ *   }
+ *   return ok(a / b);
+ * }
+ * ```
+ */
+/**
+ * 成功 Result を作成する
+ *
+ * @param value - 成功値
+ * @returns 成功 Result
+ */
+export function ok(value) {
+    return { success: true, value };
+}
+/**
+ * 失敗 Result を作成する
+ *
+ * @param error - エラー値
+ * @returns 失敗 Result
+ */
+export function err(error) {
+    return { error, success: false };
+}
+/**
+ * Result が成功かどうかを判定する型ガード
+ *
+ * @param result - 判定対象の Result
+ * @returns 成功の場合 true
+ */
+export function isOk(result) {
+    return result.success;
+}
+/**
+ * Result が失敗かどうかを判定する型ガード
+ *
+ * @param result - 判定対象の Result
+ * @returns 失敗の場合 true
+ */
+export function isErr(result) {
+    return !result.success;
+}
+/**
+ * 成功 Result から値を取り出す
+ * 失敗 Result の場合はエラーをスローする
+ *
+ * @param result - 対象の Result
+ * @returns 成功値
+ * @throws 失敗 Result の場合
+ */
+export function unwrap(result) {
+    if (isOk(result)) {
+        return result.value;
+    }
+    throw new Error(`Attempted to unwrap an Err value: ${String(result.error)}`);
+}
+/**
+ * 失敗 Result からエラー値を取り出す
+ * 成功 Result の場合はエラーをスローする
+ *
+ * @param result - 対象の Result
+ * @returns エラー値
+ * @throws 成功 Result の場合
+ */
+export function unwrapErr(result) {
+    if (isErr(result)) {
+        return result.error;
+    }
+    throw new Error('Attempted to unwrapErr an Ok value');
+}
+/**
+ * 成功 Result から値を取り出す
+ * 失敗 Result の場合はデフォルト値を返す
+ *
+ * @param result - 対象の Result
+ * @param defaultValue - 失敗時のデフォルト値
+ * @returns 成功値またはデフォルト値
+ */
+export function unwrapOr(result, defaultValue) {
+    if (isOk(result)) {
+        return result.value;
+    }
+    return defaultValue;
+}
+/**
+ * 成功 Result の値を変換する
+ * 失敗 Result の場合はそのまま返す
+ *
+ * @param result - 対象の Result
+ * @param fn - 変換関数
+ * @returns 変換された Result
+ */
+export function mapResult(result, fn) {
+    if (isOk(result)) {
+        return ok(fn(result.value));
+    }
+    return result;
+}
+/**
+ * 失敗 Result のエラー値を変換する
+ * 成功 Result の場合はそのまま返す
+ *
+ * @param result - 対象の Result
+ * @param fn - 変換関数
+ * @returns 変換された Result
+ */
+export function mapErr(result, fn) {
+    if (isErr(result)) {
+        return err(fn(result.error));
+    }
+    return result;
+}

package/dist/types/storage.d.ts

@@ -0,0 +1,209 @@
+/**
+ * ストレージサービスに関する型定義
+ *
+ * Jira Issue / Confluence ページをディレクトリ構造で保存するための型を定義する。
+ */
+import type { Result } from 'neverthrow';
+import type { ConfluenceAttachment, ConfluenceVersion } from './confluence.js';
+import type { DiffHunk, DiffStats } from './diff.js';
+import type { JiraAttachment, JiraChangelogEntry, JiraComment } from './jira.js';
+/**
+ * Manifest のリソースタイプ
+ */
+export type ManifestResourceType = 'jiraIssue' | 'confluencePage';
+/**
+ * Manifest の問題レベル
+ */
+export type ManifestIssueLevel = 'error' | 'warning';
+/**
+ * Manifest の問題
+ */
+export interface ManifestIssue {
+    /** 問題レベル */
+    readonly level: ManifestIssueLevel;
+    /** エラーコード */
+    readonly code: string;
+    /** エラーメッセージ */
+    readonly message: string;
+    /** 追加コンテキスト */
+    readonly context?: Record<string, unknown>;
+}
+/**
+ * 添付ファイルダウンロード結果のステータス
+ */
+export type AttachmentResultStatus = 'success' | 'failed' | 'skipped';
+/**
+ * 添付ファイルダウンロード結果
+ */
+export interface AttachmentResult {
+    /** 添付ファイル ID */
+    readonly id: string;
+    /** ファイル名 */
+    readonly filename: string;
+    /** MIME タイプ */
+    readonly mimeType: string;
+    /** ファイルサイズ（バイト） */
+    readonly size: number;
+    /** ダウンロード結果ステータス */
+    readonly status: AttachmentResultStatus;
+    /** 保存先パス（成功時のみ） */
+    readonly savedPath?: string;
+    /** エラーメッセージ（失敗時のみ） */
+    readonly error?: string;
+}
+/**
+ * Manifest（取得メタデータ）
+ */
+export interface Manifest {
+    /** 取得対象の種別 */
+    readonly resourceType: ManifestResourceType;
+    /** 入力URL（正規化後） */
+    readonly sourceUrl: string;
+    /** 取得時刻（ISO 8601 形式） */
+    readonly fetchedAt: string;
+    /** CLI バージョン */
+    readonly cliVersion: string;
+    /** 取得結果サマリ */
+    readonly summary: {
+        readonly success: boolean;
+        readonly resourceId: string;
+        readonly title: string;
+    };
+    /** エラー・警告一覧 */
+    readonly issues: readonly ManifestIssue[];
+    /** 添付ファイル取得結果 */
+    readonly attachments: readonly AttachmentResult[];
+}
+/**
+ * Jira Issue 保存オプション
+ */
+export interface JiraStorageOptions {
+    /** 出力先ベースディレクトリ */
+    readonly baseDir: string;
+    /** 入力 URL */
+    readonly sourceUrl: string;
+    /** CLI バージョン */
+    readonly cliVersion: string;
+}
+/**
+ * Jira Issue 保存データ
+ */
+export interface JiraSaveData {
+    /** Issue キー（例: PROJECT-123） */
+    readonly key: string;
+    /** Issue タイトル（要約） */
+    readonly summary: string;
+    /** Issue 説明（null の場合は説明なし） */
+    readonly description: string | null;
+    /** 説明のプレーンテキスト（null の場合は説明なし） */
+    readonly descriptionPlainText: string | null;
+    /** コメント一覧 */
+    readonly comments: readonly JiraComment[];
+    /** 変更履歴一覧 */
+    readonly changelog: readonly JiraChangelogEntry[];
+    /** 添付ファイル一覧 */
+    readonly attachments: readonly JiraAttachment[];
+}
+/**
+ * Confluence ページ保存オプション
+ */
+export interface ConfluenceStorageOptions {
+    /** 出力先ベースディレクトリ */
+    readonly baseDir: string;
+    /** 入力 URL */
+    readonly sourceUrl: string;
+    /** CLI バージョン */
+    readonly cliVersion: string;
+}
+/**
+ * Confluence ページ保存データ
+ */
+export interface ConfluenceSaveData {
+    /** ページ ID */
+    readonly id: string;
+    /** ページタイトル */
+    readonly title: string;
+    /** ページ本文（Storage Format） */
+    readonly body: string;
+    /** ページ本文のプレーンテキスト */
+    readonly bodyPlainText: string;
+    /** スペースキー */
+    readonly spaceKey: string;
+    /** 現在のバージョン番号 */
+    readonly currentVersion: number;
+    /** バージョン一覧 */
+    readonly versions: readonly ConfluenceVersion[];
+    /** 添付ファイル一覧 */
+    readonly attachments: readonly ConfluenceAttachment[];
+}
+/**
+ * ストレージサービスのエラーの型
+ */
+export type StorageError = {
+    kind: 'DIRECTORY_CREATE_FAILED';
+    message: string;
+    path: string;
+} | {
+    kind: 'FILE_WRITE_FAILED';
+    message: string;
+    path: string;
+} | {
+    kind: 'INVALID_DATA';
+    message: string;
+};
+/**
+ * Jira Issue 保存結果
+ */
+export interface JiraSaveResult {
+    /** 保存先ディレクトリパス */
+    readonly directory: string;
+    /** 生成された Manifest */
+    readonly manifest: Manifest;
+}
+/**
+ * Confluence ページ保存結果
+ */
+export interface ConfluenceSaveResult {
+    /** 保存先ディレクトリパス */
+    readonly directory: string;
+    /** 生成された Manifest */
+    readonly manifest: Manifest;
+}
+/**
+ * バージョン間差分メタデータ
+ *
+ * design.md の Version Diff Schema に準拠
+ */
+export interface VersionDiff {
+    /** 比較元バージョン */
+    readonly fromVersion: number;
+    /** 比較先バージョン */
+    readonly toVersion: number;
+    /** 差分生成時刻（ISO 8601 形式） */
+    readonly generatedAt: string;
+    /** 差分統計 */
+    readonly stats: DiffStats;
+    /** 差分ハンク一覧 */
+    readonly hunks: readonly DiffHunk[];
+}
+/**
+ * ストレージサービスのインターフェース
+ */
+export interface StorageServiceInterface {
+    /**
+     * Jira Issue をディレクトリ構造で保存する
+     *
+     * @param data 保存データ
+     * @param options 保存オプション
+     * @returns 成功時は Ok(JiraSaveResult)、失敗時は Err(StorageError)
+     */
+    saveJiraIssue(data: JiraSaveData, options: JiraStorageOptions): Promise<Result<JiraSaveResult, StorageError>>;
+    /**
+     * Confluence ページをディレクトリ構造で保存する
+     *
+     * @param data 保存データ
+     * @param options 保存オプション
+     * @returns 成功時は Ok(ConfluenceSaveResult)、失敗時は Err(StorageError)
+     */
+    saveConfluencePage(data: ConfluenceSaveData, options: ConfluenceStorageOptions): Promise<Result<ConfluenceSaveResult, StorageError>>;
+}

package/dist/types/storage.js

@@ -0,0 +1,6 @@
+/**
+ * ストレージサービスに関する型定義
+ *
+ * Jira Issue / Confluence ページをディレクトリ構造で保存するための型を定義する。
+ */
+export {};

package/dist/types/url-parser.d.ts

@@ -0,0 +1,46 @@
+import type { Result } from 'neverthrow';
+/**
+ * URL 解析結果の型
+ */
+export interface UrlParseResult {
+    /** リソースタイプ（jira または confluence） */
+    readonly type: 'jira' | 'confluence';
+    /** Atlassian Cloud の組織名（サブドメイン） */
+    readonly organization: string;
+    /** リソース ID（Jira の場合は Issue キー、Confluence の場合はページ ID） */
+    readonly resourceId: string;
+    /** プロジェクトキー（Jira の場合のみ） */
+    readonly projectKey?: string;
+    /** スペースキー（Confluence の場合のみ） */
+    readonly spaceKey?: string;
+}
+/**
+ * URL 解析エラーの型
+ */
+export type UrlParseError = {
+    kind: 'INVALID_FORMAT';
+    message: string;
+} | {
+    kind: 'UNSUPPORTED_HOST';
+    message: string;
+} | {
+    kind: 'MISSING_RESOURCE_ID';
+    message: string;
+};
+/**
+ * URL バリデーションエラーの型
+ */
+export type UrlValidationError = {
+    kind: 'NOT_ATLASSIAN_CLOUD';
+    message: string;
+} | {
+    kind: 'UNSUPPORTED_RESOURCE';
+    message: string;
+};
+/**
+ * URL パーサーサービスのインターフェース
+ */
+export interface UrlParserService {
+    parse(url: string): Result<UrlParseResult, UrlParseError>;
+    validate(url: string): Result<void, UrlValidationError>;
+}

package/dist/types/url-parser.js

@@ -0,0 +1 @@
+export {};