wavekat_platform_client/voice.rs
1//! Voice-product resources synced from the desktop daemon up to the
2//! platform.
3//!
4//! The first shipped marker is [`VoiceCalls`] — per-call metadata for
5//! the platform's `/voice/calls` history page (see
6//! `wavekat-voice/docs/21-platform-call-history-sync.md`). Recordings
7//! (`VoiceRecordings`), transcripts (`VoiceTranscripts`), and summaries
8//! will follow the same shape: a marker type, a wire-record struct, and
9//! a typed query — no new HTTP plumbing.
10//!
11//! All wire shapes use camelCase JSON to match the platform's Hono/Zod
12//! convention. The Rust types stay snake_case so consumers feel native.
13
14use serde::{Deserialize, Serialize};
15
16use crate::client::Client;
17use crate::error::{Error, Result};
18use crate::sign::ReleaseCredential;
19use crate::sync::{stamp_schema_version, HasSyncEnvelope, SyncEndpoint, SyncEnvelope, SyncRequest};
20
21/// Inbound vs. outbound. Wire-stable snake_case strings — never
22/// renumber or rename. New states (e.g. `internal`) would be a wire
23/// addition, not a replacement.
24#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
25#[serde(rename_all = "snake_case")]
26pub enum VoiceCallDirection {
27 Inbound,
28 Outbound,
29}
30
31/// User-visible disposition. Derived from [`VoiceCallEndReason`] by the
32/// daemon; the platform stores both, so future UI surfaces can read
33/// either without re-deriving.
34#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
35#[serde(rename_all = "snake_case")]
36pub enum VoiceCallDisposition {
37 Answered,
38 Missed,
39 Rejected,
40 Cancelled,
41 Failed,
42}
43
44/// Finer-grained terminal reason — kept distinct from
45/// [`VoiceCallDisposition`] because the disposition collapses
46/// `hangup_local` and `hangup_remote` to `Answered`, losing the
47/// "who hung up?" answer the row otherwise carries.
48///
49/// Wire-stable snake_case strings; the daemon's matching enum is the
50/// canonical source.
51#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
52#[serde(rename_all = "snake_case")]
53pub enum VoiceCallEndReason {
54 HangupLocal,
55 HangupRemote,
56 RejectedLocal,
57 RejectedRemote,
58 Missed,
59 CancelledLocal,
60 /// We blind-transferred the call to a third party (RFC 3515) and
61 /// dropped our own leg once the target answered. Distinct from
62 /// `HangupLocal`: the user didn't hang up, they handed the call off.
63 /// The destination is carried alongside in
64 /// [`VoiceCallRecord::transfer_target`]. Rows with this reason still
65 /// carry [`VoiceCallDisposition::Answered`].
66 TransferredLocal,
67 /// An established call torn down because its connection died —
68 /// the daemon's RFC 4028 session keepalive stopped getting
69 /// answers (peer crashed, NAT binding dropped). Distinct from
70 /// `HangupLocal`: the user didn't end this call. Rows with this
71 /// reason still carry [`VoiceCallDisposition::Answered`].
72 ConnectionLost,
73 Failed,
74}
75
76/// The audio codec a call negotiated, stamped once audio flows. Wire-
77/// stable snake_case strings matching the daemon's `CallCodec` enum —
78/// the platform validates against this exact list, so a rename here
79/// would bounce every upload with a 400. New codecs (e.g. `ilbc`) are
80/// wire additions, not replacements.
81///
82/// Consumers render this as a quality tier ("HD" for Opus, "Standard"
83/// for the G.711 pair), not the codec name alone — see the desktop
84/// client's call-details page for the canonical presentation.
85#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
86#[serde(rename_all = "snake_case")]
87pub enum VoiceCallCodec {
88 /// Opus wideband (16 kHz) — the "HD" tier.
89 Opus,
90 /// G.711 µ-law — the narrowband "Standard" tier.
91 Pcmu,
92 /// G.711 A-law — the narrowband "Standard" tier.
93 Pcma,
94}
95
96/// How a call flow's ("receptionist") run ended, folded by the daemon
97/// from the run's terminal trace step. Wire-stable snake_case strings
98/// matching `wavekat_flow::trace::FlowOutcome` — declared here rather
99/// than re-exported so this crate stays free of a `wavekat-flow`
100/// dependency; the two lists must be kept in step.
101///
102/// Consumers prefer this over [`VoiceCallEndReason`] when rendering a
103/// flow-answered call's outcome: the flow's own goodbye sends the BYE,
104/// so the SIP-level reason reads `HangupLocal` ("you hung up") for a
105/// call the user never touched.
106#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
107#[serde(rename_all = "snake_case")]
108pub enum VoiceCallFlowOutcome {
109 /// A `ring` node was answered by a human; the engine stepped out.
110 Answered,
111 /// A `message` node recorded a voicemail.
112 MessageLeft,
113 /// A `transfer` node handed the call to an external number.
114 Transferred,
115 /// A `hangup` node ended the call.
116 HungUp,
117 /// An effect failed mid-run (the call likely dropped).
118 Aborted,
119 /// The flow reached an impossible state. Validation is meant to
120 /// prevent this, so it signals a defect worth alerting on.
121 Defect,
122}
123
124/// One step of a call flow's run, as the daemon projects it from its
125/// local `call_flow_step` events.
126///
127/// Deliberately structural rather than a rendered sentence. The daemon
128/// has an English summary for each step, but the platform's web UI
129/// serves nine locales — shipping prose would make these permanently
130/// untranslatable there. Consumers get the parts and compose the
131/// sentence themselves.
132///
133/// `kind` is a plain `String`, not an enum, and that is the point: step
134/// kinds grow every time the flow engine gains a node type, and a
135/// consumer built against an older version of this crate must still be
136/// able to deserialize a newer daemon's trace. An unknown kind is
137/// rendered as an unnamed marker rather than rejected.
138#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
139#[serde(rename_all = "camelCase")]
140pub struct VoiceCallFlowStep {
141 /// Milliseconds from the call's answer time — the same zero the
142 /// recording starts at, so a step lines up with the audio.
143 pub at_ms: i64,
144 /// The engine's step tag: `spoke`, `hours`, `menu_choice`,
145 /// `menu_no_input`, `menu_invalid`, `ring`, `message_recorded`,
146 /// `transferred`, `hung_up`, or the synthetic `answered` marking a
147 /// mid-run take-over by the owner.
148 pub kind: String,
149 /// The flow node this step belongs to, when it names one.
150 #[serde(default, skip_serializing_if = "Option::is_none")]
151 pub node: Option<String>,
152 /// The key the caller pressed — `menu_choice` only.
153 #[serde(default, skip_serializing_if = "Option::is_none")]
154 pub digit: Option<String>,
155 /// Recorded message length in seconds — `message_recorded` only.
156 #[serde(default, skip_serializing_if = "Option::is_none")]
157 pub secs: Option<i64>,
158 /// Where the call was sent — `transferred` only.
159 #[serde(default, skip_serializing_if = "Option::is_none")]
160 pub target: Option<String>,
161 /// Whether an hours check landed inside business hours.
162 #[serde(default, skip_serializing_if = "Option::is_none")]
163 pub open: Option<bool>,
164 /// Whether a `ring` step was picked up.
165 #[serde(default, skip_serializing_if = "Option::is_none")]
166 pub answered: Option<bool>,
167}
168
169/// One historical call as it crosses the wire from the daemon up to the
170/// platform.
171///
172/// Mirrors the daemon's local `CallRecord` (see
173/// `wavekat-voice/crates/wavekat-voice/src/db.rs`) with one rename:
174/// the daemon's local primary key (`id`) is shipped as `source_id`
175/// because the platform allocates its own row id and treats the
176/// daemon-side UUID as the idempotency key.
177#[derive(Debug, Clone, Serialize, Deserialize)]
178#[serde(rename_all = "camelCase")]
179pub struct VoiceCallRecord {
180 /// Daemon-generated UUID. The platform's `(user_id, source_id)`
181 /// upsert key — re-syncing the same id is a no-op.
182 pub source_id: String,
183 /// SIP account UUID on the daemon side. Opaque to the platform.
184 pub account_id: String,
185 pub direction: VoiceCallDirection,
186 /// SIP `From:` (inbound) or `To:` (outbound). Free text — caller
187 /// IDs, display names, and SIP URIs all land here.
188 pub party: String,
189 /// RFC 3339. First ring (inbound) or first dial-out (outbound).
190 pub ring_at: String,
191 /// RFC 3339. Present only when the call reached the answered
192 /// state.
193 #[serde(default, skip_serializing_if = "Option::is_none")]
194 pub answer_at: Option<String>,
195 /// RFC 3339. Terminal timestamp; the platform uses this as the
196 /// list cursor.
197 pub end_at: String,
198 /// `answer_at` → `end_at` in milliseconds. `None` for calls that
199 /// were never answered.
200 #[serde(default, skip_serializing_if = "Option::is_none")]
201 pub duration_ms: Option<i64>,
202 pub disposition: VoiceCallDisposition,
203 pub end_reason: VoiceCallEndReason,
204 /// Free-text error, populated only when `disposition == Failed`.
205 #[serde(default, skip_serializing_if = "Option::is_none")]
206 pub error: Option<String>,
207 /// Visibility tier of any *active* (not revoked / expired) share on this
208 /// call's recording, or `None` when it isn't shared. Read-only: the
209 /// platform sets it on list (`GET /api/voice/calls`) and detail responses
210 /// so a consumer can badge the row "Public" / "Invited only"; it is
211 /// skipped on serialize, so syncing a call never sends it. `Private` never
212 /// appears here — an unshared call is `None`.
213 #[serde(default, skip_serializing_if = "Option::is_none")]
214 pub share_visibility: Option<ShareVisibility>,
215 /// Where a transferred call was sent — the number or SIP address the
216 /// far end was asked to call (RFC 3515 `Refer-To`). Set only when
217 /// `end_reason == TransferredLocal`; `None` for every other call.
218 /// Unlike `share_visibility` this is daemon-owned data, so it *is*
219 /// sent on sync (serialized when present) and echoed back on read.
220 #[serde(default, skip_serializing_if = "Option::is_none")]
221 pub transfer_target: Option<String>,
222 /// The negotiated audio codec, present when the call reached the
223 /// audio-flowing state on a daemon new enough to record it; `None`
224 /// for never-answered calls and rows synced by older daemons. Like
225 /// `transfer_target` this is daemon-owned data, so it *is* sent on
226 /// sync (serialized when present) and echoed back on read.
227 #[serde(default, skip_serializing_if = "Option::is_none")]
228 pub codec: Option<VoiceCallCodec>,
229 /// Which call flow ("receptionist") answered this call, when one
230 /// did: the platform flow id the daemon held at answer time, and
231 /// the flow's display name *at that moment*. The name is shipped
232 /// verbatim rather than resolved from the flow on read, so a later
233 /// rename or delete doesn't rewrite what history says happened.
234 /// Both `None` for calls the user answered themselves. Daemon-owned
235 /// data like `codec`, so both are sent on sync and echoed on read.
236 #[serde(default, skip_serializing_if = "Option::is_none")]
237 pub flow_id: Option<String>,
238 #[serde(default, skip_serializing_if = "Option::is_none")]
239 pub flow_name: Option<String>,
240 /// How the flow's run ended. `None` when no flow answered, and for
241 /// runs with no terminal step (the caller hung up mid-flow) — there
242 /// [`VoiceCallRecord::end_reason`] is already the honest story.
243 #[serde(default, skip_serializing_if = "Option::is_none")]
244 pub flow_outcome: Option<VoiceCallFlowOutcome>,
245 /// The flow run's step-by-step trace, in answer-time order. Drives
246 /// the markers the platform's call-detail page draws on the
247 /// recording waveform.
248 ///
249 /// `None` for human-answered calls and for daemons predating the
250 /// trace. Sent on sync like the other daemon-owned fields, but
251 /// echoed back only on the *detail* read (`GET /api/voice/calls/
252 /// {sourceId}`) — the list route omits it, since nothing on a list
253 /// row renders a trace and it would weigh down every page.
254 #[serde(default, skip_serializing_if = "Option::is_none")]
255 pub flow_steps: Option<Vec<VoiceCallFlowStep>>,
256 /// RFC 3339 soft-delete tombstone. `None` = live; `Some` = the user
257 /// deleted this call at that time.
258 ///
259 /// Calls are otherwise immutable one-way pushes, and this is the
260 /// single exception: a delete has to reach the platform somehow, and
261 /// a hard `DELETE` can't sync under a "push the row" model — once
262 /// the row is gone there's nothing left to push. So a delete rides
263 /// as an ordinary upsert with this field set, exactly like
264 /// [`VoiceAccountRecord::deleted_at`].
265 ///
266 /// Where it differs from the account tombstone: **the platform
267 /// treats this one as sticky, not last-write-wins.** An account is
268 /// genuinely mutable, so it carries `updated_at` and conflicts
269 /// resolve on it; a call has no such field because delete is the
270 /// only mutation it has. The platform resolves the column
271 /// `COALESCE(existing, incoming)`, so once a call is deleted a
272 /// later sync of the same `source_id` can never revive it — which
273 /// also means a consumer must not expect to "undelete" by syncing
274 /// the row again with `None`.
275 ///
276 /// Deleting a call is not only a flag on the platform side: the
277 /// recording bytes are removed from object storage, the recording
278 /// and transcript rows are dropped, and any live share link is
279 /// revoked (it answers 410 thereafter). The tombstone row is
280 /// retained so a late-syncing device still learns about the delete
281 /// — read it via `include_deleted` on
282 /// [`VoiceCallsQuery`]. `GET /api/voice/calls/{sourceId}` returns
283 /// 404 for a deleted call rather than echoing the tombstone.
284 #[serde(default, skip_serializing_if = "Option::is_none")]
285 pub deleted_at: Option<String>,
286 /// Version + forward-compat fields shared by every sync record.
287 /// Flattened so `schemaVersion` and `extras` sit at the top of
288 /// the JSON object alongside the other columns. See
289 /// [`SyncEnvelope`] and doc 21 §"Versioning and forward
290 /// compatibility".
291 #[serde(flatten, default)]
292 pub envelope: SyncEnvelope,
293}
294
295/// Query params for `GET /api/voice/calls`. All fields optional — the
296/// default returns the newest page.
297#[derive(Debug, Clone, Default, Serialize, Deserialize)]
298#[serde(rename_all = "camelCase")]
299pub struct VoiceCallsQuery {
300 /// Include soft-deleted tombstones in the response. Absent / false
301 /// returns only live calls — what a human-facing list wants. A
302 /// delta-syncing device sets this `true` to learn about deletes
303 /// made on another device or on the web, so it can reap its local
304 /// copy.
305 ///
306 /// Unlike [`VoiceAccountsQuery::include_deleted`] there is no
307 /// "restore a fresh device" use for this: a tombstoned call has had
308 /// its recording and transcript destroyed, so the only thing left
309 /// to learn from it is that it's gone.
310 #[serde(default, skip_serializing_if = "Option::is_none")]
311 pub include_deleted: Option<bool>,
312 /// RFC 3339 cursor; rows with `end_at < before` are returned.
313 #[serde(default, skip_serializing_if = "Option::is_none")]
314 pub before: Option<String>,
315 /// 1..=200. Server default is 50.
316 #[serde(default, skip_serializing_if = "Option::is_none")]
317 pub limit: Option<u32>,
318}
319
320/// Marker for the `/api/voice/calls/{sync,list}` endpoint pair.
321///
322/// Use as a type parameter, never construct: `client.sync::<VoiceCalls>(&items)`.
323pub struct VoiceCalls;
324
325impl SyncEndpoint for VoiceCalls {
326 const RESOURCE: &'static str = "calls";
327 type Record = VoiceCallRecord;
328 type Query = VoiceCallsQuery;
329}
330
331impl HasSyncEnvelope for VoiceCallRecord {
332 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
333 &mut self.envelope
334 }
335}
336
337// ---- VoiceRecordings ------------------------------------------------------
338
339/// One per-call recording's metadata as it crosses the wire from the
340/// daemon up to the platform. The WAV bytes ride on a separate
341/// follow-up call ([`Client::upload_recording_bytes`]) so the
342/// idempotent metadata sync stays small and a flaky bytes upload
343/// doesn't force the daemon to re-ship the row.
344///
345/// Mirrors the daemon's `RecordingArtifact` (see
346/// `wavekat-voice/crates/wavekat-voice/src/recording.rs`) with one
347/// rename: the daemon's local id (`id`) ships as `source_id` because
348/// the platform allocates its own row id and treats the daemon-side
349/// UUID as the idempotency key (same convention as
350/// [`VoiceCallRecord`]).
351#[derive(Debug, Clone, Serialize, Deserialize)]
352#[serde(rename_all = "camelCase")]
353pub struct VoiceRecordingRecord {
354 /// Daemon-generated UUID for this recording artifact. Upsert key
355 /// on the platform side.
356 pub source_id: String,
357 /// Daemon's `calls.id` — the call this recording belongs to.
358 /// The platform stores both so the /voice/calls history page can
359 /// link a call to its recording without a separate join table.
360 pub call_source_id: String,
361 /// Byte length of the WAV file the daemon will PUT in the follow-
362 /// up bytes call. The platform refuses a PUT whose body length
363 /// disagrees.
364 pub size_bytes: u64,
365 pub duration_ms: u64,
366 pub sample_rate: u32,
367 pub channels: u16,
368 /// RFC 3339 timestamp the daemon stamped on the artifact at
369 /// finalize time. Drives the platform's `/voice/recordings` GET
370 /// cursor.
371 pub created_at: String,
372 #[serde(flatten, default)]
373 pub envelope: SyncEnvelope,
374}
375
376/// Query params for `GET /api/voice/recordings`.
377#[derive(Debug, Clone, Default, Serialize, Deserialize)]
378#[serde(rename_all = "camelCase")]
379pub struct VoiceRecordingsQuery {
380 /// RFC 3339 cursor; rows with `created_at < before` are returned.
381 #[serde(default, skip_serializing_if = "Option::is_none")]
382 pub before: Option<String>,
383 #[serde(default, skip_serializing_if = "Option::is_none")]
384 pub limit: Option<u32>,
385}
386
387/// Marker for the `/api/voice/recordings/{sync,list}` endpoint pair.
388///
389/// The corresponding bytes-upload endpoint
390/// (`PUT /api/voice/recordings/{sourceId}/bytes`) is invoked via
391/// [`Client::upload_recording_bytes`] — it doesn't fit the
392/// `SyncEndpoint` mold (no batch, no JSON body) so it has its own
393/// inherent method on `Client`.
394pub struct VoiceRecordings;
395
396impl SyncEndpoint for VoiceRecordings {
397 const RESOURCE: &'static str = "recordings";
398 type Record = VoiceRecordingRecord;
399 type Query = VoiceRecordingsQuery;
400}
401
402impl HasSyncEnvelope for VoiceRecordingRecord {
403 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
404 &mut self.envelope
405 }
406}
407
408/// One item in the platform's response to
409/// `POST /api/voice/recordings/sync`. Lets the daemon learn the R2
410/// key the platform stamped (so a subsequent bytes PUT can target it)
411/// without re-deriving it, and check whether bytes have already
412/// landed on a prior cycle (so the daemon can mark the local row
413/// synced without re-uploading the WAV).
414#[derive(Debug, Clone, Serialize, Deserialize)]
415#[serde(rename_all = "camelCase")]
416pub struct VoiceRecordingSyncItem {
417 pub source_id: String,
418 pub r2_key: String,
419 pub bytes_uploaded: bool,
420}
421
422/// Full response from `POST /api/voice/recordings/sync`. Superset of
423/// the generic [`crate::SyncResponse`] — see [`Client::sync_recordings`].
424#[derive(Debug, Clone, Serialize, Deserialize)]
425#[serde(rename_all = "camelCase")]
426pub struct VoiceRecordingsSyncResponse {
427 pub accepted: u32,
428 pub skipped: u32,
429 pub items: Vec<VoiceRecordingSyncItem>,
430}
431
432// ---- VoiceTranscripts -----------------------------------------------------
433
434/// Wire-stable transcript channel tag. Matches the daemon's
435/// `TranscriptChannelLabel` and `events::TranscriptChannel`.
436#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
437#[serde(rename_all = "snake_case")]
438pub enum VoiceTranscriptChannel {
439 /// Local mic audio — what the user said.
440 Local,
441 /// Received RTP audio — what the remote party said.
442 Remote,
443}
444
445/// One ASR transcript segment ("final" in wavekat-asr parlance) as it
446/// crosses the wire. Each segment is a row on the daemon side
447/// (`transcripts` table); the daemon batches a slice of them per
448/// upload and the platform upserts per (user_id, source_id).
449#[derive(Debug, Clone, Serialize, Deserialize)]
450#[serde(rename_all = "camelCase")]
451pub struct VoiceTranscriptRecord {
452 /// Daemon-side row id, formatted as text (the column is an
453 /// autoincrement integer on SQLite). Stable per (call, segment)
454 /// so re-shipping converges.
455 pub source_id: String,
456 /// Daemon's `calls.id` — the call this segment belongs to.
457 pub call_source_id: String,
458 pub channel: VoiceTranscriptChannel,
459 /// Start of the segment in milliseconds relative to the start of
460 /// the call's audio stream (not wall-clock).
461 pub ts_ms: i64,
462 /// End of the segment, same reference frame as `ts_ms`.
463 pub end_ms: i64,
464 /// Recognised text. Free-form; the platform stores it verbatim.
465 pub text: String,
466 #[serde(flatten, default)]
467 pub envelope: SyncEnvelope,
468}
469
470/// Query params for `GET /api/voice/transcripts` — required
471/// `call_source_id` (the endpoint refuses a flat list).
472#[derive(Debug, Clone, Default, Serialize, Deserialize)]
473#[serde(rename_all = "camelCase")]
474pub struct VoiceTranscriptsQuery {
475 pub call_source_id: String,
476}
477
478/// Marker for the `/api/voice/transcripts/{sync,list}` endpoint pair.
479pub struct VoiceTranscripts;
480
481impl SyncEndpoint for VoiceTranscripts {
482 const RESOURCE: &'static str = "transcripts";
483 type Record = VoiceTranscriptRecord;
484 type Query = VoiceTranscriptsQuery;
485}
486
487impl HasSyncEnvelope for VoiceTranscriptRecord {
488 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
489 &mut self.envelope
490 }
491}
492
493// ---- VoiceAccounts --------------------------------------------------------
494
495/// SIP transport for a synced account line. Wire-stable snake_case;
496/// mirrors the daemon's `TransportKind`.
497#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
498#[serde(rename_all = "snake_case")]
499pub enum VoiceTransport {
500 Udp,
501 Tcp,
502}
503
504/// One SIP account line's *configuration* as it crosses the wire from a
505/// device up to the platform and back down to another device
506/// (`wavekat-voice/docs/40-account-config-sync.md`).
507///
508/// Unlike calls / recordings / transcripts — which are immutable,
509/// one-way pushes — account config is **mutable and bidirectional**: a
510/// line is edited, toggled, renamed, and deleted, and those changes must
511/// restore onto a second device. The same idempotent
512/// `(user_id, source_id)` upsert that [`Client::sync`] performs carries
513/// every kind of change here; a *delete* is a soft-delete that rides as
514/// an upsert with `deleted_at` set, because a hard DELETE can't sync
515/// under a "push the row" model — once the row is gone there's nothing
516/// left to push.
517///
518/// **No secret field, by construction.** The SIP password never appears
519/// on this wire. Config sync (policy levels 1–2) keeps the credential
520/// device-local, and the end-to-end-encrypted secret path (level 3)
521/// ships its ciphertext through a *separate* opaque resource, never as a
522/// field here. Omitting it means level 3 can't be populated by accident
523/// before it exists.
524#[derive(Debug, Clone, Serialize, Deserialize)]
525#[serde(rename_all = "camelCase")]
526pub struct VoiceAccountRecord {
527 /// Daemon-side account UUID (`accounts.id`). The platform's
528 /// `(user_id, source_id)` upsert key — re-syncing the same id
529 /// updates the row in place (mutable), unlike the immutable
530 /// resources where a re-sync is a no-op.
531 pub source_id: String,
532 /// Whether the line registers on daemon boot. Pausing a line is a
533 /// portable preference, so it rides along.
534 pub enabled: bool,
535 pub display_name: String,
536 pub username: String,
537 pub domain: String,
538 #[serde(default, skip_serializing_if = "Option::is_none")]
539 pub auth_username: Option<String>,
540 #[serde(default, skip_serializing_if = "Option::is_none")]
541 pub server: Option<String>,
542 #[serde(default, skip_serializing_if = "Option::is_none")]
543 pub port: Option<u16>,
544 pub transport: VoiceTransport,
545 pub register_expires: u32,
546 #[serde(default, skip_serializing_if = "Option::is_none")]
547 pub keepalive_secs: Option<u32>,
548 /// Record-disclosure beep toggle — a column on the account row, so
549 /// it rides along for free (the account-portable taxonomy in doc 40).
550 pub disclosure_enabled: bool,
551 /// RFC 3339 last-modification time — the **last-write-wins key**. On
552 /// conflict the platform (and a pulling client) keep the copy with
553 /// the later `updated_at`. Whole-row LWW for v1; per-field merge is
554 /// deferred until users actually report lost edits (doc 40).
555 pub updated_at: String,
556 /// RFC 3339 soft-delete tombstone. `None` = live; `Some` = the line
557 /// was deleted on some device at that time. A tombstone syncs like
558 /// any other mutation so the delete propagates to other devices,
559 /// then is reaped locally once confirmed. The platform retains
560 /// tombstones so a late-syncing device still learns about the delete.
561 #[serde(default, skip_serializing_if = "Option::is_none")]
562 pub deleted_at: Option<String>,
563 /// Version + forward-compat fields shared by every sync record.
564 #[serde(flatten, default)]
565 pub envelope: SyncEnvelope,
566}
567
568/// Query params for `GET /api/voice/accounts`. All fields optional.
569#[derive(Debug, Clone, Default, Serialize, Deserialize)]
570#[serde(rename_all = "camelCase")]
571pub struct VoiceAccountsQuery {
572 /// Include soft-deleted tombstones in the response. Absent / false
573 /// returns only live lines — the restore-grade pull a fresh device
574 /// wants. A delta-syncing device sets this `true` to also learn
575 /// about deletes made elsewhere (doc 40).
576 #[serde(default, skip_serializing_if = "Option::is_none")]
577 pub include_deleted: Option<bool>,
578}
579
580/// Marker for the `/api/voice/accounts/{sync,list}` endpoint pair.
581///
582/// Accounts are the first *mutable, bidirectional* sync resource, but
583/// the wire shape is the same idempotent upsert the immutable resources
584/// use — the [`SyncResponse::skipped`](crate::sync::SyncResponse) field
585/// was reserved for exactly this case — so no new HTTP plumbing is
586/// needed: `client.sync::<VoiceAccounts>(&items)` uploads (including
587/// tombstones), `client.list::<VoiceAccounts>(&query)` pulls.
588pub struct VoiceAccounts;
589
590impl SyncEndpoint for VoiceAccounts {
591 const RESOURCE: &'static str = "accounts";
592 type Record = VoiceAccountRecord;
593 type Query = VoiceAccountsQuery;
594}
595
596impl HasSyncEnvelope for VoiceAccountRecord {
597 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
598 &mut self.envelope
599 }
600}
601
602// ---- VoiceFlows (published pull) -------------------------------------------
603//
604// The daemon-facing pull leg of the call-flow ("Receptionist") system —
605// `wavekat-voice/docs/48-ivr-call-flows.md`'s control-plane split. Flows
606// are *authored* on the platform (drafts, publish gate, version
607// history); the daemon only ever reads the published snapshots, caches
608// them locally, and runs them offline. There is no upload direction, so
609// this is not a `SyncEndpoint` (that trait models the `{resource}/sync`
610// + list pair): it's a single typed GET, like the share commands above.
611
612/// One published call-flow snapshot as served by
613/// `GET /api/voice/flows/published`: the latest published version of a
614/// flow the bearer authored. The YAML carries the platform-stamped
615/// `id`/`name`/`version` and is served verbatim — the daemon re-parses
616/// and re-validates it on load rather than trusting the wire.
617#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
618#[serde(rename_all = "camelCase")]
619pub struct VoiceFlowRecord {
620 /// Platform-assigned flow id (`flow_…`), stable across versions.
621 pub id: String,
622 pub name: String,
623 /// Latest published version number (1-based, bumps on publish).
624 pub version: u32,
625 /// The immutable published document, verbatim.
626 pub yaml: String,
627 /// RFC 3339 time this version was published.
628 pub published_at: String,
629}
630
631/// Query params for `GET /api/voice/flows/published`. Cursor-paginated
632/// by flow id ascending; pass the previous page's `next_after` until it
633/// comes back `None` to collect the full set. The full set is what the
634/// daemon's reconcile wants — a cached flow absent from a complete pull
635/// was deleted on the platform.
636#[derive(Debug, Clone, Default, Serialize, Deserialize)]
637#[serde(rename_all = "camelCase")]
638pub struct VoiceFlowsQuery {
639 #[serde(default, skip_serializing_if = "Option::is_none")]
640 pub after: Option<String>,
641 /// Page size, server-capped at 100. `None` = server default (50).
642 #[serde(default, skip_serializing_if = "Option::is_none")]
643 pub limit: Option<u32>,
644 /// The document versions this caller's flow engine can run —
645 /// `wavekat_flow::SUPPORTED_SCHEMA_VERSIONS`, comma-separated
646 /// ascending ("1,2"). The platform withholds documents in any other
647 /// version rather than serving one the caller would fail to parse.
648 ///
649 /// **Send it.** `None` does not mean "anything goes": the platform
650 /// reads a missing value as version 1 only, because this parameter
651 /// arrived alongside version 2 and a caller that omits it is an
652 /// older build. A client that can run a newer version and stays
653 /// quiet silently loses those flows.
654 //
655 // Explicitly renamed: the struct is camelCase overall, but this
656 // route's query parameter is `schema_versions`, and a silently
657 // camelCased key would be ignored by the server — which reads
658 // exactly like a platform that has no such flows.
659 #[serde(
660 rename = "schema_versions",
661 default,
662 skip_serializing_if = "Option::is_none"
663 )]
664 pub schema_versions: Option<String>,
665}
666
667/// One page of published flow snapshots.
668#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
669#[serde(rename_all = "camelCase")]
670pub struct VoiceFlowsPage {
671 pub items: Vec<VoiceFlowRecord>,
672 /// Cursor for the next page; `None` = end of the set.
673 #[serde(default)]
674 pub next_after: Option<String>,
675}
676
677/// One frozen audio asset of a published flow version, as served by
678/// `GET /api/voice/flows/{id}/versions/{version}/assets` (wavekat-platform
679/// docs 16/17). The bytes were copied into a version-owned R2 object at
680/// publish time and never change, so `content_hash` identifies them
681/// exactly — the daemon diffs its local cache against it rather than
682/// trusting a bare filename, because the *same* `ref` can carry different
683/// bytes across two versions of the same flow.
684#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
685#[serde(rename_all = "camelCase")]
686pub struct VoiceFlowVersionAsset {
687 /// The `vprompt_…` reference exactly as it appears in the flow YAML.
688 #[serde(rename = "ref")]
689 pub asset_ref: String,
690 /// Source telephony format the clip was frozen as (`ulaw_8000`,
691 /// `pcm_16000`, `mp3`, …); the container is WAV unless `mp3`.
692 pub format: String,
693 /// Size of the frozen bytes.
694 pub byte_size: u64,
695 /// Clip duration if the platform knew it at freeze time.
696 #[serde(default)]
697 pub duration_ms: Option<u64>,
698 /// sha256 of the frozen bytes — the cache's content key.
699 pub content_hash: String,
700}
701
702/// The frozen-asset manifest for one published version. Not paginated:
703/// a flow's asset count is bounded by its node count (a phone tree is
704/// tens of clips), so the platform returns them all in one response.
705#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
706#[serde(rename_all = "camelCase")]
707pub struct VoiceFlowAssetsPage {
708 pub assets: Vec<VoiceFlowVersionAsset>,
709}
710
711impl Client {
712 /// `GET /api/voice/flows/published` — one page of the caller's
713 /// published flow snapshots (latest version each). Strictly
714 /// creator-scoped server-side; never returns another user's flows.
715 pub async fn published_flows(&self, query: &VoiceFlowsQuery) -> Result<VoiceFlowsPage> {
716 self.get_json_query::<VoiceFlowsPage, _>("/api/voice/flows/published", query)
717 .await
718 }
719
720 /// `GET /api/voice/flows/{id}/versions/{version}/assets` — the frozen
721 /// audio manifest for one published version (docs 16/17). Flow-scoped
722 /// server-side: a version of a flow the caller doesn't own is a 404,
723 /// never another user's assets. An existing, visible version with no
724 /// generated audio returns an empty manifest.
725 pub async fn flow_version_assets(
726 &self,
727 flow_id: &str,
728 version: u32,
729 ) -> Result<VoiceFlowAssetsPage> {
730 let path = format!("/api/voice/flows/{flow_id}/versions/{version}/assets");
731 self.get_json::<VoiceFlowAssetsPage>(&path).await
732 }
733
734 /// `GET /api/voice/flows/{id}/versions/{version}/assets/{ref}/bytes` —
735 /// the immutable frozen copy of one clip, served from the version's own
736 /// asset set (never the mutable library). Returned in memory because a
737 /// clip is tens of KB and the daemon writes it atomically into its
738 /// on-disk cache; same flow-scoped 404 as the manifest.
739 pub async fn flow_version_asset_bytes(
740 &self,
741 flow_id: &str,
742 version: u32,
743 asset_ref: &str,
744 ) -> Result<Vec<u8>> {
745 let path =
746 format!("/api/voice/flows/{flow_id}/versions/{version}/assets/{asset_ref}/bytes");
747 self.get_bytes(&path).await
748 }
749}
750
751// ---- Booking (mid-call, synchronous) ---------------------------------------
752//
753// The action plane of wavekat-platform's docs/30: a `book` step asking
754// "when is this business free?" and then "put the caller in at this
755// time", with the caller on the line.
756//
757// Unlike every other endpoint in this file, these are **synchronous and
758// in-call**. Nothing here is queued, batched or retried: a person is
759// waiting, so the platform answers within seconds or answers
760// `unavailable`, and the flow takes its fallback exit. Callers should
761// give these a short timeout of their own and treat expiry the same way
762// they treat `unavailable`.
763//
764// The calendar credential never reaches this crate. The platform holds
765// the connection and answers in times and outcomes — which is what makes
766// booking a pair of platform calls rather than a Google client in every
767// daemon.
768//
769// Wire note: these routes use `snake_case` bodies, unlike the camelCase
770// sync resources above, so these types carry no `rename_all`.
771
772/// One open window in a business's week, `"HH:MM"` 24-hour local time —
773/// the same shape the flow document's `hours`/`book` steps carry.
774#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
775pub struct BookingTimeRange {
776 pub open: String,
777 pub close: String,
778}
779
780/// Open windows per weekday. A missing or empty day is closed.
781#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
782pub struct BookingSchedule {
783 #[serde(default, skip_serializing_if = "Vec::is_empty")]
784 pub mon: Vec<BookingTimeRange>,
785 #[serde(default, skip_serializing_if = "Vec::is_empty")]
786 pub tue: Vec<BookingTimeRange>,
787 #[serde(default, skip_serializing_if = "Vec::is_empty")]
788 pub wed: Vec<BookingTimeRange>,
789 #[serde(default, skip_serializing_if = "Vec::is_empty")]
790 pub thu: Vec<BookingTimeRange>,
791 #[serde(default, skip_serializing_if = "Vec::is_empty")]
792 pub fri: Vec<BookingTimeRange>,
793 #[serde(default, skip_serializing_if = "Vec::is_empty")]
794 pub sat: Vec<BookingTimeRange>,
795 #[serde(default, skip_serializing_if = "Vec::is_empty")]
796 pub sun: Vec<BookingTimeRange>,
797}
798
799/// A single-date override of the weekly schedule (a holiday, or special
800/// hours).
801#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
802pub struct BookingException {
803 /// `"YYYY-MM-DD"` in the schedule's own timezone.
804 pub date: String,
805 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
806 pub closed: bool,
807 #[serde(default, skip_serializing_if = "Vec::is_empty")]
808 pub ranges: Vec<BookingTimeRange>,
809}
810
811/// Body of `POST /api/voice/booking/slots`.
812///
813/// Everything except `source_id` comes straight off the flow document's
814/// `book` step; the platform holds no per-node configuration of its own.
815#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
816pub struct BookingSlotsRequest {
817 /// The call this offer belongs to (`voice_calls.source_id`). Slots
818 /// are held against it, which is what stops a caller being blocked
819 /// by their own offers — and what stops a second caller being
820 /// offered the same time.
821 pub source_id: String,
822 pub duration_mins: u32,
823 #[serde(default)]
824 pub buffer_mins: u32,
825 #[serde(default)]
826 pub lead_mins: u32,
827 #[serde(default)]
828 pub horizon_days: u32,
829 pub schedule: BookingSchedule,
830 /// IANA zone the schedule is written in.
831 pub timezone: String,
832 #[serde(default, skip_serializing_if = "Vec::is_empty")]
833 pub exceptions: Vec<BookingException>,
834 /// How many times to offer. The answer may be shorter, never longer.
835 pub limit: u32,
836}
837
838/// One offerable appointment, as absolute RFC 3339 instants.
839#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
840pub struct BookingSlot {
841 pub start: String,
842 pub end: String,
843}
844
845/// Answer to `POST /api/voice/booking/slots`.
846///
847/// `slots` empty is a real answer — the calendar is full, or the window
848/// closed — and not an error: the flow takes its no-slots exit.
849#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
850pub struct BookingSlotsResponse {
851 #[serde(default)]
852 pub slots: Vec<BookingSlot>,
853 /// The zone the times should be *spoken* in — the business's, echoed
854 /// back so the caller isn't told a time in the server's zone.
855 #[serde(default)]
856 pub timezone: String,
857 /// Set when the platform could not read the calendar at all
858 /// (`"unavailable"`); `slots` is then empty and the reason is for
859 /// logs, never for a caller.
860 #[serde(default, skip_serializing_if = "Option::is_none")]
861 pub status: Option<String>,
862 #[serde(default, skip_serializing_if = "Option::is_none")]
863 pub reason: Option<String>,
864}
865
866/// Body of `POST /api/voice/booking/book`.
867///
868/// Idempotent on `source_id`: a retried request for a call that already
869/// has an appointment answers `booked` with the existing event's start,
870/// without touching the calendar. A timed-out request is therefore safe
871/// to repeat.
872#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
873pub struct BookingBookRequest {
874 pub source_id: String,
875 /// One of the `start`s `/slots` handed back, verbatim.
876 pub start: String,
877 pub duration_mins: u32,
878 pub timezone: String,
879 /// Who is booking, for the calendar entry. Empty when the call
880 /// carried no caller id.
881 #[serde(default)]
882 pub caller_number: String,
883 #[serde(default, skip_serializing_if = "Option::is_none")]
884 pub caller_name: Option<String>,
885}
886
887/// Answer to `POST /api/voice/booking/book`.
888///
889/// Three outcomes, and the flow does something different with each:
890/// `booked` continues, `slot_taken` can offer again, `unavailable` falls
891/// back. Left as a string rather than an enum so a status added later
892/// deserializes instead of failing the call.
893#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
894pub struct BookingBookResponse {
895 pub status: String,
896 /// Present on `booked` — the instant the appointment actually
897 /// starts, which on an idempotent retry is the *existing* event's
898 /// start and not necessarily the one that was asked for.
899 #[serde(default, skip_serializing_if = "Option::is_none")]
900 pub start: Option<String>,
901 #[serde(default, skip_serializing_if = "Option::is_none")]
902 pub reason: Option<String>,
903}
904
905impl Client {
906 /// `POST /api/voice/booking/slots` — when is this business free?
907 ///
908 /// Writes as well as reads: every time it returns is held for
909 /// `source_id` for a couple of minutes, so a second caller is not
910 /// offered it while this one is still deciding. Re-offering the same
911 /// call refreshes its own holds rather than colliding with them.
912 pub async fn booking_slots(
913 &self,
914 request: &BookingSlotsRequest,
915 ) -> Result<BookingSlotsResponse> {
916 self.post_json::<BookingSlotsResponse, _>("/api/voice/booking/slots", request)
917 .await
918 }
919
920 /// `POST /api/voice/booking/book` — put the caller in at this time.
921 pub async fn booking_book(&self, request: &BookingBookRequest) -> Result<BookingBookResponse> {
922 self.post_json::<BookingBookResponse, _>("/api/voice/booking/book", request)
923 .await
924 }
925}
926
927// ---- Anonymous install heartbeat ------------------------------------------
928//
929// A first-run / per-launch ping the desktop daemon fires *before* (and
930// independently of) any platform sign-in, so the platform can count
931// installs and track version / OS adoption for users who never sign in.
932// It hits the public, unauthenticated `POST /api/voice/installs/heartbeat`
933// and upserts a row keyed by `install_id` alone (no user) — distinct
934// from the authenticated `voice_clients` heartbeat, which is keyed by
935// `(user, install_id)`.
936//
937// The environment fields (os / os_version / arch / locale) are gathered
938// *here*, inside the client crate, rather than on the consumer side:
939// the daemon only owns the two values this crate genuinely cannot
940// discover — the persisted `install_id` and its own app version.
941
942/// Best-effort snapshot of the host environment, detected at call time.
943/// Every field is best-effort; a probe that fails contributes `None`
944/// (or, for the always-available `os` / `arch`, the compile-time
945/// target) rather than failing the heartbeat.
946#[derive(Debug, Clone, PartialEq, Eq)]
947pub struct SystemInfo {
948 /// `std::env::consts::OS` — `"macos"`, `"windows"`, `"linux"`, …
949 pub os: String,
950 /// Human OS version, e.g. `"15.5.0"`. `None` when the OS probe
951 /// can't determine it.
952 pub os_version: Option<String>,
953 /// `std::env::consts::ARCH` — `"aarch64"`, `"x86_64"`, …
954 pub arch: String,
955 /// BCP-47 system locale, e.g. `"en-NZ"`. `None` when unset /
956 /// undetectable (common for GUI-launched apps on some platforms).
957 pub locale: Option<String>,
958}
959
960impl SystemInfo {
961 /// Probe the current host. Cheap enough to call per heartbeat; we
962 /// don't cache so a locale change between launches is reflected.
963 pub fn detect() -> Self {
964 let os_version = match os_info::get().version() {
965 os_info::Version::Unknown => None,
966 v => Some(v.to_string()),
967 };
968 SystemInfo {
969 os: std::env::consts::OS.to_string(),
970 os_version,
971 arch: std::env::consts::ARCH.to_string(),
972 locale: sys_locale::get_locale(),
973 }
974 }
975}
976
977/// Body of `POST /api/voice/installs/heartbeat`. The daemon supplies
978/// `install_id` + `app_version`; [`Client::install_heartbeat`] fills the
979/// environment fields from [`SystemInfo::detect`].
980#[derive(Debug, Clone, Serialize, Deserialize)]
981#[serde(rename_all = "camelCase")]
982pub struct InstallHeartbeatRequest {
983 /// The daemon's persisted install UUID — the platform's upsert key.
984 pub install_id: String,
985 /// WaveKat Voice's own version (`env!("CARGO_PKG_VERSION")` on the
986 /// daemon side) — *not* this crate's version.
987 pub app_version: String,
988 pub os: String,
989 #[serde(default, skip_serializing_if = "Option::is_none")]
990 pub os_version: Option<String>,
991 #[serde(default, skip_serializing_if = "Option::is_none")]
992 pub arch: Option<String>,
993 #[serde(default, skip_serializing_if = "Option::is_none")]
994 pub locale: Option<String>,
995 /// How this copy was obtained — `"direct"` for a plain download,
996 /// `"mas"` for the sandboxed Mac App Store build. Unlike every other
997 /// field here it is **not** detectable: the two macOS builds share a
998 /// bundle id and a version, and the binary is identical, so only the
999 /// consumer knows which one it is shipping inside. Hence a caller
1000 /// argument rather than part of [`SystemInfo`].
1001 ///
1002 /// Free text by contract, not an enum: the platform stores whatever
1003 /// arrives so a new distribution can ship without a server release.
1004 /// `None` when the consumer has nothing meaningful to say (a source
1005 /// build, a package this crate has never heard of) — omitted from
1006 /// the body entirely rather than sent as null.
1007 #[serde(default, skip_serializing_if = "Option::is_none")]
1008 pub distribution: Option<String>,
1009}
1010
1011/// The platform's view of an install row, echoed back from a heartbeat.
1012#[derive(Debug, Clone, Serialize, Deserialize)]
1013#[serde(rename_all = "camelCase")]
1014pub struct InstallHeartbeatResponse {
1015 pub id: String,
1016 pub install_id: String,
1017 pub app_version: String,
1018 pub os: String,
1019 pub os_version: Option<String>,
1020 pub arch: Option<String>,
1021 pub locale: Option<String>,
1022 /// Echoed back. `#[serde(default)]` because a platform deployed
1023 /// before this field existed omits the key rather than sending null,
1024 /// and a heartbeat must not fail to parse against an older server.
1025 #[serde(default)]
1026 pub distribution: Option<String>,
1027 pub first_seen_at: String,
1028 pub last_seen_at: String,
1029}
1030
1031impl Client {
1032 /// `POST /api/voice/installs/heartbeat` — the anonymous, no-auth
1033 /// first-run install ping. Detects the host environment internally
1034 /// and posts it alongside the caller-supplied `install_id` +
1035 /// `app_version`. Associated (not a method) because the endpoint is
1036 /// unauthenticated — there's no token, and at first run there's no
1037 /// signed-in `Client` to hang it off of.
1038 ///
1039 /// Though unauthenticated, the request is **signed** with the release
1040 /// credential `cred` (a per-version Ed25519 key + master-issued
1041 /// certificate the consumer bakes in at build time) so the platform
1042 /// can verify it came from a genuine release and reject forged or
1043 /// replayed pings — see [`Client::post_public_signed_json`] and
1044 /// [`crate::sign`]. The platform needs only the master *public* key to
1045 /// verify.
1046 ///
1047 /// `base_url` is the platform base (e.g. `https://platform.wavekat.com`).
1048 ///
1049 /// `distribution` says how this copy was obtained (`"direct"`,
1050 /// `"mas"`, …). It is the one field this call can't detect for
1051 /// itself — see [`InstallHeartbeatRequest::distribution`] — so pass
1052 /// `None` if the consumer has nothing meaningful to say.
1053 pub async fn install_heartbeat(
1054 base_url: &str,
1055 install_id: &str,
1056 app_version: &str,
1057 distribution: Option<&str>,
1058 cred: &ReleaseCredential,
1059 ) -> Result<InstallHeartbeatResponse> {
1060 let sys = SystemInfo::detect();
1061 let body = InstallHeartbeatRequest {
1062 install_id: install_id.to_string(),
1063 app_version: app_version.to_string(),
1064 os: sys.os,
1065 os_version: sys.os_version,
1066 arch: Some(sys.arch),
1067 locale: sys.locale,
1068 distribution: distribution.map(str::to_string),
1069 };
1070 Client::post_public_signed_json::<InstallHeartbeatResponse, _>(
1071 base_url,
1072 "/api/voice/installs/heartbeat",
1073 &body,
1074 cred,
1075 )
1076 .await
1077 }
1078}
1079
1080// ---- Client surface for recordings ----------------------------------------
1081//
1082// Recordings don't fit the generic `Client::sync` shape cleanly:
1083//
1084// - the response carries per-item provenance (the platform-stamped
1085// `r2Key`, plus whether bytes have already landed) that the
1086// daemon needs in order to decide which rows still owe a PUT;
1087// - the bytes upload is its own HTTP call (`PUT
1088// /api/voice/recordings/{sourceId}/bytes`), not a JSON batch.
1089//
1090// Rather than overloading `SyncEndpoint` to carry these shapes, we
1091// expose two inherent methods on `Client` that compose the existing
1092// JSON / bytes-PUT primitives.
1093
1094impl Client {
1095 /// `POST /api/voice/recordings/sync` — idempotent batch upsert of
1096 /// recording metadata. Returns the per-item `r2Key` the daemon
1097 /// should target for the follow-up bytes PUT, and whether bytes
1098 /// have already landed for each row.
1099 ///
1100 /// Batch sizing rules match [`Client::sync`]: the platform rejects
1101 /// batches over 100 items; the daemon's uploader chunks at 50.
1102 pub async fn sync_recordings(
1103 &self,
1104 items: &[VoiceRecordingRecord],
1105 ) -> Result<VoiceRecordingsSyncResponse> {
1106 let stamped = stamp_schema_version::<VoiceRecordings>(items);
1107 let body = SyncRequest { items: stamped };
1108 self.post_json::<VoiceRecordingsSyncResponse, _>("/api/voice/recordings/sync", &body)
1109 .await
1110 }
1111
1112 /// `PUT /api/voice/recordings/{sourceId}/bytes` — upload the WAV
1113 /// bytes for a recording whose metadata was previously synced via
1114 /// [`Client::sync_recordings`]. The platform refuses (`HTTP 413`)
1115 /// if `bytes.len()` disagrees with the synced `sizeBytes`.
1116 ///
1117 /// `source_id` is path-segmented as-is; callers pass the
1118 /// daemon-side UUID they used for the metadata sync. Empty /
1119 /// path-traversal-shaped ids are not specifically guarded here —
1120 /// the platform's Zod schema rejects them server-side, so a
1121 /// malformed id surfaces as a 4xx via [`Error::Http`].
1122 pub async fn upload_recording_bytes(&self, source_id: &str, bytes: Vec<u8>) -> Result<()> {
1123 if source_id.is_empty() {
1124 return Err(Error::BadRequest("source_id must not be empty".into()));
1125 }
1126 let path = format!("/api/voice/recordings/{source_id}/bytes");
1127 self.put_raw_bytes(&path, "audio/wav", bytes).await
1128 }
1129}
1130
1131// ---- Recording sharing ----------------------------------------------------
1132//
1133// Sharing is a *command* — mutate one recording's share state and get a
1134// result back — not the "batch upsert + cursor list" shape `SyncEndpoint`
1135// exists for (see wavekat-voice doc 38). So it's a typed method pair on
1136// `Client` (mirroring `whoami` rather than `sync::<E>()`), not a marker.
1137//
1138// The desktop daemon keeps only a *mirror* of what these return; the
1139// platform is authoritative for who may open a share. See
1140// `wavekat-voice/docs/38-share-a-recording.md`.
1141
1142/// Access tier for a shared recording, mirroring Loom's model. Wire-stable
1143/// snake_case strings — the platform's Zod schema validates against this
1144/// exact list, so a rename here would bounce every share command with a 400.
1145///
1146/// - `Private` — owner only (the default; "not shared").
1147/// - `Restricted` — owner + explicitly invited WaveKat accounts; the
1148/// recipient must be signed in as an invited identity ("protected by login").
1149/// - `Public` — anyone holding the capability link, no sign-in.
1150#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1151#[serde(rename_all = "snake_case")]
1152pub enum ShareVisibility {
1153 Private,
1154 Restricted,
1155 Public,
1156}
1157
1158/// How a shared recording's caller/callee identity (the call's `party`) is
1159/// exposed to a viewer. Wire-stable snake_case, matching the platform's Zod
1160/// enum, so a rename here bounces a share command with a 400.
1161///
1162/// - `Full` — hidden behind a neutral direction label ("Inbound call").
1163/// - `Partial` — best-effort redaction (keeps shape, drops the value).
1164/// - `None` — the raw `party` is shown.
1165///
1166/// Absent on the wire → the platform defaults to `Partial` (identity
1167/// masked) — privacy-forward without fully erasing the caller. See
1168/// `wavekat-platform` docs/14.
1169#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1170#[serde(rename_all = "snake_case")]
1171pub enum PartyMasking {
1172 Full,
1173 Partial,
1174 None,
1175}
1176
1177/// Body of `POST /api/voice/recordings/{id}/share` — create or update a
1178/// recording's share. The recording must already be synced (metadata +
1179/// bytes) or the platform returns 404.
1180#[derive(Debug, Clone, Serialize, Deserialize)]
1181#[serde(rename_all = "camelCase")]
1182pub struct ShareRecordingRequest {
1183 /// The artifact UUID, as synced (daemon-side `artifacts.id`). Goes in
1184 /// the URL path; carried in the struct so callers pass one value.
1185 pub recording_source_id: String,
1186 pub visibility: ShareVisibility,
1187 /// Restricted tier — the WaveKat-account emails allowed to open the
1188 /// share. Ignored (and omitted) for `Private` / `Public`.
1189 #[serde(default, skip_serializing_if = "Option::is_none")]
1190 pub invited_emails: Option<Vec<String>>,
1191 /// Per-share visibility controls (platform docs/14) — what a viewer may
1192 /// see. Each is omitted when unset; the platform then applies its
1193 /// privacy-forward default (identity masked, transcript hidden, audio
1194 /// shown, download off). NB the platform treats the request as the
1195 /// *full* desired state, so an omitted control is reset to its default,
1196 /// not preserved from a prior share — send all of them when editing an
1197 /// existing share's controls.
1198 #[serde(default, skip_serializing_if = "Option::is_none")]
1199 pub party_masking: Option<PartyMasking>,
1200 #[serde(default, skip_serializing_if = "Option::is_none")]
1201 pub show_transcript: Option<bool>,
1202 #[serde(default, skip_serializing_if = "Option::is_none")]
1203 pub show_audio: Option<bool>,
1204 /// Whether a viewer may *download* the WAV, distinct from hearing it.
1205 /// Off by default and only meaningful while `show_audio` is true — the
1206 /// platform forces it off otherwise (you can't save what you can't
1207 /// hear). A soft control: it hides the viewer's Download affordance,
1208 /// not the bytes a listener already fetches to play.
1209 #[serde(default, skip_serializing_if = "Option::is_none")]
1210 pub allow_download: Option<bool>,
1211 /// Per-channel playback defaults — which side is *audible by default*
1212 /// in the viewer's player (docs/14). A call has two channels: `local`
1213 /// (the owner's microphone, "your side") and `remote` (the other
1214 /// party, "their side"). `true` means that side starts muted; the
1215 /// viewer can still un-mute it, and the audio file is unchanged — this
1216 /// is only the player's starting state. Each is omitted when unset, in
1217 /// which case the platform defaults to audible (`false`). Only
1218 /// meaningful while `show_audio` is true; ignored when audio is hidden.
1219 #[serde(default, skip_serializing_if = "Option::is_none")]
1220 pub default_mute_local: Option<bool>,
1221 #[serde(default, skip_serializing_if = "Option::is_none")]
1222 pub default_mute_remote: Option<bool>,
1223 /// Phase 2 — out-of-band password gate. Omitted when unset.
1224 #[serde(default, skip_serializing_if = "Option::is_none")]
1225 pub password: Option<String>,
1226 /// Phase 2 — RFC 3339 auto-revoke time. Omitted when unset.
1227 #[serde(default, skip_serializing_if = "Option::is_none")]
1228 pub expires_at: Option<String>,
1229}
1230
1231/// The platform's response to a successful share command. `share_url` is
1232/// the full https link the user copies; `token` is the opaque capability
1233/// identifier embedded in it (returned separately so the daemon can store
1234/// it for display without re-parsing the URL).
1235#[derive(Debug, Clone, Serialize, Deserialize)]
1236#[serde(rename_all = "camelCase")]
1237pub struct ShareRecordingResponse {
1238 pub visibility: ShareVisibility,
1239 pub token: String,
1240 pub share_url: String,
1241 /// RFC 3339 — when the recording was first shared.
1242 pub shared_at: String,
1243 /// Effective visibility controls the platform stored (docs/14). Optional
1244 /// for tolerance — a platform predating the feature omits them, in which
1245 /// case the daemon should assume the defaults (identity masked, transcript
1246 /// hidden, audio shown, download off).
1247 #[serde(default, skip_serializing_if = "Option::is_none")]
1248 pub party_masking: Option<PartyMasking>,
1249 #[serde(default, skip_serializing_if = "Option::is_none")]
1250 pub show_transcript: Option<bool>,
1251 #[serde(default, skip_serializing_if = "Option::is_none")]
1252 pub show_audio: Option<bool>,
1253 /// Effective download permission — `show_audio && allow_download`, so
1254 /// it's never true when the audio is hidden. Absent on a platform
1255 /// predating the control (assume off).
1256 #[serde(default, skip_serializing_if = "Option::is_none")]
1257 pub allow_download: Option<bool>,
1258 /// Effective per-channel playback defaults the platform stored — which
1259 /// side starts muted in the viewer's player (docs/14). Absent on a
1260 /// platform predating the control (assume audible, `false`).
1261 #[serde(default, skip_serializing_if = "Option::is_none")]
1262 pub default_mute_local: Option<bool>,
1263 #[serde(default, skip_serializing_if = "Option::is_none")]
1264 pub default_mute_remote: Option<bool>,
1265}
1266
1267/// The platform's response to `GET /api/voice/recordings/{id}/share` — the
1268/// *authoritative* current share state for an owned recording. The POST
1269/// reply omits the invited-email list and a local mirror can't reflect a
1270/// share changed from another device, so the desktop "who can open this"
1271/// panel reads here.
1272///
1273/// A recording that was never shared (or whose share is revoked / expired)
1274/// comes back as [`ShareVisibility::Private`] with the optional fields
1275/// absent — the same "not shared" state DELETE leaves behind.
1276#[derive(Debug, Clone, Serialize, Deserialize)]
1277#[serde(rename_all = "camelCase")]
1278pub struct ShareStateResponse {
1279 pub visibility: ShareVisibility,
1280 /// Absent when `visibility == Private` (nothing is shared).
1281 #[serde(default, skip_serializing_if = "Option::is_none")]
1282 pub token: Option<String>,
1283 #[serde(default, skip_serializing_if = "Option::is_none")]
1284 pub share_url: Option<String>,
1285 /// RFC 3339 — when the recording was first shared. Absent when private.
1286 #[serde(default, skip_serializing_if = "Option::is_none")]
1287 pub shared_at: Option<String>,
1288 /// The restricted tier's audience (lowercased, de-duped). Present
1289 /// (possibly empty) only for [`ShareVisibility::Restricted`].
1290 #[serde(default, skip_serializing_if = "Option::is_none")]
1291 pub invited_emails: Option<Vec<String>>,
1292 /// Per-share visibility controls (docs/14). Present for a live share;
1293 /// absent when `Private` (nothing is shared, so no controls apply).
1294 #[serde(default, skip_serializing_if = "Option::is_none")]
1295 pub party_masking: Option<PartyMasking>,
1296 #[serde(default, skip_serializing_if = "Option::is_none")]
1297 pub show_transcript: Option<bool>,
1298 #[serde(default, skip_serializing_if = "Option::is_none")]
1299 pub show_audio: Option<bool>,
1300 /// Effective download permission — `show_audio && allow_download`, so
1301 /// never true when the audio is hidden. Absent when private.
1302 #[serde(default, skip_serializing_if = "Option::is_none")]
1303 pub allow_download: Option<bool>,
1304 /// Effective per-channel playback defaults — which side starts muted in
1305 /// the viewer's player (docs/14). Absent when private.
1306 #[serde(default, skip_serializing_if = "Option::is_none")]
1307 pub default_mute_local: Option<bool>,
1308 #[serde(default, skip_serializing_if = "Option::is_none")]
1309 pub default_mute_remote: Option<bool>,
1310}
1311
1312impl Client {
1313 /// `POST /api/voice/recordings/{id}/share` — create or update a share
1314 /// for an already-synced recording. Returns the capability link + token
1315 /// the desktop UI puts on the clipboard.
1316 ///
1317 /// Per the 404-not-403 ownership rule (doc 21 §"Authorization"), asking
1318 /// to share a recording the caller doesn't own surfaces as
1319 /// [`Error::Http`] with status 404 — existence doesn't leak.
1320 pub async fn share_recording(
1321 &self,
1322 req: &ShareRecordingRequest,
1323 ) -> Result<ShareRecordingResponse> {
1324 if req.recording_source_id.is_empty() {
1325 return Err(Error::BadRequest(
1326 "recording_source_id must not be empty".into(),
1327 ));
1328 }
1329 let path = format!("/api/voice/recordings/{}/share", req.recording_source_id);
1330 self.post_json::<ShareRecordingResponse, _>(&path, req)
1331 .await
1332 }
1333
1334 /// `GET /api/voice/recordings/{id}/share` — read the authoritative
1335 /// share state for an owned recording, including the restricted tier's
1336 /// invited emails (which the share command's reply omits). Like
1337 /// [`share_recording`](Self::share_recording), a recording the caller
1338 /// doesn't own surfaces as [`Error::Http`] with status 404.
1339 pub async fn get_recording_share(
1340 &self,
1341 recording_source_id: &str,
1342 ) -> Result<ShareStateResponse> {
1343 if recording_source_id.is_empty() {
1344 return Err(Error::BadRequest(
1345 "recording_source_id must not be empty".into(),
1346 ));
1347 }
1348 let path = format!("/api/voice/recordings/{recording_source_id}/share");
1349 self.get_json::<ShareStateResponse>(&path).await
1350 }
1351
1352 /// `DELETE /api/voice/recordings/{id}/share` — revoke the share. The
1353 /// recording reverts to Private and any outstanding link returns 410.
1354 pub async fn revoke_recording_share(&self, recording_source_id: &str) -> Result<()> {
1355 if recording_source_id.is_empty() {
1356 return Err(Error::BadRequest(
1357 "recording_source_id must not be empty".into(),
1358 ));
1359 }
1360 let path = format!("/api/voice/recordings/{recording_source_id}/share");
1361 self.delete(&path).await
1362 }
1363}
1364
1365#[cfg(test)]
1366mod tests {
1367 use super::*;
1368
1369 #[test]
1370 fn share_visibility_types_are_reachable_from_the_crate_root() {
1371 // Regression for the 0.0.13 gap: `PartyMasking` was added to this
1372 // module but left out of the crate-root `pub use voice::{…}`, and the
1373 // module is private — so a consumer (`wavekat-voice`) couldn't name
1374 // the type to build a `ShareRecordingRequest`. Pin every share-control
1375 // type to the root path so dropping one fails to compile here, not in
1376 // a downstream crate. The body never runs; reachability is the test.
1377 #[allow(dead_code)]
1378 fn _reachable() {
1379 let _: Option<crate::PartyMasking> = Some(crate::PartyMasking::Partial);
1380 let _: Option<crate::ShareVisibility> = Some(crate::ShareVisibility::Public);
1381 let _: fn(&crate::ShareRecordingRequest) = |_| {};
1382 let _: fn(&crate::ShareRecordingResponse) = |_| {};
1383 }
1384 }
1385
1386 #[test]
1387 fn record_serializes_with_camel_case_keys() {
1388 let r = VoiceCallRecord {
1389 source_id: "11111111-1111-4111-8111-111111111111".into(),
1390 account_id: "22222222-2222-4222-8222-222222222222".into(),
1391 direction: VoiceCallDirection::Inbound,
1392 party: "+14155550123".into(),
1393 ring_at: "2026-05-16T10:00:00Z".into(),
1394 answer_at: Some("2026-05-16T10:00:05Z".into()),
1395 end_at: "2026-05-16T10:01:00Z".into(),
1396 duration_ms: Some(55_000),
1397 disposition: VoiceCallDisposition::Answered,
1398 end_reason: VoiceCallEndReason::HangupRemote,
1399 error: None,
1400 share_visibility: None,
1401 transfer_target: None,
1402 codec: None,
1403 flow_id: None,
1404 flow_name: None,
1405 flow_outcome: None,
1406 flow_steps: None,
1407 deleted_at: None,
1408 envelope: SyncEnvelope::for_endpoint::<VoiceCalls>(),
1409 };
1410 let s = serde_json::to_string(&r).unwrap();
1411 assert!(s.contains("\"sourceId\":"), "{s}");
1412 assert!(s.contains("\"accountId\":"), "{s}");
1413 assert!(s.contains("\"ringAt\":"), "{s}");
1414 assert!(s.contains("\"endAt\":"), "{s}");
1415 assert!(s.contains("\"durationMs\":55000"), "{s}");
1416 // Optional `error` is None — should be omitted from the wire.
1417 assert!(!s.contains("\"error\""), "error should be omitted: {s}");
1418 // Optional `transferTarget` is None here — omitted from the wire,
1419 // exactly like a non-transferred call ships.
1420 assert!(
1421 !s.contains("\"transferTarget\""),
1422 "transferTarget should be omitted: {s}"
1423 );
1424 // Optional `codec` is None (never-answered call, or an older
1425 // daemon) — omitted from the wire, never `null`.
1426 assert!(!s.contains("\"codec\""), "codec should be omitted: {s}");
1427 // Envelope flattens to the top of the object — schemaVersion
1428 // sits next to the other fields rather than nested under
1429 // "envelope". Future resources rely on this layout.
1430 assert!(
1431 s.contains("\"schemaVersion\":1"),
1432 "schemaVersion should flatten: {s}"
1433 );
1434 // `extras` is None, so the envelope contributes no `extras`
1435 // key. Stays out of the row to keep the small/fast path.
1436 assert!(!s.contains("\"extras\""), "extras should be omitted: {s}");
1437 // A live call omits the tombstone entirely rather than sending
1438 // `null` — every ordinary sync is a live call, so this is the
1439 // common path and it should stay off the wire.
1440 assert!(
1441 !s.contains("\"deletedAt\""),
1442 "deletedAt should be omitted on a live call: {s}"
1443 );
1444 }
1445
1446 #[test]
1447 fn call_tombstone_serializes_deleted_at() {
1448 // The delete-propagation mechanism: a deleted call rides up as
1449 // an ordinary upsert with `deletedAt` set (platform docs/22),
1450 // the same shape the account tombstone uses.
1451 let mut r = VoiceCallRecord {
1452 source_id: "11111111-1111-4111-8111-111111111111".into(),
1453 account_id: "22222222-2222-4222-8222-222222222222".into(),
1454 direction: VoiceCallDirection::Inbound,
1455 party: "+14155550123".into(),
1456 ring_at: "2026-05-16T10:00:00Z".into(),
1457 answer_at: None,
1458 end_at: "2026-05-16T10:01:00Z".into(),
1459 duration_ms: None,
1460 disposition: VoiceCallDisposition::Missed,
1461 end_reason: VoiceCallEndReason::HangupRemote,
1462 error: None,
1463 share_visibility: None,
1464 transfer_target: None,
1465 codec: None,
1466 flow_id: None,
1467 flow_name: None,
1468 flow_outcome: None,
1469 flow_steps: None,
1470 deleted_at: None,
1471 envelope: SyncEnvelope::for_endpoint::<VoiceCalls>(),
1472 };
1473 r.deleted_at = Some("2026-07-30T12:00:00Z".into());
1474 let s = serde_json::to_string(&r).unwrap();
1475 assert!(s.contains("\"deletedAt\":\"2026-07-30T12:00:00Z\""), "{s}");
1476 }
1477
1478 #[test]
1479 fn call_record_parses_without_deleted_at() {
1480 // Reading back a live call from `GET /api/voice/calls`: the
1481 // platform sends `deletedAt: null`, and a platform build
1482 // predating the field sends nothing at all. Both must land as
1483 // `None` rather than failing the whole page.
1484 let raw = r#"{
1485 "sourceId": "a",
1486 "accountId": "b",
1487 "direction": "outbound",
1488 "party": "+14155550123",
1489 "ringAt": "2026-05-16T10:00:00Z",
1490 "endAt": "2026-05-16T10:01:00Z",
1491 "disposition": "answered",
1492 "endReason": "hangup_local"
1493 }"#;
1494 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1495 assert!(parsed.deleted_at.is_none());
1496
1497 let with_null: VoiceCallRecord =
1498 serde_json::from_str(&raw.replace('}', r#", "deletedAt": null }"#)).unwrap();
1499 assert!(with_null.deleted_at.is_none());
1500 }
1501
1502 #[test]
1503 fn calls_query_serializes_include_deleted() {
1504 // The delta-pull flag a device sets to learn about deletes made
1505 // elsewhere. Omitted when unset, so an ordinary list request is
1506 // unchanged.
1507 let live = VoiceCallsQuery::default();
1508 assert_eq!(serde_json::to_string(&live).unwrap(), "{}");
1509
1510 let delta = VoiceCallsQuery {
1511 include_deleted: Some(true),
1512 ..Default::default()
1513 };
1514 let s = serde_json::to_string(&delta).unwrap();
1515 assert!(s.contains("\"includeDeleted\":true"), "{s}");
1516 }
1517
1518 #[test]
1519 fn record_round_trips_optional_fields() {
1520 // An unanswered call has answer_at/duration_ms/error all absent.
1521 let raw = r#"{
1522 "sourceId": "a",
1523 "accountId": "b",
1524 "direction": "inbound",
1525 "party": "anonymous",
1526 "ringAt": "2026-05-16T10:00:00Z",
1527 "endAt": "2026-05-16T10:00:30Z",
1528 "disposition": "missed",
1529 "endReason": "missed"
1530 }"#;
1531 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1532 assert!(parsed.answer_at.is_none());
1533 assert!(parsed.duration_ms.is_none());
1534 assert!(parsed.error.is_none());
1535 assert_eq!(parsed.disposition, VoiceCallDisposition::Missed);
1536 assert_eq!(parsed.end_reason, VoiceCallEndReason::Missed);
1537 }
1538
1539 #[test]
1540 fn query_omits_unset_fields() {
1541 let q = VoiceCallsQuery::default();
1542 let s = serde_json::to_string(&q).unwrap();
1543 // Empty object — every field skipped when None.
1544 assert_eq!(
1545 s, "{}",
1546 "default query should serialize to empty object: {s}"
1547 );
1548 }
1549
1550 #[test]
1551 fn enum_round_trip_via_json() {
1552 // The wire form for each direction/disposition/reason must
1553 // match what the daemon and platform expect — this guards
1554 // against accidental Rust-side renames.
1555 for d in [VoiceCallDirection::Inbound, VoiceCallDirection::Outbound] {
1556 let s = serde_json::to_string(&d).unwrap();
1557 let back: VoiceCallDirection = serde_json::from_str(&s).unwrap();
1558 assert_eq!(d, back);
1559 }
1560 for d in [
1561 VoiceCallDisposition::Answered,
1562 VoiceCallDisposition::Missed,
1563 VoiceCallDisposition::Rejected,
1564 VoiceCallDisposition::Cancelled,
1565 VoiceCallDisposition::Failed,
1566 ] {
1567 let s = serde_json::to_string(&d).unwrap();
1568 let back: VoiceCallDisposition = serde_json::from_str(&s).unwrap();
1569 assert_eq!(d, back);
1570 }
1571 for r in [
1572 VoiceCallEndReason::HangupLocal,
1573 VoiceCallEndReason::HangupRemote,
1574 VoiceCallEndReason::RejectedLocal,
1575 VoiceCallEndReason::RejectedRemote,
1576 VoiceCallEndReason::Missed,
1577 VoiceCallEndReason::CancelledLocal,
1578 VoiceCallEndReason::TransferredLocal,
1579 VoiceCallEndReason::ConnectionLost,
1580 VoiceCallEndReason::Failed,
1581 ] {
1582 let s = serde_json::to_string(&r).unwrap();
1583 let back: VoiceCallEndReason = serde_json::from_str(&s).unwrap();
1584 assert_eq!(r, back);
1585 }
1586 }
1587
1588 #[test]
1589 fn connection_lost_pins_its_wire_string() {
1590 // The platform's sync endpoint validates end reasons against
1591 // an exact string list — a rename here would make every
1592 // upload from a session-timer teardown bounce with a 400.
1593 let s = serde_json::to_string(&VoiceCallEndReason::ConnectionLost).unwrap();
1594 assert_eq!(s, "\"connection_lost\"");
1595 }
1596
1597 #[test]
1598 fn transferred_local_pins_its_wire_string() {
1599 // Same contract as `connection_lost`: the platform validates
1600 // against an exact string list, so a rename here would bounce
1601 // every transferred-call upload with a 400.
1602 let s = serde_json::to_string(&VoiceCallEndReason::TransferredLocal).unwrap();
1603 assert_eq!(s, "\"transferred_local\"");
1604 }
1605
1606 #[test]
1607 fn record_round_trips_transfer_target() {
1608 // A transferred call carries `transferTarget` both ways — the
1609 // daemon ships it (it's its own data, not read-only decoration),
1610 // and the platform echoes it back on read.
1611 let raw = r#"{
1612 "sourceId": "a",
1613 "accountId": "b",
1614 "direction": "inbound",
1615 "party": "Alice <sip:alice@example.com>",
1616 "ringAt": "2026-06-28T10:00:00Z",
1617 "answerAt": "2026-06-28T10:00:05Z",
1618 "endAt": "2026-06-28T10:00:30Z",
1619 "durationMs": 25000,
1620 "disposition": "answered",
1621 "endReason": "transferred_local",
1622 "transferTarget": "1002"
1623 }"#;
1624 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1625 assert_eq!(parsed.end_reason, VoiceCallEndReason::TransferredLocal);
1626 assert_eq!(parsed.transfer_target.as_deref(), Some("1002"));
1627 // And it survives a re-serialize (daemon → platform direction).
1628 let s = serde_json::to_string(&parsed).unwrap();
1629 assert!(s.contains("\"transferTarget\":\"1002\""), "{s}");
1630 }
1631
1632 #[test]
1633 fn codec_pins_its_wire_strings() {
1634 // The platform's sync endpoint validates the codec against an
1635 // exact string list, and the daemon's `CallCodec::as_str` emits
1636 // these same strings — a rename here would bounce every upload
1637 // from an answered call with a 400.
1638 for (codec, wire) in [
1639 (VoiceCallCodec::Opus, "\"opus\""),
1640 (VoiceCallCodec::Pcmu, "\"pcmu\""),
1641 (VoiceCallCodec::Pcma, "\"pcma\""),
1642 ] {
1643 assert_eq!(serde_json::to_string(&codec).unwrap(), wire);
1644 let back: VoiceCallCodec = serde_json::from_str(wire).unwrap();
1645 assert_eq!(back, codec);
1646 }
1647 }
1648
1649 #[test]
1650 fn record_round_trips_codec() {
1651 // An answered call carries `codec` both ways — the daemon ships
1652 // it (its own data, like transferTarget), and the platform
1653 // echoes it back on read so the website can show the call's
1654 // audio quality.
1655 let raw = r#"{
1656 "sourceId": "a",
1657 "accountId": "b",
1658 "direction": "inbound",
1659 "party": "Alice <sip:alice@example.com>",
1660 "ringAt": "2026-07-03T10:00:00Z",
1661 "answerAt": "2026-07-03T10:00:05Z",
1662 "endAt": "2026-07-03T10:00:30Z",
1663 "durationMs": 25000,
1664 "disposition": "answered",
1665 "endReason": "hangup_remote",
1666 "codec": "opus"
1667 }"#;
1668 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1669 assert_eq!(parsed.codec, Some(VoiceCallCodec::Opus));
1670 // And it survives a re-serialize (daemon → platform direction).
1671 let s = serde_json::to_string(&parsed).unwrap();
1672 assert!(s.contains("\"codec\":\"opus\""), "{s}");
1673
1674 // A row from an older daemon has no codec — reads as None.
1675 let legacy = raw.replace(",\n \"codec\": \"opus\"", "");
1676 let parsed: VoiceCallRecord = serde_json::from_str(&legacy).unwrap();
1677 assert_eq!(parsed.codec, None);
1678 }
1679
1680 #[test]
1681 fn flow_outcome_pins_its_wire_strings() {
1682 // Three parties agree on these exact strings: the daemon's
1683 // `flow_outcome_to_str`, `wavekat_flow::trace::FlowOutcome`'s
1684 // snake_case serde, and the platform's zod enum. A rename here
1685 // 400s every flow-answered call's batch.
1686 for (outcome, wire) in [
1687 (VoiceCallFlowOutcome::Answered, "\"answered\""),
1688 (VoiceCallFlowOutcome::MessageLeft, "\"message_left\""),
1689 (VoiceCallFlowOutcome::Transferred, "\"transferred\""),
1690 (VoiceCallFlowOutcome::HungUp, "\"hung_up\""),
1691 (VoiceCallFlowOutcome::Aborted, "\"aborted\""),
1692 (VoiceCallFlowOutcome::Defect, "\"defect\""),
1693 ] {
1694 assert_eq!(serde_json::to_string(&outcome).unwrap(), wire);
1695 let back: VoiceCallFlowOutcome = serde_json::from_str(wire).unwrap();
1696 assert_eq!(back, outcome);
1697 }
1698 }
1699
1700 #[test]
1701 fn record_round_trips_flow_attribution() {
1702 // A flow-answered call carries which flow took it and how the
1703 // run ended, both ways: the daemon ships them, the platform
1704 // echoes them so the website can say "Answered by “X”" and show
1705 // the run's own outcome instead of the misleading SIP one.
1706 let raw = r#"{
1707 "sourceId": "a",
1708 "accountId": "b",
1709 "direction": "inbound",
1710 "party": "Alice <sip:alice@example.com>",
1711 "ringAt": "2026-07-03T10:00:00Z",
1712 "answerAt": "2026-07-03T10:00:05Z",
1713 "endAt": "2026-07-03T10:00:30Z",
1714 "durationMs": 25000,
1715 "disposition": "answered",
1716 "endReason": "hangup_local",
1717 "flowId": "flow_after_hours",
1718 "flowName": "After hours",
1719 "flowOutcome": "message_left"
1720 }"#;
1721 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1722 assert_eq!(parsed.flow_id.as_deref(), Some("flow_after_hours"));
1723 assert_eq!(parsed.flow_name.as_deref(), Some("After hours"));
1724 assert_eq!(parsed.flow_outcome, Some(VoiceCallFlowOutcome::MessageLeft));
1725
1726 let s = serde_json::to_string(&parsed).unwrap();
1727 assert!(s.contains("\"flowId\":\"flow_after_hours\""), "{s}");
1728 assert!(s.contains("\"flowName\":\"After hours\""), "{s}");
1729 assert!(s.contains("\"flowOutcome\":\"message_left\""), "{s}");
1730 }
1731
1732 #[test]
1733 fn record_round_trips_a_flow_step_trace() {
1734 // Pins the per-step field names. These are consumed by the
1735 // platform's Zod schema on one side and produced by the daemon's
1736 // projection on the other; a silent rename here breaks both.
1737 let raw = r#"{
1738 "sourceId": "a",
1739 "accountId": "b",
1740 "direction": "inbound",
1741 "party": "sip:alice@example.com",
1742 "ringAt": "2026-07-03T10:00:00Z",
1743 "answerAt": "2026-07-03T10:00:05Z",
1744 "endAt": "2026-07-03T10:00:30Z",
1745 "disposition": "answered",
1746 "endReason": "hangup_local",
1747 "flowId": "f",
1748 "flowName": "F",
1749 "flowSteps": [
1750 { "atMs": 0, "kind": "spoke", "node": "greeting" },
1751 { "atMs": 4200, "kind": "menu_choice", "digit": "2" },
1752 { "atMs": 9100, "kind": "message_recorded", "secs": 31 }
1753 ]
1754 }"#;
1755 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1756 let steps = parsed.flow_steps.as_deref().expect("steps present");
1757 assert_eq!(steps.len(), 3);
1758 assert_eq!(steps[1].kind, "menu_choice");
1759 assert_eq!(steps[1].digit.as_deref(), Some("2"));
1760 assert_eq!(steps[2].secs, Some(31));
1761 // Absent per-step fields stay absent rather than serializing as
1762 // nulls — same contract as the record's own optional fields.
1763 let s = serde_json::to_string(&steps[0]).unwrap();
1764 assert_eq!(s, r#"{"atMs":0,"kind":"spoke","node":"greeting"}"#);
1765 }
1766
1767 #[test]
1768 fn flow_step_accepts_a_kind_this_build_does_not_know() {
1769 // The whole reason `kind` is a String. A consumer pinned to an
1770 // older crate version must still deserialize a newer daemon's
1771 // trace — rejecting would fail the entire call record, not one
1772 // step.
1773 let step: VoiceCallFlowStep =
1774 serde_json::from_str(r#"{"atMs": 10, "kind": "consulted_the_oracle"}"#).unwrap();
1775 assert_eq!(step.kind, "consulted_the_oracle");
1776 assert_eq!(step.digit, None);
1777 }
1778
1779 #[test]
1780 fn record_omits_flow_steps_for_a_human_answered_call() {
1781 // A call the user took themselves has no trace. The field must
1782 // stay off the wire entirely rather than serializing as null.
1783 let raw = r#"{
1784 "sourceId": "a",
1785 "accountId": "b",
1786 "direction": "inbound",
1787 "party": "sip:alice@example.com",
1788 "ringAt": "2026-07-03T10:00:00Z",
1789 "endAt": "2026-07-03T10:00:30Z",
1790 "disposition": "answered",
1791 "endReason": "hangup_local"
1792 }"#;
1793 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1794 assert!(parsed.flow_steps.is_none());
1795 let s = serde_json::to_string(&parsed).unwrap();
1796 assert!(!s.contains("flowSteps"), "{s}");
1797 }
1798
1799 #[test]
1800 fn record_omits_flow_fields_for_a_human_answered_call() {
1801 // Calls the user took themselves — and every row from a daemon
1802 // predating call flows — carry none of the three. They must
1803 // stay off the wire entirely, not serialize as nulls.
1804 let raw = r#"{
1805 "sourceId": "a",
1806 "accountId": "b",
1807 "direction": "inbound",
1808 "party": "sip:alice@example.com",
1809 "ringAt": "2026-07-03T10:00:00Z",
1810 "endAt": "2026-07-03T10:00:30Z",
1811 "disposition": "answered",
1812 "endReason": "hangup_remote"
1813 }"#;
1814 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1815 assert_eq!(parsed.flow_id, None);
1816 assert_eq!(parsed.flow_name, None);
1817 assert_eq!(parsed.flow_outcome, None);
1818
1819 let s = serde_json::to_string(&parsed).unwrap();
1820 assert!(!s.contains("\"flowId\""), "flowId should be omitted: {s}");
1821 assert!(
1822 !s.contains("\"flowName\""),
1823 "flowName should be omitted: {s}"
1824 );
1825 assert!(
1826 !s.contains("\"flowOutcome\""),
1827 "flowOutcome should be omitted: {s}"
1828 );
1829 }
1830
1831 #[test]
1832 fn voice_calls_marker_resource_is_calls() {
1833 assert_eq!(<VoiceCalls as SyncEndpoint>::RESOURCE, "calls");
1834 }
1835
1836 #[test]
1837 fn record_accepts_unknown_extras_for_forward_compat() {
1838 // A newer client shipping a `notes` field that this platform
1839 // version doesn't have a column for should round-trip via
1840 // the `extras` envelope. The platform persists the blob
1841 // verbatim; a future deploy can promote it to a typed
1842 // column without data loss.
1843 let raw = r#"{
1844 "sourceId": "a",
1845 "accountId": "b",
1846 "direction": "inbound",
1847 "party": "anon",
1848 "ringAt": "2026-05-16T10:00:00Z",
1849 "endAt": "2026-05-16T10:00:30Z",
1850 "disposition": "answered",
1851 "endReason": "hangup_remote",
1852 "schemaVersion": 2,
1853 "extras": { "notes": "from staging build" }
1854 }"#;
1855 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1856 assert_eq!(parsed.envelope.schema_version, Some(2));
1857 let extras = parsed.envelope.extras.as_ref().expect("extras present");
1858 assert_eq!(extras["notes"], "from staging build");
1859 }
1860
1861 #[test]
1862 fn call_record_parses_share_visibility_from_list_response() {
1863 // The list / detail endpoints decorate a call with the tier of any
1864 // active share on its recording, so a consumer can badge the row.
1865 let raw = r#"{
1866 "sourceId": "a",
1867 "accountId": "b",
1868 "direction": "outbound",
1869 "party": "+14155550123",
1870 "ringAt": "2026-05-16T10:00:00Z",
1871 "endAt": "2026-05-16T10:00:30Z",
1872 "disposition": "answered",
1873 "endReason": "hangup_remote",
1874 "shareVisibility": "public"
1875 }"#;
1876 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1877 assert_eq!(parsed.share_visibility, Some(ShareVisibility::Public));
1878
1879 let restricted = raw.replace("public", "restricted");
1880 let parsed: VoiceCallRecord = serde_json::from_str(&restricted).unwrap();
1881 assert_eq!(parsed.share_visibility, Some(ShareVisibility::Restricted));
1882 }
1883
1884 #[test]
1885 fn call_record_unshared_has_no_share_visibility() {
1886 // Absent (older platform, or an unshared call) and an explicit
1887 // `null` both read as "not shared" — never `Some(Private)`.
1888 let base = r#"{
1889 "sourceId": "a",
1890 "accountId": "b",
1891 "direction": "inbound",
1892 "party": "anon",
1893 "ringAt": "2026-05-16T10:00:00Z",
1894 "endAt": "2026-05-16T10:00:30Z",
1895 "disposition": "missed",
1896 "endReason": "missed"
1897 }"#;
1898 let parsed: VoiceCallRecord = serde_json::from_str(base).unwrap();
1899 assert_eq!(parsed.share_visibility, None);
1900
1901 let with_null = base.replace(
1902 r#""endReason": "missed""#,
1903 r#""endReason": "missed", "shareVisibility": null"#,
1904 );
1905 let parsed: VoiceCallRecord = serde_json::from_str(&with_null).unwrap();
1906 assert_eq!(parsed.share_visibility, None);
1907 }
1908
1909 #[test]
1910 fn synced_call_omits_share_visibility() {
1911 // `share_visibility` is read-only decoration: a call uploaded via
1912 // sync must not carry it on the wire (skip_serializing_if = None),
1913 // so the round trip from a sync-shaped record stays clean.
1914 let raw = r#"{
1915 "sourceId": "a",
1916 "accountId": "b",
1917 "direction": "inbound",
1918 "party": "anon",
1919 "ringAt": "2026-05-16T10:00:00Z",
1920 "endAt": "2026-05-16T10:00:30Z",
1921 "disposition": "answered",
1922 "endReason": "hangup_remote"
1923 }"#;
1924 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1925 assert_eq!(parsed.share_visibility, None);
1926 let s = serde_json::to_string(&parsed).unwrap();
1927 assert!(
1928 !s.contains("shareVisibility"),
1929 "sync payload leaked share_visibility: {s}"
1930 );
1931 }
1932
1933 #[test]
1934 fn recording_marker_resource_is_recordings() {
1935 // Path constant drives the URL in `Client::sync_recordings`;
1936 // a rename here would silently 404 against the platform.
1937 assert_eq!(<VoiceRecordings as SyncEndpoint>::RESOURCE, "recordings");
1938 }
1939
1940 #[test]
1941 fn recording_record_serializes_with_camel_case_and_envelope() {
1942 let r = VoiceRecordingRecord {
1943 source_id: "11111111-1111-4111-8111-111111111111".into(),
1944 call_source_id: "22222222-2222-4222-8222-222222222222".into(),
1945 size_bytes: 44 + 64_000,
1946 duration_ms: 2_000,
1947 sample_rate: 8_000,
1948 channels: 2,
1949 created_at: "2026-05-16T10:01:05Z".into(),
1950 envelope: SyncEnvelope::for_endpoint::<VoiceRecordings>(),
1951 };
1952 let s = serde_json::to_string(&r).unwrap();
1953 // Field-by-field wire contract — these strings are also what
1954 // the platform's Zod schema expects.
1955 assert!(s.contains("\"sourceId\":"), "{s}");
1956 assert!(s.contains("\"callSourceId\":"), "{s}");
1957 assert!(s.contains("\"sizeBytes\":64044"), "{s}");
1958 assert!(s.contains("\"durationMs\":2000"), "{s}");
1959 assert!(s.contains("\"sampleRate\":8000"), "{s}");
1960 assert!(s.contains("\"channels\":2"), "{s}");
1961 assert!(s.contains("\"createdAt\":"), "{s}");
1962 // Envelope flattens to the top of the object, same as VoiceCallRecord.
1963 assert!(s.contains("\"schemaVersion\":1"), "{s}");
1964 }
1965
1966 #[test]
1967 fn recordings_sync_response_round_trips() {
1968 // The richer-than-generic response carries per-item provenance —
1969 // the daemon's uploader reads `r2Key` for the bytes follow-up
1970 // and `bytesUploaded` to short-circuit when the row already
1971 // landed on a previous cycle.
1972 let raw = r#"{
1973 "accepted": 2,
1974 "skipped": 0,
1975 "items": [
1976 {"sourceId": "a", "r2Key": "voice/recordings/1/a.wav", "bytesUploaded": false},
1977 {"sourceId": "b", "r2Key": "voice/recordings/1/b.wav", "bytesUploaded": true}
1978 ]
1979 }"#;
1980 let parsed: VoiceRecordingsSyncResponse = serde_json::from_str(raw).unwrap();
1981 assert_eq!(parsed.accepted, 2);
1982 assert_eq!(parsed.items.len(), 2);
1983 assert_eq!(parsed.items[0].r2_key, "voice/recordings/1/a.wav");
1984 assert!(!parsed.items[0].bytes_uploaded);
1985 assert!(parsed.items[1].bytes_uploaded);
1986 }
1987
1988 #[test]
1989 fn install_heartbeat_request_serializes_with_camel_case_keys() {
1990 let req = InstallHeartbeatRequest {
1991 install_id: "11111111-1111-4111-8111-111111111111".into(),
1992 app_version: "0.0.21".into(),
1993 os: "macos".into(),
1994 os_version: Some("15.5.0".into()),
1995 arch: Some("aarch64".into()),
1996 locale: Some("en-NZ".into()),
1997 distribution: Some("mas".into()),
1998 };
1999 let s = serde_json::to_string(&req).unwrap();
2000 assert!(s.contains("\"installId\":"), "{s}");
2001 assert!(s.contains("\"appVersion\":\"0.0.21\""), "{s}");
2002 assert!(s.contains("\"os\":\"macos\""), "{s}");
2003 assert!(s.contains("\"osVersion\":\"15.5.0\""), "{s}");
2004 assert!(s.contains("\"arch\":\"aarch64\""), "{s}");
2005 assert!(s.contains("\"locale\":\"en-NZ\""), "{s}");
2006 assert!(s.contains("\"distribution\":\"mas\""), "{s}");
2007 }
2008
2009 #[test]
2010 fn install_heartbeat_request_omits_absent_optional_fields() {
2011 // A host where the OS version / locale probe came up empty
2012 // shouldn't send `null` — keeping the keys out lets the
2013 // platform's Zod `.optional()` accept the body and the column
2014 // stay NULL rather than the string "null".
2015 let req = InstallHeartbeatRequest {
2016 install_id: "x".into(),
2017 app_version: "0.0.21".into(),
2018 os: "linux".into(),
2019 os_version: None,
2020 arch: None,
2021 locale: None,
2022 distribution: None,
2023 };
2024 let s = serde_json::to_string(&req).unwrap();
2025 assert!(!s.contains("osVersion"), "osVersion should be omitted: {s}");
2026 assert!(!s.contains("arch"), "arch should be omitted: {s}");
2027 assert!(!s.contains("locale"), "locale should be omitted: {s}");
2028 assert!(
2029 !s.contains("distribution"),
2030 "distribution should be omitted: {s}"
2031 );
2032 }
2033
2034 #[test]
2035 fn install_heartbeat_response_parses_platform_shape() {
2036 let raw = r#"{
2037 "id": "abc-123",
2038 "installId": "11111111-1111-4111-8111-111111111111",
2039 "appVersion": "0.0.21",
2040 "os": "macos",
2041 "osVersion": "15.5.0",
2042 "arch": "aarch64",
2043 "locale": null,
2044 "firstSeenAt": "2026-05-31T10:00:00.000Z",
2045 "lastSeenAt": "2026-05-31T10:00:00.000Z"
2046 }"#;
2047 let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2048 assert_eq!(parsed.id, "abc-123");
2049 assert_eq!(parsed.app_version, "0.0.21");
2050 assert_eq!(parsed.os_version.as_deref(), Some("15.5.0"));
2051 assert!(parsed.locale.is_none());
2052 // The fixture above carries no `distribution` key at all, which
2053 // is what a platform deployed before the field looks like. It
2054 // must parse, not error — hence `#[serde(default)]`.
2055 assert!(parsed.distribution.is_none());
2056 }
2057
2058 #[test]
2059 fn install_heartbeat_response_reads_the_distribution_back() {
2060 let raw = r#"{
2061 "id": "abc-123",
2062 "installId": "11111111-1111-4111-8111-111111111111",
2063 "appVersion": "0.0.48",
2064 "os": "macos",
2065 "osVersion": "15.5.0",
2066 "arch": "aarch64",
2067 "locale": "en-NZ",
2068 "distribution": "mas",
2069 "firstSeenAt": "2026-08-22T10:00:00.000Z",
2070 "lastSeenAt": "2026-08-22T10:00:00.000Z"
2071 }"#;
2072 let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2073 assert_eq!(parsed.distribution.as_deref(), Some("mas"));
2074 }
2075
2076 #[test]
2077 fn install_heartbeat_response_accepts_an_unknown_distribution() {
2078 // Free text by contract: the platform stores whatever arrives so
2079 // a new distribution can ship without a server release. Parsing
2080 // it into an enum here would undo that on the client side.
2081 let raw = r#"{
2082 "id": "abc-123",
2083 "installId": "11111111-1111-4111-8111-111111111111",
2084 "appVersion": "0.1.0",
2085 "os": "windows",
2086 "osVersion": null,
2087 "arch": "x86_64",
2088 "locale": null,
2089 "distribution": "msstore",
2090 "firstSeenAt": "2026-08-22T10:00:00.000Z",
2091 "lastSeenAt": "2026-08-22T10:00:00.000Z"
2092 }"#;
2093 let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2094 assert_eq!(parsed.distribution.as_deref(), Some("msstore"));
2095 }
2096
2097 #[test]
2098 fn system_info_detect_fills_os_and_arch() {
2099 // os / arch come from compile-time consts, so they're always
2100 // non-empty on every supported target. os_version / locale are
2101 // best-effort and intentionally not asserted.
2102 let sys = SystemInfo::detect();
2103 assert!(!sys.os.is_empty(), "os should be a non-empty target string");
2104 assert!(
2105 !sys.arch.is_empty(),
2106 "arch should be a non-empty target string"
2107 );
2108 }
2109
2110 #[test]
2111 fn transcripts_marker_resource_is_transcripts() {
2112 assert_eq!(<VoiceTranscripts as SyncEndpoint>::RESOURCE, "transcripts");
2113 }
2114
2115 #[test]
2116 fn transcript_record_serializes_with_camel_case_and_channel_enum() {
2117 let r = VoiceTranscriptRecord {
2118 source_id: "1".into(),
2119 call_source_id: "22222222-2222-4222-8222-222222222222".into(),
2120 channel: VoiceTranscriptChannel::Remote,
2121 ts_ms: 100,
2122 end_ms: 1_500,
2123 text: "hello".into(),
2124 envelope: SyncEnvelope::for_endpoint::<VoiceTranscripts>(),
2125 };
2126 let s = serde_json::to_string(&r).unwrap();
2127 assert!(s.contains("\"sourceId\":"), "{s}");
2128 assert!(s.contains("\"callSourceId\":"), "{s}");
2129 // The channel enum is wire-stable snake_case — matches the
2130 // platform's Zod `enum(VOICE_TRANSCRIPT_CHANNELS)`.
2131 assert!(s.contains("\"channel\":\"remote\""), "{s}");
2132 assert!(s.contains("\"tsMs\":100"), "{s}");
2133 assert!(s.contains("\"endMs\":1500"), "{s}");
2134 assert!(s.contains("\"text\":\"hello\""), "{s}");
2135 assert!(s.contains("\"schemaVersion\":1"), "{s}");
2136 }
2137
2138 #[test]
2139 fn share_visibility_pins_its_wire_strings() {
2140 // The platform validates these against an exact string list; a
2141 // rename would bounce every share command with a 400.
2142 assert_eq!(
2143 serde_json::to_string(&ShareVisibility::Private).unwrap(),
2144 "\"private\""
2145 );
2146 assert_eq!(
2147 serde_json::to_string(&ShareVisibility::Restricted).unwrap(),
2148 "\"restricted\""
2149 );
2150 assert_eq!(
2151 serde_json::to_string(&ShareVisibility::Public).unwrap(),
2152 "\"public\""
2153 );
2154 for v in [
2155 ShareVisibility::Private,
2156 ShareVisibility::Restricted,
2157 ShareVisibility::Public,
2158 ] {
2159 let s = serde_json::to_string(&v).unwrap();
2160 let back: ShareVisibility = serde_json::from_str(&s).unwrap();
2161 assert_eq!(v, back);
2162 }
2163 }
2164
2165 #[test]
2166 fn share_request_serializes_with_camel_case_and_omits_unset() {
2167 let req = ShareRecordingRequest {
2168 recording_source_id: "11111111-1111-4111-8111-111111111111".into(),
2169 visibility: ShareVisibility::Public,
2170 invited_emails: None,
2171 party_masking: None,
2172 show_transcript: None,
2173 show_audio: None,
2174 allow_download: None,
2175 default_mute_local: None,
2176 default_mute_remote: None,
2177 password: None,
2178 expires_at: None,
2179 };
2180 let s = serde_json::to_string(&req).unwrap();
2181 assert!(s.contains("\"recordingSourceId\":"), "{s}");
2182 assert!(s.contains("\"visibility\":\"public\""), "{s}");
2183 // Phase-2 / tier-specific / visibility-control fields stay off the
2184 // wire when unset so the platform's `.optional()` schema accepts the
2185 // body (and the omitted controls fall to the platform defaults).
2186 assert!(!s.contains("invitedEmails"), "{s}");
2187 assert!(!s.contains("partyMasking"), "{s}");
2188 assert!(!s.contains("showTranscript"), "{s}");
2189 assert!(!s.contains("showAudio"), "{s}");
2190 assert!(!s.contains("allowDownload"), "{s}");
2191 assert!(!s.contains("defaultMuteLocal"), "{s}");
2192 assert!(!s.contains("defaultMuteRemote"), "{s}");
2193 assert!(!s.contains("password"), "{s}");
2194 assert!(!s.contains("expiresAt"), "{s}");
2195 }
2196
2197 #[test]
2198 fn share_request_serializes_visibility_controls_camel_case() {
2199 let req = ShareRecordingRequest {
2200 recording_source_id: "a".into(),
2201 visibility: ShareVisibility::Public,
2202 invited_emails: None,
2203 party_masking: Some(PartyMasking::Partial),
2204 show_transcript: Some(false),
2205 show_audio: Some(true),
2206 allow_download: Some(true),
2207 default_mute_local: Some(false),
2208 default_mute_remote: Some(true),
2209 password: None,
2210 expires_at: None,
2211 };
2212 let s = serde_json::to_string(&req).unwrap();
2213 assert!(s.contains("\"partyMasking\":\"partial\""), "{s}");
2214 assert!(s.contains("\"showTranscript\":false"), "{s}");
2215 assert!(s.contains("\"showAudio\":true"), "{s}");
2216 assert!(s.contains("\"allowDownload\":true"), "{s}");
2217 // The owner muted their own side by default but left the other
2218 // party audible — both ride the wire as camelCase booleans.
2219 assert!(s.contains("\"defaultMuteLocal\":false"), "{s}");
2220 assert!(s.contains("\"defaultMuteRemote\":true"), "{s}");
2221 }
2222
2223 #[test]
2224 fn share_request_carries_invited_emails_for_restricted() {
2225 let req = ShareRecordingRequest {
2226 recording_source_id: "a".into(),
2227 visibility: ShareVisibility::Restricted,
2228 invited_emails: Some(vec!["alex@example.com".into()]),
2229 party_masking: None,
2230 show_transcript: None,
2231 show_audio: None,
2232 allow_download: None,
2233 default_mute_local: None,
2234 default_mute_remote: None,
2235 password: None,
2236 expires_at: None,
2237 };
2238 let s = serde_json::to_string(&req).unwrap();
2239 assert!(s.contains("\"visibility\":\"restricted\""), "{s}");
2240 assert!(
2241 s.contains("\"invitedEmails\":[\"alex@example.com\"]"),
2242 "{s}"
2243 );
2244 }
2245
2246 #[test]
2247 fn share_response_parses_platform_shape() {
2248 let raw = r#"{
2249 "visibility": "public",
2250 "token": "Zr7-x9F2k1QpLmN4sT8wYa",
2251 "shareUrl": "https://platform.wavekat.com/voice/s/Zr7-x9F2k1QpLmN4sT8wYa",
2252 "sharedAt": "2026-06-19T10:00:00.000Z"
2253 }"#;
2254 let parsed: ShareRecordingResponse = serde_json::from_str(raw).unwrap();
2255 assert_eq!(parsed.visibility, ShareVisibility::Public);
2256 assert_eq!(parsed.token, "Zr7-x9F2k1QpLmN4sT8wYa");
2257 assert!(parsed.share_url.ends_with(&parsed.token));
2258 }
2259
2260 #[test]
2261 fn share_state_parses_restricted_with_invited_emails() {
2262 // The GET read carries the audience back — this is the field the
2263 // POST reply omits and the desktop "who can open this" panel needs.
2264 let raw = r#"{
2265 "visibility": "restricted",
2266 "token": "Zr7-x9F2k1QpLmN4sT8wYa",
2267 "shareUrl": "https://platform.wavekat.com/voice/s/Zr7-x9F2k1QpLmN4sT8wYa",
2268 "sharedAt": "2026-06-19T10:00:00.000Z",
2269 "invitedEmails": ["bob@example.com", "carol@example.com"],
2270 "partyMasking": "full",
2271 "showTranscript": true,
2272 "showAudio": false,
2273 "allowDownload": false,
2274 "defaultMuteLocal": false,
2275 "defaultMuteRemote": true
2276 }"#;
2277 let parsed: ShareStateResponse = serde_json::from_str(raw).unwrap();
2278 assert_eq!(parsed.visibility, ShareVisibility::Restricted);
2279 assert_eq!(
2280 parsed.invited_emails.as_deref(),
2281 Some(
2282 [
2283 "bob@example.com".to_string(),
2284 "carol@example.com".to_string()
2285 ]
2286 .as_slice()
2287 )
2288 );
2289 // The visibility controls ride back on the live-share read.
2290 assert_eq!(parsed.party_masking, Some(PartyMasking::Full));
2291 assert_eq!(parsed.show_transcript, Some(true));
2292 assert_eq!(parsed.show_audio, Some(false));
2293 // Audio hidden here, so download comes back off (platform folds the two).
2294 assert_eq!(parsed.allow_download, Some(false));
2295 // Per-channel playback defaults ride back too.
2296 assert_eq!(parsed.default_mute_local, Some(false));
2297 assert_eq!(parsed.default_mute_remote, Some(true));
2298 }
2299
2300 #[test]
2301 fn share_state_parses_private_with_fields_absent() {
2302 // A never-shared (or revoked) recording reports private with no
2303 // token / url / emails — the optional fields stay None.
2304 let parsed: ShareStateResponse =
2305 serde_json::from_str(r#"{ "visibility": "private" }"#).unwrap();
2306 assert_eq!(parsed.visibility, ShareVisibility::Private);
2307 assert!(parsed.token.is_none());
2308 assert!(parsed.share_url.is_none());
2309 assert!(parsed.shared_at.is_none());
2310 assert!(parsed.invited_emails.is_none());
2311 }
2312
2313 #[test]
2314 fn share_request_rejects_empty_source_id_before_hitting_network() {
2315 // Guarded client-side so an empty id can't produce a path like
2316 // `/api/voice/recordings//share` that 404s confusingly.
2317 let req = ShareRecordingRequest {
2318 recording_source_id: String::new(),
2319 visibility: ShareVisibility::Private,
2320 invited_emails: None,
2321 party_masking: None,
2322 show_transcript: None,
2323 show_audio: None,
2324 allow_download: None,
2325 default_mute_local: None,
2326 default_mute_remote: None,
2327 password: None,
2328 expires_at: None,
2329 };
2330 // We can't call the async method without a runtime here, but the
2331 // guard mirrors `upload_recording_bytes` — assert the precondition
2332 // shape the method checks.
2333 assert!(req.recording_source_id.is_empty());
2334 }
2335
2336 // ---- VoiceAccounts ----
2337
2338 fn sample_account() -> VoiceAccountRecord {
2339 VoiceAccountRecord {
2340 source_id: "11111111-1111-4111-8111-111111111111".into(),
2341 enabled: true,
2342 display_name: "Work line".into(),
2343 username: "alice".into(),
2344 domain: "sip.example.com".into(),
2345 auth_username: Some("alice-auth".into()),
2346 server: Some("sip.example.com".into()),
2347 port: Some(5060),
2348 transport: VoiceTransport::Udp,
2349 register_expires: 60,
2350 keepalive_secs: Some(50),
2351 disclosure_enabled: true,
2352 updated_at: "2026-06-20T10:00:00Z".into(),
2353 deleted_at: None,
2354 envelope: SyncEnvelope::for_endpoint::<VoiceAccounts>(),
2355 }
2356 }
2357
2358 #[test]
2359 fn accounts_marker_resource_is_accounts() {
2360 // Path constant drives the URL in `Client::sync` / `Client::list`;
2361 // a rename here would silently 404 against the platform.
2362 assert_eq!(<VoiceAccounts as SyncEndpoint>::RESOURCE, "accounts");
2363 }
2364
2365 #[test]
2366 fn account_record_serializes_with_camel_case_and_envelope() {
2367 let s = serde_json::to_string(&sample_account()).unwrap();
2368 // Field-by-field wire contract — also what the platform's Zod
2369 // schema expects.
2370 assert!(s.contains("\"sourceId\":"), "{s}");
2371 assert!(s.contains("\"displayName\":\"Work line\""), "{s}");
2372 assert!(s.contains("\"authUsername\":\"alice-auth\""), "{s}");
2373 assert!(s.contains("\"registerExpires\":60"), "{s}");
2374 assert!(s.contains("\"keepaliveSecs\":50"), "{s}");
2375 assert!(s.contains("\"disclosureEnabled\":true"), "{s}");
2376 assert!(s.contains("\"transport\":\"udp\""), "{s}");
2377 assert!(s.contains("\"updatedAt\":\"2026-06-20T10:00:00Z\""), "{s}");
2378 // A live line carries no tombstone.
2379 assert!(!s.contains("deletedAt"), "deletedAt should be omitted: {s}");
2380 // The secret never crosses this wire, by construction.
2381 assert!(!s.contains("password"), "no password field: {s}");
2382 // Envelope flattens to the top, same as the other resources.
2383 assert!(s.contains("\"schemaVersion\":1"), "{s}");
2384 }
2385
2386 #[test]
2387 fn account_tombstone_serializes_deleted_at() {
2388 // A soft-delete rides as an upsert with deletedAt set — the
2389 // delete-propagation mechanism (doc 40).
2390 let mut r = sample_account();
2391 r.deleted_at = Some("2026-06-20T12:00:00Z".into());
2392 let s = serde_json::to_string(&r).unwrap();
2393 assert!(s.contains("\"deletedAt\":\"2026-06-20T12:00:00Z\""), "{s}");
2394 }
2395
2396 #[test]
2397 fn account_record_round_trips_optional_fields() {
2398 // A minimal line — no auth username, server, port, keepalive, or
2399 // tombstone — should parse with those all absent.
2400 let raw = r#"{
2401 "sourceId": "a",
2402 "enabled": false,
2403 "displayName": "Cheap trunk",
2404 "username": "u",
2405 "domain": "d",
2406 "transport": "tcp",
2407 "registerExpires": 120,
2408 "disclosureEnabled": false,
2409 "updatedAt": "2026-06-20T10:00:00Z"
2410 }"#;
2411 let parsed: VoiceAccountRecord = serde_json::from_str(raw).unwrap();
2412 assert!(!parsed.enabled);
2413 assert!(parsed.auth_username.is_none());
2414 assert!(parsed.server.is_none());
2415 assert!(parsed.port.is_none());
2416 assert!(parsed.keepalive_secs.is_none());
2417 assert!(parsed.deleted_at.is_none());
2418 assert_eq!(parsed.transport, VoiceTransport::Tcp);
2419 assert_eq!(parsed.register_expires, 120);
2420 }
2421
2422 #[test]
2423 fn voice_transport_round_trips_via_json() {
2424 for t in [VoiceTransport::Udp, VoiceTransport::Tcp] {
2425 let s = serde_json::to_string(&t).unwrap();
2426 let back: VoiceTransport = serde_json::from_str(&s).unwrap();
2427 assert_eq!(t, back);
2428 }
2429 // Pin the wire strings — the daemon's `TransportKind` and the
2430 // platform's Zod enum both depend on these exact tokens.
2431 assert_eq!(
2432 serde_json::to_string(&VoiceTransport::Udp).unwrap(),
2433 "\"udp\""
2434 );
2435 assert_eq!(
2436 serde_json::to_string(&VoiceTransport::Tcp).unwrap(),
2437 "\"tcp\""
2438 );
2439 }
2440
2441 #[test]
2442 fn accounts_query_omits_unset_and_serializes_include_deleted() {
2443 let empty = serde_json::to_string(&VoiceAccountsQuery::default()).unwrap();
2444 assert_eq!(empty, "{}", "default query should be empty: {empty}");
2445 let with_deleted = serde_json::to_string(&VoiceAccountsQuery {
2446 include_deleted: Some(true),
2447 })
2448 .unwrap();
2449 assert!(
2450 with_deleted.contains("\"includeDeleted\":true"),
2451 "{with_deleted}"
2452 );
2453 }
2454
2455 // ---- VoiceFlows ----
2456
2457 #[test]
2458 fn flows_query_serializes_cursor_and_omits_absent_fields() {
2459 let empty = serde_json::to_string(&VoiceFlowsQuery::default()).unwrap();
2460 assert_eq!(empty, "{}");
2461 let cursored = serde_json::to_string(&VoiceFlowsQuery {
2462 after: Some("flow_abc".into()),
2463 limit: Some(100),
2464 schema_versions: None,
2465 })
2466 .unwrap();
2467 assert!(cursored.contains("\"after\":\"flow_abc\""), "{cursored}");
2468 assert!(cursored.contains("\"limit\":100"), "{cursored}");
2469 }
2470
2471 #[test]
2472 fn flows_query_sends_schema_versions_under_the_servers_name() {
2473 // The struct is camelCase; this parameter is not. A silently
2474 // camelCased key is ignored by the server, which reads exactly
2475 // like an account with no flows in that version — so pin it.
2476 let query = serde_json::to_string(&VoiceFlowsQuery {
2477 schema_versions: Some("1,2".into()),
2478 ..Default::default()
2479 })
2480 .unwrap();
2481 assert_eq!(query, r#"{"schema_versions":"1,2"}"#);
2482 }
2483
2484 // ---- Booking ----
2485
2486 #[test]
2487 fn booking_slots_request_uses_the_routes_snake_case_wire() {
2488 // Unlike the sync resources above, these routes speak snake_case.
2489 // A camelCased body is rejected as a validation error mid-call,
2490 // which the flow can only render as "unavailable".
2491 let body = serde_json::to_string(&BookingSlotsRequest {
2492 source_id: "call_1".into(),
2493 duration_mins: 30,
2494 buffer_mins: 10,
2495 lead_mins: 120,
2496 horizon_days: 14,
2497 schedule: BookingSchedule {
2498 tue: vec![BookingTimeRange {
2499 open: "09:00".into(),
2500 close: "17:00".into(),
2501 }],
2502 ..Default::default()
2503 },
2504 timezone: "Pacific/Auckland".into(),
2505 exceptions: Vec::new(),
2506 limit: 3,
2507 })
2508 .unwrap();
2509 assert!(body.contains(r#""source_id":"call_1""#), "{body}");
2510 assert!(body.contains(r#""duration_mins":30"#), "{body}");
2511 assert!(body.contains(r#""timezone":"Pacific/Auckland""#), "{body}");
2512 // Days with no hours, and an empty exception list, stay off the
2513 // wire entirely rather than shipping empty arrays.
2514 assert!(!body.contains("\"mon\""), "{body}");
2515 assert!(!body.contains("exceptions"), "{body}");
2516 }
2517
2518 #[test]
2519 fn booking_slots_response_parses_both_answers() {
2520 let offered: BookingSlotsResponse = serde_json::from_str(
2521 r#"{"slots":[{"start":"2026-08-11T21:00:00Z","end":"2026-08-11T21:30:00Z"}],"timezone":"Pacific/Auckland"}"#,
2522 )
2523 .unwrap();
2524 assert_eq!(offered.slots.len(), 1);
2525 assert_eq!(offered.timezone, "Pacific/Auckland");
2526 assert!(offered.status.is_none());
2527
2528 // The calendar could not be read. Not an error to the caller of
2529 // this crate — the flow has an exit for it.
2530 let down: BookingSlotsResponse =
2531 serde_json::from_str(r#"{"status":"unavailable","reason":"not_connected"}"#).unwrap();
2532 assert!(down.slots.is_empty());
2533 assert_eq!(down.status.as_deref(), Some("unavailable"));
2534 assert_eq!(down.reason.as_deref(), Some("not_connected"));
2535 }
2536
2537 #[test]
2538 fn booking_book_response_parses_every_outcome() {
2539 let booked: BookingBookResponse =
2540 serde_json::from_str(r#"{"status":"booked","start":"2026-08-11T21:00:00Z"}"#).unwrap();
2541 assert_eq!(booked.status, "booked");
2542 assert_eq!(booked.start.as_deref(), Some("2026-08-11T21:00:00Z"));
2543
2544 let taken: BookingBookResponse =
2545 serde_json::from_str(r#"{"status":"slot_taken"}"#).unwrap();
2546 assert_eq!(taken.status, "slot_taken");
2547 assert!(taken.start.is_none());
2548
2549 // A status this build has never heard of still parses: failing
2550 // here would drop a live call over an unknown string.
2551 let future: BookingBookResponse =
2552 serde_json::from_str(r#"{"status":"needs_deposit"}"#).unwrap();
2553 assert_eq!(future.status, "needs_deposit");
2554 }
2555
2556 #[test]
2557 fn flows_page_parses_platform_shape() {
2558 let raw = r#"{
2559 "items": [{
2560 "id": "flow_1",
2561 "name": "Luigi's — after hours",
2562 "version": 3,
2563 "yaml": "schema_version: 1\n",
2564 "publishedAt": "2026-07-13T10:00:00Z"
2565 }],
2566 "nextAfter": null
2567 }"#;
2568 let page: VoiceFlowsPage = serde_json::from_str(raw).unwrap();
2569 assert_eq!(page.items.len(), 1);
2570 let rec = &page.items[0];
2571 assert_eq!(rec.id, "flow_1");
2572 assert_eq!(rec.version, 3);
2573 assert_eq!(rec.published_at, "2026-07-13T10:00:00Z");
2574 assert!(page.next_after.is_none());
2575
2576 // A mid-walk page carries the cursor.
2577 let more: VoiceFlowsPage =
2578 serde_json::from_str(r#"{ "items": [], "nextAfter": "flow_1" }"#).unwrap();
2579 assert_eq!(more.next_after.as_deref(), Some("flow_1"));
2580 }
2581
2582 #[test]
2583 fn flow_assets_manifest_parses_platform_shape() {
2584 // `ref` (a reserved word) maps to `asset_ref`; a null duration is
2585 // accepted (the platform doesn't always know it).
2586 let raw = r#"{
2587 "assets": [{
2588 "ref": "vprompt_ab12cd34",
2589 "format": "ulaw_8000",
2590 "byteSize": 48044,
2591 "durationMs": null,
2592 "contentHash": "9f2c00aa"
2593 }]
2594 }"#;
2595 let page: VoiceFlowAssetsPage = serde_json::from_str(raw).unwrap();
2596 assert_eq!(page.assets.len(), 1);
2597 let asset = &page.assets[0];
2598 assert_eq!(asset.asset_ref, "vprompt_ab12cd34");
2599 assert_eq!(asset.format, "ulaw_8000");
2600 assert_eq!(asset.byte_size, 48044);
2601 assert!(asset.duration_ms.is_none());
2602 assert_eq!(asset.content_hash, "9f2c00aa");
2603
2604 // A text-only version legitimately has no frozen audio.
2605 let empty: VoiceFlowAssetsPage = serde_json::from_str(r#"{ "assets": [] }"#).unwrap();
2606 assert!(empty.assets.is_empty());
2607 }
2608
2609 #[test]
2610 fn account_record_accepts_unknown_extras_for_forward_compat() {
2611 // A newer client shipping a field this platform version lacks a
2612 // column for round-trips via the `extras` envelope.
2613 let raw = r#"{
2614 "sourceId": "a",
2615 "enabled": true,
2616 "displayName": "x",
2617 "username": "u",
2618 "domain": "d",
2619 "transport": "udp",
2620 "registerExpires": 60,
2621 "disclosureEnabled": true,
2622 "updatedAt": "2026-06-20T10:00:00Z",
2623 "schemaVersion": 2,
2624 "extras": { "ringtone": "classic" }
2625 }"#;
2626 let parsed: VoiceAccountRecord = serde_json::from_str(raw).unwrap();
2627 assert_eq!(parsed.envelope.schema_version, Some(2));
2628 let extras = parsed.envelope.extras.as_ref().expect("extras present");
2629 assert_eq!(extras["ringtone"], "classic");
2630 }
2631}