# 機能設計書 44-配送プロファイル管理

## 概要

本ドキュメントは、Medusaコマースプラットフォームにおける配送プロファイル管理機能の設計を記述する。配送プロファイルは、配送オプションをグループ化し、商品に紐付けることで、商品ごとの配送ルールを定義するためのエンティティである。

### 本機能の処理概要

**業務上の目的・背景**：ECサイトにおいて、商品によって利用可能な配送方法が異なる場合がある。例えば、冷凍食品は冷凍便のみ、大型家具は特殊配送のみなど。配送プロファイルは、このような商品種別ごとの配送ルールを一元管理し、商品と配送オプションを柔軟に紐付けるための機能を提供する。

**機能の利用シーン**：
- 新規商品カテゴリに対応する配送プロファイルを作成する場合
- 配送プロファイルに配送オプションを紐付ける場合
- 商品に配送プロファイルを設定する場合
- 配送プロファイルの設定を変更する場合

**主要な処理内容**：
1. 配送プロファイルの作成（名前、タイプ、メタデータ）
2. 配送プロファイルの更新
3. 配送プロファイルのUpsert
4. 配送プロファイルの取得・一覧表示
5. 配送プロファイルの削除（配送オプションが紐付いている場合は削除不可）

**関連システム・外部連携**：
- 配送オプションとの1対多関係
- 商品モジュールとの連携（Link経由）

**権限による制御**：管理画面からの操作は管理者権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 15 | 商品配送プロファイル編集画面 | 補助機能 | 商品の配送プロファイル設定 |
| 142 | 配送プロファイル一覧画面 | 主機能 | 配送プロファイル一覧の取得・表示 |
| 143 | 配送プロファイル作成画面 | 主機能 | 新規配送プロファイルの作成 |
| 144 | 配送プロファイル詳細画面 | 主機能 | 配送プロファイル詳細の表示 |
| 145 | 配送プロファイルメタデータ編集画面 | 主機能 | プロファイルメタデータの編集 |

## 機能種別

CRUD操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| name | string | Yes | 配送プロファイル名 | ユニーク制約あり |
| type | string | Yes | プロファイルタイプ | - |
| metadata | object | No | カスタムメタデータ | JSON形式 |

### 入力データソース

- 管理画面からのフォーム入力
- Admin API（POST /admin/shipping-profiles）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| id | string | 配送プロファイルID（sp_xxx形式） |
| name | string | プロファイル名 |
| type | string | プロファイルタイプ |
| shipping_options | array | 紐付いた配送オプションの配列 |
| metadata | object | メタデータ |
| created_at | datetime | 作成日時 |
| updated_at | datetime | 更新日時 |
| deleted_at | datetime | 削除日時 |

### 出力先

- API Response（JSON形式）
- DBテーブル：shipping_profile

## 処理フロー

### 処理シーケンス

