# 通知設計書 5-注文アクセス通知

## 概要

本ドキュメントは、Payload CMSのecommerceテンプレートにおける注文アクセス通知の設計仕様を記述する。ECサイトで注文情報へのアクセスリンクをメールで送信する機能の詳細を定義する。

### 本通知の処理概要

この通知は、ECサイトにおいてゲスト購入者や、ログインせずに注文情報を確認したいユーザーに対して、注文詳細ページへのアクセスリンクを含むメールを送信する機能を提供する。注文IDとメールアドレスの組み合わせで注文を検索し、アクセストークンを含むURLを送信することで、ユーザーは認証なしで自分の注文を確認できる。

**業務上の目的・背景**：ゲスト購入者やアカウントを持たない顧客が、注文後に注文状況を確認できるようにすることが目的である。ユーザーは会員登録なしで購入でき、後からメールアドレスを使って注文を検索し、アクセスリンクを取得できる。これにより、ゲスト購入のハードルを下げつつ、注文追跡機能を提供できる。

**通知の送信タイミング**：ユーザーが「注文を探す」フォーム（FindOrderForm）から注文IDとメールアドレスを送信し、対応する注文が見つかった場合に送信される。これはユーザー主導のオンデマンド送信であり、自動的には送信されない。

**通知の受信者**：フォームで入力されたメールアドレス（注文のcustomerEmailと一致する必要がある）に送信される。メールアドレスが注文と一致しない場合は送信されないが、セキュリティ上の理由からエラーは返さない。

**通知内容の概要**：注文詳細ページへのアクセスURL（注文ID、メールアドレス、アクセストークンを含む）、注文番号、リンクの説明が含まれる。

**期待されるアクション**：受信者はメール内のリンクをクリックし、注文詳細ページで注文状況、配送情報、購入商品などを確認することが期待される。

## 通知種別

メール

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（Server Actions） |
| 優先度 | 中 |
| リトライ | なし（エラーログのみ記録、常にsuccessを返却） |

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

1. ユーザーがFindOrderFormから注文IDとメールアドレスを入力
2. ordersコレクションを検索（id === orderID AND customerEmail === email）
3. 一致する注文が存在し、かつaccessTokenが設定されている場合のみ送信
4. 一致しない場合は送信せず、success: trueを返却（情報漏洩防止）

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | Payloadメール設定に依存 |
| 送信元名称 | Payloadメール設定に依存 |
| 件名 | `Access your order #${order.id}` |
| 形式 | HTML |

### 本文テンプレート

```html
<h1>View Your Order</h1>
<p>Click the link below to view your order details:</p>
<p><a href="${orderURL}">View Order #${order.id}</a></p>
<p>Or copy and paste this URL into your browser:</p>
<p>${orderURL}</p>
<p>This link will give you access to view your order details.</p>
```

