# 画面設計書 169-税オーバーライド編集画面

## 概要

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

### 本画面の処理概要

税オーバーライド編集画面は、既存の税オーバーライド設定を変更するためのドロワー形式の画面である。

**業務上の目的・背景**：税オーバーライドの内容（名前、税率、税コード、適用対象）を更新する必要が生じた場合に使用する。例えば、軽減税率の対象商品を追加・削除したり、税率を変更したりする場合に使用する。

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

**主要な操作・処理内容**：
1. 現在のオーバーライド情報の確認
2. 名前の編集
3. 税率の編集
4. 税コードの編集
5. 結合可能フラグの編集
6. 適用対象（商品/商品タイプ/配送オプション）の編集
7. 保存ボタンで変更を適用

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

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

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 55 | 税率管理 | 主機能 | 税オーバーライドの編集 |

## 画面種別

編集（ドロワー形式）

## URL/ルーティング

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

## 入出力項目

| 項目名 | 型 | 必須 | 説明 |
|--------|-----|------|------|
| name | string | 必須 | オーバーライド名 |
| rate | number | 任意 | 税率（%） |
| code | string | 必須 | 税コード |
| is_combinable | boolean | 任意 | 税率の結合可能フラグ |
| enabled_rules.product | boolean | - | 商品ルールの有効/無効 |
| enabled_rules.product_type | boolean | - | 商品タイプルールの有効/無効 |
| enabled_rules.shipping_option | boolean | - | 配送オプションルールの有効/無効 |
| product | array | 任意 | 対象商品一覧 |
| product_type | array | 任意 | 対象商品タイプ一覧 |
| shipping_option | array | 任意 | 対象配送オプション一覧 |

## 表示項目

| セクション | 項目 | 説明 |
|-----------|------|------|
| ヘッダー | 画面タイトル | 「税オーバーライドを編集」 |
| 基本情報 | 名前 | テキスト入力（現在値をデフォルト表示） |
| 基本情報 | 税コード | テキスト入力（現在値をデフォルト表示） |
| 基本情報 | 税率 | パーセンテージ入力（現在値をデフォルト表示、小数点以下4桁まで） |
| オプション | 結合可能 | スイッチ（現在値をデフォルト） |
| 適用対象 | ターゲットルール | 商品/商品タイプ/配送オプションの選択カード（現在値を表示） |
| フッター | キャンセルボタン | ドロワーを閉じる |
| フッター | 保存ボタン | 変更を保存 |

## イベント仕様

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

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

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

### 2-ターゲット追加ボタン押下

新しいルールタイプを追加する。利用可能なルールタイプから選択。

### 3-ブラウズボタン押下

StackedDrawerを開き、対象（商品/商品タイプ/配送オプション）を検索・選択する。

### 4-ターゲット削除ボタン押下

選択したルールタイプとその対象を削除する。

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

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

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

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

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| 保存ボタン押下 | tax_rate | UPDATE | 税オーバーライド情報の更新 |
| 保存ボタン押下 | tax_rate_rule | DELETE/INSERT | 税率ルールの再作成 |

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

#### tax_rate

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | name | フォーム入力値 | |
| UPDATE | rate | フォーム入力値（パーセント値） | |
| UPDATE | code | フォーム入力値 | null指定可能 |
| UPDATE | is_combinable | フォーム入力値 | |
| UPDATE | updated_at | 現在日時 | 自動更新 |

#### tax_rate_rule

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE/INSERT | - | - | 全ルールを置き換え |

## メッセージ仕様

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

## 例外処理

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

## 備考

- 既存のルール情報は初期表示時に取得・表示される（最大10件まで表示）
- 10件を超える対象がある場合は「+N件」として表示
- StackedDrawer（ドロワー内ドロワー）で対象選択UIを提供
- 現在の値がフォームのデフォルト値として設定される

---

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

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

### 推奨読解順序

#### Step 1: 初期データ取得を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | tax-region-tax-override-edit.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-override-edit/tax-region-tax-override-edit.tsx` | useDefaultRulesValues（54-211行目）で既存ルールの初期値取得ロジックを確認 |