```
1. 入力データの受信
   └─ APIまたはサービスメソッド経由でデータを受信

2. バリデーション処理
   └─ 名前のユニーク性確認（DBインデックス）

3. 配送プロファイルの作成/更新
   └─ shippingProfileService_.create/update()を呼び出し

4. 削除時のバリデーション
   └─ 配送オプションが紐付いていないかチェック
   └─ 紐付いている場合はエラー

5. レスポンスの生成とイベント発行
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[入力データ受信]
    B --> C{削除操作?}
    C -->|Yes| D[配送オプション紐付けチェック]
    C -->|No| E{IDあり?}
    D --> F{紐付けあり?}
    F -->|Yes| G[エラー返却]
    F -->|No| H[削除実行]
    E -->|Yes| I[更新処理]
    E -->|No| J[作成処理]
    I --> K[shippingProfileService_.update]
    J --> L[shippingProfileService_.create]
    H --> M[シリアライズ]
    K --> M
    L --> M
    M --> N[イベント発行]
    N --> O[レスポンス返却]
    G --> P[終了]
    O --> P
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-44-01 | 名前ユニーク制約 | 配送プロファイル名は一意でなければならない | 作成・更新時 |
| BR-44-02 | 削除制約 | 配送オプションが紐付いている場合は削除不可 | 削除時 |
| BR-44-03 | ソフトデリート | 削除はソフトデリート（deleted_at設定） | 削除時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| createShippingProfiles | shipping_profile | INSERT | 新規配送プロファイル作成 |
| updateShippingProfiles | shipping_profile | UPDATE | プロファイル情報更新 |
| deleteShippingProfiles | shipping_profile | UPDATE | deleted_atを設定（ソフトデリート） |

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

#### shipping_profile

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | 自動生成（sp_xxx形式） | プライマリキー |
| INSERT | name | 入力値 | ユニークインデックス |
| INSERT | type | 入力値 | - |
| INSERT | metadata | 入力値（nullable） | JSON |
| UPDATE | name | 入力値 | - |
| UPDATE | type | 入力値 | - |
| UPDATE | deleted_at | 現在時刻 | ソフトデリート時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| NOT_FOUND | MedusaError | 指定された配送プロファイルIDが存在しない | 正しいIDを指定 |
| INVALID_DATA | MedusaError | 配送オプションが紐付いている状態で削除 | 配送オプションを先に削除 |
| UNIQUE_VIOLATION | DBError | 名前が重複 | 別の名前を使用 |

### リトライ仕様

トランザクションレベルでのリトライ対応。

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

- `@InjectTransactionManager()`デコレータによりトランザクション内で実行
- エラー発生時は全体がロールバック

## パフォーマンス要件

- 通常のCRUD操作は100ms以内
- リスト取得時はページネーション対応

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

- 管理者認証必須

## 備考

- 配送プロファイルはデフォルトプロファイルとカスタムプロファイルに分類される
- IDプレフィックスは「sp」

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | shipping-profile.ts | `packages/modules/fulfillment/src/models/shipping-profile.ts` | エンティティ定義、リレーション |
| 1-2 | shipping-option.ts | `packages/modules/fulfillment/src/models/shipping-option.ts` | 配送オプションとの関係（belongsTo） |

**読解のコツ**: ShippingProfileはシンプルなエンティティで、shipping_optionsへのhasManyリレーション（10-12行目）と名前のユニーク制約（15-20行目）が主要なポイント。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | fulfillment-module-service.ts | `packages/modules/fulfillment/src/services/fulfillment-module-service.ts` | 配送プロファイル関連メソッド |

**主要処理フロー**:
1. **454-503行目**: `createShippingProfiles()`/`createShippingProfiles_()`
2. **1577-1648行目**: `updateShippingProfiles()`/`updateShippingProfiles_()`
3. **1650-1710行目**: `upsertShippingProfiles()`/`upsertShippingProfiles_()`
4. **2018-2075行目**: `deleteShippingProfiles()`/`softDeleteShippingProfiles()`/`validateShippingProfileDeletion()`

#### Step 3: 削除バリデーションを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | fulfillment-module-service.ts | `packages/modules/fulfillment/src/services/fulfillment-module-service.ts` | validateShippingProfileDeletion |

**主要処理フロー**:
- **2049-2075行目**: `validateShippingProfileDeletion()` - 配送オプション紐付けチェック
  - shipping_optionsリレーションを取得
  - 紐付いている場合はINVALID_DATAエラーをスロー

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

```
FulfillmentModuleService
    │
    ├─ createShippingProfiles() [public]
    │      └─ createShippingProfiles_() [protected]
    │             └─ shippingProfileService_.create()
    │
    ├─ updateShippingProfiles() [public]
    │      └─ updateShippingProfiles_() [protected]
    │             ├─ shippingProfileService_.retrieve() - 存在確認
    │             └─ shippingProfileService_.update()
    │
    ├─ upsertShippingProfiles() [public]
    │      └─ upsertShippingProfiles_() [protected]
    │             ├─ shippingProfileService_.create() - 新規
    │             └─ shippingProfileService_.update() - 既存
    │
    └─ deleteShippingProfiles() [public]
           ├─ validateShippingProfileDeletion() [protected]
           │      └─ shippingProfileService_.list() - 紐付けチェック
           └─ super.deleteShippingProfiles()
```

### データフロー図

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

CreateShippingProfileDTO   FulfillmentModuleService           ShippingProfileDTO
         │                          │                                │
         ▼                          ▼                                ▼
    ┌──────────┐           ┌─────────────────┐              ┌──────────────┐
    │ API      │ ────────▶ │ createShipping  │ ───────────▶ │ JSON Response│
    │ Request  │           │ Profiles        │              │ (serialized) │
    └──────────┘           └─────────────────┘              └──────────────┘
                                   │
                                   ▼
                           ┌───────────────┐
                           │ shipping_     │
                           │ profile       │
                           └───────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| fulfillment-module-service.ts | `packages/modules/fulfillment/src/services/fulfillment-module-service.ts` | ソース | モジュールサービス本体 |
| shipping-profile.ts | `packages/modules/fulfillment/src/models/shipping-profile.ts` | ソース | 配送プロファイルエンティティ |
| shipping-option.ts | `packages/modules/fulfillment/src/models/shipping-option.ts` | ソース | 配送オプション（子エンティティ） |
