@crvouga/mockingbird-service-workos

中文文档
1.13.0发布于 2026/11/15MITTypeScriptES Module构建来源已验证近 30 天下载 1970

状态工作OS AuthKit 仿真器,带有签名会话,旋转刷新符和用户页码.

中文使用文档
文档目录7 节
  1. 安装
  2. 使用量
  3. 路线
  4. 国家和控制
  5. 核查
  6. 故意不模拟
  7. API 密码

@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 发送 PKCE code_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。 。 。 .

版本与发布记录

@crvouga/mockingbird-service-workos 共发布 20 个版本,首次发布于 2026/10/05;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.13.0latest2026/11/151 天前
1.12.02026/11/133 天前
1.11.12026/11/123 天前
1.11.02026/11/123 天前
1.10.02026/11/114 天前
1.9.42026/11/0312 天前

关于 @crvouga/mockingbird-service-workos 的常见问题

@crvouga/mockingbird-service-workos 是什么?

状态工作OS AuthKit 仿真器,带有签名会话,旋转刷新符和用户页码.

如何安装 @crvouga/mockingbird-service-workos?

在项目目录运行 npm install @crvouga/mockingbird-service-workos,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 mockingbird-workos,可以用 npx mockingbird-workos 直接运行。

@crvouga/mockingbird-service-workos 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@crvouga/mockingbird-service-workos 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@crvouga/mockingbird-service-workos 可以商用吗?

@crvouga/mockingbird-service-workos 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@crvouga/mockingbird-service-workos 的下载量有多少?

根据 npm 官方下载统计,@crvouga/mockingbird-service-workos 在 2026/10/11 – 2026/11/09 这 30 天内被下载 1,970 次,日均约 66 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@crvouga/mockingbird-service-workos 还在维护吗?

最新版本 1.13.0 发布于 2026/11/15(1 天前);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/10/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。