lash-remote-protocol 0.1.0-alpha.104

Versioned remote embedding protocol DTOs for Lash sessions, turns, activities, tools, and LLM calls.
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Transport-neutral foreground-turn cancellation envelopes.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::registry_errors::{RemoteProtocolError, require_non_empty};
use crate::{REMOTE_PROTOCOL_VERSION, ensure_protocol_version};

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum RemoteTurnControlDurabilityTier {
    Inline,
    Durable,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct RemoteTurnCancellationEvidence {
    pub request_id: String,
    /// Opaque host-domain data; Lash records and returns it unchanged.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub origin: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
}

impl RemoteTurnCancellationEvidence {
    pub fn validate(&self) -> Result<(), RemoteProtocolError> {
        require_non_empty(
            "RemoteTurnCancellationEvidence",
            "request_id",
            &self.request_id,
        )
    }
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct RemoteTurnCancelRequest {
    pub protocol_version: u32,
    pub session_id: String,
    pub turn_id: String,
    pub request_id: String,
    /// Opaque host-domain data; Lash never interprets this value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub origin: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
}

impl RemoteTurnCancelRequest {
    pub fn validate(&self) -> Result<(), RemoteProtocolError> {
        ensure_protocol_version(self.protocol_version)?;
        require_non_empty("RemoteTurnCancelRequest", "session_id", &self.session_id)?;
        require_non_empty("RemoteTurnCancelRequest", "turn_id", &self.turn_id)?;
        require_non_empty("RemoteTurnCancelRequest", "request_id", &self.request_id)
    }
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(tag = "outcome", rename_all = "snake_case")]
pub enum RemoteTurnCancelOutcome {
    Requested {
        cancellation: RemoteTurnCancellationEvidence,
    },
    AlreadyRequested {
        cancellation: RemoteTurnCancellationEvidence,
    },
    CompletionWonRace,
    UnknownOrRevoked,
}

impl RemoteTurnCancelOutcome {
    fn validate(&self) -> Result<(), RemoteProtocolError> {
        match self {
            Self::Requested { cancellation } | Self::AlreadyRequested { cancellation } => {
                cancellation.validate()
            }
            Self::CompletionWonRace | Self::UnknownOrRevoked => Ok(()),
        }
    }
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct RemoteTurnCancelReceipt {
    pub protocol_version: u32,
    pub session_id: String,
    pub turn_id: String,
    pub durability_tier: RemoteTurnControlDurabilityTier,
    pub outcome: RemoteTurnCancelOutcome,
}

impl RemoteTurnCancelReceipt {
    pub fn new(
        session_id: impl Into<String>,
        turn_id: impl Into<String>,
        durability_tier: RemoteTurnControlDurabilityTier,
        outcome: RemoteTurnCancelOutcome,
    ) -> Self {
        Self {
            protocol_version: REMOTE_PROTOCOL_VERSION,
            session_id: session_id.into(),
            turn_id: turn_id.into(),
            durability_tier,
            outcome,
        }
    }

    pub fn validate(&self) -> Result<(), RemoteProtocolError> {
        ensure_protocol_version(self.protocol_version)?;
        require_non_empty("RemoteTurnCancelReceipt", "session_id", &self.session_id)?;
        require_non_empty("RemoteTurnCancelReceipt", "turn_id", &self.turn_id)?;
        self.outcome.validate()
    }
}