# 画面設計書 167-税率編集画面

## 概要

本ドキュメントは、Medusa Admin Dashboardの税率編集画面の設計仕様を定義したものである。

### 本画面の処理概要

税率編集画面は、既存の税率（デフォルト税率）の設定を変更するためのドロワー形式の画面である。

**業務上の目的・背景**：税制度の変更や運用上の調整により、既存の税率を更新する必要が生じた場合に使用する。名前、税率、税コード、結合可能フラグを変更できる。

**画面へのアクセス方法**：税リージョン詳細画面または都道府県詳細画面の税率行から編集アクション（編集ボタン）を選択することでドロワーが開く。

**主要な操作・処理内容**：
1. 現在の税率情報の確認
2. 税率名の編集
3. 税率の編集
4. 税コードの編集
5. 結合可能フラグの編集（サブレベルの場合のみ）
6. 保存ボタンで変更を適用

**画面遷移**：
- 遷移元：税リージョン詳細画面 / 都道府県詳細画面
- 遷移先：保存成功時は元の画面に戻る

**権限による表示制御**：管理者権限を持つユーザーのみがアクセス可能。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 55 | 税率管理 | 主機能 | 税率情報の編集 |

## 画面種別

編集（ドロワー形式）

## URL/ルーティング

- 税リージョンレベル: `/settings/tax-regions/:id/tax-rates/:tax_rate_id/edit`
- 都道府県レベル: `/settings/tax-regions/:id/provinces/:province_id/tax-rates/:tax_rate_id/edit`

## 入出力項目

| 項目名 | 型 | 必須 | 説明 |
|--------|-----|------|------|
| name | string | 必須 | 税率の名前 |
| rate | number | 任意 | 税率（%） |
| code | string | 任意 | 税コード |
| is_combinable | boolean | 任意 | 税率の結合可能フラグ（サブレベルのみ） |

## 表示項目

| セクション | 項目 | 説明 |
|-----------|------|------|
| ヘッダー | 画面タイトル | 「税率を編集」 |
| フォーム | 名前 | テキスト入力（現在値をデフォルト表示） |
| フォーム | 税コード | テキスト入力（現在値をデフォルト表示） |
| フォーム | 税率 | パーセンテージ入力（現在値をデフォルト表示、小数点以下4桁まで） |
| フォーム | 結合可能 | スイッチ（サブレベルの場合のみ表示、現在値をデフォルト） |
| フッター | キャンセルボタン | ドロワーを閉じる |
| フッター | 保存ボタン | 変更を保存 |

## イベント仕様

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

保存ボタンを押下すると、以下の処理が実行される：

1. フォームのバリデーションを実行
2. バリデーション成功時、`useUpdateTaxRate` フックを使用してAPI呼び出し
3. リクエストペイロードに更新する税率情報を含める
4. 成功時：成功トーストを表示し、ドロワーを閉じる
5. 失敗時：エラートーストを表示

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

ドロワーを閉じて元の画面に戻る。

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

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

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| 保存ボタン押下 | tax_rate | UPDATE | 税率情報の更新 |

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

#### tax_rate

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | name | フォーム入力値 | |
| UPDATE | rate | フォーム入力値（パーセント値） | |
| UPDATE | code | フォーム入力値 | |
| UPDATE | is_combinable | フォーム入力値 | サブレベルの場合のみ |
| UPDATE | updated_at | 現在日時 | 自動更新 |

## メッセージ仕様

| メッセージ種別 | メッセージ内容 | 表示条件 |
|--------------|--------------|---------|
| 成功 | 税率が更新されました | 更新成功時 |
| エラー | 名前を入力してください | 名前未入力時 |
| エラー | {エラーメッセージ} | API呼び出し失敗時 |

## 例外処理

| 例外ケース | 処理内容 |
|-----------|---------|
| 必須項目未入力 | バリデーションエラーを表示 |
| 税率が存在しない | エラーをスロー |
| ネットワークエラー | エラートーストを表示 |

## 備考

