umf 0.2.6

Universal Message Format (UMF) - Provider-agnostic message representation for LLM interactions with ChatML formatting, internal hub model, and MCP support
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

//! Event envelope for type-erased event storage

use super::traits::EventType;
use super::{MessageEvent, ToolCallEvent, ToolResultEvent};
use serde::{Deserialize, Serialize};

/// Event envelope for storage and serialization
///
/// This provides a uniform wrapper for any event type, suitable for
/// JSONL storage where each line is a single envelope.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EventEnvelope {
    /// Unique event ID
    pub event_id: String,

    /// Event type discriminator
    pub event_type: EventType,

    /// Session this event belongs to
    pub session_id: String,

    /// Project hash (for storage routing)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub project_hash: Option<String>,

    /// Event timestamp (Unix milliseconds)
    pub timestamp_ms: u64,

    /// Sequence number for ordering within session
    pub sequence: u32,

    /// Type-specific payload
    pub payload: serde_json::Value,
}

impl EventEnvelope {
    /// Create a message event envelope
    pub fn message(event: MessageEvent) -> Self {
        Self {
            event_id: event.event_id.clone(),
            event_type: EventType::Message,
            session_id: event.session_id.clone(),
            project_hash: event.project_hash.clone(),
            timestamp_ms: event.timestamp_ms,
            sequence: event.sequence,
            payload: serde_json::to_value(&event).unwrap(),
        }
    }

    /// Create a tool call event envelope
    pub fn tool_call(event: ToolCallEvent) -> Self {
        Self {
            event_id: event.event_id.clone(),
            event_type: EventType::ToolCall,
            session_id: event.session_id.clone(),
            project_hash: event.project_hash.clone(),
            timestamp_ms: event.timestamp_ms,
            sequence: event.sequence,
            payload: serde_json::to_value(&event).unwrap(),
        }
    }

    /// Create a tool result event envelope
    pub fn tool_result(event: ToolResultEvent) -> Self {
        Self {
            event_id: event.event_id.clone(),
            event_type: EventType::ToolResult,
            session_id: event.session_id.clone(),
            project_hash: event.project_hash.clone(),
            timestamp_ms: event.timestamp_ms,
            sequence: event.sequence,
            payload: serde_json::to_value(&event).unwrap(),
        }
    }

    /// Extract as message event
    pub fn as_message_event(&self) -> Option<MessageEvent> {
        if self.event_type == EventType::Message {
            serde_json::from_value(self.payload.clone()).ok()
        } else {
            None
        }
    }

    /// Extract as tool call event
    pub fn as_tool_call_event(&self) -> Option<ToolCallEvent> {
        if self.event_type == EventType::ToolCall {
            serde_json::from_value(self.payload.clone()).ok()
        } else {
            None
        }
    }

    /// Extract as tool result event
    pub fn as_tool_result_event(&self) -> Option<ToolResultEvent> {
        if self.event_type == EventType::ToolResult {
            serde_json::from_value(self.payload.clone()).ok()
        } else {
            None
        }
    }

    /// Serialize to JSON string (for JSONL storage)
    pub fn to_json_line(&self) -> String {
        serde_json::to_string(self).unwrap()
    }

    /// Parse from JSON string (for JSONL reading)
    pub fn from_json_line(line: &str) -> Result<Self, serde_json::Error> {
        serde_json::from_str(line)
    }
}