# 機能設計書 30-YNAB4インポート

## 概要

本ドキュメントは、Actual Budget における YNAB4インポート機能の設計仕様を記述する。この機能は、YNAB4（You Need A Budget 4）形式のバックアップファイルからデータをインポートし、Actualへの移行を支援することを目的とする。

### 本機能の処理概要

YNAB4インポート機能は、YNAB4デスクトップ版のバックアップファイル（.ynab4形式のZIPファイル）を解析し、口座、カテゴリ、支払先、取引、予算データをActual形式に変換してインポートする。これにより、YNAB4ユーザーがActualに移行する際のデータ移行を自動化する。

**業務上の目的・背景**：YNAB4は人気のある予算管理ソフトウェアであったが、開発終了によりユーザーは新しいソリューションを探している。Actualは YNAB4の精神を受け継いでおり、既存のYNAB4ユーザーがスムーズに移行できるようにすることは重要である。手動でのデータ移行は膨大な作業となるため、自動インポート機能が必要である。

**機能の利用シーン**：
- YNAB4からActualへの移行時
- YNAB4バックアップからの復元
- 過去の財務データのActualへの取り込み

**主要な処理内容**：
1. ZIPファイルの解析：.ynab4形式のZIPファイルを展開
2. 最新デバイスの特定：複数デバイスのデータから最新を選択
3. Budget.yfullの解析：JSON形式の予算データをパース
4. 口座のインポート：口座情報をActual形式に変換
5. カテゴリのインポート：カテゴリとカテゴリグループをインポート
6. 支払先のインポート：支払先データをインポート
7. 取引のインポート：取引データ（分割取引含む）をインポート
8. 予算のインポート：月次予算データをインポート

**関連システム・外部連携**：
- AdmZip：ZIPファイルの解析
- Actual API：データのインポート

**権限による制御**：特別な権限制御はなく、予算ファイル作成権限があれば実行可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 7 | ウェルカム画面 | 遷移先機能 | YNAB4形式のデータインポート画面への遷移 |

## 機能種別

データインポート / バッチ処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| buffer | Buffer | Yes | YNAB4バックアップファイルの内容 | ZIPファイル形式 |

### YNAB4ファイル構造

```
Budget~51938D82.ynab4/
├── Budget.ymeta           # メタ情報（データフォルダパス）
└── data1~E1A4F694/        # データフォルダ
    ├── devices/           # デバイス情報
    │   └── */
    │       └── deviceSettings
    └── {deviceGUID}/
        └── Budget.yfull   # メインの予算データ（JSON）
```

### Budget.yfull構造

| フィールド | 型 | 説明 |
|-----------|-----|------|
| accounts | Account[] | 口座一覧 |
| masterCategories | MasterCategory[] | カテゴリグループ一覧 |
| payees | Payee[] | 支払先一覧 |
| transactions | Transaction[] | 取引一覧 |
| monthlyBudgets | MonthlyBudget[] | 月次予算一覧 |
| scheduledTransactions | ScheduledTransaction[] | スケジュール取引（未使用） |

### 入力データソース

- ユーザーがアップロードしたYNAB4バックアップファイル

## 出力仕様

### 出力データ

インポートされるデータ:

| データ種別 | 説明 |
|-----------|------|
| 口座 | YNAB4の口座をActual口座に変換 |
| カテゴリグループ | masterCategoriesをActualカテゴリグループに変換 |
| カテゴリ | subCategoriesをActualカテゴリに変換 |
| 支払先 | payeesをActual支払先に変換 |
| 取引 | transactionsをActual取引に変換（分割取引含む） |
| 予算 | monthlyBudgetsをActual予算に変換 |

### 出力先

- ローカルDB：Actualの各テーブル

## 処理フロー

### 処理シーケンス

```
1. ファイル解析
   └─ ZIPファイルを展開
   └─ Budget.ymetaから相対パスを取得
   └─ devicesフォルダから最新デバイスを特定
   └─ Budget.yfullをJSONとしてパース

2. 口座インポート
   └─ 各口座をsortableIndexでソート
   └─ tombstoneでない口座をActualに作成
   └─ entityIdとActual IDのマッピングを保存

3. カテゴリインポート
   └─ masterCategories（type=OUTFLOW）をインポート
   └─ subCategoriesをインポート
   └─ Hidden Categoriesの名前を整形

4. 支払先インポート
   └─ tombstoneでない支払先をインポート
   └─ 振替先口座の関連付け

5. 取引インポート
   └─ 全取引にUUIDを事前生成（振替対応）
   └─ 口座ごとにグループ化
   └─ 各取引を変換（分割取引含む）
   └─ addTransactionsでバッチインポート

6. 予算インポート
   └─ 月次予算をbatchBudgetUpdates内で処理
   └─ カテゴリごとの予算額を設定
   └─ 繰越設定（Carryover）を設定
```

