# 通知設計書 12-エントリ非公開化成功通知

## 概要

本ドキュメントは、Decap CMS の編集ワークフローにおいて、公開済みエントリの非公開化（unpublish）が正常に完了した場合に表示される成功トースト通知の設計を記述する。

### 本通知の処理概要

エントリ非公開化成功通知は、公開済みのエントリを編集ワークフローに戻す（非公開化する）操作が正常に完了した際に、ユーザーに対して処理の成功をフィードバックするトースト通知である。

**業務上の目的・背景**：コンテンツ管理においては、一度公開したエントリを非公開に戻して再編集するケースが存在する。公開済みエントリの非公開化は、バックエンドでのエントリ削除と未公開エントリとしての再永続化という複数のステップを含む複雑な処理であり、処理の完了をユーザーに明確に伝える必要がある。本通知により、非公開化処理が成功したことをユーザーが確認でき、安心して次の編集作業に進むことができる。

**通知の送信タイミング**：`unpublishPublishedEntry` アクション内で、`backend.deleteEntry()` によるエントリ削除と `backend.persistEntry()` による未公開状態での再永続化が両方とも成功した後の `.then()` チェーン内で送信される。

**通知の受信者**：非公開化操作を実行した現在のログインユーザー（ブラウザ上のセッションユーザー）。クライアントサイドのアプリ内通知であるため、操作を実行した本人のみが受信する。

**通知内容の概要**：i18nキー `ui.toast.entryUnpublished` に対応するローカライズされた成功メッセージが表示される。英語では "Entry unpublished"、日本語では "未公開にしました。" となる。

**期待されるアクション**：ユーザーは非公開化が完了したことを確認し、必要に応じてワークフローボードで当該エントリの編集を継続するか、他の作業に移ることが期待される。

## 通知種別

アプリ内トースト通知（react-toastify ベース）

## 送信仕様

### 基本情報

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

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

操作を実行した現在のブラウザセッションユーザーに対して、クライアントサイドで直接トースト通知を表示する。Redux ストアの `notifications` ステートに通知が追加され、`Notifications` コンポーネントが react-toastify を通じてUIに描画する。

## 通知テンプレート

### メール通知の場合

該当なし（本通知はアプリ内トースト通知のみ）

### 本文テンプレート

```
Entry unpublished
```

日本語の場合：
```
未公開にしました。
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| （なし） | 本通知にはテンプレート変数はない | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | エントリエディタからの非公開化操作 | `backend.deleteEntry()` と `backend.persistEntry()` の両方が成功した場合 | `unpublishPublishedEntry` thunkアクション内の `.then()` チェーンで発火 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 非公開化処理が失敗した場合 | 失敗時は `ui.toast.onFailToUnpublishEntry` のエラー通知が表示され、本成功通知は表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがエントリ非公開化を実行] --> B[unpublishPublishedEntry thunk dispatch]
    B --> C[unpublishedEntryPersisting dispatch]
    C --> D[backend.deleteEntry 呼び出し]
    D --> E{削除結果}
    E -->|成功| F[backend.persistEntry 呼び出し - PENDING_PUBLISH ステータス]
    E -->|失敗| G[catch: addNotification - onFailToUnpublishEntry]
    F --> H{永続化結果}
    H -->|成功| I[unpublishedEntryPersisted dispatch]
    H -->|失敗| G
    I --> J[entryDeleted dispatch]
    J --> K[loadUnpublishedEntry dispatch]
    K --> L[addNotification dispatch - entryUnpublished]
    L --> M[トースト表示 4秒後自動消去]
    G --> N[トースト表示 8秒後自動消去]
    M --> O[終了]
    N --> O
```

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

### 参照テーブル一覧

該当なし（クライアントサイドのみの処理。バックエンドAPIとの通信結果のみ使用）

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| Redux Store: notifications | INSERT | 通知オブジェクトを notifications 配列に追加 |

#### Redux Store 更新詳細

| 操作 | 項目 | 更新値 | 備考 |
|-----|------|-------|------|
| INSERT | notifications.notifications[] | `{ id: uuid(), message: { key: 'ui.toast.entryUnpublished' }, type: 'success', dismissAfter: 4000 }` | uuid v4 で一意ID生成 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 本通知は成功時のみ表示 | エラー時は別途 No.13 の非公開化失敗通知が表示される |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 該当なし（成功通知のためリトライ不要） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし（明示的な制限なし） |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（ユーザー操作に応じて随時発生）

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

- 本通知は成功メッセージのみを表示し、機密情報は含まれない。
- クライアントサイドのトースト通知であり、操作ユーザー本人のブラウザにのみ表示される。

## 備考

- 非公開化処理（`unpublishPublishedEntry`）は、内部的にまず `backend.deleteEntry()` で公開済みエントリを削除し、次に `backend.persistEntry()` で `PENDING_PUBLISH` ステータスとして再永続化するという2段階の処理を行う。
- 本通知の i18nキーは `ui.toast.entryUnpublished` であり、多言語対応済みである。
- `dismissAfter: 4000` が設定されており、4秒後に自動消去される。

---

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

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

### 推奨読解順序

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

