# 機能設計書 24-AMDライブラリ出力

## 概要

本ドキュメントは、webpackのAmdLibraryPluginによるAMD（Asynchronous Module Definition）形式でのライブラリ出力機能について記述する。

### 本機能の処理概要

AmdLibraryPluginは、webpackでバンドルされたライブラリをAMD形式（`define()`呼び出し）で出力する機能を提供する。RequireJSなどのAMDローダーで利用可能なモジュールを生成する。

**業務上の目的・背景**：AMD形式は、ブラウザ環境でモジュールの非同期読み込みを実現するための仕組みである。RequireJSやcurl.jsなどのAMDローダーと連携するライブラリを出力する場合に必要となる。また、`amd-require`タイプでは`require()`形式のラッパーも生成可能である。

**機能の利用シーン**：AMD対応のモジュールシステムで利用されるライブラリ構築時に、`output.library.type: 'amd'` または `'amd-require'` を指定して利用する。`amdContainer`オプションでカスタムAMDコンテナを指定可能。

**主要な処理内容**：
1. ライブラリオプション（名前、amdContainer）をパースする
2. 外部モジュール（ExternalModule）をamd/amd-requireタイプでフィルタリングする
3. `define()` または `require()` 呼び出しでラップしたソースコードを生成する
4. チャンクハッシュにプラグイン固有の情報を反映する

**関連システム・外部連携**：EnableLibraryPluginを通じて有効化される。ExportPropertyLibraryPluginと連携して特定エクスポートの抽出も可能。

**権限による制御**：本機能に権限による制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面機能マッピングに該当する画面なし |

## 機能種別

コード生成処理（AMD形式ラッパーコードの生成）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| library.name | string | No | AMDモジュール名 | amd-requireの場合はunset必須。文字列のみ許可 |
| library.amdContainer | string | No | AMDコンテナプレフィックス | - |
| options.type | 'amd' \| 'amd-require' | Yes | AMD出力タイプ | - |
| options.requireAsWrapper | boolean | No | require形式ラッパーを使用するか | amd-require時にtrue |

### 入力データソース

webpack設定の `output.library` オプション。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| source | ConcatSource | AMD形式ラッパー付きバンドルソース |

### 出力先

JavascriptModulesPluginのrenderフックを通じて、バンドルファイルとして出力される。

## 処理フロー

### 処理シーケンス

```
1. オプションパース（parseOptions）
   ├─ requireAsWrapper=true の場合、nameが設定されていればエラー
   ├─ nameが文字列以外の場合はエラー
   └─ name と amdContainer を返却
2. レンダリング（render）
   ├─ ExternalModuleをamd/amd-requireタイプでフィルタ
   ├─ 外部依存を配列形式に変換
   ├─ コールバック関数を生成（Arrow Function対応）
   ├─ amdContainerプレフィックスを付加
   └─ define/require形式でラップ
       ├─ requireAsWrapper=true: require([deps], fn)
       ├─ 名前あり: define("name", [deps], fn)
       ├─ 外部依存あり: define([deps], fn)
       └─ 外部依存なし: define(fn)
```

### フローチャート