**読解のコツ**:
- 各ルールタイプごとにIDを抽出し、対応するフック（useProducts, useProductTypes, useShippingOptions）でエンティティ情報を取得
- DISPLAY_OVERRIDE_ITEMS_LIMIT（10件）で表示上限を制御

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

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

**主要処理フロー**:
1. **20行目**: useParamsでURLからtax_rate_idを取得
2. **22行目**: useTaxRateで現在の税率データを取得
3. **24-25行目**: useDefaultRulesValuesで既存ルールの初期値を取得
4. **33-50行目**: RouteDrawer内にヘッダーとフォームをレンダリング

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

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

**主要処理フロー**:
- **86-111行目**: useFormでフォーム状態を初期化（現在値と既存ルールをデフォルト値として設定）
- **113行目**: useUpdateTaxRateフックでAPIミューテーション取得
- **115-179行目**: handleSubmitでフォーム送信処理
- **596-610行目**: 表示上限を超える場合の「+N件」表示

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

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

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

```
TaxRegionTaxOverrideEdit (tax-region-tax-override-edit.tsx)
    │
    ├─ useParams (React Router)
    │      └─ tax_rate_id取得
    │
    ├─ useTaxRate (tax-rates.tsx)
    │      └─ sdk.admin.taxRate.retrieve
    │
    ├─ useDefaultRulesValues (カスタムフック)
    │      ├─ useProducts
    │      ├─ useProductTypes
    │      └─ useShippingOptions
    │
    └─ TaxRegionTaxOverrideEditForm (tax-region-tax-override-edit-form.tsx)
           │
           ├─ useForm (react-hook-form)
           │      └─ zodResolver (バリデーション)
           │
           ├─ useFieldArray (複数)
           │      ├─ products
           │      ├─ productTypes
           │      └─ shippingOptions
           │
           ├─ StackedDrawer
           │      └─ TargetForm (商品/商品タイプ/配送オプション選択)
           │
           └─ useUpdateTaxRate (tax-rates.tsx)
                  └─ sdk.admin.taxRate.update (API呼び出し)
```

### データフロー図

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

URLパラメータ
  (tax_rate_id) ───────▶ TaxRegionTaxOverrideEdit
                                │
現在の税率 ◀───────────────── useTaxRate
                                │
既存ルール ◀───────────────── useDefaultRulesValues
                                │       ├─▶ useProducts
                                │       ├─▶ useProductTypes
                                │       └─▶ useShippingOptions
                                │
名前（必須）─────────────┐    │
                        │    ▼
税率（任意）───────────┤  TaxRegionTaxOverrideEditForm
                        │       │
税コード（必須）────────┤       ├─▶ createTaxRulePayload
                        │       │       └─▶ ルール配列を生成
結合可能フラグ ─────────┤       │
                        │       └─▶ useUpdateTaxRate
ターゲットルール ───────┤               │
  - 商品               │               └─▶ PATCH /admin/tax-rates/:id
  - 商品タイプ         │                       (rules: [...])
  - 配送オプション ────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| tax-region-tax-override-edit.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-override-edit/tax-region-tax-override-edit.tsx` | ソース | エントリーポイント |
| tax-region-tax-override-edit-form.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-override-edit/components/tax-region-tax-override-edit-form/tax-region-tax-override-edit-form.tsx` | ソース | フォームコンポーネント |
| types.ts | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-override-edit/types.ts` | ソース | 型定義 |
| constants.ts | `packages/admin/dashboard/src/routes/tax-regions/common/constants.ts` | ソース | ルールタイプ定義 |
| utils.ts | `packages/admin/dashboard/src/routes/tax-regions/common/utils.ts` | ソース | ユーティリティ関数 |
| target-form.tsx | `packages/admin/dashboard/src/routes/tax-regions/common/components/target-form/target-form.tsx` | ソース | ターゲット選択フォーム |
| target-item.tsx | `packages/admin/dashboard/src/routes/tax-regions/common/components/target-item/target-item.tsx` | ソース | ターゲットアイテム表示 |
| tax-rates.tsx | `packages/admin/dashboard/src/hooks/api/tax-rates.tsx` | ソース | API連携フック |
