フレームワーク統合の作成
Auth.jsのコア機能 - @auth/core - はWeb標準のRequest/Responseモデルに基づいて構築されており、フレームワークに依存しません。各フレームワークに対して、認証機能をフレームワーク固有の方法で使用できる統合レイヤーを提供しています。現在利用可能な統合一覧をご覧ください。
新しい公式統合への貢献を歓迎します。新しい統合の作成と維持に関心のある方は、以下のガイドラインをお読みください。
公式フレームワークガイドライン
@auth/名前空間の下で新しい公式フレームワーク統合を作成して配布する場合は、次の手順に従い、以下のメンテナンス要件を満たしていることを確認してください。
新しい統合の設定
新しい統合に必要なすべてのファイルを生成するスクリプトを提供しています。スクリプトを実行するには、次のコマンドを実行します。
npm setup-fw-integration <framework-name>これにより、公式テンプレートの./packages/frameworks-templateからpackages/の下の新しいディレクトリに、必要なすべてのファイルを含むすべてのファイルがコピーされ、プレースホルダーが指定したフレームワークの名前に名前変更されます。
-
コーディングスタイル。ソースコードファイルは
- TypeScriptで記述する必要があります。
- モノレポのリンティングルールに合格する必要があります。
- 名前付きエクスポートをメインモジュールからエクスポートする必要があります。例：
export function ExpressAuth()
-
APIリファレンスドキュメント - 自動ドキュメント生成にはTypeDocを使用しています。ドキュメントは
- JSDocコメントで記述する必要があります。
- 統合の使用方法と設定方法について説明する必要があります。セッション管理、ログイン/ログアウト、基本URLの設定方法など。
- リファレンスセクションに公式フレームワークドキュメントへのリンクを含める必要があります。
-
デプロイ済み例。このタスクはフォローアップのPRで行うことができます。デプロイ済み例は
- すべての操作（URL）が期待通りに動作する必要があります。
- 少なくとも1つのOAuthプロバイダーが設定されている必要があります。
- サンプルコードは
apps/examples/<framework-name>の下に配置する必要があります。例：apps/examples/express。
上記は、パッケージを公式パッケージとして配布するために必要です。チェックリストが完了したら、PRを「レビューの準備完了」としてマークすると、メンテナがレビューします。