orderURLの形式:
```
${serverURL}/orders/${order.id}?email=${encodeURIComponent(email)}&accessToken=${order.accessToken}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| order.id | 注文ID | ordersコレクション | Yes |
| order.accessToken | アクセストークン | ordersコレクション | Yes |
| email | 顧客メールアドレス | フォーム入力 | Yes |
| serverURL | サーバーのベースURL | getServerSideURL() | Yes |
| orderURL | 注文詳細ページURL | 上記を組み合わせて生成 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | FindOrderFormの送信 | 注文が存在 AND accessTokenが存在 | 「注文を探す」フォームからの送信 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 注文が存在しない | 該当する注文がない場合（success: trueを返却） |
| accessTokenが未設定 | 注文にアクセストークンがない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[FindOrderForm送信] --> B[sendOrderAccessEmail呼び出し]
    B --> C[Payloadインスタンス取得]
    C --> D[ordersコレクション検索]
    D --> E{注文が見つかった?}
    E -->|No| F[success: true を返却]
    E -->|Yes| G{accessTokenが存在?}
    G -->|No| F
    G -->|Yes| H[serverURL取得]
    H --> I[orderURL生成]
    I --> J[メール本文生成]
    J --> K[console.logでデバッグ出力]
    K --> L[payload.sendEmail呼び出し]
    L --> M{送信成功?}
    M -->|Yes| N[success: true を返却]
    M -->|No| O[エラーログ出力]
    O --> N
    F --> P[処理終了]
    N --> P
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| orders | 注文情報の取得 | id AND customerEmailで検索 |

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

#### orders

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 注文識別子 | WHERE id = :orderID AND customerEmail = :email |
| accessToken | アクセス認証用トークン | 同上 |
| customerEmail | 顧客メールアドレス（検証用） | 同上 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 送信通知処理ではDB更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 送信失敗 | メールサーバー接続エラー | payload.logger.errorでログ出力、success: trueを返却 |
| 注文検索エラー | DB接続エラーなど | try-catch内でエラーログ出力、success: trueを返却 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | Payload設定に依存（デフォルトなし） |
| 1日あたり上限 | Payload設定に依存（デフォルトなし） |

### 配信時間帯

制限なし（24時間送信可能）

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

1. **アクセストークン**: 注文ごとに一意のアクセストークンを生成し、URLパラメータとして使用
2. **メールアドレス検証**: 注文のcustomerEmailと入力されたメールアドレスが一致する場合のみ送信
3. **情報漏洩防止**: 注文が見つからない場合もsuccess: trueを返却し、注文の存在有無を外部から判別できないようにしている
4. **URLエンコード**: メールアドレスはencodeURIComponentでエンコードされる
5. **HTTPSの使用**: orderURLにはサーバーURLが使用されるため、HTTPS設定が重要

## 備考

- この実装はtemplates/ecommerceプロジェクト固有のものであり、プラグインではない
- 'use server'ディレクティブによりNext.js Server Actionsとして実装
- getServerSideURL()はサーバーサイドでのURL取得ユーティリティ
- accessTokenの生成ロジックは注文作成時に別途実装されている（本通知の範囲外）
- デバッグ用のconsole.logが含まれているが、本番環境では削除を推奨

---

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

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

### 推奨読解順序

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

まず、関数の入出力型を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sendOrderAccessEmail.ts | `templates/ecommerce/src/components/forms/FindOrderForm/sendOrderAccessEmail.ts` | SendOrderAccessEmailArgs型（7-10行目）とSendOrderAccessEmailResult型（12-15行目） |

**読解のコツ**: TypeScript型定義から、この関数がemail（文字列）とorderID（文字列）を受け取り、success（真偽値）とオプションのerror（文字列）を返すことがわかる。

#### Step 2: メイン処理ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sendOrderAccessEmail.ts | `templates/ecommerce/src/components/forms/FindOrderForm/sendOrderAccessEmail.ts` | sendOrderAccessEmail関数（17-64行目） |

**主要処理フロー**:
1. **1行目**: 'use server'ディレクティブ（Server Actions）
2. **21行目**: getPayload()でPayloadインスタンス取得
3. **24-31行目**: ordersコレクションを検索（id AND customerEmail条件）
4. **35-37行目**: 注文が見つからない OR accessTokenがない場合は早期リターン
5. **39行目**: getServerSideURL()でサーバーURL取得
6. **40行目**: orderURL生成（email, accessToken含む）
7. **42-49行目**: メール本文HTML生成
8. **51行目**: デバッグ用console.log
9. **53-57行目**: payload.sendEmail実行
10. **60-62行目**: エラーハンドリング

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

```
FindOrderForm (クライアントコンポーネント)
    │
    └─ sendOrderAccessEmail (Server Action)
           │
           ├─ getPayload (Payloadインスタンス取得)
           │
           ├─ payload.find (ordersコレクション検索)
           │      └─ where: { and: [{id}, {customerEmail}] }
           │
           ├─ getServerSideURL (サーバーURL取得)
           │
           ├─ orderURL生成
           │      └─ ${serverURL}/orders/${id}?email=...&accessToken=...
           │
           └─ payload.sendEmail
                  │
                  ├─ to: email
                  ├─ subject: Access your order #${id}
                  └─ html: emailBody
```

### データフロー図

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

FindOrderForm ───▶ sendOrderAccessEmail ───▶ SendOrderAccessEmailResult
   │                       │                        │
   ├─ email ───────────────┤                        └─ { success: true }
   │                       │
   └─ orderID ─────────────┤
                           │
                           ├─▶ payload.find(orders)
                           │       │
                           │       └─▶ order (id, accessToken)
                           │
                           ├─▶ getServerSideURL()
                           │       └─▶ serverURL
                           │
                           └─▶ orderURL生成
                                   │
                                   └─▶ payload.sendEmail
                                           │
                                           └─▶ 顧客メールボックス
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sendOrderAccessEmail.ts | `templates/ecommerce/src/components/forms/FindOrderForm/sendOrderAccessEmail.ts` | ソース | Server Action本体 |
| FindOrderForm | `templates/ecommerce/src/components/forms/FindOrderForm/index.tsx`（推定） | ソース | フォームコンポーネント |
| getURL.ts | `templates/ecommerce/src/utilities/getURL.ts`（推定） | ソース | URL取得ユーティリティ |
| orders | `templates/ecommerce/src/collections/Orders.ts`（推定） | ソース | 注文コレクション定義 |
