meerkat-live 0.8.10

Live multimodal transport for Meerkat — composable WebSocket bridge between clients and LiveAdapterHost
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

//! meerkat-live — Live multimodal transport for Meerkat.
//!
//! Composable WebSocket bridge between browser/test clients and
//! `LiveAdapterHost`. Any Meerkat surface (CLI, RPC, REST, MCP) can
//! mount the axum router or start a standalone listener.
//!
//! Frame protocol: client sends `LiveInputChunk` JSON, receives
//! `LiveAdapterObservation` JSON. Token-based channel auth.

pub mod host;
pub mod transport;
#[cfg(feature = "webrtc")]
pub mod webrtc;
pub mod wire_input;

pub use host::{
    DEFAULT_LIVE_TOOL_TIMEOUT, DeltaIdentity, LiveAdapterHost, LiveAdapterHostError,
    LiveChannelCloseCommitAuthority, LiveChannelCloseObservation, LiveChannelId,
    LiveChannelOpenAuthority, LiveChannelStatusCommitAuthority, LiveChannelStatusObservation,
    LiveCommandAcceptanceKind, LiveCommandQueueAcceptance, LiveProjectionError, LiveProjectionSink,
    LiveRefreshQueueAcceptance, LiveToolDispatchError, LiveToolDispatchTimeout, LiveToolDispatcher,
    LiveTranscriptIdentity, LiveTranscriptIdentityError, NoOpProjectionSink, ObservationOutcome,
    ObservationRouting, ToolDispatchSkipReason,
};
pub use transport::{
    LIVE_WS_PATH, LiveChannelCloseFeedback, LiveChannelStatusFeedback, LiveTokenString,
    LiveWsState, LiveWsTokenAdmission, LiveWsTokenAdmissionPublicErrorClass,
    LiveWsTokenAdmissionRejection, LiveWsTokenAuthority, LiveWsTokenIssue, live_ws_router,
    serve_live_ws_listener,
};
#[cfg(feature = "webrtc")]
pub use webrtc::{
    LIVE_WEBRTC_ANSWER_METHOD, LIVE_WEBRTC_ANSWER_PATH, LiveWebrtcAnswerAccepted, LiveWebrtcError,
    LiveWebrtcState, WebrtcAudioBridge, live_webrtc_router, serve_live_ws_and_webrtc_listener,
};
pub use wire_input::{
    LiveInputChunkDecodeError, live_input_chunk_decode_rejection, live_input_chunk_from_wire,
};

// E26 regression: `meerkat-live` must not depend on `meerkat-runtime`. The
// dependency direction is: `meerkat-live` owns the live-adapter host
// (`crate::host`) and the transport (`crate::transport`); surfaces compose
// the two with their own session-runtime backing. A previous design had
// `LiveAdapterHost` living in `meerkat-runtime` and `meerkat-live`
// depending on it — wrong direction (transport pulling runtime). This
// inline test parses `Cargo.toml` at compile time and asserts the
// `meerkat-runtime` line is absent. Anyone who re-introduces the dep will
// fail this test before E26 silently regresses.
#[cfg(test)]
mod e26_dependency_direction {
    /// E26: `meerkat-live` must not list `meerkat-runtime` as a dependency.
    /// We read `Cargo.toml` via `include_str!` (compile-time embed, no I/O
    /// at test runtime) and assert the line is absent. This catches both
    /// `meerkat-runtime = { workspace = true }` and the older
    /// `meerkat-runtime = "..."` shapes; we simply look for the bare
    /// crate name as a TOML key.
    #[test]
    fn cargo_toml_does_not_depend_on_meerkat_runtime() {
        let cargo_toml = include_str!("../Cargo.toml");
        // Per-line scan so we don't trip on the word in a comment (none
        // present today, but futureproof against documentation drift).
        for line in cargo_toml.lines() {
            let trimmed = line.trim_start();
            assert!(
                !trimmed.starts_with("meerkat-runtime"),
                "E26 regression: meerkat-live must not depend on meerkat-runtime; \
                 found Cargo.toml line: {line}"
            );
        }
    }

    #[test]
    fn webrtc_media_dependencies_are_feature_gated() {
        let cargo_toml = include_str!("../Cargo.toml");
        assert!(
            cargo_toml.lines().any(|line| line.trim() == "default = []"),
            "meerkat-live default feature set must not enable WebRTC/media"
        );
        for dep in ["webrtc", "webrtc-media", "opus", "rubato"] {
            let needle = format!("{dep} = ");
            let dep_line = cargo_toml
                .lines()
                .find(|line| line.trim_start().starts_with(&needle))
                .unwrap_or_else(|| panic!("missing optional {dep} dependency"));
            assert!(
                dep_line.contains("optional = true"),
                "{dep} dependency must stay optional: {dep_line}"
            );
        }
    }
}