### フローチャート

```mermaid
flowchart TD
    A[YNAB4ファイル受信] --> B[parseFile]
    B --> C[ZIPを展開]
    C --> D[Budget.ymeta読み込み]
    D --> E[最新デバイス特定]
    E --> F[Budget.yfull読み込み]
    F --> G[doImport]
    G --> H[importAccounts]
    H --> I[importCategories]
    I --> J[importPayees]
    J --> K[importTransactions]
    K --> L[importBudgets]
    L --> M[完了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-30-1 | tombstone除外 | isTombstone=trueのエンティティはスキップ | 全インポート処理 |
| BR-30-2 | 最新デバイス選択 | knowledgeの総バージョン数が最大のデバイスを使用 | ファイル解析時 |
| BR-30-3 | カテゴリタイプ限定 | type='OUTFLOW'のmasterCategoriesのみインポート | カテゴリインポート時 |
| BR-30-4 | 収入カテゴリマッピング | __ImmediateIncome__/__DeferredIncome__はIncomeカテゴリに | 取引インポート時 |
| BR-30-5 | オフバジェット口座 | onBudget=falseの口座はoffbudget=trueで作成 | 口座インポート時 |
| BR-30-6 | Hidden Categoriesの名前整形 | entityIdを除去し、パス区切りを"/"に変更 | カテゴリインポート時 |

### 計算ロジック

**最新デバイス特定（estimateRecentness）**:
```javascript
function estimateRecentness(str) {
  return str.split(',').reduce((total, version) => {
    const [_, number] = version.split('-');
    return total + parseInt(number);
  }, 0);
}
```

**金額変換**:
```javascript
amountToInteger(transaction.amount)  // 小数点以下を整数に変換
```

**清算状態マッピング**:
```javascript
cleared: transaction.cleared === 'Cleared' || transaction.cleared === 'Reconciled'
reconciled: transaction.cleared === 'Reconciled'
```

**予算繰越設定**:
```javascript
if (overspendingHandling === 'AffectsBuffer') {
  setBudgetCarryover(month, catId, false);  // 繰越なし
} else if (overspendingHandling === 'Confined') {
  setBudgetCarryover(month, catId, true);   // 繰越あり
}
```

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 口座インポート | accounts | INSERT | 口座レコードの作成 |
| カテゴリグループインポート | category_groups | INSERT | カテゴリグループの作成 |
| カテゴリインポート | categories | INSERT | カテゴリの作成 |
| 支払先インポート | payees | INSERT | 支払先の作成 |
| 取引インポート | transactions | INSERT | 取引の作成 |
| 予算インポート | budget | INSERT/UPDATE | 予算額の設定 |
| ノート保存 | notes | INSERT | カテゴリノートの保存 |

### エンティティIDマッピング

インポート処理ではYNAB4のentityIdとActualのIDのマッピングを`entityIdMap`（Map<string, string>）で管理する。

| YNAB4 entityId | Actual ID |
|----------------|-----------|
| account.entityId | account.id |
| masterCategory.entityId | categoryGroup.id |
| subCategory.entityId | category.id |
| payee.entityId | payee.id |
| transaction.entityId | transaction.id |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| FILE_NOT_FOUND | ファイルエラー | 必要なファイルがZIP内にない | 正しいYNAB4バックアップを使用 |
| PARSE_ERROR | パースエラー | Budget.yfullのJSON解析失敗 | ファイルの破損を確認 |
| ACCOUNT_NOT_FOUND | 参照エラー | 取引の口座が見つからない | データの整合性を確認 |

### リトライ仕様

- インポートは一括処理のため、エラー時は最初からやり直し
- 部分的なインポートは行わない

## トランザクション仕様

- 各データ種別のインポートは個別に実行
- 予算インポートはbatchBudgetUpdates内でバッチ処理

## パフォーマンス要件

- 大規模ファイル（数年分のデータ）でも5分以内に完了

## セキュリティ考慮事項

- アップロードされたファイルは一時的に処理され、永続化されない
- ファイル内の機密情報（口座名、取引内容等）はローカルDBに保存

## 備考

- スケジュール取引（scheduledTransactions）は現在インポート対象外
- payeeのrenameConditions（ルール）は現在インポート対象外
- YNAB5（nYNAB）は別のインポーター（ynab5.ts）で対応

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: 型定義を理解する

YNAB4のデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ynab4-types.ts | `packages/loot-core/src/server/importers/ynab4-types.ts` | YFull, Account, Transaction等の型定義 |

**読解のコツ**:
- **1-11行目**: `YFull`型 - Budget.yfullのトップレベル構造
- **13-27行目**: `MasterCategory`型 - カテゴリグループ
- **29-42行目**: `SubCategory`型 - カテゴリ
- **44-59行目**: `Payee`型 - 支払先
- **97-115行目**: `Transaction`型 - 取引（subTransactionsを含む）
- **148-163行目**: `Account`型 - 口座

#### Step 2: インポート処理を理解する

メインのインポート処理を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ynab4.ts | `packages/loot-core/src/server/importers/ynab4.ts` | インポート処理全体 |

**主要処理フロー**:
- **408-441行目**: `parseFile` - ZIPファイルの解析
  - **409-410行目**: ZIPを展開、エントリ取得
  - **418-419行目**: Budget.ymeta読み込み
  - **422-425行目**: 最新デバイス特定
  - **430-440行目**: Budget.yfull読み込み・パース

- **348-367行目**: `doImport` - メインインポート処理
  - 各インポート関数を順次呼び出し

- **20-38行目**: `importAccounts` - 口座インポート
  - sortableIndexでソート
  - tombstoneでないものをcreateAccount

- **40-104行目**: `importCategories` - カテゴリインポート
  - masterCategories（type=OUTFLOW）をインポート
  - Hidden Categoriesの名前整形

- **106-122行目**: `importPayees` - 支払先インポート

- **124-242行目**: `importTransactions` - 取引インポート
  - **157-165行目**: 全取引にUUIDを事前生成
  - **167行目**: 口座ごとにグループ化
  - **173-231行目**: 取引変換処理
  - **237-240行目**: addTransactionsでバッチインポート

- **274-307行目**: `importBudgets` - 予算インポート
  - **280行目**: batchBudgetUpdates内で処理
  - **296-302行目**: 予算額と繰越設定

#### Step 3: ユーティリティ関数を理解する

補助的な関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ynab4.ts | `packages/loot-core/src/server/importers/ynab4.ts` | ユーティリティ関数 |

**主要関数**:
- **309-318行目**: `estimateRecentness` - デバイスの最新度を推定
- **320-346行目**: `findLatestDevice` - 最新デバイスを特定
- **369-386行目**: `getBudgetName` - ファイルパスから予算名を抽出
- **388-397行目**: `getFile` - ZIPエントリからファイル取得
- **399-406行目**: `join` - パス結合

### プログラム呼び出し階層図

```
parseFile(buffer)
    │
    ├─ AdmZip(buffer)
    │
    ├─ getFile(entries, 'Budget.ymeta')
    │
    ├─ findLatestDevice(zipped, deviceFiles)
    │       │
    │       └─ estimateRecentness(knowledge)
    │
    └─ JSON.parse(Budget.yfull)


