@crvouga/ mockingbird-service-检查器
本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .
WIP 检查器 v1 用于合成候选人的仿真器,包/分级计数,邀请 以及种子报告/ETA。 不需要检查、电子邮件或真实的个人数据.
安装
bun add -d @crvouga/mockingbird-service-checkr
使用量
import { createServer } from "@crvouga/mockingbird-service-checkr/server"
// Test setup: the emulator. The application's Checkr origin becomes server.url.
const server = await createServer()
const baseUrl = server.url
// Application code: the request it sends to api.checkr.com, Basic auth with the API key.
const response = await fetch(`${baseUrl}/v1/packages`, {
headers: { authorization: `Basic ${btoa("mock_checkr_key:")}` },
})
const packages = (await response.json()) as { data: { slug: string }[] }
await server.close()
弹出 server.url (b) 取代生产/储存
来源,而不是 /v1 前缀. createRuntime().fetch(Request) 支持进程内适配器.
接受基本认证 apiKey (默认) mock_checkr_key)作为用户名和一个空密码.
路线
获取 /v1/packages, (中文(简体) ), /v1/nodes, (中文(简体) ), /v1/candidates, (中文(简体) ), /v1/invitations 以
page编号 :per_page 当地 next_href 链接。 候选人电子邮件和邀请书候选人/地位
支持过滤器 。 邮政 /v1/candidates 财务报告和审定财务报表 /v1/invitations 创建记录; 邀请
核实候选人/包装参考书目和工作地点,然后储存任何东西.
获取/删除 /v1/invitations/{id} 阅读/取消邀请。 取消是删除,
不是发明 canceled 状态 : deleted_at 被设定,普通读取/列表排除,
获取 ?include_deleted=true 揭发. 在文件取消/删除之后
并包含 已删除的机制;引用的通用 DELETE 响应示例不包含
显示删除后的时间戳。 待发邀请在7天后默认失效.
获取 /v1/reports/{id} 财务报告和审定财务报表 /v1/reports/{id}/eta 读取种子报告; 缺少 ETA 返回 404.
国家和控制
运行时种子 : packages, (中文(简体) ), nodes, (中文(简体) ), candidates, (中文(简体) ), reports· ; hierarchyEnabled 默认为虚假,
因此节点返回403, 而其他 API 工作。 启用的分级要求有一个可用的节点/包
在邀请创建. invitationTtlMs 和模拟器时钟驱动器过期.
所有记录和设置都在 /__admin/state:编辑价格,报告状态/ETA,
在无外部服务的情况下,邀请到期/完成和分级访问。 管理种子
报告反映在候选人的报告中。 行政控制故意不
执行供应商优惠完整性;种子统一装置.
标准管理员重新设置,时光线快照/快照,时钟和日记都有.
使用命名空间 x-mockingbird-namespace, (中文(简体) ), /__admin/ns/<name>/…基本证书;
pagination URL 保留命名空间,包括已迁移 adminPrefix 路径.
期刊只保留请求元数据,而不是候选数据或全权证书.
预设 : forbidden, (中文(简体) ), hierarchy_denied, (中文(简体) ), rate_limited, (中文(简体) ), server_error, (中文(简体) ), non_json, (中文(简体) ),
connection_drop. 通用断层间隔和客户端中止信号模型定时.
没有执行或声称网络呼号.
核查
bun test 通过原始客户端端端口覆盖每个报告的行为,服务HTTP,
命名空间/错误/重置,独立的 OpenAPI 行走和故意有差异的情况.
这个消费者没有使用官方SDK. 端口跟随问题的表面; 不变
私人应用程序的接受不主张。 这个 官方查询
没有使用现场证书或背景检查请求.
CHECKR_API_KEY=… bun run parity 安全检查软件包列表响应形状;没有
键它退出 2。 它从未产生候选人、邀请书或报告.
故意不模拟
实际背景筛查、犯罪记录、真实的PII、邀请电子邮件发送、托管 候选人同意 UI, 网页发送和制作裁定。 报告为: 明确合成装置;不只通过邀请候选人而自动生成报告. 错误诊断字符串和每个外地的完整供应商验证都不属于这一范围.
API 密码
根运行时间导出 : CheckrAPI, (中文(简体) ), CHECKR_NAMESPACE, (中文(简体) ), DEFAULT_PACKAGES, (中文(简体) ), createRuntime, (中文(简体) ),
CHECKR_PRESETS, (中文(简体) ), document, (中文(简体) ), operationIds, (中文(简体) ), supportedOperationIds。 。 。 .
类型 : Package, (中文(简体) ), Node, (中文(简体) ), Candidate, (中文(简体) ), Invitation, (中文(简体) ), Report, (中文(简体) ), CheckrAPIOptions, (中文(简体) ),
CheckrRuntimeOptions, (中文(简体) ), CheckrRuntime, (中文(简体) ), OperationId, (中文(简体) ), SupportedOperationId。 。 。 .
这个 /server 进口 createServer, (中文(简体) ), serveTarget, (中文(简体) ), DEFAULT_PORT。 。 。 .