# 通知設計書 21-パーツ更新

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：在庫管理システムにおいて、パーツ（部品）情報の正確性は業務遂行に不可欠である。パーツ名称、説明、カテゴリ、価格、サプライヤー情報などの変更が正しく反映されたことをユーザーに即座にフィードバックすることで、データ整合性の確認と業務効率向上を実現する。編集操作後に明確なフィードバックがないと、ユーザーは変更が保存されたか不安になり、重複操作や確認作業が増加する。

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

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

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

**期待されるアクション**：ユーザーは通知を確認し、編集が正常に完了したことを認識する。追加のアクションは必要なく、通知は5秒後に自動的に消える。必要に応じてスナックバーをタップして早期に閉じることも可能。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

編集操作を実行したユーザーの画面に直接表示される。送信先の決定ロジックは不要で、現在アクティブな画面コンテキストに対して通知が表示される。

## 通知テンプレート

### スナックバー通知

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

### 本文テンプレート

```
Part updated
```

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| API応答エラー | サーバーからエラー応答があった場合は成功通知は表示されない |
| コンテキスト不在 | アプリのコンテキストが存在しない場合（バックグラウンド時など） |

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| part | 編集対象パーツの現在値取得 | InvenTreePart モデル経由 |

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

#### part（サーバー側）

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

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| part | UPDATE | パーツ情報の更新 |

#### 更新処理

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | name, description等 | フォーム入力値 | APIリクエストボディ経由 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- 通知メッセージは国際化対応済み（L10().partEdited）
- 通知音は鳴らない（視覚フィードバックのみ）
- スナックバーはタップで即時閉じることが可能

---

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

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

### 推奨読解順序

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

InvenTreePartクラスがパーツデータの構造を定義している。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | part.dart | `lib/inventree/part.dart` | InvenTreePartクラスの定義、formFieldsメソッドでフォームフィールド定義を確認 |

**読解のコツ**: Dartのクラス継承とミックスインに注目。InvenTreeModelを継承している。

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

パーツ詳細画面が編集操作のエントリーポイント。

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

**主要処理フロー**:
1. **72-87行目**: appBarActionsで編集ボタンを追加
2. **312行目**: `_editPartDialog`メソッド定義
3. **313-315行目**: part.editForm呼び出し
4. **316-320行目**: onSuccessコールバックでrefreshとshowSnackIcon呼び出し

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

showSnackIcon関数がスナックバー表示を担当。

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

**主要処理フロー**:
- **11行目**: showSnackIcon関数定義（text, icon, onAction, success, actionText引数）
- **32-48行目**: success引数に基づく背景色とアイコン選択
- **58-80行目**: OneContext().showSnackBarでスナックバー表示

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

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

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

```
PartDetailWidget (part_detail.dart)
    |
    +-- _editPartDialog() [312行目]
           |
           +-- part.editForm() [313行目]
                  |
                  +-- onSuccess callback [316-320行目]
                         |
                         +-- refresh(context) [317行目]
                         |
                         +-- showSnackIcon() [318行目] --> snacks.dart [11行目]
                                |
                                +-- OneContext().showSnackBar() [58行目]
```

### データフロー図

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

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

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| part_detail.dart | `lib/widget/part/part_detail.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` | ソース | 国際化ヘルパー |
