# 画面設計書 69-予算編集画面

## 概要

本ドキュメントは、Medusa Admin Dashboard の予算編集画面について、画面仕様・機能・データ処理を定義した画面設計書です。

### 本画面の処理概要

この画面では、キャンペーンの予算上限を編集することができます。予算タイプに応じて、使用回数の上限または支出額の上限を設定します。

**業務上の目的・背景**：キャンペーンの予算上限を変更するための専用画面です。キャンペーン詳細画面のサイドバーにある「予算」セクションから直接アクセスでき、予算上限のみを素早く変更できます。予算タイプが「spend」の場合は通貨入力、「usage」の場合は数値入力となります。

**画面へのアクセス方法**：キャンペーン詳細画面のサイドバーにある予算セクションの編集ボタンをクリックすることで、ドロワー形式でこの画面が表示されます。URL: `/campaigns/:id/edit-budget`

**主要な操作・処理内容**：
1. 予算上限を編集（通貨入力または数値入力）
2. 保存ボタンで更新を実行

**画面遷移**：
- 遷移元：キャンペーン詳細画面（`/campaigns/:id`）
- 遷移先：更新成功時はドロワーを閉じてキャンペーン詳細画面に戻る、キャンセル時も同様

**権限による表示制御**：認証済みの管理者ユーザーのみがアクセス可能です。キャンペーン管理権限を持つユーザーが操作できます。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 38 | キャンペーン管理 | 主機能 | キャンペーン予算の編集 |
| 39 | キャンペーン予算管理 | 補助機能 | 予算上限の設定 |

## 画面種別

編集（ドロワー形式）

## URL/ルーティング

`/campaigns/:id/edit-budget`

## 入出力項目

| 項目名 | 項目ID | 型 | 必須 | 入力/出力 | 説明 |
|--------|--------|-----|------|-----------|------|
| 予算上限 | limit | number | - | 入力 | 0以上、null許可 |

## 表示項目

| 項目名 | 説明 |
|--------|------|
| 画面タイトル | 「予算を編集」 |
| 予算上限フィールド | 予算タイプがspendの場合はCurrencyInput、それ以外はInput |
| キャンセルボタン | ドロワーを閉じる |
| 保存ボタン | 変更を保存 |

## イベント仕様

### 1-保存ボタン押下

**処理フロー**：
1. フォームバリデーションを実行
2. `useUpdateCampaign` フックを使用してAPIを呼び出し
3. 予算上限が未設定の場合はnullを送信
4. 成功時：トースト通知を表示し、ドロワーを閉じる
5. 失敗時：エラーメッセージをトーストで表示

**API呼び出し**：
- エンドポイント: `POST /admin/campaigns/:id`
- リクエストボディ:
```json
{
  "budget": {
    "limit": number | null
  }
}
```

### 2-キャンセルボタン押下

**処理フロー**：
1. フォームの入力内容を破棄
2. ドロワーを閉じてキャンペーン詳細画面に戻る

## データベース更新仕様

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

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| 保存ボタン押下 | campaign_budget | UPDATE | キャンペーン予算上限の更新 |

### テーブル別更新項目詳細

#### campaign_budget

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | limit | フォームの limit または null | null許可 |

## メッセージ仕様

| メッセージID | 種別 | メッセージ内容 | 表示条件 |
|-------------|------|---------------|----------|
| MSG-001 | 成功 | キャンペーン「{name}」を更新しました | 更新成功時 |
| MSG-002 | エラー | {エラーメッセージ} | API通信エラー時 |

## 例外処理

| 例外 | 処理内容 |
|------|---------|
| キャンペーンが見つからない | エラーをスローしてエラー画面を表示 |
| API通信エラー | エラーメッセージをtoastで表示 |

## 備考

- ドロワー形式（RouteDrawer）で表示される
- 予算タイプに応じて入力フィールドが変わる
  - spend: CurrencyInputで通貨付き入力
  - usage/use_by_attribute: 通常のInputで数値入力
