SDK リファレンス
SDK リファレンスは、NeoTavern がプラグイン、テーマ、プロバイダー作者に公開する 4 つの公開 TypeScript パッケージの自動生成 API リファレンスです。
生成されるもの
リファレンスは、サイトビルドのたびに TypeDoc が各パッケージの src/index.ts エントリポイントから生成します。以下の正確なエクスポートサーフェスを文書化します:
- プラグイン SDK —
@neotavern/plugin-sdk: マニフェスト検証、権限モデル、型付きイベント、フロントエンド・バックエンドのプラグイン API コントラクト。 - テーマ SDK —
@neotavern/theme-sdk: デザイントークンコントラクト、テーママニフェスト検証、継承解決、CSS 変数の生成。 - プロバイダー SDK —
@neotavern/provider-sdk: プロバイダーアダプターコントラクト、組み込みアダプター、トークン推定、ランタイムレジストリ。 - コントラクト —
@neotavern/contracts: バックエンドルートとフロントエンドの型の両方が由来する共有のリクエスト、レスポンス、エンティティスキーマ。
生成されたページは手書きではなく、リポジトリにコミットもされません。ビルドのたびに再作成されるため、常にパッケージの現在の src/ と一致します。
リファレンスの再生成
Docusaurus ビルドはパイプラインの一部としてリファレンスを再生成します:
pnpm --filter @neotavern/docs build
SDK ソースファイルを変更した後に新しいリファレンスが欲しいときは、ローカルで同じコマンドを実行してください。
パッケージの閲覧
生の API 一覧ではなく使用ガイドが必要な場合は、このドキュメントのプラグイン SDK、テーマ SDK、プロバイダーの各セクションを参照してください。それらはコントラクトを例付きの散文で説明し、正確なシグネチャについては生成されたページにリンクしています。