创建框架集成
Auth.js 的核心功能 - @auth/core
- 建立在 Web 标准 Request/Response 模型之上,因此是框架无关的。对于每个框架,我们提供一个集成层,允许您以特定于框架的方式使用身份验证功能。请查看当前可用的 集成列表。
我们欢迎新的官方集成贡献。如果您有兴趣创建和维护新的集成,请阅读以下指南。
官方框架指南
如果您想创建一个新的官方框架集成并在 @auth/
命名空间下分发它,请确保遵循以下步骤并满足我们的维护要求。
设置新的集成
我们提供一个脚本,用于生成新集成所需的所有文件。要运行该脚本,请运行以下命令
npm setup-fw-integration <framework-name>
这将从我们官方模板中的 ./packages/frameworks-template
复制所有文件到 packages/
下的新目录,其中包含所有必需的文件,并将占位符重命名为您提供的框架名称。
-
编码风格。源代码文件应
- 用 TypeScript 编写
- 通过单仓库的 linting 规则
- 从其主模块导出一个命名导出。例如:
export function ExpressAuth()
-
API 参考文档 - 我们使用 TypeDoc 进行自动文档生成。文档应
- 用 JSDoc 注释编写。
- 解释如何使用和配置集成:如何进行会话管理、如何登录/注销、如何配置基本 URL。
- 在参考部分包含指向官方框架文档的链接。
-
部署示例。这项任务可以在后续的 PR 中完成。部署的示例应
- 所有操作 (URL) 均应按预期工作。
- 至少配置一个 OAuth 提供商。
- 示例代码应位于
apps/examples/<framework-name>
下。例如:apps/examples/express
。
以上是我们将软件包作为官方软件包分发的必要条件。完成清单后,您可以将 PR 标记为“准备审查”,维护人员将对其进行审查。