- CurrencyInputではキャンペーンの予算通貨コードを表示
- 予算上限は0以上の数値、またはnull（無制限）
- 空欄で保存するとnull（無制限）として扱われる

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | edit-campaign-budget-form.tsx | `packages/admin/dashboard/src/routes/campaigns/campaign-budget-edit/components/edit-campaign-budget-form/edit-campaign-budget-form.tsx` | EditCampaignSchema（17-19行目）でフォームの構造を確認 |

**読解のコツ**: limitフィールドのみを持つシンプルな編集フォームです。min(0)で0以上の制約があり、nullableです。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | campaign-budget-edit.tsx | `packages/admin/dashboard/src/routes/campaigns/campaign-budget-edit/campaign-budget-edit.tsx` | RouteDrawerレイアウトとキャンペーンデータのロード |

**主要処理フロー**:
1. **11行目**: useParamsでキャンペーンIDを取得
2. **12行目**: useCampaignでキャンペーン詳細を取得
3. **18-28行目**: RouteDrawerでドロワーをレンダリング
4. **26行目**: EditCampaignBudgetFormコンポーネントを表示

#### Step 3: フォームコンポーネントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | edit-campaign-budget-form.tsx | `packages/admin/dashboard/src/routes/campaigns/campaign-budget-edit/components/edit-campaign-budget-form/edit-campaign-budget-form.tsx` | フォームロジックと送信処理 |

**主要処理フロー**:
- **27-32行目**: useFormでフォーム初期化（既存の予算上限をデフォルト値に設定）
- **34行目**: useUpdateCampaignでミューテーション準備
- **36-58行目**: handleSubmitで送信処理
- **39-41行目**: budget.limitの値を送信（空ならnull）
- **76-107行目**: 予算タイプによる入力フィールドの分岐

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

```
CampaignBudgetEdit (campaign-budget-edit.tsx)
    │
    ├─ useCampaign() - キャンペーン詳細取得
    │      └─ sdk.admin.campaign.retrieve()
    │             └─ GET /admin/campaigns/:id
    │
    └─ EditCampaignBudgetForm (edit-campaign-budget-form.tsx)
           │
           ├─ useForm() - フォーム状態管理
           │
           ├─ getCurrencySymbol() - 通貨シンボル取得
           │
           └─ useUpdateCampaign() - 更新ミューテーション
                  └─ sdk.admin.campaign.update()
                         └─ POST /admin/campaigns/:id
                                └─ updateCampaignsWorkflow
```

### データフロー図

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

URLパラメータ ────▶ useCampaign() ────▶ キャンペーン詳細
     (id)                                      ↓
                    budget.type確認 ──▶ 入力タイプ判定
                                              ↓
                    useForm() ─────────▶ フォーム初期化
                                              ↓
予算上限入力 ───────▶ CurrencyInput ──▶ 編集データ
              または   /Input
                                              ↓
保存ボタン ──────────▶ handleSubmit ───▶ null変換処理
                                              ↓
                    useUpdateCampaign() ▶ API更新
                                              ↓
                    toast.success() ──▶ 成功通知
                                              ↓
                    handleSuccess() ──▶ ドロワー閉じる
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| campaign-budget-edit.tsx | `packages/admin/dashboard/src/routes/campaigns/campaign-budget-edit/campaign-budget-edit.tsx` | ソース | エントリーポイント |
| edit-campaign-budget-form.tsx | `packages/admin/dashboard/src/routes/campaigns/campaign-budget-edit/components/edit-campaign-budget-form/edit-campaign-budget-form.tsx` | ソース | フォームコンポーネント |
| currencies.ts | `packages/admin/dashboard/src/lib/data/currencies.ts` | ソース | 通貨シンボル取得 |
| campaigns.tsx | `packages/admin/dashboard/src/hooks/api/campaigns.tsx` | ソース | APIフック |
| route.ts | `packages/medusa/src/api/admin/campaigns/[id]/route.ts` | ソース | APIエンドポイント |
