@crvouga/mockingbird-service-clerk

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

Stateful Clerk public vendor API emulator with native namespaces, checkpoints and test controls.

原始使用文档
文档目录3 节
  1. Install
  2. Usage
  3. API

@crvouga/mockingbird-service-clerk

Local emulators. Real API contracts. Part of Mockingbird.

OIDC discovery, JWKS, OAuth authorize/token/userinfo, users, email addresses, organizations, memberships, invitations, sessions. Runs through Mockingbird's portable Fetch runtime with SQLite persistence, namespaces, checkpoints, faults and admin controls.

Install

npm install @crvouga/mockingbird-service-clerk

Usage

import { createServer } from "@crvouga/mockingbird-service-clerk/server"

const server = await createServer({ seed: 1 })

// The app's Backend API calls, with the emulator's URL in place of https://api.clerk.com.
const headers = { authorization: "Bearer sk_test_fixture", "content-type": "application/json" }
const created = await fetch(`${server.url}/v1/users`, {
  method: "POST",
  headers,
  body: JSON.stringify({ email_address: ["[email protected]"], first_name: "Ada" }),
})
const user = (await created.json()) as { id: string; first_name: string }
const listed = await fetch(`${server.url}/v1/[email protected]`, { headers })
const { data } = (await listed.json()) as { data: { id: string }[] }
console.log(data[0]?.id === user.id) // true
await server.close()

The example uses plain fetch because @clerk/backend only parses a response whose content-type is exactly application/json, and the emulator answers application/json; charset=UTF-8. With createClerkClient({ secretKey, apiUrl: server.url }) the requests succeed but resources come back as unparsed JSON strings.

API

  • ClerkAPI: portable provider instance; accepts SQLite, namespace, clock, fixtures and baseUrl.
  • createRuntime: shared runtime, including native namespace and checkpoint controls.
  • CLERK_NAMESPACE: default storage namespace.
  • document, operationIds, supportedOperationIds: registered provider route inventory.
  • createServer, DEFAULT_PORT, serveTarget from /server: loopback listener and CLI configuration.

fixtures accepts synthetic provider seed records. reset() restores defaults. Emulate 0.12.1 is a test oracle only, never a runtime dependency. Vendor handlers ported under Apache-2.0 retain their license and attribution; see LICENSE_EMULATE and THIRD_PARTY_NOTICES.md.

See SUPPORT.md for coverage and limits and API_EVIDENCE.md for validation status.

版本与发布记录

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

版本发布日期距今
0.10.0latest2026/11/11今天
0.9.92026/11/038 天前
0.9.82026/11/038 天前
0.9.72026/11/038 天前
0.9.62026/11/038 天前
0.9.52026/11/038 天前

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

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

Stateful Clerk public vendor API emulator with native namespaces, checkpoints and test controls.

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

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

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

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

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

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

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

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

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

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

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

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