@crvouga/ mockingbird-service-formbricks (英语)

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

开源状态仿真器 窗体砖 (6.x) 用于 测试套件:客户端环境说明 JS SDK 的加载调查,响应创建 上游验证和 {code, message, details} 错误, v1 管理 API( 答复和 调查, x-api-key),部件脚本 网络 SDK 负载,以及响应管道 responseCreated 编号 : responseFinished 网络用户每个命名空间都有一个小的种子 合成调查体src/corpus/surveys.json:核动力源、登入、产品反馈、链接 调查和暂停调查;发明内容).

• 行动范围: 支助
• 合同openapi.yaml)由上游Formbricks 6.0.0的路由处理器手写 编辑 文档。 。 。 .

安装

npm install -D @crvouga/mockingbird-service-formbricks

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-formbricks serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与任何获取服务器.

使用量

指着SDK appUrl 在模拟器上(和您的管理 API 基础 URL),使用工作空间 id cworkspace000000000000001 (或其遗留环境d) cenvironment0000000000001,随着年长 SDKs发送),以及任何管理API密钥.

npx mockingbird-formbricks serve --port 8813 \
  --webhook-url http://127.0.0.1:3000/webhooks/formbricks \
  --webhook-secret "whsec_…"

用你自己的设置和调查来启动它,没有包装程序或一个 PUT 启动后 :

npx mockingbird-formbricks serve \
  --settings '{"workspaces": ["cworkspace000000000000002"], "legacyEnvironmentIds": {"cenvironment0000000000002": "cworkspace000000000000002"}}' \
  --surveys ./surveys.json

--settings <json|file> (或 MOCKINGBIRD_SETTINGS,或舰队进入 settings) 采取 领域 GET|PUT /__admin/settings,用其类型检查(拼错的密钥是错误)。 他们 是每个命名空间的默认值, 重设返回, 以及您给的替换字段 内置值整数( give) legacyEnvironmentIds 而默认的环境别名已消失. --workspace-id 添加到脚上 workspaces。 。 。 . --surveys <file> (一清单,或 {surveys: [...]}(中文(简体) ) 在每个命名空间 都加上了你的调查 并且它们都活下来了 调查 (或更早的一行)已经跳过的人的身份证 workspaceId 服务于 每个配置的工作空间,以及 type, (中文(简体) ), status 和遗产 environmentId 处理方式为 PUT /__admin/surveys 处理他们. --surveys-mode replace 将文件作为整体. 在舰队,设定 options: {"surveys": "surveys.json"}。 。 。 .

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

// Test setup: the emulator, posting response webhooks to the app's handler.
const server = await createServer({
  webhooks: { url: "http://127.0.0.1:3000/webhooks/formbricks", secret: "whsec_…" },
})

// Application code: appUrl is server.url. Submit a response to the seeded NPS survey.
const appUrl = server.url
const created = await fetch(`${appUrl}/api/v2/client/${WORKSPACE_ID}/responses`, {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    surveyId: "csurveynps000000000000001",
    finished: true,
    data: { nps_score: 9 },
  }),
})
// → {data: {id, quotaFull: false}}. The emulator validates it, stores it, and posts
// responseFinished to the webhook.

// Test control: read what was stored.
const stored = await fetch(`${appUrl}/__admin/responses`)
await server.close()

路线

客户端路由在路径中选择工作空间 id 或 遗留( 前为 Formbricks-5) 环境 id ; 两者均 决心在同一工作空间.

管理调查 questions 来源于 blocks (块上最后一个按钮标签) 要素), workspaceId遗产 environmentId,以及 projectOverwrites管理路线 需求 x-api-key (任何非空密钥,除非 apiKeys ),否则401 {code: "not_authenticated", message: "Not authenticated", details: {"x-Api-Key": "…"}}。 。 。 .

网络呼号

POST <webhook-url> 与 {webhookId, event, data: {...response, survey: {title, type, status, createdAt, updatedAt}}},标题 webhook-id, (中文(简体) ), webhook-timestamp 当终点有 whsec_… 暗号, webhook-signature: v1,<base64 HMAC-SHA256> (标准网呼). 只有事件 a 端点订阅发送 : responseFinished 默认(events: ["responseCreated", "responseFinished"] 两者均适用). --webhook-token 附录a ?token= 对检查一个的接收器. 报复, GET /__admin/webhooks, (中文(简体) ), …/events, (中文(简体) ), …/replay, (中文(简体) ), …/flush 财务报告和审定财务报表 PUT /__admin/webhook-endpoints 工作如常.

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets: rate_limited (429个) too_many_requests, (中文(简体) ), server_error (500个), missing_response_id (储存,但 答案中没有编号, environment_unavailable, (中文(简体) ), data_as_string (管理层) data 作为JSON 字符串, management_unauthorized, (中文(简体) ), connection_drop, (中文(简体) ), duplicate (下个网钩两次), webhook_drop, (中文(简体) ), webhook_reorder。 。 。 .

命名空间

x-mockingbird-namespace页:1 /__admin/ns/<name> 应用程序 URL 前缀,或者通过证书:工作空间 (或遗留环境) id 在客户端路径( SDK 无法添加信头) 或管理器中 x-api-key,通过 PUT /__admin/credentials {"credentials": {"<workspace id or key>": "<namespace>"}}。 。 。 .

故意不模拟

• 显示、 联系人/ 识别, user 财务报告和审定财务报表 storage 客户端 API (部件脚本) 的路由 是无操作的,所以SDK从不给它们打电话; 响应更新( S)PUT …/responses/{id}) (中文(简体) ).
• 配额(总是) quotaFull: false),单用链接,PIN保护,reCAPTCHA,电子邮件 校验、文件上载检查、自定义 validation.rules, (中文(简体) ), 调查逻辑,以及关于创建的全部调查计划(仅检查上面的形状).
• 超过允许列表的嵌入式数据吸收合同(封闭字段、强制、大小限制), userAgent 解析( 总是) {device: "desktop"}),和超越通俗的语言卡通化 光线密码.
• 组织、 API- key 权限(unauthorized,其他管理层 API (原始内容存档于2019-10-21). Formbricks UI.

API 密码

部分 嘲笑鸟。 。 。 .