ucp-graph 0.1.15

Generic graph runtime, stores, and traversal APIs for UCP documents
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

mod document;
#[cfg(not(target_arch = "wasm32"))]
mod sqlite;

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use thiserror::Error;
use ucm_core::{BlockId, PortableDocument};

use crate::types::GraphEdgeSummary;

pub use document::InMemoryGraphStore;
#[cfg(not(target_arch = "wasm32"))]
pub use sqlite::SqliteGraphStore;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphNodeRecord {
    pub block_id: BlockId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub label: Option<String>,
    pub content_type: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub semantic_role: Option<String>,
    #[serde(default)]
    pub tags: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub parent: Option<BlockId>,
    pub children: usize,
    pub outgoing_edges: usize,
    pub incoming_edges: usize,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphStoreStats {
    pub backend: String,
    pub document_id: String,
    pub root_block_id: BlockId,
    pub node_count: usize,
    pub explicit_edge_count: usize,
    pub structural_edge_count: usize,
    pub captured_at: DateTime<Utc>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub graph_key: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphStoreObservability {
    pub stats: GraphStoreStats,
    #[serde(default)]
    pub indexed_fields: Vec<String>,
}

#[derive(Debug, Error)]
pub enum GraphStoreError {
    #[error(transparent)]
    Ucm(#[from] ucm_core::Error),
    #[error(transparent)]
    Regex(#[from] regex::Error),
    #[error(transparent)]
    Serde(#[from] serde_json::Error),
    #[error(transparent)]
    Io(#[from] std::io::Error),
    #[error(transparent)]
    #[cfg(not(target_arch = "wasm32"))]
    Sqlite(#[from] rusqlite::Error),
    #[error("graph not found: {0}")]
    GraphNotFound(String),
}

pub trait GraphStore {
    fn stats(&self) -> GraphStoreStats;
    fn observability(&self) -> GraphStoreObservability;
    fn root_id(&self) -> BlockId;
    fn node_ids(&self) -> Vec<BlockId>;
    fn node(&self, block_id: BlockId) -> Option<GraphNodeRecord>;
    fn children(&self, block_id: BlockId) -> Vec<BlockId>;
    fn parent(&self, block_id: BlockId) -> Option<BlockId>;
    fn outgoing_edges(&self, block_id: BlockId) -> Vec<GraphEdgeSummary>;
    fn incoming_edges(&self, block_id: BlockId) -> Vec<GraphEdgeSummary>;
    fn resolve_selector(&self, selector: &str) -> Option<BlockId>;
    fn to_portable_document(&self) -> Result<PortableDocument, GraphStoreError>;
}