# 通知設計書 22-カテゴリ更新

## 概要

本ドキュメントは、InvenTreeアプリにおけるパーツカテゴリ更新通知の設計を定義する。パーツカテゴリ情報の編集が正常に完了した際に、ユーザーにスナックバー形式で成功を通知する。

### 本通知の処理概要

カテゴリ更新通知は、ユーザーがパーツカテゴリ表示画面からカテゴリ情報を編集し、その変更がサーバーに正常に保存された際に表示される。

**業務上の目的・背景**：パーツカテゴリは在庫管理における部品の分類体系を構成する重要な要素である。カテゴリ名、説明、親カテゴリなどの変更が正しく反映されたことをユーザーに即座にフィードバックすることで、在庫分類体系の整合性維持と管理効率向上を実現する。カテゴリ構造の変更は多数のパーツに影響を与える可能性があるため、変更完了の明確な確認が重要である。

**通知の送信タイミング**：カテゴリ編集フォームで「保存」操作を実行し、サーバーAPIからの応答が成功となった直後に通知が送信される。`_editCategoryDialog`メソッド内の`onSuccess`コールバックで発火する。

**通知の受信者**：編集操作を実行したユーザー本人のみ。ローカル通知のため、他のユーザーには通知されない。

**通知内容の概要**：「Part category updated」（パーツカテゴリが更新されました）というテキストメッセージと成功を示す緑色のチェックマークアイコンが表示される。

**期待されるアクション**：ユーザーは通知を確認し、カテゴリ編集が正常に完了したことを認識する。通知は5秒後に自動的に消える。

## 通知種別

アプリ内通知（スナックバー）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（UIスレッド） |
| 優先度 | 中 |
| リトライ | 無し |

### 送信先決定ロジック

編集操作を実行したユーザーの画面に直接表示される。現在アクティブな画面コンテキストに対して通知が表示される。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 背景色 | Colors.lightGreen（成功時） |
| アイコン | TablerIcons.circle_check |
| 表示位置 | 画面下部 |
| 自動消去 | 5秒後 |

### 本文テンプレート

```
Part category updated
```

多言語対応: L10().categoryUpdated により国際化された文字列が使用される。

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | スナックバー通知のため添付なし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| categoryUpdated | 通知メッセージ | L10().categoryUpdated（国際化リソース） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | カテゴリ編集フォームの保存ボタン押下 | API応答が成功 | `_editCategoryDialog`メソッド内でeditFormのonSuccessコールバック実行時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| API応答エラー | サーバーからエラー応答があった場合は成功通知は表示されない |
| トップレベルカテゴリ | widget.categoryがnullの場合は編集不可 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[編集ボタン押下] --> B{カテゴリがnull?}
    B -->|Yes| Z[処理終了]
    B -->|No| C[編集フォーム表示]
    C --> D[ユーザーが値を変更]
    D --> E[保存ボタン押下]
    E --> F[API PUT/PATCH リクエスト送信]
    F --> G{API応答}
    G -->|成功| H[onSuccessコールバック実行]
    G -->|失敗| I[エラーハンドリング]
    H --> J[画面リフレッシュ]
    J --> K[showSnackIcon呼び出し]
    K --> L[スナックバー表示]
    L --> M[5秒後自動消去]
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| part_category | 編集対象カテゴリの現在値取得 | InvenTreePartCategory モデル経由 |

### テーブル別参照項目詳細

#### part_category（サーバー側）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| pk | カテゴリ識別子 | 編集対象カテゴリのID |
| name | カテゴリ名 | フォーム表示用 |
| description | 説明 | フォーム表示用 |
| parent | 親カテゴリID | フォーム表示用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| part_category | UPDATE | カテゴリ情報の更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API通信エラー | ネットワーク接続不可 | エラーダイアログ表示 |
| バリデーションエラー | 入力値が不正 | フォームエラー表示 |
| 権限エラー | 編集権限なし | 権限エラー通知 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（自動リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（ユーザー操作起点のため）

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

- 通知はローカル表示のみで外部送信なし
- 通知内容に機密情報は含まれない
- 編集権限チェックはAPI側で実施（InvenTreePartCategory().canEdit）

## 備考

- 通知メッセージは国際化対応済み（L10().categoryUpdated）
- トップレベルカテゴリ（null）は編集不可
- 通知音は鳴らない（視覚フィードバックのみ）

---

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

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

### 推奨読解順序

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

InvenTreePartCategoryクラスがカテゴリデータの構造を定義している。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | part.dart | `lib/inventree/part.dart` | InvenTreePartCategoryクラスの定義 |

**読解のコツ**: InvenTreePartCategoryはInvenTreeModelを継承し、カテゴリ固有のプロパティを持つ。

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

カテゴリ表示画面が編集操作のエントリーポイント。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | category_display.dart | `lib/widget/part/category_display.dart` | `_editCategoryDialog`メソッド（82-98行目）が編集処理の起点 |

**主要処理フロー**:
1. **33-51行目**: appBarActionsで編集ボタンを追加
2. **36-37行目**: widget.categoryがnullでなく、canEditの場合のみ編集ボタン表示
3. **82行目**: `_editCategoryDialog`メソッド定義
4. **86-88行目**: nullチェック後にreturn
5. **90-97行目**: editFormのonSuccessコールバックでrefreshとshowSnackIcon呼び出し

#### Step 3: 通知表示層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数の実装詳細 |

**主要処理フロー**:
- **11行目**: showSnackIcon関数定義
- **35-41行目**: success: true時の緑色背景とチェックアイコン設定

#### Step 4: 国際化リソースを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | app_en.arb | `lib/l10n/app_en.arb` | categoryUpdated（258行目）の定義 |

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

```
CategoryDisplayWidget (category_display.dart)
    |
    +-- appBarActions() [33-51行目]
           |
           +-- IconButton onPressed
                  |
                  +-- _editCategoryDialog() [82行目]
                         |
                         +-- _cat.editForm() [90行目]
                                |
                                +-- onSuccess callback [93-96行目]
                                       |
                                       +-- refresh(context) [94行目]
                                       |
                                       +-- showSnackIcon() [95行目]
```

### データフロー図

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

ユーザー操作
(編集ボタン)  ──────> _editCategoryDialog()
                            |
                            v
                      nullチェック
                            |
                            v
                      editForm()
                            |
                            v
                      API PUT/PATCH ──────> サーバー
                            |
                            v
                      onSuccess
                            |
                            +───> refresh()
                            |
                            +───> showSnackIcon() ──────> スナックバー表示
                                        |
                                        v
                                  L10().categoryUpdated ──────> "Part category updated"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| category_display.dart | `lib/widget/part/category_display.dart` | ソース | カテゴリ表示画面、編集ダイアログ起動 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知表示 |
| part.dart | `lib/inventree/part.dart` | ソース | カテゴリモデル定義 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語メッセージ定義 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー |
