essence 0.3.3

Essential models and database logic for the Adapt chat platform.
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

use serde::{Deserialize, Serialize};
#[cfg(feature = "openapi")]
use utoipa::ToSchema;

/// The method to use to retrieve an authentication token.
#[derive(Copy, Clone, Debug, Default, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "snake_case")]
pub enum TokenRetrievalMethod {
    /// Generate a new token as a new session. This will keep old tokens but add an alternate token
    /// to the user's account.
    New,
    /// Generate a new token, revoking all other sessions. This will log out all other sessions.
    Revoke,
    /// Use an existing token if one exists, else create a new one. This is the default.
    #[default]
    Reuse,
}

/// The request body for POST /login
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct LoginRequest {
    /// The email to log in with.
    pub email: String,
    /// The password to log in with.
    #[cfg_attr(feature = "openapi", schema(format = "password"))]
    pub password: String,
    /// The token retrieval method to use.
    #[serde(default)]
    pub method: TokenRetrievalMethod,
}

/// The response body for POST /login
#[derive(Clone, Debug, Serialize)]
#[cfg_attr(feature = "client", derive(Deserialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct LoginResponse {
    /// The user ID of the logged in user.
    pub user_id: u64,
    /// The authentication token to use for future requests.
    pub token: String,
}