khive-types 0.13.0

Core type primitives: Id128, Timestamp, Namespace, and the 3 substrate data types (Note, Entity, Event).
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use super::*;
use crate::{Id128, Namespace};
#[cfg(feature = "serde")]
use alloc::string::ToString;

fn test_header() -> Header {
    Header::new(
        Id128::from_u128(1),
        Namespace::local(),
        Timestamp::from_secs(1700000000),
    )
}

#[test]
fn note_construction() {
    let note = Note {
        header: test_header(),
        kind: String::from("decision"),
        status: NoteStatus::Active,
        content: String::from("Use BGE-base for multilingual corpus"),
        properties: BTreeMap::new(),
        tags: alloc::vec!["retrieval".into()],
        salience: Some(0.8),
        decay_factor: Some(0.01),
        expires_at: None,
        deleted_at: None,
    };
    assert_eq!(note.kind, "decision");
    assert_eq!(note.tags.len(), 1);
}

#[test]
fn note_construction_uses_pack_owned_kind_string() {
    let note = Note {
        header: test_header(),
        kind: String::from("decision"),
        status: NoteStatus::Active,
        content: String::from("test"),
        properties: BTreeMap::new(),
        tags: alloc::vec![],
        salience: None,
        decay_factor: None,
        expires_at: None,
        deleted_at: None,
    };
    assert_eq!(note.kind, "decision");
}

#[test]
fn note_status_deleted_roundtrip() {
    use core::str::FromStr;
    assert_eq!(
        NoteStatus::from_str("deleted").unwrap(),
        NoteStatus::Deleted
    );
    assert_eq!(NoteStatus::Deleted.name(), "deleted");
}

#[test]
fn note_is_valid_checks_salience_range() {
    let mut note = Note {
        header: test_header(),
        kind: String::from("observation"),
        status: NoteStatus::Active,
        content: String::from("test"),
        properties: BTreeMap::new(),
        tags: alloc::vec![],
        salience: Some(1.5),
        decay_factor: None,
        expires_at: None,
        deleted_at: None,
    };
    assert!(!note.is_valid());
    note.salience = Some(0.5);
    assert!(note.is_valid());
}

#[test]
fn note_is_valid_checks_decay_non_negative() {
    let mut note = Note {
        header: test_header(),
        kind: String::from("observation"),
        status: NoteStatus::Active,
        content: String::from("test"),
        properties: BTreeMap::new(),
        tags: alloc::vec![],
        salience: None,
        decay_factor: Some(-0.1),
        expires_at: None,
        deleted_at: None,
    };
    assert!(!note.is_valid());
    note.decay_factor = Some(0.01);
    assert!(note.is_valid());
}

#[cfg(feature = "serde")]
#[test]
fn note_serde_rejects_salience_above_one() {
    let json = serde_json::json!({
        "id": "00000000-0000-0000-0000-000000000001",
        "namespace": "local",
        "created_at": 1700000000000000_u64,
        "updated_at": 1700000000000000_u64,
        "kind": "observation",
        "status": "active",
        "content": "test",
        "properties": {},
        "tags": [],
        "salience": 1.5,
        "decay_factor": null,
        "expires_at": null,
        "deleted_at": null
    });
    let result: Result<Note, _> = serde_json::from_value(json);
    assert!(result.is_err());
    let err = result.unwrap_err().to_string();
    assert!(
        err.contains("[0.0, 1.0]"),
        "error should mention range: {err}"
    );
}

#[cfg(feature = "serde")]
#[test]
fn note_serde_rejects_negative_decay() {
    let json = serde_json::json!({
        "id": "00000000-0000-0000-0000-000000000001",
        "namespace": "local",
        "created_at": 1700000000000000_u64,
        "updated_at": 1700000000000000_u64,
        "kind": "observation",
        "status": "active",
        "content": "test",
        "properties": {},
        "tags": [],
        "salience": null,
        "decay_factor": -0.5,
        "expires_at": null,
        "deleted_at": null
    });
    let result: Result<Note, _> = serde_json::from_value(json);
    assert!(result.is_err());
    let err = result.unwrap_err().to_string();
    assert!(
        err.contains("non-negative"),
        "error should mention non-negative: {err}"
    );
}

#[cfg(feature = "serde")]
#[test]
fn note_serde_accepts_valid_values() {
    let json = serde_json::json!({
        "id": "00000000-0000-0000-0000-000000000001",
        "namespace": "local",
        "created_at": 1700000000000000_u64,
        "updated_at": 1700000000000000_u64,
        "kind": "decision",
        "status": "active",
        "content": "test content",
        "properties": {},
        "tags": ["tag1"],
        "salience": 0.8,
        "decay_factor": 0.01,
        "expires_at": null,
        "deleted_at": null
    });
    let note: Note = serde_json::from_value(json).expect("valid note should deserialize");
    assert_eq!(note.salience, Some(0.8));
    assert_eq!(note.decay_factor, Some(0.01));
}