kg-cli 0.2.16

A knowledge graph CLI tool for managing structured information
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
use anyhow::{Result, anyhow, bail};

use crate::graph::{Edge, GraphFile, Node};
use crate::validate::{
    edge_type_rule, format_edge_source_type_error, format_edge_target_type_error,
    is_valid_node_type, is_valid_relation,
};

// ---------------------------------------------------------------------------
// Node mutations
// ---------------------------------------------------------------------------

pub fn validate_node(node: &Node) -> Result<()> {
    if !is_valid_node_type(&node.r#type) {
        bail!(
            "invalid node_type '{}'. Valid types: {:?}",
            node.r#type,
            crate::validate::VALID_TYPES
        );
    }
    if let Err(error) = crate::validate::canonicalize_node_id_for_type(&node.id, &node.r#type) {
        bail!(error);
    }
    validate_required_metadata(node)?;
    Ok(())
}

pub fn add_node(graph: &mut GraphFile, mut node: Node) -> Result<()> {
    normalize_sources(&mut node.source_files);
    validate_node(&node)?;
    if graph.node_by_id(&node.id).is_some() {
        bail!("node already exists: {}", node.id);
    }
    graph.nodes.push(node);
    graph.refresh_counts();
    Ok(())
}

#[allow(clippy::too_many_arguments)]
pub fn modify_node(
    graph: &mut GraphFile,
    id: &str,
    node_type: Option<String>,
    name: Option<String>,
    description: Option<String>,
    domain_area: Option<String>,
    provenance: Option<String>,
    confidence: Option<f64>,
    created_at: Option<String>,
    importance: Option<f64>,
    facts: Vec<String>,
    aliases: Vec<String>,
    sources: Vec<String>,
    valid_from: Option<String>,
    valid_to: Option<String>,
) -> Result<()> {
    let idx = graph
        .nodes
        .iter()
        .position(|node| node.id == id)
        .ok_or_else(|| anyhow!("node not found: {id}"))?;

    let mut updated = graph.nodes[idx].clone();

    if let Some(v) = node_type {
        updated.r#type = v;
    }
    if let Some(v) = name {
        updated.name = v;
    }
    if let Some(v) = description {
        updated.properties.description = v;
    }
    if let Some(v) = domain_area {
        updated.properties.domain_area = v;
    }
    if let Some(v) = provenance {
        updated.properties.provenance = v;
    }
    if let Some(v) = confidence {
        updated.properties.confidence = Some(v);
    }
    if let Some(v) = created_at {
        updated.properties.created_at = v;
    }
    if let Some(v) = importance {
        validate_importance(v)?;
        updated.properties.importance = v;
    }
    for fact in facts {
        push_unique(&mut updated.properties.key_facts, fact);
    }
    for alias in aliases {
        push_unique(&mut updated.properties.alias, alias);
    }
    for source in sources {
        push_unique(&mut updated.source_files, source);
    }
    if let Some(v) = valid_from {
        updated.properties.valid_from = v;
    }
    if let Some(v) = valid_to {
        updated.properties.valid_to = v;
    }

    normalize_sources(&mut updated.source_files);

    validate_node(&updated)?;
    graph.nodes[idx] = updated;

    graph.refresh_counts();
    Ok(())
}

fn validate_importance(value: f64) -> Result<()> {
    if crate::validate::is_valid_importance(value) {
        return Ok(());
    }
    bail!("importance must be in range 0..1, got {value}")
}

fn validate_required_metadata(node: &Node) -> Result<()> {
    if node.name.trim().is_empty() {
        bail!("name is required and cannot be empty");
    }
    if node.properties.description.trim().is_empty() {
        bail!("description is required and cannot be empty");
    }
    if node.properties.domain_area.trim().is_empty() {
        bail!("domain_area is required and cannot be empty");
    }
    if node.properties.provenance.trim().is_empty() {
        bail!("provenance is required and cannot be empty");
    }
    if !crate::validate::VALID_PROVENANCE_CODES.contains(&node.properties.provenance.as_str()) {
        bail!(
            "provenance must be one of: {}",
            crate::validate::VALID_PROVENANCE_CODES.join(", ")
        );
    }
    let Some(confidence) = node.properties.confidence else {
        bail!("confidence is required and must be in range 0..1");
    };
    if !(0.0..=1.0).contains(&confidence) {
        bail!("confidence must be in range 0..1, got {confidence}");
    }
    if node.properties.created_at.trim().is_empty() {
        bail!("created_at is required and cannot be empty");
    }
    if !crate::validate::is_valid_iso_utc_timestamp(node.properties.created_at.trim()) {
        bail!("created_at must use UTC format YYYY-MM-DDTHH:MM:SSZ");
    }

    if node.source_files.is_empty() {
        bail!("at least one --source is required");
    }
    for source in &node.source_files {
        if let Err(err) = crate::validate::validate_source_reference(source) {
            bail!("invalid source '{}': {err}", source);
        }
    }

    validate_importance(node.properties.importance)?;
    Ok(())
}

