stry-common 0.1.3

Shared code for stry crates, from backends to frontends, they all depend on this.
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

//! Base entities that are used internally and by other 'modules'.

use crate::models::{blog::Post, story::Story, Existing};

/// Universal site settings.
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Settings {
    /// A unique setting name.
    ///
    /// Left as a [`String`] to allow for other modules to use the settings
    /// without using extension types.
    pub key: String,

    /// The value of the key, encoded as JSON.
    pub value: String,
}

/// A user of the website, used from displaying authors to signing in.
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct User {
    pub account: SettingsAccount,
    pub site: SettingsSite,

    /// Stores all the stories that the user owns.
    ///
    /// # Variant
    ///
    /// Is `None` when this type is used indirectly (ie in another entity).
    pub stories: Option<Vec<Existing<Story>>>,

    /// Stores all the blog posts that the user has.
    ///
    /// # Variant
    ///
    /// Is `None` when this type is used indirectly (ie in another entity).
    pub posts: Option<Vec<Existing<Post>>>,
}

/// User settings for the user themself, ie name, biography, and security details.
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct SettingsAccount {
    /// The user's visible username.
    ///
    /// # Note
    ///
    /// Usernames are not unique, users are tracked with their `Id` only.
    ///
    /// Due to this, multiple users can have the same username. If possible
    /// let the user choose which account they interact with instead of using
    /// the first retrieved user.
    pub name: String,

    /// The user's email address.
    ///
    /// # Variant
    ///
    /// Is only `Some` when returned for login, a email change and for a user
    /// profile 'view'.
    pub email: Option<String>,

    /// The hash of the user's password stored as bytes.
    ///
    /// # Variant
    ///
    /// This is only `Some` during a login attempt or password change.
    pub hash: Option<Vec<u8>>,

    /// The user's biography in parts.
    ///
    /// # Variant
    ///
    /// Is `None` if you aren't accessing a user profile 'view'.
    pub biography: Option<Vec<Existing<Part>>>,
}

/// User settings for the site itself, ie appearance and notifications.
// TODO: support color blindness
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct SettingsSite {
    pub theme: SiteTheme,
}

/// Website theme the user currently has selected, takes precedence over `prefers-color-scheme`.
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub enum SiteTheme {
    Dark,
    Light,
}

/// A chapter or comment segment that can be commented on.
///
/// # Notes
///
/// Due to parts having comments and comments being made of parts,
/// replies/comments could be nested.
/// It is better to store them separately rather than the whole tree.
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Part {
    pub kind: PartKind,

    /// Any comments on or replying to the current part.
    pub comments: Vec<Existing<Comment>>,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub enum PartKind {
    Heading { level: u8 },
    Image { url: String, alt: Option<String>, },
    Text { content: String, words: i64, },
}

/// A comment made of parts and comments that can be commented on.
///
/// # Notes
///
/// Due to parts having comments and comments being made of parts,
/// replies/comments could be nested.
/// It is better to store them separately rather than the whole tree.
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Comment {
    pub author: Existing<User>,
    pub main: Vec<Existing<Part>>,
    pub children: Vec<Existing<Comment>>,
}