# 機能設計書 8-カテゴリ一覧取得

## 概要

本ドキュメントは、ECモバイルアプリケーションにおけるカテゴリ一覧取得機能の設計仕様を定義する。ホーム画面やドロワーメニューに表示するカテゴリ情報をバックエンドから取得する。

### 本機能の処理概要

**業務上の目的・背景**：ECサイトの商品は階層的なカテゴリで分類されており、ユーザーが目的の商品を見つけやすくするためにカテゴリナビゲーションを提供する。カテゴリ一覧はホーム画面のカテゴリカルーセルやドロワーメニューで使用される。

**機能の利用シーン**：
- ホーム画面初期表示時（カテゴリカルーセル用）
- ドロワーメニュー表示時（ナビゲーション用）

**主要な処理内容**：
1. GraphQL APIを通じたカテゴリ一覧の取得
2. フィルタ条件に基づくカテゴリ絞り込み
3. カテゴリの階層構造（親子関係）の取得
4. 取得データのキャッシュ保存

**関連システム・外部連携**：Bagisto（Laravel製ECプラットフォーム）のGraphQL APIと連携し、homeCategories queryを呼び出す。

**権限による制御**：本機能は認証不要で呼び出し可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 2 | ホーム画面 | 主画面 | カテゴリカルーセルの表示 |
| 3 | ドロワー | 参照画面 | カテゴリナビゲーションの表示 |
| 7 | カテゴリ一覧画面 | 遷移先画面 | カテゴリタップ時の遷移先 |

## 機能種別

データ取得 / API連携 / キャッシュ管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| filters | List<Map<String, dynamic>> | No | フィルタ条件リスト | - |
| filters[].key | String | Yes | フィルタキー（status, locale, parent_id等） | - |
| filters[].value | String | Yes | フィルタ値 | - |

### 入力データソース

- テーマカスタマイズ設定：category_carouselのfilters
- 固定フィルタ：ドロワー用（status=1, locale, parent_id=1）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| data | List<HomeCategories> | カテゴリ一覧 |
| data[].id | String | カテゴリID |
| data[].name | String | カテゴリ名 |
| data[].slug | String | カテゴリスラッグ（URLに使用） |
| data[].description | String | カテゴリ説明 |
| data[].logoUrl | String | カテゴリロゴ画像URL |
| data[].bannerUrl | String | カテゴリバナー画像URL |
| data[].children | List<Children> | 子カテゴリ一覧 |

### 出力先

- ホーム画面：FetchHomeCategoriesStateで渡される
- ドロワー：FetchDrawerPageDataStateで渡される
- SharedPreferences/Hive：ドロワーカテゴリはキャッシュ保存
- GlobalData.categoriesDrawerData：グローバル状態に保存

## 処理フロー

### 処理シーケンス

```
1. イベント発行
   └─ ホーム用: FetchHomePageCategoriesEvent
   └─ ドロワー用: FetchDrawerPageEvent

2. BlocがRepositoryを通じてAPI呼び出し
   └─ repository?.getHomeCategoriesList(filters: filters)

3. ApiClientがGraphQL queryを実行
   └─ mutation.homeCategoriesFilters(filters: filters)

4. レスポンスをGetDrawerCategoriesDataにパース
   └─ GetDrawerCategoriesData.fromJson()

5. 状態更新
   └─ ホーム用: FetchHomeCategoriesState.success
   └─ ドロワー用: FetchDrawerPageDataState.success

6. ドロワーの場合、キャッシュ保存
   └─ appStoragePref.setDrawerCategories()
```

### フローチャート

