scraps 5.0.0

Scraps is a portable CLI knowledge hub for managing interconnected Markdown documentation with Wiki-link notation.
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

use crate::usecase::scrap::lookup_links::usecase::LinkRefKind;
use crate::usecase::scrap::scrap_ref::ScrapRef;
use chrono::SecondsFormat;
use scraps_libs::markdown::query::{CodeBlock, Heading};
use scraps_libs::model::source::Source;
use scraps_libs::model::verification::{TrustTier, Verification};
use serde::Serialize;

/// A scrap as a tool result names it: `key` is what to pass back to a tool,
/// `title` is what readers see, and `ctx` is the folder part of the key.
#[derive(Debug, Serialize)]
pub struct ScrapRefJson {
    pub key: String,
    pub title: String,
    pub ctx: Option<String>,
}

impl From<&ScrapRef> for ScrapRefJson {
    fn from(scrap: &ScrapRef) -> Self {
        ScrapRefJson {
            key: scrap.key.to_string(),
            title: scrap.title.clone(),
            ctx: scrap.ctx().as_ref().map(|c| c.to_string()),
        }
    }
}

/// A search hit: the scrap, plus its description when it has one so an
/// agent can choose what to read without fetching bodies.
#[derive(Debug, Serialize)]
pub struct SearchHitJson {
    #[serde(flatten)]
    pub scrap: ScrapRefJson,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

#[derive(Debug, Serialize)]
pub struct HeadingJson {
    pub level: u8,
    pub text: String,
    pub line: usize,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub parent: Option<String>,
}

impl From<Heading> for HeadingJson {
    fn from(h: Heading) -> Self {
        Self {
            level: h.level,
            text: h.text,
            line: h.line,
            parent: h.parent,
        }
    }
}

#[derive(Debug, Serialize)]
pub struct CodeBlockJson {
    pub lang: Option<String>,
    pub content: String,
    pub line: usize,
}

impl From<CodeBlock> for CodeBlockJson {
    fn from(c: CodeBlock) -> Self {
        Self {
            lang: c.lang,
            content: c.content,
            line: c.line,
        }
    }
}

/// A scrap's confirmations, read as an OKF consumer reads `verified`: the
/// trust tier derived from them, and the readable entries newest first.
#[derive(Debug, Serialize)]
pub struct VerifiedJson {
    pub tier: String,
    pub entries: Vec<VerificationJson>,
}

#[derive(Debug, Serialize)]
pub struct VerificationJson {
    pub by: String,
    pub at: String,
}

impl VerifiedJson {
    pub fn new(verifications: &[Verification], tier: TrustTier) -> Self {
        Self {
            tier: tier.as_str().to_string(),
            entries: verifications
                .iter()
                .map(|v| VerificationJson {
                    by: v.by.clone(),
                    at: v.at.to_rfc3339_opts(SecondsFormat::AutoSi, true),
                })
                .collect(),
        }
    }
}

/// One material a scrap derives from, read as an OKF consumer reads an entry
/// of `sources`. Optional keys the entry leaves out are left out here too.
#[derive(Debug, Serialize)]
pub struct SourceJson {
    pub resource: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub author: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub last_modified: Option<String>,
}

impl From<&Source> for SourceJson {
    fn from(source: &Source) -> Self {
        Self {
            resource: source.resource.clone(),
            id: source.id.clone(),
            title: source.title.clone(),
            author: source.author.clone(),
            last_modified: source
                .last_modified
                .map(|at| at.to_rfc3339_opts(SecondsFormat::AutoSi, true)),
        }
    }
}

/// How one scrap references another: in the body, as an embed, or as one of
/// its `sources`.
#[derive(Debug, Serialize, PartialEq, Eq, Clone, Copy)]
#[serde(rename_all = "lowercase")]
pub enum LinkKindJson {
    Link,
    Embed,
    Source,
}

impl From<LinkRefKind> for LinkKindJson {
    fn from(kind: LinkRefKind) -> Self {
        match kind {
            LinkRefKind::Link => LinkKindJson::Link,
            LinkRefKind::Embed => LinkKindJson::Embed,
            LinkRefKind::Source => LinkKindJson::Source,
        }
    }
}