建立框架整合
Auth.js 的核心功能 - @auth/core
- 是建立在 Web 標準 Request/Response 心理模型之上,因此與框架無關。對於每個框架,我們都提供一個整合層,讓您可以使用特定於該框架的方式來使用驗證功能。請參閱目前可用的整合列表。
我們歡迎對新的官方整合做出貢獻。如果您有興趣建立和維護新的整合,請閱讀以下指南。
官方框架指南
如果您想建立新的官方框架整合並在 @auth/
命名空間下分發,請確保遵循以下步驟並滿足我們以下的維護要求
設定新的整合
我們提供一個腳本,可為新的整合產生所有必需的檔案。要執行該腳本,請執行以下命令
npm setup-fw-integration <framework-name>
這會將我們官方範本中的所有檔案從 ./packages/frameworks-template
複製到 packages/
下的新目錄中,其中包含所有必需的檔案,並將預留位置重新命名為您提供的框架名稱。
-
程式碼樣式。原始碼檔案應
- 使用 TypeScript 撰寫
- 通過 monorepo 的 linting 規則
- 從其主模組匯出具名匯出。例如:
export function ExpressAuth()
-
API 參考文件 - 我們使用 TypeDoc 進行自動文件產生。文件應
- 以 JSDoc 註解撰寫。
- 說明如何使用和設定整合:如何進行 Session 管理、如何登入/登出、如何設定基本 URL。
- 在參考章節中包含指向官方框架文件的連結。
-
部署的範例。此任務可以在後續的 PR 中進行。部署的範例應
- 所有動作 (URL) 都應如預期般運作。
- 至少設定一個 OAuth 提供者。
- 範例程式碼應位於
apps/examples/<framework-name>
下。例如:apps/examples/express
。
以上是我們將套件作為官方套件分發所必需的。完成檢查清單後,您可以將 PR 標記為「準備審閱」,維護人員將會審閱它。