```mermaid
flowchart TD
    A[イベント発行] --> B{イベントタイプ}
    B -->|ホーム用| C[FetchHomePageCategoriesEvent]
    B -->|ドロワー用| D[FetchDrawerPageEvent]
    C --> E[getHomeCategoriesList]
    D --> E
    E --> F[homeCategories query実行]
    F --> G[GetDrawerCategoriesData生成]
    G --> H{呼び出し元}
    H -->|ホーム| I[FetchHomeCategoriesState]
    H -->|ドロワー| J[FetchDrawerPageDataState]
    J --> K[キャッシュ保存]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | アクティブカテゴリのみ | status=1のカテゴリのみ取得 | 常時 |
| BR-002 | 言語フィルタ | 現在の言語設定に応じたカテゴリ名を取得 | 常時 |
| BR-003 | 階層構造 | 親カテゴリとその子カテゴリを取得 | 常時 |
| BR-004 | キャッシュ利用 | ドロワー用カテゴリはHiveでキャッシュ | ドロワー用 |
| BR-005 | ルートカテゴリ指定 | parent_id=1でルートカテゴリから取得 | ドロワー用 |

### 計算ロジック

本機能に計算ロジックは存在しない。

## データベース操作仕様

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

モバイルアプリ側ではデータベース操作なし（APIからのデータ取得のみ）。

### テーブル別操作詳細

#### Hive（ローカルストレージ）

| 操作 | 項目（キー名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| WRITE | drawerCategories | GetDrawerCategoriesData | ドロワー用キャッシュ |
| READ | drawerCategories | オフライン時の表示用 | fetchOfflineProductDataで取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ネットワークエラー | API通信失敗 | fail状態発行、キャッシュデータ使用 |
| - | パースエラー | JSONパース失敗 | 例外をキャッチしてfail状態発行 |

### リトライ仕様

本機能にリトライ処理は実装されていない。

## トランザクション仕様

モバイルアプリ側ではトランザクション管理は行わない。

## パフォーマンス要件

- API応答時間：2秒以内
- キャッシュによるオフライン対応

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

- 公開データのみを取得するため認証不要

## 備考

- カテゴリデータは2箇所（ホームカルーセル、ドロワー）で使用されるが、別々に取得される
- GetDrawerCategoriesDataはHiveTypeとしてローカル永続化に対応

---

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

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

### 推奨読解順序

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

レスポンスのデータモデルを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | get_categories_drawer_data_model.dart | `lib/screens/home_page/data_model/get_categories_drawer_data_model.dart` | GetDrawerCategoriesData、HomeCategories、Children |

**主要クラス**:
- **18-29行目**: GetDrawerCategoriesData - ルートモデル（HiveType対応）
- **32-62行目**: HomeCategories - カテゴリ情報（HiveType対応）
- **98-117行目**: Children - 子カテゴリ情報

#### Step 2: ビジネスロジックを理解する（ホーム用）

HomePageBlocでの処理を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | home_page_bloc.dart | `lib/screens/home_page/bloc/home_page_bloc.dart` | FetchHomePageCategoriesEvent処理（163-172行目） |

#### Step 3: ビジネスロジックを理解する（ドロワー用）

DrawerBlocでの処理を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | drawer_bloc.dart | `lib/screens/drawer/bloc/drawer_bloc.dart` | FetchDrawerPageEvent処理 |

#### Step 4: リポジトリ層を理解する

API呼び出しの実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | home_page_repository.dart | `lib/screens/home_page/bloc/home_page_repository.dart` | getHomeCategoriesList()（36-48行目） |

#### Step 5: API通信層を理解する

GraphQL query定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | mutation_query.dart | `lib/services/mutation_query.dart` | homeCategoriesFilters()（19-39行目） |

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

```
HomeScreen / DrawerListView
    │
    ├─ HomePageBloc (ホームカルーセル用)
    │      │
    │      └─ FetchHomePageCategoriesEvent
    │             │
    │             └─ HomePageRepository.getHomeCategoriesList()
    │
    └─ DrawerBloc (ドロワー用)
           │
           └─ FetchDrawerPageEvent
                  │
                  └─ HomePageRepository.getHomeCategoriesList()
                         │
                         └─ ApiClient.homeCategories()
                                │
                                └─ MutationsData.homeCategoriesFilters()
```

### データフロー図

```
[フィルタ条件]              [API]                    [出力]

filters: [              homeCategories query
  {status: "1"},              │
  {locale: "en"},             ▼
  {parent_id: "1"}     GetDrawerCategoriesData
]                             │
        │                     ├──▶ ホームカルーセル表示
        │                     │
        └─────────────────────├──▶ ドロワーメニュー表示
                              │
                              └──▶ Hiveキャッシュ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| get_categories_drawer_data_model.dart | `lib/screens/home_page/data_model/get_categories_drawer_data_model.dart` | ソース | データモデル定義 |
| home_page_bloc.dart | `lib/screens/home_page/bloc/home_page_bloc.dart` | ソース | ホーム用Bloc |
| drawer_bloc.dart | `lib/screens/drawer/bloc/drawer_bloc.dart` | ソース | ドロワー用Bloc |
| home_page_repository.dart | `lib/screens/home_page/bloc/home_page_repository.dart` | ソース | リポジトリ層 |
| api_client.dart | `lib/services/api_client.dart` | ソース | API通信クライアント |
| mutation_query.dart | `lib/services/mutation_query.dart` | ソース | GraphQLクエリ定義 |
