grdn 0.0.1

The canonical TypeScript and JavaScript implementation of the `grdn` protocol
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

//! Basic definitions of the idea of a "garden" -- like a "feed" but designed
//! from the start to support content which "grows" over time. Think of it as a
//! *complement to* rather than an *alternative to* traditional feed structures
//! like [RSS][rss], [Atom][atom], [JSON Feed][jf], etc.
//!
//! [rss]: TODO
//! [atom]: TODO
//! [jf]: TODO

mod uuid_v4;

use serde::{Deserialize, Serialize};
use uuid_v4::UUIDv4;

#[derive(Serialize, Deserialize, Debug)]
pub struct Garden {
    pub title: String,
    pub link: URL,
    pub items: Vec<Item>,
    pub last_updated: ISO8601Time,
}

/// An item in the garden.
///
/// Nomenclature: In the mental structure of a "garden", an "item" is not
/// necessarily a "plant": it could be a bench someone sits on instead. So this
/// is an "item".
#[derive(Serialize, Deserialize, Debug)]
pub struct Item {
    title: String,
    id: UUIDv4,
    summary: String,
    created: ISO8601Time,
    updates: Vec<Update>,
    link: URL,
}

/// An update to an item in the garden.
#[derive(Serialize, Deserialize, Debug)]
pub struct Update {
    time: ISO8601Time,
    /// What is the basic nature of the change?
    change: Change,
}

#[derive(Serialize, Deserialize, Debug)]
pub enum Change {
    Summary(String),
    Patch(Patch),
    SummaryAndPatch { summary: String, patch: Patch },
}

// This isn't how you'd serialize these; it's a representation of the *transport format*.

// TODO: actually parse from string -> time::whatever
#[derive(Serialize, Deserialize, Debug)]
pub struct ISO8601Time(String);

// TODO: make this parse diffs!
/// Patches in standard `diff` format.
#[derive(Serialize, Deserialize, Debug)]
pub struct Patch(String);

// TODO: actually make this a WHATWG URL. (There's a crate, I am sure.)
#[derive(Serialize, Deserialize, Debug)]
pub struct URL(String);