# 通知設計書 14-在庫スキャン成功

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「在庫スキャン成功」通知の設計仕様を定義する。この通知は、在庫アイテムをバーコードスキャンによってロケーションに移動させる操作が成功した際に表示される成功通知である。

### 本通知の処理概要

この通知は、バーコードスキャン機能を使用して在庫アイテムを新しいロケーションに移動させた際のフィードバックとして機能する。

**業務上の目的・背景**：倉庫や製造現場では、在庫アイテムの物理的な移動が頻繁に発生する。バーコードスキャンを使用することで、ユーザーは迅速かつ正確に在庫の移動を記録できる。この通知により、ユーザーはスキャン操作が正常に完了し、在庫アイテムが新しいロケーションに登録されたことを即座に確認できる。

**通知の送信タイミング**：`StockItemScanIntoLocationHandler` を使用して在庫アイテムをスキャンし、`transferStock()` メソッドが成功を返した時点で通知が生成される。具体的には、サーバーAPIが在庫移動を正常に処理した後に表示される。

**通知の受信者**：バーコードスキャン操作を実行した現在のアプリユーザー。通知はアプリ内スナックバーとして即座に表示される。

**通知内容の概要**：「Scanned into location」というメッセージが表示され、在庫アイテムが指定ロケーションにスキャン移動されたことをユーザーに伝える。成功音声フィードバックも再生される。

**期待されるアクション**：ユーザーはスキャン移動が完了したことを確認し、次の在庫アイテムのスキャンに進むか、バーコードスキャナーを閉じて他の作業に移行する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

現在の操作を実行しているアプリユーザーに対して即座に表示される。サーバーへの通知送信は行わず、クライアントサイドのみで処理される。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面下部 |
| 背景色 | lightGreen（成功時） |
| アイコン | circle_check |
| 表示時間 | 5秒 |

### 本文テンプレート

