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

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

国家模拟器 日报.co 测试套房的REST API:房间(创建,获取,更新, 删除、出席、弹出、会议标志(薄荷和验证)、核查HS256会议 表示我们的后端标志本身, 和最后的网络呼号(transcription.stopped, (中文(简体) ), recording.ready-to-download)与写入堆S3的笔录. 每个EMR 订房创造了一个房间和一个标志;今天,由于订房,一个破碎的每日一体化是沉默的 吞入错误。 它对于仿效者,是可观察的,是可证实的.

• 行动范围: 支助
• 合同openapi.yaml从《每日日报》记录的 REST API 到我们的电话 后端和EMR制作,并带有所发送的字段.

安装

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

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

使用量

将应用程序指向模拟器( G- D1 接合) :

npx mockingbird-daily serve --port 8800 \
  --room-url-base https://acme-mock.daily.test/ \
  --domain-id "$DAILY_API_DOMAIN_ID" \
  --webhook-url http://127.0.0.1:4000/v1/webhooks/daily \
  --webhook-secret "$DAILY_WEBHOOK_SECRET" \
  --s3-endpoint http://127.0.0.1:4569 --s3-bucket "$S3_BUCKET_NAME"

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

// Test setup: the emulator, its webhook receiver and the S3 bucket transcripts land in.
const server = await createServer({
  settings: { roomUrlBase: "https://acme-mock.daily.test/" },
  webhooks: { url: "http://127.0.0.1:4000/v1/webhooks/daily", secret: "whsec-daily" },
  transcripts: { endpoint: "http://127.0.0.1:4569", bucket: "emr-transcripts" },
})

// Application code: DAILY_API_BASE_URL is `${server.url}/v1`. The EMR books an appointment.
const baseUrl = `${server.url}/v1`
const headers = { authorization: "Bearer daily-api-key", "content-type": "application/json" }
const created = await fetch(`${baseUrl}/rooms`, {
  method: "POST",
  headers,
  body: JSON.stringify({ privacy: "private" }),
})
const room = (await created.json()) as { name: string; url: string }
const minted = await fetch(`${baseUrl}/meeting-tokens`, {
  method: "POST",
  headers,
  body: JSON.stringify({ properties: { room_name: room.name, user_id: "prac-1", is_owner: true } }),
})
const { token } = (await minted.json()) as { token: string }

// Test control: end the call. Writes <room>/<session>.json to S3, then fires transcription.stopped.
await fetch(`${server.url}/__admin/rooms/${room.name}/session`, {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    participants: [{ userId: "prac-1" }, { userId: "pat-1" }],
    durationSec: 1200,
    transcript: [{ s: "prac-1", t: "How are you feeling?", ts: 0.5, te: 2.1 }],
  }),
})
await server.close()

路线

奥特. Authorization: Bearer <DAILY_API_KEY>; 任何密钥,除非 apiKeys 已经设定。 失踪 —— 401 (中文(简体) ) {error: "authentication-error"}。 。 。 .

毫秒时. 我们的一些人通过 nbf编号 :exp 以毫秒计(例如,EMR) generatePatientToken 通过 Date.parse(end)) (中文(简体) ). 模拟器接受它们,解释值 1e11作为时间检查,每个记录在 GET /__admin/warnings,并标记日记条目 (单位:千美元)ids.warning: "exp in milliseconds") (中文(简体) ).

网络呼号

每日会话: {version: "1.0.0", type, event, id, event_ts, payload} (我们的接收器读取) event; 每日文件 type;两者均送去).

• transcription.stopped —— 说 payload: {room_name, session_id, duration, s3_key, instance_id}。 。 。 .
• recording.ready-to-download —— 说 payload: {type: "cloud", recording_id, room_name, session_id, start_ts, status: "finished", max_participants, duration, s3_key} (我们的EMR只是敲它。).

签字——我们的计谋,不是"日报"的. x-webhook-signature =: 六进制 HMAC-SHA256 (英语:DAILY_WEBHOOK_SECRET,原始体),这是我们EMR验证的(只在 秘密已经设定). 日报的记录计划不同 基础64 HMAC -SHA256 "<X-Webhook-Timestamp>.<body>" 与基础64解码的秘密——所以真正的"每日网络"会 检查失败 ; 模拟器显示我们的密码检查方式 . x-webhook-timestamp 也发送. 复议:立即,5s,5分钟,30分钟,2小时; GET /__admin/webhooks, (中文(简体) ), …/events, (中文(简体) ), …/replay, (中文(简体) ), …/flush 和往常一样.

管理员(超过标准合同)

时间规则运行在模拟器时钟上(POST /__admin/clock: 信使/房间 nbf 财务报告和审定财务报表 exp,以及 因此,后端的13h 房间的创建延迟 和30min的护栏窗口 日报看到.

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}: room_not_found (404小时) /v1/rooms/:name…, (中文(简体) ), unauthorized (401个), rate_limited (429个), server_error (500个), webhook_duplicate, (中文(简体) ), webhook_reorder, (中文(简体) ), webhook_drop。 。 。 .

命名空间

x-mockingbird-namespace页:1 /__admin/ns/<name> 前缀在基址上,或用 API 键: PUT /__admin/credentials {"credentials": {"<DAILY_API_KEY>": "<namespace>"}}。 。 。 .

故意不模拟

• 媒体飞机:SFU、WebRTC、敲门/录取、录音和抄录. daily-js 加载 Daily 的 CDN 捆绑; 成员应用 UI 测试应注入假 DailyCallLike 结束 useCallProviderLogic(createCallObject)。 。 。 .
• 会议室页 https://<domain>.daily.co/<room>?t= (URL是制作的,没有服务).
• 日报自有"网络呼克"签名计划及"网络呼克"注册API(见上文).
• 录音/特写 REST API,拨出,流出.

API 密码

部分 嘲笑鸟。 。 。 .