@crvouga/嘲笑鸟-服务-工作
本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .
WIP WorkingOS AuthKit模拟器:授权重定向,单用代码,已签名的JWT会话, 旋转刷新令牌,用户元数据并发页. 只有合成装置.
安装
bun add -d @crvouga/mockingbird-service-workos
使用量
import { WorkOS } from "@workos-inc/node"
import { createServer } from "@crvouga/mockingbird-service-workos/server"
const server = await createServer()
const url = new URL(server.url)
// The app's own WorkOS client. Only its API host changes.
const workos = new WorkOS("mock_workos_key", {
clientId: "client_mock",
apiHostname: url.hostname,
port: Number(url.port),
https: false,
})
const authorizationUrl = workos.userManagement.getAuthorizationUrl({
provider: "authkit",
clientId: "client_mock",
redirectUri: "http://localhost:3000/callback",
})
// The test stands in for the browser: the emulator signs in the seeded user and redirects with a code.
const redirect = await fetch(authorizationUrl, { redirect: "manual" })
const code = new URL(redirect.headers.get("location") ?? "").searchParams.get("code") ?? ""
const { user } = await workos.userManagement.authenticateWithCode({ code })
const { data: users } = await workos.userManagement.listUsers({ email: user.email })
console.log(users[0]?.id === user.id) // true
await server.close()
为 AuthKit 设定 WORKOS_API_HOSTNAME编号 :WORKOS_API_PORT 从 server.url 财务报告和审定财务报表
WORKOS_API_HTTPS=false,与 WORKOS_API_KEY=mock_workos_key 财务报告和审定财务报表 WORKOS_CLIENT_ID=client_mock。 。 。 .
在客户端种子中注册回调并使用本地 WORKOS_COOKIE_PASSWORD。 。 。 .
createRuntime().fetch(Request) 支持进程内适配器。 原始用户镜像应使用
替换服务器 URL https://api.workos.com。默认的注册回调是
http://localhost:3000/callback;授权立即选择客户端的种子用户.
准确 @workos-inc/[email protected] 财务报告和审定财务报表 @workos-inc/[email protected] SDK测试
超过HTTP,包括PKCE,JWT签名验证和过期会话刷新.
路线
GET /user_management/authorize:注册回调,代码,状态,可选组织/PKCE.POST /user_management/authenticate: 有授权的客户端秘密 代码或刷新 token. 公共(浏览器或本地)客户端可能省略client_secret发送 PKCEcode_verifier相反,正如 AuthKit 的浏览器 SDK 所做的那样;这样开始的会话也会毫无秘密地刷新.GET /user_management/users:无记名 API 密钥,限制/ 之后和电子邮件过滤.GET /sso/jwks/{clientId}: AuthKit使用的公用ephemeral RS256验证密钥.
国家和控制
种子 users, (中文(简体) ), clients 财务报告和审定财务报表 memberships 有运行时间选项。 选项 accessTtlMs, (中文(简体) ),
refreshTtlMs 财务报告和审定财务报表 codeTtlMs 控制过期。 模拟器时钟控制器发布了时间戳.
标准 /__admin/state 收藏会暴露用户、客户、会员、代码、会话
和新鲜的托肯斯。 编辑 sessions.revoked,过期字段或用于失败情景的旗帜.
私人签名密钥为 ephemeral , 且从未进行日记; 重置状态无效状态会刷新
代号,但离线JWT核查 没有撤销检查, 就像SDK.
标准 /__admin 重置、 时间线快照/ 空白、 时钟、 断层和请求日记
备有。 期刊存储元数据,而不是客户端机密或信使请求机构.
标题( E)x-mockingbird-namespace),路径(/__admin/ns/<name>/…)和无记名证书
命名空间隔离持久状态。 AuthKit 应用程序应使用每台专用服务器
测试命名空间,所以SDK的JWKS URL和发行器仍然一致. 配置 adminPrefix
将保留树移出。 预设 : auth_failure, (中文(简体) ), rate_limited, (中文(简体) ), server_error, (中文(简体) ),
connection_drop;通用断层也支持确定性延迟.
核查
bun test 包括接受、独立的OpenAPI行走、故意分歧以及两者
钉住SDK. WORKOS_API_KEY=… bun run parity 运行一个安全的列表用户形状探测器; 它执行
没有账户突变,也没有打印用户数据。 失证出道口 2.
甲骨文参考: 认证, (中文(简体) ),
用户还有SDK官方消息来源.
故意不模拟
企业 SAML,目录同步,密码,MFA,主机AuthKit页面,登录, 用户突变和网络呼号。 授权是一个合成自动登录,而不是主机UI. 没有第三方身份、网络联合会、准确的生产刷新政策或 分布式签名键持续. 错误信封模型常见的已记录失败; 具体供应商的诊断条件和无凭证的索赔要求没有保证.
API 密码
根运行时间导出 : WorkOSAPI, (中文(简体) ), WORKOS_NAMESPACE, (中文(简体) ), DEFAULT_USERS, (中文(简体) ), DEFAULT_CLIENTS, (中文(简体) ),
createRuntime, (中文(简体) ), WORKOS_PRESETS, (中文(简体) ), document, (中文(简体) ), operationIds, (中文(简体) ), supportedOperationIds。 。 。 .
类型包括: WorkOSUser, (中文(简体) ), WorkOSClient, (中文(简体) ), Membership, (中文(简体) ), WorkOSAPIOptions, (中文(简体) ),
WorkOSRuntimeOptions, (中文(简体) ), WorkOSRuntime, (中文(简体) ), OperationId, (中文(简体) ), SupportedOperationId。 。 。 .
这个 /server 进口 createServer, (中文(简体) ), serveTarget, (中文(简体) ), DEFAULT_PORT。 。 。 .