```
Scanned into location
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | L10().barcodeScanIntoLocationSuccess | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| バーコード操作 | ロケーションスキャン成功 | transferStock()がtrueを返却 | 在庫アイテムのロケーションスキャンが成功した場合 |
| バーコード操作 | 親ロケーション設定成功 | API statusCode 200/201 | ロケーションの親を変更するスキャンが成功した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| スキャン失敗時 | transferStockがfalseを返却した場合は失敗通知が表示される |
| 確認ダイアログ表示時 | confirm設定が有効な場合、通知ではなくフォームダイアログが表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[在庫アイテム詳細画面] --> B[スキャンイントゥロケーション選択]
    B --> C[StockItemScanIntoLocationHandler起動]
    C --> D[ロケーションバーコードスキャン]
    D --> E[onLocationScanned呼び出し]
    E --> F{確認設定チェック}
    F -->|confirm=false| G[transferStock API呼び出し]
    F -->|confirm=true| H[確認ダイアログ表示]
    G --> I{API結果}
    H --> I
    I -->|成功| J[barcodeSuccess呼び出し]
    I -->|失敗| K[失敗通知表示]
    J --> L[barcodeSuccessTone再生]
    L --> M[showSnackIcon success=true]
    M --> N[スナックバー表示]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし（クライアント側のみ） | - | サーバー側で在庫移動が処理される |

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

クライアントアプリ側では直接データベースを参照しない。サーバーAPI経由で在庫移動が行われる。

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| サーバー側StockItemテーブル | UPDATE | 在庫アイテムのロケーションが更新される |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | 成功通知のため該当なし | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（成功通知のため不要） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

24時間365日（アプリ使用時のみ）

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

- 通知内容には具体的な在庫情報やロケーション情報は含まれず、単純な成功メッセージのみ
- 在庫移動操作自体はサーバー側で適切な権限チェックが行われる

## 備考

- 音声フィードバックが有効な場合、barcodeSuccessTone()による成功音が再生される
- 国際化対応済み（L10()による多言語サポート）
- 確認設定（INV_STOCK_CONFIRM_SCAN）が有効な場合、通知ではなく確認ダイアログが表示される

---

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

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

### 推奨読解順序

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

在庫スキャン成功通知に関連するデータ構造を把握する。

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

**読解のコツ**: このメッセージはバーコードスキャンによるロケーション移動成功時に使用される。

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

スキャン操作の起点となる画面を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | stock_detail.dart | `lib/widget/stock/stock_detail.dart` | barcodeButtons関数（160-192行目） |

**主要処理フロー**:
1. **164-178行目**: scanIntoLocation SpeedDialChild設定
2. **170-176行目**: StockItemScanIntoLocationHandler起動

#### Step 3: ハンドラー層を理解する

スキャン処理を行うハンドラーの実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | stock.dart | `lib/barcode/stock.dart` | StockItemScanIntoLocationHandler クラス（111-157行目） |

**主要処理フロー**:
- **117-156行目**: onLocationScanned - ロケーションスキャン時の処理
- **118-121行目**: 確認設定の取得（INV_STOCK_CONFIRM_SCAN）
- **125-143行目**: 確認ダイアログ表示フロー
- **145行目**: transferStock API呼び出し
- **148-149行目**: barcodeSuccess(L10().barcodeScanIntoLocationSuccess) 呼び出し

#### Step 4: 成功通知表示層を理解する

成功通知の表示メカニズムを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | barcode.dart | `lib/barcode/barcode.dart` | barcodeSuccess関数（38-41行目） |

**主要処理フロー**:
- **38-41行目**: barcodeSuccess - 成功音再生とスナックバー表示
- **39行目**: barcodeSuccessTone() - 成功音再生
- **40行目**: showSnackIcon(msg, success: true) - スナックバー表示

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

```
StockDetailWidget.barcodeButtons (stock_detail.dart:160)
    │
    └─ SpeedDialChild "Scan Into Location" (stock_detail.dart:164)
           │
           └─ scanBarcode(handler: StockItemScanIntoLocationHandler)
                  │
                  └─ StockItemScanIntoLocationHandler (stock.dart:111)
                         │
                         └─ onLocationScanned (stock.dart:117)
                                │
                                ├─ [confirm=true] launchApiForm
                                │       └─ onSuccess → showSnackIcon(stockItemUpdated)
                                │
                                └─ [confirm=false] item.transferStock(locationId)
                                        │
                                        └─ [success] barcodeSuccess (barcode.dart:38)
                                               │
                                               ├─ barcodeSuccessTone (tones.dart:7)
                                               └─ showSnackIcon(barcodeScanIntoLocationSuccess)
```

### データフロー図

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

在庫アイテム        ───▶ StockItemScan              ───▶ サーバーAPI
詳細画面                 IntoLocationHandler              │
    │                         │                           ▼
    ▼                         │                     transferStock()
スキャンボタン               │                           │
タップ                        │                           ▼
    │                         │                      成功応答
    ▼                         │                           │
ロケーション                 ▼                           ▼
バーコードスキャン    ──▶ onLocationScanned         barcodeSuccess()
                              │                           │
                              │                     ┌─────┴─────┐
                              │                     ▼           ▼
                              │              成功音再生    スナックバー
                              └──────────────────────▶  "Scanned into
                                                        location"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| stock.dart | `lib/barcode/stock.dart` | ソース | 在庫スキャンハンドラー |
| barcode.dart | `lib/barcode/barcode.dart` | ソース | barcodeSuccess関数定義 |
| stock_detail.dart | `lib/widget/stock/stock_detail.dart` | ソース | 在庫アイテム詳細画面 |
| tones.dart | `lib/barcode/tones.dart` | ソース | 音声フィードバック |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー表示 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語ローカライゼーション |
| preferences.dart | `lib/preferences.dart` | ソース | 確認設定管理 |
