axiomsync 1.0.0

Core data-processing engine for AxiomSync local retrieval runtime.
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Entry {
    pub uri: String,
    pub name: String,
    pub is_dir: bool,
    pub size: u64,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GlobResult {
    pub matches: Vec<String>,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(rename_all = "snake_case")]
pub enum AddResourceWaitMode {
    #[default]
    Relaxed,
    Strict,
}

impl AddResourceWaitMode {
    #[must_use]
    pub const fn contract_label(self) -> &'static str {
        match self {
            Self::Relaxed => "relaxed_single_replay",
            Self::Strict => "strict_terminal_done",
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AddResourceResult {
    pub root_uri: String,
    pub queued: bool,
    pub message: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub wait_mode: Option<AddResourceWaitMode>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub wait_contract: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AddResourceRequest {
    pub source: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target: Option<String>,
    pub wait: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timeout_secs: Option<u64>,
    #[serde(default)]
    pub wait_mode: AddResourceWaitMode,
    #[serde(default)]
    pub ingest_options: AddResourceIngestOptions,
}

impl AddResourceRequest {
    #[must_use]
    pub fn new(source: impl Into<String>) -> Self {
        Self {
            source: source.into(),
            target: None,
            wait: false,
            timeout_secs: None,
            wait_mode: AddResourceWaitMode::default(),
            ingest_options: AddResourceIngestOptions::default(),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct AddResourceIngestOptions {
    #[serde(default)]
    pub markdown_only: bool,
    #[serde(default = "default_include_hidden")]
    pub include_hidden: bool,
    #[serde(default)]
    pub exclude_globs: Vec<String>,
}

const fn default_include_hidden() -> bool {
    true
}

impl Default for AddResourceIngestOptions {
    fn default() -> Self {
        Self {
            markdown_only: false,
            include_hidden: true,
            exclude_globs: Vec::new(),
        }
    }
}

impl AddResourceIngestOptions {
    #[must_use]
    pub fn markdown_only_defaults() -> Self {
        Self {
            markdown_only: true,
            include_hidden: false,
            exclude_globs: vec![
                ".obsidian".to_string(),
                ".obsidian/**".to_string(),
                "**/*.json".to_string(),
            ],
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MarkdownDocument {
    pub uri: String,
    pub content: String,
    pub etag: String,
    pub updated_at: String,
    pub format: String,
    pub editable: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MarkdownSaveResult {
    pub uri: String,
    pub etag: String,
    pub updated_at: String,
    pub reindexed_root: String,
    pub save_ms: u128,
    pub reindex_ms: u128,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TreeNode {
    pub uri: String,
    pub is_dir: bool,
    pub children: Vec<TreeNode>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TreeResult {
    pub root: TreeNode,
}