pub fn remove_node(graph: &mut GraphFile, id: &str) -> Result<usize> {
    let before_nodes = graph.nodes.len();
    graph.nodes.retain(|node| node.id != id);
    if before_nodes == graph.nodes.len() {
        bail!("node not found: {id}");
    }
    let before_edges = graph.edges.len();
    graph
        .edges
        .retain(|edge| edge.source_id != id && edge.target_id != id);
    let removed_edges = before_edges - graph.edges.len();
    graph.refresh_counts();
    Ok(removed_edges)
}

// ---------------------------------------------------------------------------
// Edge mutations
// ---------------------------------------------------------------------------

pub fn validate_edge(graph: &GraphFile, edge: &Edge) -> Result<()> {
    if !is_valid_relation(&edge.relation) {
        bail!(
            "invalid relation '{}'. Valid: {:?}",
            edge.relation,
            crate::validate::VALID_RELATIONS
        );
    }

    if let Err(error) = crate::validate::validate_bidirectional_similarity_edge(
        &edge.source_id,
        &edge.relation,
        &edge.target_id,
        &edge.properties.detail,
        edge.properties.bidirectional,
    ) {
        bail!(error);
    }

    let src_node = graph.node_by_id(&edge.source_id);
    let tgt_node = graph.node_by_id(&edge.target_id);

    if let (Some(src), Some(tgt)) = (src_node, tgt_node) {
        if crate::validate::VALID_TYPES.contains(&src.r#type.as_str())
            && crate::validate::VALID_TYPES.contains(&tgt.r#type.as_str())
        {
            if let Some((src_types, tgt_types)) = edge_type_rule(edge.relation.as_str()) {
                if !src_types.is_empty() && !src_types.contains(&src.r#type.as_str()) {
                    bail!(
                        "{}",
                        format_edge_source_type_error(
                            &src.r#type,
                            edge.relation.as_str(),
                            src_types
                        )
                    );
                }
                if !tgt_types.is_empty() && !tgt_types.contains(&tgt.r#type.as_str()) {
                    bail!(
                        "{}",
                        format_edge_target_type_error(
                            &tgt.r#type,
                            edge.relation.as_str(),
                            tgt_types
                        )
                    );
                }
            }
        }
    }
    Ok(())
}

pub fn add_edge(graph: &mut GraphFile, edge: Edge) -> Result<()> {
    validate_edge(graph, &edge)?;
    if graph.node_by_id(&edge.source_id).is_none() {
        bail!("source node not found: {}", edge.source_id);
    }
    if graph.node_by_id(&edge.target_id).is_none() {
        bail!("target node not found: {}", edge.target_id);
    }
    if graph.has_edge(&edge.source_id, &edge.relation, &edge.target_id) {
        bail!(
            "edge already exists: {} {} {}",
            edge.source_id,
            edge.relation,
            edge.target_id
        );
    }
    graph.edges.push(edge);
    graph.refresh_counts();
    Ok(())
}

pub fn remove_edge(
    graph: &mut GraphFile,
    source_id: &str,
    relation: &str,
    target_id: &str,
) -> Result<()> {
    let before = graph.edges.len();
    graph.edges.retain(|edge| {
        !(edge.source_id == source_id && edge.relation == relation && edge.target_id == target_id)
    });
    if before == graph.edges.len() {
        bail!("edge not found: {source_id} {relation} {target_id}");
    }
    graph.refresh_counts();
    Ok(())
}

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

pub fn push_unique(items: &mut Vec<String>, value: String) {
    if !items.iter().any(|item| item == &value) {
        items.push(value);
    }
}

fn normalize_sources(sources: &mut Vec<String>) {
    for source in sources.iter_mut() {
        *source = crate::validate::normalize_source_reference(source);
    }
}

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

    fn valid_node(id: &str, name: &str, node_type: &str) -> crate::graph::Node {
        let mut properties = crate::graph::NodeProperties::default();
        properties.description = "Test description".to_owned();
        properties.domain_area = "test_domain".to_owned();
        properties.provenance = "U".to_owned();
        properties.confidence = Some(0.9);
        properties.created_at = "2026-01-01T00:00:00Z".to_owned();
        properties.importance = 0.8;
        crate::graph::Node {
            id: id.to_owned(),
            name: name.to_owned(),
            r#type: node_type.to_owned(),
            properties,
            source_files: vec!["DOC /tmp/test.md".to_owned()],
        }
    }

    #[test]
    fn push_unique_adds_new_items() {
        let mut items = vec!["a".to_string(), "b".to_string()];
        push_unique(&mut items, "c".to_string());
        assert_eq!(items, vec!["a", "b", "c"]);
    }

    #[test]
    fn push_unique_ignores_duplicates() {
        let mut items = vec!["a".to_string(), "b".to_string()];
        push_unique(&mut items, "a".to_string());
        assert_eq!(items, vec!["a", "b"]);
    }

    #[test]
    fn add_node_rejects_duplicate_id() {
        use crate::graph::GraphFile;
        let mut graph = GraphFile::new("test");
        let node = valid_node("concept:n1", "Test Node", "Concept");
        add_node(&mut graph, node.clone()).unwrap();
        let result = add_node(&mut graph, node);
        assert!(result.is_err());
        assert_eq!(
            result.unwrap_err().to_string(),
            "node already exists: concept:n1"
        );
    }

    #[test]
    fn add_node_requires_source() {
        use crate::graph::GraphFile;
        let mut graph = GraphFile::new("test");
        let mut node = valid_node("concept:n1", "Test Node", "Concept");
        node.source_files.clear();
        let result = add_node(&mut graph, node);
        assert!(result.is_err());
        assert_eq!(
            result.unwrap_err().to_string(),
            "at least one --source is required"
        );
    }

    #[test]
    fn remove_node_returns_removed_count() {
        use crate::graph::GraphFile;
        let mut graph = GraphFile::new("test");
        let node = valid_node("concept:n1", "Test Node", "Concept");
        add_node(&mut graph, node).unwrap();
        let removed = remove_node(&mut graph, "concept:n1").unwrap();
        assert_eq!(removed, 0);
        assert!(graph.nodes.is_empty());
    }

    #[test]
    fn add_edge_validates_source_exists() {
        use crate::graph::{Edge, EdgeProperties, GraphFile};
        let mut graph = GraphFile::new("test");
        let node = valid_node("concept:target", "Target", "Concept");
        add_node(&mut graph, node).unwrap();
        let edge = Edge {
            source_id: "concept:nonexistent".to_string(),
            target_id: "concept:target".to_string(),
            relation: "DEPENDS_ON".to_string(),
            properties: EdgeProperties::default(),
        };
        let result = add_edge(&mut graph, edge);
        let err_msg = result.unwrap_err().to_string();
        eprintln!("Error: {}", err_msg);
        assert!(
            err_msg.contains("source node not found"),
            "Got: {}",
            err_msg
        );
    }

    #[test]
    fn add_node_accepts_custom_type() {
        use crate::graph::GraphFile;
        let mut graph = GraphFile::new("test");
        let node = valid_node("~:n1", "Virtual Node", "~");

        add_node(&mut graph, node).expect("custom type should be accepted");
        assert!(graph.node_by_id("~:n1").is_some());
    }

    #[test]
    fn add_edge_accepts_custom_relation() {
        use crate::graph::{Edge, EdgeProperties, GraphFile};
        let mut graph = GraphFile::new("test");
        let source = valid_node("concept:source", "Source", "Concept");
        let target = valid_node("concept:target", "Target", "Concept");
        add_node(&mut graph, source).expect("source node");
        add_node(&mut graph, target).expect("target node");

        add_edge(
            &mut graph,
            Edge {
                source_id: "concept:source".to_owned(),
                relation: "~".to_owned(),
                target_id: "concept:target".to_owned(),
                properties: EdgeProperties::default(),
            },
        )
        .expect("custom relation should be accepted");

        assert!(graph.has_edge("concept:source", "~", "concept:target"));
    }

    #[test]
    fn add_edge_rejects_invalid_bidirectional_similarity_score() {
        use crate::graph::{Edge, EdgeProperties, GraphFile};
        let mut graph = GraphFile::new("test");
        let source = valid_node("~:a", "A", "~");
        let target = valid_node("~:b", "B", "~");
        add_node(&mut graph, source).expect("source node");
        add_node(&mut graph, target).expect("target node");

        let err = add_edge(
            &mut graph,
            Edge {
                source_id: "~:a".to_owned(),
                relation: "~".to_owned(),
                target_id: "~:b".to_owned(),
                properties: EdgeProperties {
                    detail: "2.0".to_owned(),
                    bidirectional: true,
                    ..Default::default()
                },
            },
        )
        .expect_err("invalid score should fail");

        assert!(err.to_string().contains("requires score in range 0..1"));
    }

    #[test]
    fn add_edge_allows_has_from_custom_cluster_type() {
        use crate::graph::{Edge, EdgeProperties, GraphFile};
        let mut graph = GraphFile::new("test");
        add_node(&mut graph, valid_node("@:cluster_0001", "Cluster", "@")).expect("cluster");
        add_node(&mut graph, valid_node("concept:x", "X", "Concept")).expect("member");

        add_edge(
            &mut graph,
            Edge {
                source_id: "@:cluster_0001".to_owned(),
                relation: "HAS".to_owned(),
                target_id: "concept:x".to_owned(),
                properties: EdgeProperties {
                    detail: "0.88".to_owned(),
                    ..Default::default()
                },
            },
        )
        .expect("custom cluster membership should be accepted");
    }
}