まず、通知のデータ構造と型定義を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notifications.ts (actions) | `packages/decap-cms-core/src/actions/notifications.ts` | `NotificationPayload` インターフェース（行8-12）で通知データの型を理解する。成功通知では `type: 'success'` が使用される |
| 1-2 | notifications.ts (reducers) | `packages/decap-cms-core/src/reducers/notifications.ts` | `Notification` 型（行17-22）でストア内の通知状態構造を理解する |

**読解のコツ**: 成功通知では `details` フィールドが使用されないため、`message` は `{ key: string }` のみのシンプルな構造になる。

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

非公開化処理の起点となる thunk アクションを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | editorialWorkflow.ts | `packages/decap-cms-core/src/actions/editorialWorkflow.ts` | `unpublishPublishedEntry` 関数（行525-567）が非公開化処理のエントリーポイント。`collection` と `slug` を受け取り、削除→再永続化の2段階処理を行う |

**主要処理フロー**:
1. **行529**: `selectEntry` でReduxストアから公開済みエントリを取得
2. **行531**: `unpublishedEntryPersisting` を dispatch（ローディング状態開始）
3. **行533**: `backend.deleteEntry()` で公開済みエントリを削除
4. **行535-541**: `backend.persistEntry()` で `PENDING_PUBLISH` ステータスとして再永続化
5. **行545**: `unpublishedEntryPersisted` を dispatch
6. **行546**: `entryDeleted` を dispatch
7. **行547**: `loadUnpublishedEntry` を dispatch（未公開エントリとして再読込）
8. **行548-553**: `addNotification` を dispatch（**本通知の発火箇所**）

#### Step 3: 通知ディスパッチの仕組みを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | notifications.ts (actions) | `packages/decap-cms-core/src/actions/notifications.ts` | `addNotification` 関数（行18-19）が `NOTIFICATION_SEND` アクションを生成 |
| 3-2 | notifications.ts (reducers) | `packages/decap-cms-core/src/reducers/notifications.ts` | `NOTIFICATION_SEND` ケース（行40-47）で uuid を付与して通知配列に追加 |

#### Step 4: UIレンダリングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Notifications.tsx | `packages/decap-cms-core/src/components/UI/Notifications.tsx` | `useEffect` 内（行30-52）で新規通知を検出し、`toast()` で react-toastify のトーストを表示する。`type: 'success'` の場合は緑色の成功スタイルで表示される |

#### Step 5: i18nメッセージを確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | index.js (en) | `packages/decap-cms-locales/src/en/index.js` | 行277: `entryUnpublished: 'Entry unpublished'` |
| 5-2 | index.js (ja) | `packages/decap-cms-locales/src/ja/index.js` | 行264: `entryUnpublished: '未公開にしました。'` |

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

```
unpublishPublishedEntry (editorialWorkflow.ts:525)
    |
    +-- unpublishedEntryPersisting (editorialWorkflow.ts:130)
    |
    +-- backend.deleteEntry (バックエンドAPI: エントリ削除)
    |       |
    |       +-- [成功時] backend.persistEntry (バックエンドAPI: 再永続化)
    |               |
    |               +-- [成功時] .then() チェーン (editorialWorkflow.ts:544)
    |                       |
    |                       +-- unpublishedEntryPersisted (editorialWorkflow.ts:140)
    |                       +-- entryDeleted (entries.ts)
    |                       +-- loadUnpublishedEntry (editorialWorkflow.ts:240)
    |                       +-- addNotification (notifications.ts:18)
    |                               |
    |                               +-- NOTIFICATION_SEND → reducer (reducers/notifications.ts:40)
    |                                       |
    |                                       +-- Notifications.tsx useEffect (Notifications.tsx:30)
    |                                               |
    |                                               +-- toast() (react-toastify)
```

### データフロー図

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

ユーザー非公開化操作 ────> unpublishPublishedEntry thunk ────> Redux dispatch
  (collection, slug)             |                                    |
                         backend.deleteEntry                          |
                                 |                                    |
                         backend.persistEntry                  NOTIFICATION_SEND
                         (status: PENDING_PUBLISH)                    |
                                 |                            reducer: notifications
                         addNotification({                           |
                           message: {                          Notifications コンポーネント
                             key: 'ui.toast.                         |
                               entryUnpublished'              react-toastify toast()
                           },                                        |
                           type: 'success',                   トースト表示（4秒後自動消去）
                           dismissAfter: 4000
                         })
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| editorialWorkflow.ts | `packages/decap-cms-core/src/actions/editorialWorkflow.ts` | ソース | 非公開化処理のthunkアクション。成功時に通知を dispatch する |
| notifications.ts (actions) | `packages/decap-cms-core/src/actions/notifications.ts` | ソース | `addNotification` アクションクリエーター |
| notifications.ts (reducers) | `packages/decap-cms-core/src/reducers/notifications.ts` | ソース | 通知ステートの管理リデューサー |
| Notifications.tsx | `packages/decap-cms-core/src/components/UI/Notifications.tsx` | ソース | トースト通知のUIコンポーネント |
| index.js (en) | `packages/decap-cms-locales/src/en/index.js` | i18n | 英語翻訳定義 |
| index.js (ja) | `packages/decap-cms-locales/src/ja/index.js` | i18n | 日本語翻訳定義 |
| publishModes.ts | `packages/decap-cms-core/src/constants/publishModes.ts` | ソース | `PENDING_PUBLISH` ステータス定数の定義 |
