# 通知設計書 32-アイテム更新

## 概要

本ドキュメントは、InvenTreeモバイルアプリケーションにおける「アイテム更新」通知の設計仕様を定義するものです。この通知は、製造元パーツ（ManufacturerPart）などのアイテム情報が正常に更新された際にユーザーに表示されるスナックバー通知です。

### 本通知の処理概要

この通知は、各種アイテムの編集フォームで変更を保存した後、サーバーへの更新処理が成功した場合にユーザーにフィードバックを提供する機能です。

**業務上の目的・背景**：ユーザーがアイテム情報を編集する際、保存操作の結果を明確に伝える必要があります。この通知により、ユーザーは変更が正常に保存されたことを即座に確認でき、二重保存や保存漏れを防止します。これにより、データ更新の確実性とユーザー体験の向上を実現します。

**通知の送信タイミング**：`editForm()` メソッドの `onSuccess` コールバック内で、APIからの成功レスポンス（HTTP 200/201）を受け取った直後に通知が発生します。これは、編集画面での保存ボタン押下後に発生します。

**通知の受信者**：通知は、アプリで編集操作を実行している現在のユーザーに対してのみ表示されます。

**通知内容の概要**：国際化対応されたメッセージ「Item updated」（または相当するローカライズ文字列）がスナックバーとして画面下部に表示されます。成功を示すライトグリーンの背景とチェックアイコンが付加されます。

**期待されるアクション**：ユーザーは更新が成功したことを確認し、引き続き作業を続けるか、詳細画面に戻ることが期待されます。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | なし |

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

アプリの現在アクティブなユーザーに対してのみ表示されます。編集権限を持つユーザーのみが編集画面にアクセスできるため、間接的に権限が考慮されています。

## 通知テンプレート

### スナックバー通知の場合

| 項目 | 内容 |
|-----|------|
| 背景色 | ライトグリーン（Colors.lightGreen） |
| アイコン | TablerIcons.circle_check |
| 表示時間 | 5秒 |
| 閉じるボタン | あり |

### 本文テンプレート

```
{L10().itemUpdated}
```

実際の表示例（英語）：
```
Item updated
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| itemUpdated | 更新成功メッセージ | L10()国際化リソース | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | editManufacturerPart() onSuccess | API成功レスポンス（200/201） | 製造元パーツ編集の成功時 |
| 画面操作 | editForm() onSuccess | API成功レスポンス（200/201） | 各種アイテム編集の成功時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| バリデーションエラー | フォームバリデーション失敗時は通知しない |
| APIエラー | サーバーエラー時は別のエラー通知が表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[編集フォーム表示] --> B[ユーザーが変更入力]
    B --> C[保存ボタン押下]
    C --> D[フォームバリデーション]
    D -->|失敗| E[バリデーションエラー表示]
    D -->|成功| F[API PATCHリクエスト]
    F --> G{APIレスポンス}
    G -->|200/201| H[onSuccess コールバック]
    G -->|エラー| I[エラー通知表示]
    H --> J[refresh()呼び出し]
    H --> K[showSnackIcon呼び出し]
    K --> L[スナックバー表示]
    L --> M[5秒後自動非表示]
```

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

### 参照テーブル一覧

該当なし（クライアントサイドのみの処理、サーバー側でDB更新）

### 更新テーブル一覧

サーバー側で対象モデルの更新が行われる

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| コンテキスト不在 | Flutterコンテキストが無効な場合 | 通知をスキップ |
| フォームエラー | バリデーション失敗時 | フォームエラー通知（No.34）が表示される |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間対応）

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

- 更新されたアイテムの詳細情報は通知メッセージに含まれない
- 編集権限を持つユーザーのみが編集フォームにアクセス可能
- 認証済みユーザーのみがアプリを使用可能

## 備考

- この通知パターンは複数の詳細画面で共通して使用される（製造元パーツ、サプライヤーパーツなど）
- 国際化対応により、アプリの言語設定に応じたメッセージが表示される

---

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

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

### 推奨読解順序

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

まず、InvenTreeManufacturerPartクラスとeditForm()メソッドの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | model.dart | `lib/inventree/model.dart` | editForm()メソッドの定義（行301-320） |

**読解のコツ**: onSuccess コールバックパターンに注目する

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

editManufacturerPart()メソッドのonSuccessコールバック内でのshowSnackIcon呼び出しを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | manufacturer_part_detail.dart | `lib/widget/company/manufacturer_part_detail.dart` | editManufacturerPart()メソッド（行82-91） |

**主要処理フロー**:
1. **行82-83**: editManufacturerPart()メソッドの開始
2. **行83-85**: editForm()の呼び出し、タイトル設定
3. **行86-89**: onSuccessコールバックの定義
4. **行87**: `refresh(context)` - 画面のリフレッシュ
5. **行88**: `showSnackIcon(L10().itemUpdated, success: true)` - 通知表示

#### Step 3: スナックバー表示ロジックを理解する

showSnackIcon関数の成功時の実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数のsuccess=true分岐（行35-41） |

**主要処理フロー**:
- **行35-41**: success=trueの場合のスタイル設定（ライトグリーン背景、チェックアイコン）

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

```
ManufacturerPartDetailWidget  [lib/widget/company/manufacturer_part_detail.dart]
    │
    ├─ editManufacturerPart()  [行82]
    │      │
    │      └─ widget.manufacturerPart.editForm()  [行83]
    │             │
    │             └─ launchApiForm()  [lib/api_form.dart]
    │                    │
    │                    └─ onSuccess callback
    │                           ├─ refresh(context)
    │                           └─ showSnackIcon()  [lib/widget/snacks.dart:11]
    │
    └─ appBarActions()  [行103]
           └─ editManufacturerPartボタン表示
```

### データフロー図

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

ユーザー入力        ───▶  editForm()                    ───▶  スナックバー表示
（フォームデータ）         ├─ API PATCHリクエスト               │
                          ├─ レスポンス処理                    └─ 「Item updated」
                          └─ onSuccess呼び出し                    メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| manufacturer_part_detail.dart | `lib/widget/company/manufacturer_part_detail.dart` | ソース | 製造元パーツ詳細画面、editManufacturerPart()メソッド |
| model.dart | `lib/inventree/model.dart` | ソース | editForm()メソッドの基底実装 |
| api_form.dart | `lib/api_form.dart` | ソース | launchApiForm()関数、フォーム処理 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | showSnackIcon関数の実装 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数L10() |
