tauri-plugin-velesdb 1.13.3

Tauri plugin for VelesDB - Vector search in desktop apps
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

//! Knowledge Graph request/response DTOs extracted from `types.rs` (EPIC-015 US-001).
//!
//! Contains graph-related types: edges, traversal, node degree, and parallel traversal.
//!
//! These types are Tauri-IPC-specific because:
//! - Request types carry a `collection` field (no URL path in IPC)
//! - All types use `#[serde(rename_all = "camelCase")]` for JavaScript callers
//! - Response types like `EdgeOutput` and `TraversalOutput` project core structs
//!   into a JS-friendly shape

use serde::{Deserialize, Serialize};

// ============================================================================
// Default value functions (graph-specific)
// ============================================================================

pub(crate) fn default_max_depth() -> u32 {
    3
}

pub(crate) fn default_traverse_limit() -> usize {
    100
}

pub(crate) fn default_algorithm() -> String {
    "bfs".to_string()
}

// ============================================================================
// Knowledge Graph Types
// ============================================================================

/// Request to add an edge to the knowledge graph.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AddEdgeRequest {
    /// Collection name.
    pub collection: String,
    /// Edge ID.
    pub id: u64,
    /// Source node ID.
    pub source: u64,
    /// Target node ID.
    pub target: u64,
    /// Edge label (relationship type).
    pub label: String,
    /// Optional edge properties.
    #[serde(default)]
    pub properties: Option<serde_json::Value>,
}

/// Request to get edges from the knowledge graph.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct GetEdgesRequest {
    /// Collection name.
    pub collection: String,
    /// Optional label filter.
    pub label: Option<String>,
    /// Optional source node filter.
    pub source: Option<u64>,
    /// Optional target node filter.
    pub target: Option<u64>,
}

/// Request to traverse the knowledge graph.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TraverseGraphRequest {
    /// Collection name.
    pub collection: String,
    /// Starting node ID.
    pub source: u64,
    /// Maximum traversal depth.
    #[serde(default = "default_max_depth")]
    pub max_depth: u32,
    /// Optional relationship type filter.
    pub rel_types: Option<Vec<String>>,
    /// Maximum number of results.
    #[serde(default = "default_traverse_limit")]
    pub limit: usize,
    /// Traversal algorithm: "bfs" or "dfs".
    #[serde(default = "default_algorithm")]
    pub algorithm: String,
}

/// Request to get node degree.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct GetNodeDegreeRequest {
    /// Collection name.
    pub collection: String,
    /// Node ID.
    pub node_id: u64,
}

/// Edge output for API responses.
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct EdgeOutput {
    /// Edge ID.
    pub id: u64,
    /// Source node ID.
    pub source: u64,
    /// Target node ID.
    pub target: u64,
    /// Edge label.
    pub label: String,
    /// Edge properties.
    pub properties: serde_json::Value,
}

/// Traversal result output.
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct TraversalOutput {
    /// Target node ID reached.
    pub target_id: u64,
    /// Depth of traversal.
    pub depth: u32,
    /// Path taken (node IDs).
    pub path: Vec<u64>,
}

/// Node degree output.
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct NodeDegreeOutput {
    /// Node ID.
    pub node_id: u64,
    /// Number of incoming edges.
    pub in_degree: usize,
    /// Number of outgoing edges.
    pub out_degree: usize,
}

/// Request for multi-source parallel BFS traversal.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TraverseGraphParallelRequest {
    /// Collection name.
    pub collection: String,
    /// Source node IDs to start traversal from.
    pub sources: Vec<u64>,
    /// Maximum traversal depth.
    #[serde(default = "default_max_depth")]
    pub max_depth: u32,
    /// Maximum number of results.
    #[serde(default = "default_traverse_limit")]
    pub limit: usize,
    /// Optional relationship types to follow.
    pub rel_types: Option<Vec<String>>,
}