syncular_client/
api.rs

1//! Driver-facing API shapes (JSON-able), mirroring the conformance
2//! `ClientInstance` contract: sync reports, conflicts, rejections, row
3//! states, subscription states. Serialized as camelCase to cross the shim
4//! boundary unchanged.
5
6use std::collections::BTreeMap;
7
8use serde::{Deserialize, Serialize};
9use serde_json::{Map, Value};
10
11use crate::previous_version::PreviousVersionContextConfig;
12/// Stable dynamic value boundary used by generated named queries.
13pub type QueryValue = Value;
14/// One dynamic query result row, keyed by QueryIR runtime projection name.
15pub type QueryRow = Map<String, QueryValue>;
16
17/// An owned blob body returned by the Rust client without driver encoding.
18#[derive(Debug, Clone, PartialEq, Eq)]
19pub struct FetchedBlob {
20    pub blob_id: String,
21    pub byte_length: i64,
22    pub bytes: Vec<u8>,
23    pub media_type: Option<String>,
24}
25
26#[derive(Debug, Clone, Copy, PartialEq, Eq)]
27pub enum TimeBucketUnit {
28    Month,
29}
30
31const MAX_TIME_BUCKET_MS: i64 = 253_402_300_799_999;
32
33fn utc_year_month(timestamp_ms: i64) -> Result<(i64, i64), String> {
34    if !(0..=MAX_TIME_BUCKET_MS).contains(&timestamp_ms) {
35        return Err(
36            "sync.invalid_request: time bucket timestamps must fall from 1970 through 9999"
37                .to_owned(),
38        );
39    }
40    let z = timestamp_ms / 86_400_000 + 719_468;
41    let era = z.div_euclid(146_097);
42    let day_of_era = z - era * 146_097;
43    let year_of_era =
44        (day_of_era - day_of_era / 1_460 + day_of_era / 36_524 - day_of_era / 146_096) / 365;
45    let mut year = year_of_era + era * 400;
46    let day_of_year = day_of_era - (365 * year_of_era + year_of_era / 4 - year_of_era / 100);
47    let month_prime = (5 * day_of_year + 2) / 153;
48    let month = month_prime + if month_prime < 10 { 3 } else { -9 };
49    if month <= 2 {
50        year += 1;
51    }
52    Ok((year, month))
53}
54
55/// Derive the immutable UTC scope value stored when a row is created.
56pub fn creation_time_bucket(created_at_ms: i64, unit: TimeBucketUnit) -> Result<String, String> {
57    match unit {
58        TimeBucketUnit::Month => {
59            let (year, month) = utc_year_month(created_at_ms)?;
60            Ok(format!("{year:04}-{month:02}"))
61        }
62    }
63}
64
65/// Return a rolling UTC month window ordered from oldest to newest.
66pub fn last(count: usize, unit: TimeBucketUnit, now_ms: i64) -> Result<Vec<String>, String> {
67    if !(1..=1_200).contains(&count) {
68        return Err(
69            "sync.invalid_request: time bucket count must be from 1 through 1200".to_owned(),
70        );
71    }
72    match unit {
73        TimeBucketUnit::Month => {
74            let (year, month) = utc_year_month(now_ms)?;
75            let current = year * 12 + month - 1;
76            if current - (count as i64 - 1) < 1970 * 12 {
77                return Err(
78                    "sync.invalid_request: every returned UTC month must fall from 1970 through 9999"
79                        .to_owned(),
80                );
81            }
82            Ok((0..count)
83                .rev()
84                .map(|offset| {
85                    let value = current - offset as i64;
86                    format!(
87                        "{:04}-{:02}",
88                        value.div_euclid(12),
89                        value.rem_euclid(12) + 1
90                    )
91                })
92                .collect())
93        }
94    }
95}
96
97/// §4.8 window base: one table, the scope variable whose values are the
98/// window units, any fixed scopes shared by every unit, and host-opaque
99/// `params` carried onto each unit's subscription.
100#[derive(Debug, Clone)]
101pub struct WindowBase {
102    pub table: String,
103    pub variable: String,
104    /// Scopes shared by every unit (other variables), if any.
105    pub fixed_scopes: Vec<(String, Vec<String>)>,
106    pub params: Option<String>,
107}
108
109/// §4.8 completeness oracle (I3): the windowed-in units for a base, plus
110/// the subset whose bootstrap has not yet completed. Registration alone is
111/// not completeness — a `pending` unit's local replica may be empty or
112/// partial (its subscription still has `cursor: -1` or holds a resume
113/// token), and MUST NOT be rendered as complete. A unit with zero server
114/// rows still completes once its bootstrap round finishes.
115#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq)]
116#[serde(rename_all = "camelCase")]
117pub struct WindowState {
118    /// Windowed-in units for this base, ordered by value.
119    pub units: Vec<String>,
120    /// Registered units whose bootstrap has not yet completed.
121    pub pending: Vec<String>,
122}
123
124#[cfg(test)]
125mod time_bucket_tests {
126    use super::{creation_time_bucket, last, TimeBucketUnit};
127
128    #[test]
129    fn utc_month_buckets_cross_year_boundaries() {
130        let now = 1_770_508_800_000; // 2026-02-08T00:00:00Z
131        assert_eq!(
132            creation_time_bucket(now, TimeBucketUnit::Month).unwrap(),
133            "2026-02"
134        );
135        assert_eq!(
136            last(3, TimeBucketUnit::Month, now).unwrap(),
137            vec!["2025-12", "2026-01", "2026-02"]
138        );
139    }
140
141    #[test]
142    fn utc_month_buckets_reject_unbounded_input() {
143        assert!(last(0, TimeBucketUnit::Month, 0).is_err());
144        assert!(last(1_201, TimeBucketUnit::Month, 0).is_err());
145        assert!(last(2, TimeBucketUnit::Month, 0).is_err());
146        assert!(creation_time_bucket(-1, TimeBucketUnit::Month).is_err());
147    }
148}
149
150#[derive(Debug, Clone, Serialize)]
151#[serde(rename_all = "camelCase")]
152pub struct TableChange {
153    pub table: String,
154    #[serde(skip_serializing_if = "Option::is_none")]
155    pub scope_keys: Option<Vec<String>>,
156}
157
158#[derive(Debug, Clone, Serialize)]
159#[serde(rename_all = "camelCase")]
160pub struct WindowChange {
161    pub base_key: String,
162    pub table: String,
163    pub units: Vec<String>,
164}
165
166#[derive(Debug, Clone, Serialize)]
167#[serde(rename_all = "camelCase")]
168pub struct SyncStatusSnapshot {
169    pub current_schema_version: i32,
170    pub outbox: usize,
171    pub upgrading: bool,
172    #[serde(skip_serializing_if = "Option::is_none")]
173    pub lease_state: Option<LeaseState>,
174    #[serde(skip_serializing_if = "Option::is_none")]
175    pub schema_floor: Option<SchemaFloor>,
176    pub sync_needed: bool,
177    /// RFC 0005 A2: container presence, so a host can enforce the downgrade
178    /// precondition (`previousVersionDiscard`) instead of documenting it.
179    pub previous_version_context: PreviousVersionStatus,
180}
181
182/// RFC 0005 A2: presence of the previous-version container file.
183#[derive(Debug, Clone, Copy, Default, Serialize, PartialEq, Eq)]
184#[serde(rename_all = "camelCase")]
185pub struct PreviousVersionStatus {
186    pub present: bool,
187    #[serde(skip_serializing_if = "Option::is_none")]
188    pub created_at_ms: Option<i64>,
189}
190
191pub const CLIENT_DIAGNOSTICS_VERSION: u8 = 1;
192pub const MAX_DIAGNOSTIC_EXPECTED_SUBSCRIPTIONS: usize = 256;
193pub const MAX_DIAGNOSTIC_QUERY_FAILURES: usize = 256;
194
195/// §8.8 client-local code: the `required` policy refused a sync round because
196/// the realtime socket is not connected. Never a wire code (§10.3).
197pub const REALTIME_UNAVAILABLE_CODE: &str = "sync.realtime_unavailable";
198/// §8.8 client-local code: a connected socket ended without a deliberate
199/// disconnect and the round reported no transport code. Never a wire code.
200pub const REALTIME_LOST_CODE: &str = "client.realtime_lost";
201
202#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
203#[serde(rename_all = "camelCase", deny_unknown_fields)]
204pub struct ExpectedDiagnosticSubscription {
205    pub id: String,
206    pub table: String,
207}
208
209#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq)]
210#[serde(rename_all = "camelCase", deny_unknown_fields)]
211pub struct ClientDiagnosticsRequest {
212    #[serde(default)]
213    pub expected_subscriptions: Vec<ExpectedDiagnosticSubscription>,
214}
215
216#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
217#[serde(rename_all = "camelCase")]
218pub struct ClientDiagnosticsHost {
219    pub kind: String,
220    pub role: String,
221    pub connectivity: String,
222    pub realtime: RealtimeState,
223    pub realtime_policy: RealtimePolicy,
224    #[serde(skip_serializing_if = "Option::is_none")]
225    pub realtime_reason_code: Option<String>,
226    #[serde(skip_serializing_if = "Option::is_none")]
227    pub realtime_retry_delay_ms: Option<u64>,
228}
229
230#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
231#[serde(rename_all = "camelCase")]
232pub struct DiagnosticSubscription {
233    pub id: String,
234    pub table: String,
235    pub state: String,
236    pub complete: bool,
237    #[serde(skip_serializing_if = "Option::is_none")]
238    pub cursor: Option<i64>,
239    #[serde(skip_serializing_if = "Option::is_none")]
240    pub reason_code: Option<String>,
241}
242
243#[derive(Debug, Clone, Serialize, Default, PartialEq, Eq)]
244#[serde(rename_all = "camelCase")]
245pub struct DiagnosticRoundCounters {
246    pub pushed: u32,
247    pub applied: usize,
248    pub rejected: usize,
249    pub retryable: usize,
250    pub conflicts: u32,
251    pub commits_applied: u32,
252    pub segment_rows_applied: u32,
253    pub bootstrapping: usize,
254    pub resets: usize,
255    pub revoked: usize,
256    pub failed: usize,
257    pub deferred_commits: usize,
258}
259
260#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
261#[serde(rename_all = "camelCase")]
262pub struct DiagnosticLastRound {
263    pub status: String,
264    pub started_at_ms: i64,
265    pub completed_at_ms: i64,
266    pub duration_ms: i64,
267    #[serde(skip_serializing_if = "Option::is_none")]
268    pub counters: Option<DiagnosticRoundCounters>,
269    #[serde(skip_serializing_if = "Option::is_none")]
270    pub error_code: Option<String>,
271}
272
273#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
274#[serde(rename_all = "camelCase")]
275pub struct DiagnosticLastChange {
276    pub revision: String,
277    pub recorded_at_ms: i64,
278    pub tables: Vec<String>,
279    pub windows: Vec<String>,
280    pub domains_truncated: bool,
281    pub status_changed: bool,
282    pub conflicts_changed: bool,
283    pub rejections_changed: bool,
284    pub outcomes_changed: bool,
285}
286
287#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
288#[serde(rename_all = "camelCase")]
289pub struct ClientDiagnosticsStorage {
290    pub status: String,
291    #[serde(skip_serializing_if = "Option::is_none")]
292    pub database_bytes_approx: Option<i64>,
293    #[serde(skip_serializing_if = "Option::is_none")]
294    pub pending_outbox_bytes_approx: Option<i64>,
295    #[serde(skip_serializing_if = "Option::is_none")]
296    pub retained_outcome_bytes_approx: Option<i64>,
297    #[serde(skip_serializing_if = "Option::is_none")]
298    pub retained_outcome_entries: Option<i64>,
299    #[serde(skip_serializing_if = "Option::is_none")]
300    pub blob_cache_bytes_approx: Option<i64>,
301    #[serde(skip_serializing_if = "Option::is_none")]
302    pub pressure_reason_code: Option<String>,
303}
304
305/// §7.6: the latest owned snapshot read of one query id failed.
306#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
307#[serde(rename_all = "camelCase")]
308pub struct DiagnosticQueryFailure {
309    pub id: String,
310    /// Distinct generated table names, ascending.
311    pub tables: Vec<String>,
312    /// `client.storage_corrupt`, `client.storage_io`, or `client.query_failed`.
313    pub code: String,
314    /// SQLite extended result code, when the driver exposed one.
315    #[serde(skip_serializing_if = "Option::is_none")]
316    pub sqlite_code: Option<i32>,
317    /// First failure since this id's last successful read.
318    pub at_ms: i64,
319}
320
321#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
322#[serde(rename_all = "camelCase")]
323pub struct ClientDiagnosticsSnapshot {
324    pub version: u8,
325    pub captured_at_ms: i64,
326    pub host: ClientDiagnosticsHost,
327    pub security_lifecycle: String,
328    pub schema: ClientDiagnosticsSchema,
329    pub replica: ClientDiagnosticsReplica,
330    pub lease: ClientDiagnosticsLease,
331    pub subscriptions: Vec<DiagnosticSubscription>,
332    pub subscriptions_truncated: bool,
333    #[serde(skip_serializing_if = "Option::is_none")]
334    pub last_round: Option<DiagnosticLastRound>,
335    #[serde(skip_serializing_if = "Option::is_none")]
336    pub last_change: Option<DiagnosticLastChange>,
337    pub storage: ClientDiagnosticsStorage,
338    pub query_failures: Vec<DiagnosticQueryFailure>,
339}
340
341#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
342#[serde(rename_all = "camelCase")]
343pub struct ClientDiagnosticsSchema {
344    pub current_version: i32,
345    pub upgrading: bool,
346    #[serde(skip_serializing_if = "Option::is_none")]
347    pub required_version: Option<i32>,
348    #[serde(skip_serializing_if = "Option::is_none")]
349    pub latest_version: Option<i32>,
350}
351
352#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
353#[serde(rename_all = "camelCase")]
354pub struct ClientDiagnosticsReplica {
355    pub local_revision: String,
356    pub sync_needed: bool,
357    pub pending_outbox: usize,
358}
359
360/// §8.8: how this client treats the realtime binding for sync rounds.
361#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize)]
362#[serde(rename_all = "lowercase")]
363pub enum RealtimePolicy {
364    Required,
365    #[default]
366    Optional,
367    Off,
368}
369
370impl RealtimePolicy {
371    #[must_use]
372    pub fn as_str(self) -> &'static str {
373        match self {
374            RealtimePolicy::Required => "required",
375            RealtimePolicy::Optional => "optional",
376            RealtimePolicy::Off => "off",
377        }
378    }
379}
380
381/// §8.8: the explicit availability state of the realtime binding. The
382/// TypeScript host adds `unsupported` (no connector configured) and `unknown`
383/// (a wrapper without evidence); the Rust core reaches neither because a
384/// transport always carries a connect path.
385#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize)]
386#[serde(rename_all = "lowercase")]
387pub enum RealtimeState {
388    Connected,
389    Connecting,
390    #[default]
391    Disconnected,
392    Lost,
393    Refused,
394    Disabled,
395}
396
397#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
398#[serde(rename_all = "camelCase")]
399pub struct ClientDiagnosticsLease {
400    pub state: String,
401    #[serde(skip_serializing_if = "Option::is_none")]
402    pub expires_at_ms: Option<i64>,
403    #[serde(skip_serializing_if = "Option::is_none")]
404    pub error_code: Option<String>,
405}
406
407/// JSON bindings carry the u64 revision as a decimal string (§7.5).
408#[derive(Debug, Clone, Serialize)]
409#[serde(rename_all = "camelCase")]
410pub struct ClientChangeBatch {
411    pub revision: String,
412    pub tables: Vec<TableChange>,
413    pub windows: Vec<WindowChange>,
414    #[serde(skip_serializing_if = "Option::is_none")]
415    pub status: Option<SyncStatusSnapshot>,
416    pub conflicts_changed: bool,
417    pub rejections_changed: bool,
418    pub outcomes_changed: bool,
419}
420
421#[derive(Debug, Clone, Serialize)]
422#[serde(tag = "kind", rename_all = "camelCase")]
423pub enum SyncIntent {
424    None,
425    Interactive,
426    Background {
427        #[serde(rename = "delayMs")]
428        delay_ms: u64,
429    },
430}
431
432#[derive(Debug, Clone, Serialize)]
433pub struct CommandEffects {
434    pub sync: SyncIntent,
435}
436
437impl CommandEffects {
438    #[must_use]
439    pub fn none() -> Self {
440        Self {
441            sync: SyncIntent::None,
442        }
443    }
444
445    #[must_use]
446    pub fn interactive() -> Self {
447        Self {
448            sync: SyncIntent::Interactive,
449        }
450    }
451}
452
453#[derive(Debug, Clone)]
454pub struct WindowCoverage {
455    pub base: WindowBase,
456    pub units: Vec<String>,
457}
458
459#[derive(Debug, Clone, Serialize)]
460#[serde(rename_all = "camelCase")]
461pub struct WindowUnitRef {
462    pub base_key: String,
463    pub unit: String,
464}
465
466#[derive(Debug, Clone, Serialize)]
467#[serde(rename_all = "camelCase")]
468pub struct CoverageSnapshot {
469    pub complete: bool,
470    pub pending: Vec<WindowUnitRef>,
471    pub missing: Vec<WindowUnitRef>,
472}
473
474/// §7.5: the query that owns a snapshot read. The id is application-owned,
475/// stable, and PHI-free; generated named queries pass their `ID` and `TABLES`.
476#[derive(Debug, Clone, Copy)]
477pub struct QueryOwner<'a> {
478    pub id: &'a str,
479    pub tables: &'a [&'a str],
480}
481
482/// §7.5: a failed snapshot read. `code` is `client.storage_corrupt` or
483/// `client.storage_io` when SQLite reported corruption or I/O failure, and
484/// `None` for every other failure, which keeps its existing message.
485#[derive(Debug, Clone, PartialEq, Eq)]
486pub struct QueryReadFailure {
487    pub code: Option<&'static str>,
488    pub sqlite_code: Option<i32>,
489    pub sqlite_message: Option<String>,
490    pub rollback_failure: Option<Box<QueryReadFailure>>,
491    pub message: String,
492}
493
494impl std::fmt::Display for QueryReadFailure {
495    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
496        match self.code {
497            Some(code) => write!(f, "{code}: {}", self.message),
498            None => f.write_str(&self.message),
499        }
500    }
501}
502
503impl From<String> for QueryReadFailure {
504    fn from(message: String) -> Self {
505        Self {
506            code: None,
507            sqlite_code: None,
508            sqlite_message: None,
509            rollback_failure: None,
510            message,
511        }
512    }
513}
514
515impl From<rusqlite::Error> for QueryReadFailure {
516    /// Classify by SQLite's primary result code, never by message text.
517    fn from(error: rusqlite::Error) -> Self {
518        let sqlite_code = match &error {
519            rusqlite::Error::SqliteFailure(failure, _) => Some(failure.extended_code),
520            _ => None,
521        };
522        match sqlite_code.map(|code| code & 0xff) {
523            Some(11 | 26) => Self {
524                code: Some("client.storage_corrupt"),
525                sqlite_code,
526                sqlite_message: Some(error.to_string()),
527                rollback_failure: None,
528                message: "local SQLite storage is corrupt".to_owned(),
529            },
530            Some(13) => Self {
531                code: Some("client.storage_full"),
532                sqlite_code,
533                sqlite_message: Some(error.to_string()),
534                rollback_failure: None,
535                message: "local SQLite storage is full".to_owned(),
536            },
537            Some(10) => Self {
538                code: Some("client.storage_io"),
539                sqlite_code,
540                sqlite_message: Some(error.to_string()),
541                rollback_failure: None,
542                message: "local SQLite storage I/O failed".to_owned(),
543            },
544            _ => Self {
545                code: None,
546                sqlite_code,
547                sqlite_message: Some(error.to_string()),
548                rollback_failure: None,
549                message: error.to_string(),
550            },
551        }
552    }
553}
554
555impl QueryReadFailure {
556    pub fn details(&self) -> Option<Value> {
557        self.sqlite_code.map(|code| {
558            let mut details =
559                serde_json::json!({ "sqliteCode": code, "sqliteMessage": self.sqlite_message });
560            if let Some(rollback) = &self.rollback_failure {
561                details["rollbackFailure"] = serde_json::json!({
562                    "sqliteCode": rollback.sqlite_code, "message": rollback.sqlite_message
563                });
564            }
565            details
566        })
567    }
568}
569
570#[derive(Debug, Clone, Serialize)]
571#[serde(rename_all = "camelCase")]
572pub struct QuerySnapshot {
573    pub revision: String,
574    pub rows: Vec<QueryRow>,
575    pub coverage: CoverageSnapshot,
576}
577
578impl WindowState {
579    /// The per-unit verdict: registered AND bootstrap-complete.
580    #[must_use]
581    pub fn complete(&self, unit: &str) -> bool {
582        self.units.iter().any(|u| u == unit) && !self.pending.iter().any(|u| u == unit)
583    }
584}
585
586/// One local mutation (§6.1 shapes, schema-agnostic local form per §0).
587#[derive(Debug, Clone)]
588pub enum Mutation {
589    Patch {
590        table: String,
591        values: Map<String, Value>,
592        base_version: Option<i64>,
593    },
594    Upsert {
595        table: String,
596        values: Map<String, Value>,
597        base_version: Option<i64>,
598    },
599    Delete {
600        table: String,
601        row_id: String,
602        base_version: Option<i64>,
603    },
604}
605
606#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq)]
607#[serde(rename_all = "camelCase")]
608pub struct SchemaFloor {
609    #[serde(skip_serializing_if = "Option::is_none")]
610    pub required_schema_version: Option<i32>,
611    #[serde(skip_serializing_if = "Option::is_none")]
612    pub latest_schema_version: Option<i32>,
613}
614
615/// §7.3.5: the client's opaque auth-lease state — `leaseId`/`expiresAtMs`
616/// from the last `LEASE` frame, and `errorCode` once a round was rejected
617/// with a request-level lease code (stop-and-surface; no data purge).
618#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq)]
619#[serde(rename_all = "camelCase")]
620pub struct LeaseState {
621    #[serde(skip_serializing_if = "Option::is_none")]
622    pub lease_id: Option<String>,
623    #[serde(skip_serializing_if = "Option::is_none")]
624    pub expires_at_ms: Option<i64>,
625    #[serde(skip_serializing_if = "Option::is_none")]
626    pub error_code: Option<String>,
627}
628
629/// §8.6 a peer's ephemeral presence document on a scope key.
630#[derive(Debug, Clone, Serialize)]
631#[serde(rename_all = "camelCase")]
632pub struct PresencePeer {
633    pub actor_id: String,
634    pub client_id: String,
635    pub doc: serde_json::Value,
636}
637
638#[derive(Debug, Clone, Serialize, Default)]
639#[serde(rename_all = "camelCase")]
640pub struct SyncReport {
641    pub pushed: u32,
642    pub applied: Vec<String>,
643    pub rejected: Vec<String>,
644    pub retryable: Vec<String>,
645    pub conflicts: u32,
646    pub commits_applied: u32,
647    pub segment_rows_applied: u32,
648    pub bootstrapping: Vec<String>,
649    pub resets: Vec<String>,
650    pub revoked: Vec<String>,
651    pub failed: Vec<String>,
652    pub deferred_commits: usize,
653    #[serde(skip_serializing_if = "Option::is_none")]
654    pub schema_floor: Option<SchemaFloor>,
655}
656
657/// `sync()` never panics or errors out-of-band: transport and protocol
658/// failures come back as `Failed` (the driver's `{ ok: false }`).
659#[derive(Debug, Clone)]
660pub enum SyncOutcome {
661    Ok(SyncReport),
662    Failed {
663        error_code: String,
664        message: String,
665        details: Option<Value>,
666    },
667    /// §8.8: the `required` policy refused a round because the socket is not
668    /// connected. `reason_code` is present for `lost` and `refused` states,
669    /// and `retry_delay_ms` is the delay of the background retry intent this
670    /// outcome scheduled.
671    RealtimeUnavailable {
672        state: RealtimeState,
673        reason_code: Option<String>,
674        retry_delay_ms: u64,
675    },
676}
677
678impl SyncOutcome {
679    pub fn to_json(&self) -> Value {
680        match self {
681            SyncOutcome::Ok(report) => {
682                let mut map = Map::new();
683                map.insert("ok".to_owned(), Value::Bool(true));
684                map.insert(
685                    "report".to_owned(),
686                    serde_json::to_value(report).expect("report serializes"),
687                );
688                Value::Object(map)
689            }
690            SyncOutcome::Failed {
691                error_code,
692                message,
693                details,
694            } => {
695                let mut map = Map::new();
696                map.insert("ok".to_owned(), Value::Bool(false));
697                map.insert("errorCode".to_owned(), Value::from(error_code.clone()));
698                map.insert("message".to_owned(), Value::from(message.clone()));
699                if let Some(details) = details {
700                    map.insert("details".to_owned(), details.clone());
701                }
702                Value::Object(map)
703            }
704            SyncOutcome::RealtimeUnavailable {
705                state,
706                reason_code,
707                retry_delay_ms,
708            } => {
709                let mut map = Map::new();
710                map.insert("ok".to_owned(), Value::Bool(false));
711                map.insert(
712                    "errorCode".to_owned(),
713                    Value::from(REALTIME_UNAVAILABLE_CODE),
714                );
715                map.insert(
716                    "message".to_owned(),
717                    Value::from("realtime is required and the realtime socket is not connected"),
718                );
719                map.insert(
720                    "realtimeState".to_owned(),
721                    serde_json::to_value(state).expect("state serializes"),
722                );
723                if let Some(reason_code) = reason_code {
724                    map.insert(
725                        "realtimeReasonCode".to_owned(),
726                        Value::from(reason_code.clone()),
727                    );
728                }
729                map.insert("retryDelayMs".to_owned(), Value::from(*retry_delay_ms));
730                Value::Object(map)
731            }
732        }
733    }
734}
735
736#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
737#[serde(rename_all = "camelCase")]
738pub struct ConflictRecord {
739    pub client_commit_id: String,
740    pub op_index: i32,
741    pub table: String,
742    pub row_id: String,
743    pub code: String,
744    pub message: String,
745    pub server_version: i64,
746    /// Driver row (bytes as `{"$bytes": hex}`), decoded from the conflict
747    /// record's `serverRow` (§6.3).
748    pub server_row: Map<String, Value>,
749    /// §6.3 `conflictColumns`: the present columns whose `column_version`
750    /// exceeded `baseVersion`, decoded from the bitmap into column names in
751    /// declaration order. Absent on a legacy journal entry, which reads as an
752    /// empty list.
753    #[serde(default, skip_serializing_if = "Vec::is_empty")]
754    pub conflict_columns: Vec<String>,
755    #[serde(skip_serializing_if = "Option::is_none")]
756    pub operation: Option<CommitOperation>,
757}
758
759/// Bounded code-like metadata explicitly declared safe for authorized client
760/// recovery UI. Diagnostic prose remains in `RejectionRecord.message`.
761#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
762#[serde(rename_all = "camelCase", deny_unknown_fields)]
763pub struct RejectionDetails {
764    #[serde(skip_serializing_if = "Option::is_none")]
765    pub field_paths: Option<Vec<String>>,
766    #[serde(skip_serializing_if = "Option::is_none")]
767    pub reason: Option<String>,
768    #[serde(skip_serializing_if = "Option::is_none")]
769    pub required_action: Option<String>,
770    #[serde(skip_serializing_if = "Option::is_none")]
771    pub references: Option<BTreeMap<String, String>>,
772}
773
774impl RejectionDetails {
775    pub(crate) fn parse(raw: &str) -> Result<Self, String> {
776        if raw.len() > 4_096 {
777            return Err("rejection details exceed 4096 encoded bytes".to_owned());
778        }
779        let details: Self = serde_json::from_str(raw)
780            .map_err(|error| format!("invalid rejection details: {error}"))?;
781        details.validate()?;
782        Ok(details)
783    }
784
785    fn validate(&self) -> Result<(), String> {
786        let mut members = 0;
787        if let Some(paths) = &self.field_paths {
788            members += 1;
789            if paths.is_empty() || paths.len() > 32 {
790                return Err("fieldPaths must contain 1-32 paths".to_owned());
791            }
792            let mut seen = std::collections::BTreeSet::new();
793            for path in paths {
794                if path.len() > 160 || !path.split('.').all(valid_identifier) || !seen.insert(path)
795                {
796                    return Err("fieldPaths contains an invalid or duplicate path".to_owned());
797                }
798            }
799        }
800        if let Some(reason) = &self.reason {
801            members += 1;
802            if !valid_token(reason, 96) {
803                return Err("reason must be a lowercase stable token".to_owned());
804            }
805        }
806        if let Some(action) = &self.required_action {
807            members += 1;
808            if !valid_token(action, 96) {
809                return Err("requiredAction must be a lowercase stable token".to_owned());
810            }
811        }
812        if let Some(references) = &self.references {
813            members += 1;
814            if references.is_empty() || references.len() > 16 {
815                return Err("references must contain 1-16 entries".to_owned());
816            }
817            for (key, value) in references {
818                if !valid_token(key, 64)
819                    || value.is_empty()
820                    || value.len() > 256
821                    || value.trim() != value
822                    || value.chars().any(char::is_control)
823                {
824                    return Err("references contains an invalid key or value".to_owned());
825                }
826            }
827        }
828        if members == 0 {
829            return Err("rejection details must not be empty".to_owned());
830        }
831        Ok(())
832    }
833}
834
835fn valid_identifier(segment: &str) -> bool {
836    let mut chars = segment.chars();
837    matches!(chars.next(), Some(first) if first == '_' || first.is_ascii_alphabetic())
838        && chars.all(|character| character == '_' || character.is_ascii_alphanumeric())
839}
840
841fn valid_token(token: &str, max: usize) -> bool {
842    if token.is_empty() || token.len() > max || !token.starts_with(|c: char| c.is_ascii_lowercase())
843    {
844        return false;
845    }
846    let mut previous_separator = false;
847    for character in token.chars() {
848        if character.is_ascii_lowercase() || character.is_ascii_digit() {
849            previous_separator = false;
850        } else if matches!(character, '.' | '_' | '-') && !previous_separator {
851            previous_separator = true;
852        } else {
853            return false;
854        }
855    }
856    !previous_separator
857}
858
859#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
860#[serde(rename_all = "camelCase")]
861pub struct RejectionRecord {
862    pub client_commit_id: String,
863    pub op_index: i32,
864    pub code: String,
865    pub message: String,
866    pub retryable: bool,
867    #[serde(skip_serializing_if = "Option::is_none")]
868    pub details: Option<RejectionDetails>,
869    #[serde(skip_serializing_if = "Option::is_none")]
870    pub operation: Option<CommitOperation>,
871}
872
873/// Schema-agnostic local operation retained with a failed final outcome.
874#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
875#[serde(rename_all = "camelCase")]
876pub struct CommitOperation {
877    pub table: String,
878    pub row_id: String,
879    pub op: String,
880    #[serde(skip_serializing_if = "Option::is_none")]
881    pub base_version: Option<i64>,
882    #[serde(skip_serializing_if = "Option::is_none")]
883    pub values: Option<Map<String, Value>>,
884}
885
886#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
887#[serde(rename_all = "snake_case")]
888pub enum CommitOutcomeStatus {
889    Applied,
890    Cached,
891    Conflict,
892    Rejected,
893}
894
895#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
896#[serde(rename_all = "snake_case")]
897pub enum CommitOutcomeResolution {
898    Active,
899    ResolvedKeepServer,
900    Superseded,
901    Dismissed,
902}
903
904#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
905#[serde(tag = "status", rename_all = "snake_case")]
906pub enum CommitOperationOutcome {
907    Applied {
908        #[serde(rename = "opIndex")]
909        op_index: i32,
910    },
911    Conflict {
912        conflict: ConflictRecord,
913    },
914    Error {
915        rejection: RejectionRecord,
916    },
917}
918
919#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
920#[serde(rename_all = "camelCase")]
921pub struct RetainedCommitRow {
922    pub table: String,
923    pub row_id: String,
924    pub local_row: Option<Map<String, Value>>,
925    pub server_row: Option<Map<String, Value>>,
926    pub server_version: Option<i64>,
927}
928
929#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
930#[serde(rename_all = "camelCase")]
931pub struct CommitOutcome {
932    pub sequence: i64,
933    pub client_commit_id: String,
934    pub status: CommitOutcomeStatus,
935    pub recorded_at_ms: i64,
936    pub results: Vec<CommitOperationOutcome>,
937    /// Complete local failed-commit envelope retained after outbox drain.
938    /// Absent for successful and historical outcomes; never sent over wire.
939    #[serde(skip_serializing_if = "Option::is_none")]
940    pub operations: Option<Vec<CommitOperation>>,
941    #[serde(skip_serializing_if = "Option::is_none")]
942    pub retained_rows: Option<Vec<RetainedCommitRow>>,
943    pub resolution: CommitOutcomeResolution,
944    #[serde(skip_serializing_if = "Option::is_none")]
945    pub resolved_at_ms: Option<i64>,
946    #[serde(skip_serializing_if = "Option::is_none")]
947    pub replacement_client_commit_id: Option<String>,
948}
949
950#[derive(Debug, Clone, Deserialize, Default)]
951#[serde(rename_all = "camelCase")]
952pub struct CommitOutcomeQuery {
953    pub limit: Option<usize>,
954    #[serde(default)]
955    pub active_only: bool,
956}
957
958#[derive(Debug, Clone, Deserialize)]
959#[serde(rename_all = "camelCase")]
960pub struct ResolveCommitOutcomeInput {
961    pub client_commit_id: String,
962    pub resolution: CommitOutcomeResolution,
963    pub replacement_client_commit_id: Option<String>,
964}
965
966#[derive(Debug, Clone, Serialize)]
967#[serde(rename_all = "camelCase")]
968pub struct RowState {
969    pub row_id: String,
970    /// Local synced version: `-1` = optimistic, else the server version
971    /// (from a `COMMIT` change or a segment row record, §5.2/§5.6).
972    pub version: i64,
973    pub values: Map<String, Value>,
974}
975
976#[derive(Debug, Clone, Serialize)]
977#[serde(rename_all = "camelCase")]
978pub struct SubscriptionStateView {
979    pub id: String,
980    pub table: String,
981    /// `active` | `revoked` | `failed`.
982    pub status: String,
983    pub cursor: i64,
984    pub has_resume_token: bool,
985    #[serde(skip_serializing_if = "Option::is_none")]
986    pub effective_scopes: Option<Value>,
987    #[serde(skip_serializing_if = "Option::is_none")]
988    pub reason_code: Option<String>,
989}
990
991/// One AND-combined application-authorized local purge target. Targets in
992/// one input are OR-combined. Selector columns must compile to plaintext
993/// strings; values are bounded code-like routing identifiers.
994#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
995#[serde(rename_all = "camelCase", deny_unknown_fields)]
996pub struct LocalDataPurgeTarget {
997    pub table: String,
998    pub selectors: BTreeMap<String, Vec<String>>,
999}
1000
1001/// Durable local idempotency key plus exact routing targets. The host owns
1002/// directive authenticity and subscription gating; the client owns SQLite.
1003#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
1004#[serde(rename_all = "camelCase", deny_unknown_fields)]
1005pub struct LocalDataPurgeInput {
1006    pub purge_id: String,
1007    pub targets: Vec<LocalDataPurgeTarget>,
1008}
1009
1010/// Privacy-safe local purge acknowledgement; row ids never cross the bridge.
1011#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
1012#[serde(rename_all = "camelCase")]
1013pub struct LocalDataPurgeResult {
1014    pub already_applied: bool,
1015    pub purged_rows: usize,
1016    pub dropped_commits: usize,
1017}
1018
1019/// Durable application repair id. Reusing the id is an exact no-op.
1020#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
1021#[serde(rename_all = "camelCase", deny_unknown_fields)]
1022pub struct LocalDataRebootstrapInput {
1023    pub rebootstrap_id: String,
1024}
1025
1026/// Privacy-safe acknowledgement for a replicated-projection recovery.
1027#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
1028#[serde(rename_all = "camelCase")]
1029pub struct LocalDataRebootstrapResult {
1030    pub already_applied: bool,
1031    pub retained_commits: usize,
1032    pub reset_subscriptions: usize,
1033}
1034
1035/// Client limits (§4.2 request knobs).
1036#[derive(Debug, Clone, Default)]
1037pub struct ClientLimits {
1038    pub limit_commits: Option<i32>,
1039    pub limit_snapshot_rows: Option<i32>,
1040    pub max_snapshot_pages: Option<i32>,
1041    /// §4.2 accept bitmask; this client defaults to `0b0111` (rows
1042    /// baseline + sqlite images, §5.3 — rusqlite can always import).
1043    pub accept: Option<u8>,
1044    /// §5.9.7 B1 blob-cache size cap (bytes). When set and the sum of cached
1045    /// body sizes exceeds it, unreferenced bodies without pending work are
1046    /// evicted by creation timestamp after each cache write. `None` retains bodies
1047    /// until storage pressure (default).
1048    pub blob_cache_max_bytes: Option<i64>,
1049    /// Maximum durable final outcomes. Active conflicts/rejections are never
1050    /// pruned to satisfy the cap. Defaults to 1,000.
1051    pub outcome_retention_max_entries: Option<usize>,
1052    /// RFC 0005 D8: the previous-version capture config. Absent or
1053    /// `enabled: false` runs the feature off (default); the descriptor write
1054    /// and the container orphan sweep still happen.
1055    pub previous_version_context: Option<PreviousVersionContextConfig>,
1056}
syncular_client/api.rs

syncular_client/
api.rs