doImport(data)
    │
    ├─ importAccounts(data, entityIdMap)
    │       │
    │       └─ actual.createAccount()
    │
    ├─ importCategories(data, entityIdMap)
    │       │
    │       ├─ actual.createCategoryGroup()
    │       │
    │       └─ actual.createCategory()
    │
    ├─ importPayees(data, entityIdMap)
    │       │
    │       └─ actual.createPayee()
    │
    ├─ importTransactions(data, entityIdMap)
    │       │
    │       ├─ groupBy(transactions, 'accountId')
    │       │
    │       └─ actual.addTransactions()
    │
    └─ importBudgets(data, entityIdMap)
            │
            ├─ actual.batchBudgetUpdates()
            │
            ├─ actual.setBudgetAmount()
            │
            └─ actual.setBudgetCarryover()
```

### データフロー図

```
[入力]                      [処理]                       [出力]

YNAB4バックアップ
(.ynab4 ZIP)
    │
    ▼
┌─────────────┐
│  parseFile  │
│             │
│  ├─ ZIP解凍 │
│  ├─ メタ読込│
│  └─ JSON解析│
└─────────────┘
    │
    ▼
Budget.yfull (JSON)
    │
    ▼
┌─────────────┐            ┌─────────────┐
│  doImport   │            │             │
│             │            │  Actual DB  │
│ ├─ Accounts │──────────▶│  accounts   │
│ │           │            │             │
│ ├─ Category │──────────▶│  categories │
│ │   Groups  │            │  cat_groups │
│ │           │            │             │
│ ├─ Payees   │──────────▶│  payees     │
│ │           │            │             │
│ ├─ Trans    │──────────▶│transactions │
│ │           │            │             │
│ └─ Budgets  │──────────▶│  budget     │
└─────────────┘            └─────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ynab4.ts | `packages/loot-core/src/server/importers/ynab4.ts` | ソース | YNAB4インポート処理本体 |
| ynab4-types.ts | `packages/loot-core/src/server/importers/ynab4-types.ts` | ソース | YNAB4データ型定義 |
| index.ts | `packages/loot-core/src/server/importers/index.ts` | ソース | インポーターエクスポート |
| methods.ts | `packages/api/methods.ts` | ソース | Actual API（createAccount等） |
| util.ts | `packages/loot-core/src/shared/util.ts` | ソース | amountToInteger, groupBy等 |