- 税コードは任意項目として扱われる（作成時とは異なる）
- is_combinable はサブレベル（都道府県レベル）の場合のみ表示される
- 税率は小数点以下4桁まで指定可能
- 現在の値がフォームのデフォルト値として設定される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | tax-region-tax-rate-edit-form.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-edit/components/tax-region-tax-rate-edit-form/tax-region-tax-rate-edit-form.tsx` | TaxRegionTaxRateEditSchema（20-28行目）でフォームのデータ構造を確認 |

**読解のコツ**: nameのみ必須（min(1)）、codeはオプションに変更されていることを確認。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | tax-region-edit.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-edit/tax-region-edit.tsx` | 税率取得とドロワー表示 |

**主要処理フロー**:
1. **10行目**: useParamsでURLからprovince_id, tax_rate_idを取得
2. **12行目**: useTaxRateで現在の税率データを取得
3. **20-37行目**: RouteDrawer内にヘッダーとフォームをレンダリング

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | tax-region-tax-rate-edit-form.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-edit/components/tax-region-tax-rate-edit-form/tax-region-tax-rate-edit-form.tsx` | フォームの実装とAPI呼び出しロジック |

**主要処理フロー**:
- **37-47行目**: useFormでフォーム状態を初期化（現在値をデフォルト値として設定）
- **49行目**: useUpdateTaxRateフックでAPIミューテーション取得
- **51-69行目**: handleSubmitでフォーム送信処理
- **135-142行目**: isSublevelの場合のみis_combinableスイッチを表示

#### Step 4: API連携を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | tax-rates.tsx | `packages/admin/dashboard/src/hooks/api/tax-rates.tsx` | useUpdateTaxRateフックの実装 |

**主要処理フロー**:
- **61-83行目**: useUpdateTaxRateの実装、sdk.admin.taxRate.updateを呼び出し
- **77行目**: taxRegionsQueryKeys.details()も無効化

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

```
TaxRegionEdit (tax-region-edit.tsx - tax-rate-edit版)
    │
    ├─ useParams (React Router)
    │      └─ province_id, tax_rate_id取得
    │
    ├─ useTaxRate (tax-rates.tsx)
    │      └─ sdk.admin.taxRate.retrieve
    │
    └─ TaxRegionTaxRateEditForm (tax-region-tax-rate-edit-form.tsx)
           │
           ├─ useForm (react-hook-form)
           │      └─ zodResolver (バリデーション)
           │
           └─ useUpdateTaxRate (tax-rates.tsx)
                  └─ sdk.admin.taxRate.update (API呼び出し)
```

### データフロー図

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

URLパラメータ
  (province_id, tax_rate_id) ─▶ TaxRegionEdit
                                    │
現在の税率 ◀─────────────────── useTaxRate
                                    │
名前（必須）─────────────┐        │
                        │        ▼
税率（任意）───────────┤  TaxRegionTaxRateEditForm ───▶ 元の画面へ戻る
                        │       │
税コード（任意）────────┤       └─▶ useUpdateTaxRate
                        │               │
結合可能フラグ ─────────┘               └─▶ PATCH /admin/tax-rates/:id
（サブレベルのみ）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| tax-region-edit.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-edit/tax-region-edit.tsx` | ソース | エントリーポイント |
| tax-region-tax-rate-edit-form.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-edit/components/tax-region-tax-rate-edit-form/tax-region-tax-rate-edit-form.tsx` | ソース | フォームコンポーネント |
| tax-rates.tsx | `packages/admin/dashboard/src/hooks/api/tax-rates.tsx` | ソース | API連携フック |
| index.ts | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-edit/index.ts` | ソース | エクスポート定義 |
| RouteDrawer | `packages/admin/dashboard/src/components/modals` | ソース | ドロワーコンポーネント |
| PercentageInput | `packages/admin/dashboard/src/components/inputs/percentage-input` | ソース | パーセント入力コンポーネント |
| SwitchBox | `packages/admin/dashboard/src/components/common/switch-box` | ソース | スイッチボックスコンポーネント |
