# 画面設計書 166-税率作成画面

## 概要

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

### 本画面の処理概要

税率作成画面は、税リージョンに対して新規のデフォルト税率を追加するためのモーダル形式の画面である。

**業務上の目的・背景**：税リージョンには複数のデフォルト税率を設定することができる。例えば、標準税率と軽減税率を分けて管理する場合などに使用する。この画面では、新しいデフォルト税率を作成し、税リージョンに紐付ける。

**画面へのアクセス方法**：税リージョン詳細画面または都道府県詳細画面から「税率を追加」ボタンをクリックすることでモーダルが表示される。

**主要な操作・処理内容**：
1. 税率名の入力（必須）
2. 税率の設定（任意）
3. 税コードの入力（必須）
4. 結合可能フラグの設定（サブレベルの場合のみ表示）
5. 保存ボタンで税率を登録

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

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

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 55 | 税率管理 | 主機能 | 新規税率の作成 |

## 画面種別

登録（モーダルフォーム）

## URL/ルーティング

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

## 入出力項目

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

## 表示項目

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

## イベント仕様

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

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

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

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

モーダルを閉じて元の画面に戻る。

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

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

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

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

#### tax_rate

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | 自動生成UUID | |
| INSERT | tax_region_id | URLパラメータから取得 | |
| INSERT | name | フォーム入力値 | |
| INSERT | rate | フォーム入力値（パーセント値） | |
| INSERT | code | フォーム入力値 | |
| INSERT | is_default | true | デフォルト税率として作成 |
| INSERT | is_combinable | フォーム入力値 | サブレベルの場合のみ |
| INSERT | created_at | 現在日時 | |
| INSERT | updated_at | 現在日時 | |

## メッセージ仕様

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

## 例外処理

| 例外ケース | 処理内容 |
|-----------|---------|
| 必須項目未入力 | バリデーションエラーを表示し、該当フィールドをハイライト |
| 税リージョンが存在しない | エラーをスロー |
| ネットワークエラー | エラートーストを表示、フォーム入力状態は保持 |

## 備考

- is_default は常にtrueが設定される（デフォルト税率として作成）
- is_combinable はサブレベル（都道府県レベル）の場合のみ表示される
- 税率は小数点以下4桁まで指定可能
- 税率は任意入力（未入力の場合は0として扱われる可能性あり）

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: nameとcodeが必須（min(1)）、rateはオプションであることを確認。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | tax-region-tax-rate-create.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-create/tax-region-tax-rate-create.tsx` | 税リージョン取得とモーダル表示 |

**主要処理フロー**:
1. **7行目**: useParamsでURLからid, province_idを取得
2. **9-11行目**: useTaxRegionで税リージョンデータを取得（province_idがあればそちらを優先）
3. **19-28行目**: RouteFocusModal内にフォームをレンダリング

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

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

**主要処理フロー**:
- **41-51行目**: useFormでフォーム状態を初期化
- **53行目**: useCreateTaxRateフックでAPIミューテーション取得
- **55-75行目**: handleSubmitでフォーム送信処理（is_default: true）
- **154-161行目**: isSublevelの場合のみis_combinableスイッチを表示

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

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

**主要処理フロー**:
- **85-103行目**: useCreateTaxRateの実装、sdk.admin.taxRate.createを呼び出し
- **97行目**: taxRegionsQueryKeys.details()も無効化

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

```
TaxRegionTaxRateCreate (tax-region-tax-rate-create.tsx)
    │
    ├─ useParams (React Router)
    │      └─ id, province_id取得
    │
    ├─ useTaxRegion (tax-regions.tsx)
    │      └─ sdk.admin.taxRegion.retrieve
    │
    └─ TaxRegionTaxRateCreateForm (tax-region-tax-rate-create-form.tsx)
           │
           ├─ useForm (react-hook-form)
           │      └─ zodResolver (バリデーション)
           │
           └─ useCreateTaxRate (tax-rates.tsx)
                  └─ sdk.admin.taxRate.create (API呼び出し)
```

### データフロー図

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

URLパラメータ
  (id, province_id) ───▶ TaxRegionTaxRateCreate
                                │
税リージョン ◀───────────── useTaxRegion
                                │
名前（必須）─────────────┐    │
                        │    ▼
税率（任意）───────────┤  TaxRegionTaxRateCreateForm ───▶ 元の画面へ戻る
                        │       │
税コード（必須）────────┤       └─▶ useCreateTaxRate
                        │               │
結合可能フラグ ─────────┘               └─▶ POST /admin/tax-rates
（サブレベルのみ）                              (is_default: true)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| tax-region-tax-rate-create.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-create/tax-region-tax-rate-create.tsx` | ソース | エントリーポイント |
| tax-region-tax-rate-create-form.tsx | `packages/admin/dashboard/src/routes/tax-regions/tax-region-tax-rate-create/components/tax-region-tax-rate-create-form/tax-region-tax-rate-create-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-create/index.ts` | ソース | エクスポート定義 |
| RouteFocusModal | `packages/admin/dashboard/src/components/modals` | ソース | モーダルコンポーネント |
| PercentageInput | `packages/admin/dashboard/src/components/inputs/percentage-input` | ソース | パーセント入力コンポーネント |
| SwitchBox | `packages/admin/dashboard/src/components/common/switch-box` | ソース | スイッチボックスコンポーネント |
