# バッチ設計書 3-bundleTs.mjs

## 概要

本ドキュメントは、Jestモノレポにおける TypeScript 定義ファイルバンドルバッチ `bundleTs.mjs` の設計仕様を記載したものです。このバッチは Microsoft の API Extractor を使用して、各パッケージの複数の .d.ts ファイルを単一の定義ファイルに統合し、ESLint で整形します。

### 本バッチの処理概要

**業務上の目的・背景**：`buildTs.mjs` で生成された型定義ファイルは、TypeScript コンパイラの出力そのままの状態で、複数のファイルに分散しています。npm パッケージとして配布する際には、単一の .d.ts ファイルにまとめることで、パッケージ利用者の利便性を向上させ、型解決のパフォーマンスを改善します。また、API Extractor により内部実装の詳細を隠蔽し、公開 API のみを型定義として提供することで、パッケージの API 境界を明確にします。

**バッチの実行タイミング**：開発者が `yarn bundle:ts` コマンドを実行した際に随時実行されます。フルビルド（`yarn build`）の最終段階として、`yarn build:js` と `yarn build:ts` の後に実行されます。リリース準備時に CI/CD パイプラインで自動実行されます。

**主要な処理内容**：
1. `getPackagesWithTsConfig()` でパッケージ一覧を取得し、除外パッケージをフィルタリング
2. ルートに `api-extractor.json` 共通設定ファイルを生成
3. 各パッケージに `api-extractor.json` 設定ファイルを生成
4. API Extractor でエントリポイントを解析し、単一の .d.ts ファイル（`dist/index.d.ts`）を生成
5. 既存の `build/**/*.d.ts` ファイルと空ディレクトリを削除
6. `@types/node` 参照と著作権スニペットを適切な位置に配置
7. ESLint で型インポートスタイルを `no-type-imports` に統一して整形
8. 整形後のファイルを `build/index.d.ts` に出力

**前後の処理との関連**：`yarn build:ts` による型定義ファイルのビルドが完了していることが前提です。本バッチの実行後、パッケージは npm への公開準備が完了した状態となります。

**影響範囲**：対象パッケージの `build/index.d.ts` が単一ファイルに置き換えられ、その他の .d.ts ファイルは削除されます。`@jest/globals` と `@jest/test-globals` は除外されます。

## バッチ種別

ビルド処理 / バンドル処理 / コード整形

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発者操作時） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `yarn bundle:ts` コマンド実行 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| 依存関係インストール済み | `yarn install` が完了していること |
| TypeScript ビルド完了 | `yarn build:ts` が完了していること |
| パッケージの .d.ts 存在 | `packages/*/build/*.d.ts` が存在すること |

### 実行可否判定

- `getPackagesWithTsConfig()` で取得したパッケージのうち、`@jest/globals` と `@jest/test-globals` を除いたパッケージが対象
- 各パッケージの `pkg.types` で指定されたファイルが存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/build/*.d.ts | TypeScript定義 | buildTs.mjs で生成された型定義ファイル |
| packages/*/package.json | JSON | パッケージメタデータ（types 等） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/*/build/index.d.ts | TypeScript定義 | バンドルされた型定義ファイル |
| api-extractor.json | JSON | ルートの API Extractor 共通設定 |
| packages/*/api-extractor.json | JSON | 各パッケージの API Extractor 設定 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | `index.d.ts` |
| 出力先 | `packages/*/build/` |
| 文字コード | UTF-8 |
| 改行コード | LF（\r\n を \n に変換） |

## 処理フロー

### 処理シーケンス

```
1. パッケージ一覧取得
   └─ getPackagesWithTsConfig() で除外パッケージを除いた一覧を取得
2. 共通設定生成
   └─ ルートに api-extractor.json を生成
3. ESLint インスタンス作成
   └─ no-type-imports ルールを適用した ESLint インスタンスを生成
4. 各パッケージの処理（並列）
   ├─ パッケージ固有の api-extractor.json を生成
   ├─ CompilerState を初期化（初回のみ）
   ├─ API Extractor で .d.ts をバンドル
   ├─ エラー・警告がある場合は例外送出
   ├─ 既存の .d.ts ファイルを rimraf で削除
   ├─ dist/ ディレクトリを削除
   ├─ tsconfig.tsbuildinfo を削除
   ├─ 空ディレクトリを削除
   ├─ 改行コードを LF に統一
   ├─ @types/node 参照を先頭に移動
   ├─ 著作権スニペットを先頭に追加
   ├─ ESLint で整形
   └─ build/index.d.ts に出力
5. 完了通知
   └─ 成功メッセージを出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[パッケージ一覧取得]
    B --> C[除外パッケージをフィルタ]
    C --> D[共通 api-extractor.json 生成]
    D --> E[ESLint インスタンス作成]
    E --> F[各パッケージの並列処理]
    F --> G[パッケージ api-extractor.json 生成]
    G --> H{CompilerState 存在?}
    H -->|なし| I[CompilerState 初期化]
    H -->|あり| J[API Extractor 実行]
    I --> J
    J --> K{エラー/警告あり?}
    K -->|あり| L[例外送出]
    K -->|なし| M[既存 .d.ts 削除]
    M --> N[dist/ 削除]
    N --> O[tsbuildinfo 削除]
    O --> P[空ディレクトリ削除]
    P --> Q[改行コード統一]
    Q --> R{@types/node 参照あり?}
    R -->|あり| S[先頭に移動]
    R -->|なし| T[著作権スニペット追加]
    S --> T
    T --> U[ESLint で整形]
    U --> V[build/index.d.ts に出力]
    V --> W[次のパッケージ]
    W --> F
    F --> X[成功メッセージ出力]
    X --> Y[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | - | - | データベースへのアクセスなし |

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

データベース操作は発生しません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| Error | API Extractor エラー | 型定義の解析に失敗 | ソースコードの型定義を修正 |
| Error | API Extractor 警告 | 非公開型のエクスポートなど | 警告内容を確認し対応 |
| ENOTEMPTY | ディレクトリ削除失敗 | ディレクトリが空でない | 無視される（jest-jasmine2/build/jasmine 等） |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、問題のある型定義を特定
2. ソースコードの export 文や型定義を修正
3. `yarn build:ts` を再実行後、本バッチを再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 対象パッケージ数（約50） |
| 目標処理時間 | フルビルドの一部（全体で3-5分） |
| 並列処理 | Promise.all による並列実行 |

## 排他制御

- 同時実行は推奨されない（同一ファイルへの書き込み競合）
- `yarn build:ts` の完了後に実行すること

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | `Extracting TypeScript definition files` |
| エラーログ | API Extractor 失敗時 | `Unable to extract TypeScript definition files` |
| 成功ログ | バッチ正常終了時 | `Successfully extracted TypeScript definition files` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 10分超過 | CI/CDパイプライン |
| 終了コード | 非0 | CI/CDパイプライン |

## 備考

- 本バッチは `yarn build` の一部として実行される（`yarn bundle:ts`）
- `@jest/globals` と `@jest/test-globals` は型のみのパッケージのため除外
- API Extractor の `ae-forgotten-export` と `ae-missing-release-tag` メッセージは抑制
- ESLint の `consistent-type-imports` ルールで `no-type-imports` を適用（.d.ts では type キーワードは冗長）
- 改行コードは CRLF から LF に統一
