vitium-api 0.1.0

APIs for Vitium
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

use serde::{de::DeserializeOwned, Deserialize, Serialize};

/// Describes a request.
/// Any type that implements `Req` should be correctly handled
/// if sent to the server with specified `PATH` and `METHOD`.
pub trait Req: Serialize + DeserializeOwned {
    /// The JSON body of response.
    type Response: Serialize + DeserializeOwned;
    /// The path this request should be sent to.
    fn path(&self) -> String;
    /// The method this request should be sent with.
    const METHOD: &'static str;
}

/// Denotes a payload that is accessed with a REST API.
pub trait REST: Serialize + DeserializeOwned {
    /// The index type that identifies individual resource from collection, e.g. username for users.
    type Index;
    /// The path on the server to send request to.
    fn path() -> String;
}

#[derive(Clone, Serialize, Deserialize)]
#[cfg_attr(target_family = "wasm", derive(tsify_next::Tsify))]
#[cfg_attr(
    target_family = "wasm",
    tsify(into_wasm_abi, from_wasm_abi, large_number_types_as_bigints)
)]
pub struct SignUp {
    pub user: String,
    pub pass: String,
}

impl Req for SignUp {
    type Response = ();

    fn path(&self) -> String {
        "/api/auth/signup".into()
    }

    const METHOD: &'static str = "POST";
}

#[derive(Clone, Serialize, Deserialize)]
#[cfg_attr(target_family = "wasm", derive(tsify_next::Tsify))]
#[cfg_attr(
    target_family = "wasm",
    tsify(into_wasm_abi, from_wasm_abi, large_number_types_as_bigints)
)]
pub struct Enroll(pub String);

/// A global out-game chat message.
///
/// # Time Order
///
/// The [`Self::sender`] fields indicates the local timestamp on the client when and where this message is sent.
/// No guarantee is made about the consistency of the time order of message.
///
/// # HTML
///
/// The message can either be a plain text message (when [`Self::html`] is set to `false`)
/// or an HTML message (when [`Self::html`] is set to `true`).
///
/// ## Caution
///
/// Only constrait to [`Self::content`] is the same as that of [`String`], i.e. to be valid UTF-8,
/// even if [`Self::html`] is on.
/// Therefore, no guarantee is made about whether it is valid DOM element or HTML.
/// Appropriate checks shall be done before attempting to render HTML to avoid potential danger.
#[derive(Clone, Serialize, Deserialize)]
#[cfg_attr(target_family = "wasm", derive(tsify_next::Tsify))]
#[cfg_attr(
    target_family = "wasm",
    tsify(
        into_wasm_abi,
        from_wasm_abi,
        missing_as_null,
        large_number_types_as_bigints
    )
)]
pub struct Message {
    /// Milisecond UNIX timestamp when the message is sent.
    #[cfg(target_family = "wasm")] // walkaround for json missing bigint support
    pub time: f64,
    /// Milisecond UNIX timestamp when the message is sent.
    #[cfg(not(target_family = "wasm"))]
    pub time: u64,
    /// The user who sends the message.
    ///
    /// A [`None`] indicates that this message is a broadcast triggered by a server command.
    pub sender: Option<String>,
    /// Content of the chat.
    /// This field shall be interpreted with respect to [`Self::html`] as plain text or string of HTML.
    pub content: String,
    /// Whether HTML is enabled in the content of the message.
    pub html: bool,
}

#[derive(Clone, Serialize, Deserialize)]
#[cfg_attr(target_family = "wasm", derive(tsify_next::Tsify))]
#[cfg_attr(
    target_family = "wasm",
    tsify(into_wasm_abi, from_wasm_abi, large_number_types_as_bigints)
)]
pub struct EditPass(pub String);

impl Req for EditPass {
    type Response = ();

    fn path(&self) -> String {
        "/api/auth/pass".into()
    }

    const METHOD: &'static str = "POST";
}