# バッチ設計書 16-generate.ts

## 概要

本ドキュメントは、SDK生成とOpenAPIスキーマ出力を行うスクリプトの設計書です。JavaScript SDKのビルドとAPIスキーマファイルの生成を自動化します。

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

このスクリプトは、Bunランタイムで実行され、OpenCode SDKのビルドとOpenAPIスキーマの生成を一連の処理として実行します。生成後にコードフォーマットも適用します。

**業務上の目的・背景**：OpenCodeはSDKを通じてプログラマティックにアクセス可能です。APIの変更に伴いSDKとOpenAPIスキーマを常に最新の状態に保つ必要があります。このスクリプトにより、APIの変更後にワンコマンドで関連成果物を再生成でき、SDKとドキュメントの整合性を担保します。

**バッチの実行タイミング**：開発者による手動実行時に実行されます。API変更後やリリース前に実行されます。

**主要な処理内容**：
1. JavaScript SDKのビルド（packages/sdk/js/script/build.ts）
2. OpenAPIスキーマの生成（bun dev generate > ../sdk/openapi.json）
3. コードフォーマットの適用（./script/format.ts）

**前後の処理との関連**：リリース前の準備作業として実行されます。生成されたSDKはnpmパッケージとして公開されます。OpenAPIスキーマはドキュメント生成に使用されます。

**影響範囲**：packages/sdk/js配下のSDKファイル、../sdk/openapi.jsonスキーマファイル、プロジェクト全体のフォーマット

## バッチ種別

開発ツール / コード生成 / ビルドスクリプト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 手動（随時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Bunランタイム | Bunがインストールされていること |
| 依存関係 | 各パッケージのnode_modulesがインストールされていること |
| opencode dev | packages/opencode配下で開発サーバーが起動可能であること |

### 実行可否判定

前提条件が満たされていれば常に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | 入力パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/sdk/js | TypeScript | SDKソースコード |
| packages/opencode | TypeScript | API定義・実装 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/sdk/js/dist | JavaScript | ビルド済みSDK |
| ../sdk/openapi.json | JSON | OpenAPIスキーマ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| SDKファイル | ESM/CJS形式のJavaScriptファイル |
| スキーマファイル | OpenAPI 3.x形式のJSONファイル |
| 文字コード | UTF-8 |

## 処理フロー

### 処理シーケンス

```
1. SDKビルド
   └─ bun ./packages/sdk/js/script/build.ts
2. OpenAPIスキーマ生成
   └─ bun dev generate > ../sdk/openapi.json (packages/opencode配下で実行)
3. コードフォーマット
   └─ ./script/format.ts
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[SDKビルド実行]
    B --> C[ビルド成果物生成]
    C --> D[OpenAPIスキーマ生成]
    D --> E[スキーマファイル出力]
    E --> F[format.ts実行]
    F --> G[全ファイルフォーマット]
    G --> H[終了]
```

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

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

本スクリプトはデータベースを操作しません。

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ビルドエラー | TypeScriptコンパイルエラー | ソースコード修正 |
| - | スキーマ生成エラー | API定義エラー | API実装を確認 |
| - | フォーマットエラー | 構文エラー | ファイルを手動修正 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. 該当するソースコードを修正
3. 再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各コマンド単位 |
| コミットタイミング | 各コマンド完了時 |
| ロールバック条件 | Gitによる復元が必要 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回/実行 |
| 目標処理時間 | 60秒以内 |
| メモリ使用量上限 | 標準的なNode.jsプロセス |

## 排他制御

同時実行は推奨されません。同一ファイルへの同時書き込みが発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 各ステップ完了時 | ビルド結果、生成ファイル |
| エラー出力 | エラー発生時 | コンパイルエラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

ローカル実行スクリプトのため、監視・アラートは設定されていません。

## 備考

- shebang行（`#!/usr/bin/env bun`）により、`./script/generate.ts`として直接実行可能
- packages/opencode配下に`.cwd()`でカレントディレクトリを変更してスキーマ生成
- 出力先の`../sdk/openapi.json`はpackages/opencodeから見た相対パス
- 最終ステップでformat.tsを呼び出し、全ファイルのフォーマットを統一
