mempill-types 0.2.0

Shared domain types for the mempill bi-temporal AI-agent memory engine (ProvenanceLabel, Disposition, Claim, LedgerEntry, and more)
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

//! Identity types: opaque, stable identifiers used as primary keys and partition keys.

/// Opaque stable identifier for a memory agent. Primary partition key everywhere.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(transparent)]
pub struct AgentId(pub String);

/// Opaque, stable, immutable identity of a committed claim. Minted once at injection time.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(transparent)]
pub struct ClaimRef(pub uuid::Uuid);

impl ClaimRef {
    /// Mint a new random ClaimRef.
    pub fn new_random() -> Self {
        Self(uuid::Uuid::new_v4())
    }
}

/// Compound key identifying the (agent_id, subject, predicate) subject-line.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub struct SubjectLineRef {
    /// The agent that owns this subject-line.
    pub agent_id: AgentId,
    /// The entity being described.
    pub subject: String,
    /// The aspect being asserted.
    pub predicate: String,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn agent_id_equality() {
        let a = AgentId("agent-1".into());
        let b = AgentId("agent-1".into());
        assert_eq!(a, b);
    }

    #[test]
    fn claim_ref_new_random_is_unique() {
        let r1 = ClaimRef::new_random();
        let r2 = ClaimRef::new_random();
        assert_ne!(r1, r2);
    }

    #[test]
    fn claim_ref_round_trip_serde() {
        let r = ClaimRef::new_random();
        let json = serde_json::to_string(&r).unwrap();
        let back: ClaimRef = serde_json::from_str(&json).unwrap();
        assert_eq!(r, back);
    }

    #[test]
    fn claim_ref_serializes_as_bare_uuid_string() {
        let uuid = uuid::Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000").unwrap();
        let r = ClaimRef(uuid);
        let json = serde_json::to_string(&r).unwrap();
        assert_eq!(json, r#""550e8400-e29b-41d4-a716-446655440000""#);
        let back: ClaimRef = serde_json::from_str(&json).unwrap();
        assert_eq!(r, back);
    }

    #[test]
    fn agent_id_serializes_as_bare_string() {
        let id = AgentId("my-agent".into());
        let json = serde_json::to_string(&id).unwrap();
        assert_eq!(json, r#""my-agent""#);
        let back: AgentId = serde_json::from_str(&json).unwrap();
        assert_eq!(id, back);
    }

    #[test]
    fn subject_line_ref_equality() {
        let s1 = SubjectLineRef {
            agent_id: AgentId("a".into()),
            subject: "user".into(),
            predicate: "name".into(),
        };
        let s2 = s1.clone();
        assert_eq!(s1, s2);
    }
}