sdk-development

SDK 開発

ゼロから、または既存の実装から抽出して、プロフェッショナルな TypeScript SDK を作成します。

主な原則

• クリーンな公開 API — 利用者が必要とするものだけをエクスポートし、内部実装は隠します
• すべてに型を付ける — 設定、メソッド、レスポンス、エラーを完全に型付けします
• 有意義なエラー — コードとコンテキストを備えた型付きエラークラスを使用します
• 適切なデフォルト設定 — 最小限の設定ですぐに使えます
• フレームワークに依存しない — コア SDK にフレームワークへの依存関係を持たせず、バインディングは別途追加します

クイックスタートチェックリスト

1. 対象範囲を分析します：新規 SDK の作成か、既存アプリからの抽出か
2. 公開 API の範囲を設計します（エクスポート、型、設定）
3. 型付きメソッドとエラーハンドリングを備えたクライアントを実装します
4. ESM／CJS／型定義向けにビルドを設定します（tsup を推奨）
5. テスト（ユニットテスト＋統合テスト）とサンプルを作成します
6. 適切な package.json exports フィールドを設定して npm に公開します

使用しない場合

• 外部 API を利用する場合 — api-integration スキルを参照してください
• npm への公開のみを行う場合 — このスキルは SDK のライフサイクル全体を対象としています

リファレンス

リファレンス	説明
extraction-scope-and-boundaries.md	対象範囲の特定、依存関係の分析、境界の定義
extraction-usages-and-planning.md	使用箇所の調査、テストカバレッジ、段階的な抽出計画
package-structure-and-clients.md	SDK の構成、クライアント設計パターン（単一、モジュール型、ファクトリー）
configuration-and-api-design.md	設定インターフェース、デフォルト値、バレルエクスポート、メソッドシグネチャ
internal-architecture-and-best-practices.md	HTTP クライアント、状態管理、ツリーシェイキング、環境非依存
type-design.md	厳密な型、ブランド型、ジェネリクス、判別可能なユニオン
error-handling-and-async.md	エラークラスの階層、再試行ロジック、リクエストキュー、トークン管理
events-storage-and-logging.md	イベントエミッター、ストレージの抽象化、ロガーインターフェース
build-tools-and-output.md	tsup の設定、出力形式、package.json exports、TypeScript の設定
bundle-optimization-and-distribution.md	バンドルサイズ、マルチプラットフォームビルド、デュアルパッケージ、モノレポ
publishing-and-registries.md	npm への公開、プライベートレジストリ、バージョン管理、変更履歴
ci-cd-and-documentation.md	GitHub Actions、ドキュメント、公開前チェックリスト、非推奨化