用途:为 WorkOS AuthKit 集成提供架构参考与实施流程,帮助在具体框架中按标准步骤接入认证。
主要能力:定义六阶段任务结构(preflight 预检、install 安装、callback 回调、provider 认证上下文/中间件、ui 登录登出界面、verify 构建验证),并给出依赖关系;提供包管理器检测规则(pnpm-lock.yaml→pnpm、yarn.lock→yarn、bun.lockb→bun,否则 npm);区分客户端框架用 AuthKitProvider 包裹应用、服务端框架用中间件处理会话、Next.js 等混合场景可能两者都需要;回调路由路径需从 WORKOS_REDIRECT_URI 提取并精确匹配。
使用方式:第一步必须获取框架对应的 README(从 npmjs.com 或 GitHub),README 是安装命令、导入、API 用法与代码模式的唯一依据。环境变量包括 WORKOS_API_KEY(服务端认证)、WORKOS_CLIENT_ID(所有 SDK)、WORKOS_REDIRECT_URI(服务端 SDK 回调)、WORKOS_COOKIE_PASSWORD(会话加密,32 位以上);部分框架使用带前缀变体如 NEXT_PUBLIC_*,需查 README。
验证与限制:安装后确认 SDK 在 node_modules 且无错误;回调路由文件路径须与 WORKOS_REDIRECT_URI 一致并导入 SDK 回调处理器;Provider 须包裹整个应用,中间件位置正确;UI 首页显示条件认证状态并使用 SDK 函数生成登录登出 URL;最终构建退出码为 0。关键规则:先安装再写导入、使用 SDK 函数而非手写 OAuth URL、遵循 README 模式、回调路径从环境变量提取而非硬编码。错误恢复涵盖模块未找到、构建导入错误、重定向 URI 无效、Cookie 密码错误、认证状态不持久等场景。具体框架细节与代码示例以 README 为准,资料未提供完整实现代码。