```mermaid
flowchart TD
    A[renderメソッド呼び出し] --> B[ExternalModuleフィルタリング]
    B --> C[外部依存配列/コールバック引数生成]
    C --> D{requireAsWrapper?}
    D -->|Yes| E[require形式ラッパー]
    D -->|No| F{名前あり?}
    F -->|Yes| G[名前付きdefine]
    F -->|No| H{外部依存あり?}
    H -->|Yes| I[依存配列付きdefine]
    H -->|No| J[引数なしdefine]
    E --> K[ConcatSource返却]
    G --> K
    I --> K
    J --> K
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | amd-require名前禁止 | requireAsWrapper時にライブラリ名は設定不可 | type='amd-require' |
| BR-02 | 名前は文字列のみ | AMD名は単純な文字列のみ許可 | 常時 |
| BR-03 | amdContainerプレフィックス | 指定時にdefine/requireの前にコンテナ名を付加 | amdContainer設定時 |
| BR-04 | Arrow Function対応 | ランタイムがArrow Functionをサポートする場合はアロー関数形式で出力 | ES6+環境 |

### 計算ロジック

外部依存のAMDリクエスト解決：`request.amd` が存在すればそれを使用、なければrequestそのものを使用。

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

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

本機能にデータベース操作はない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Error | amd-requireでname設定時 | "AMD library name must be unset" |
| - | Error | nameが文字列以外 | "AMD library name must be a simple string or unset" |

### リトライ仕様

リトライ処理はない。

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

トランザクション管理はない。

## パフォーマンス要件

コンパイル時の一回限りのラッパー生成であり、パフォーマンスへの影響は軽微。

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

本機能にセキュリティ上の特別な考慮事項はない。

## 備考

- `amdContainer` オプションを使用すると `containerName.define()` 形式で出力される
- IIFEモードの有無に応じて、関数本体の改行制御が変わる（iife時は `return`、非iife時は改行付き）
- チャンクハッシュにプラグイン名・名前・amdContainer情報が反映される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | AmdLibraryPlugin.js | `lib/library/AmdLibraryPlugin.js` | AmdLibraryPluginParsed型（33-35行目）- name, amdContainer |
| 1-2 | AmdLibraryPlugin.js | `lib/library/AmdLibraryPlugin.js` | AmdLibraryPluginOptions型（27-29行目）- type, requireAsWrapper |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | EnableLibraryPlugin.js | `lib/library/EnableLibraryPlugin.js` | 221-231行目: 'amd'/'amd-require'での初期化 |

**主要処理フロー**:
1. **221行目**: `case 'amd':` / `case 'amd-require':` - タイプ判定
2. **223行目**: ExportPropertyLibraryPluginの有効化
3. **227-230行目**: AmdLibraryPluginのインスタンス化（requireAsWrapper設定）

#### Step 3: レンダリング処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | AmdLibraryPlugin.js | `lib/library/AmdLibraryPlugin.js` | 82-155行目: renderメソッド |

**主要処理フロー**:
- **87-94行目**: ExternalModuleのフィルタリング（amd/amd-requireタイプ）
- **96-110行目**: 外部依存配列・コールバック引数の生成
- **112-118行目**: IIFE対応のfnStart/fnEnd生成
- **125-154行目**: define/require形式の分岐処理

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

```
EnableLibraryPlugin.apply()
    │
    ├─ ExportPropertyLibraryPlugin.apply()
    │
    └─ AmdLibraryPlugin.apply()
           │
           └─ AbstractLibraryPlugin.apply()
                  ├─ hooks.render.tap() ──▶ AmdLibraryPlugin.render()
                  │      ├─ ExternalModule フィルタ
                  │      └─ define/require ラッパー生成
                  └─ hooks.chunkHash.tap() ──▶ AmdLibraryPlugin.chunkHash()
```

### データフロー図

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

library.name ──────────────▶ parseOptions() ──────▶ {name, amdContainer}
library.amdContainer ──────▶

チャンクモジュール ─────────▶ ExternalModule ──────▶ 依存配列 [deps]
                               フィルタ

ソースコード ──────────────▶ render() ─────────────▶ define([deps], fn{source})
                               (ConcatSource)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| AmdLibraryPlugin.js | `lib/library/AmdLibraryPlugin.js` | ソース | AMD形式ラッパーの生成 |
| AbstractLibraryPlugin.js | `lib/library/AbstractLibraryPlugin.js` | ソース | ライブラリプラグインの基底クラス |
| EnableLibraryPlugin.js | `lib/library/EnableLibraryPlugin.js` | ソース | ライブラリタイプの有効化・プラグイン適用 |
| ExportPropertyLibraryPlugin.js | `lib/library/ExportPropertyLibraryPlugin.js` | ソース | 特定エクスポートの抽出 |
| ExternalModule.js | `lib/ExternalModule.js` | ソース | 外部モジュールの表現 |
