aboutsummaryrefslogtreecommitdiffstats
path: root/crates/turtle/src/atuin_common/api.rs
blob: 2f909676ad6dbc9f807d7ae607ab4a047bbf19d5 (plain) (blame)
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
use semver::Version;
use serde::{Deserialize, Serialize};
use std::borrow::Cow;
use std::sync::LazyLock;
use time::OffsetDateTime;

// the usage of X- has been deprecated for quite along time, it turns out
pub(crate) static ATUIN_HEADER_VERSION: &str = "Atuin-Version";
pub(crate) static ATUIN_CARGO_VERSION: &str = env!("CARGO_PKG_VERSION");

pub(crate) static ATUIN_VERSION: LazyLock<Version> =
    LazyLock::new(|| Version::parse(ATUIN_CARGO_VERSION).expect("failed to parse self semver"));

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct UserResponse {
    pub(crate) username: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct RegisterRequest {
    pub(crate) email: String,
    pub(crate) username: String,
    pub(crate) password: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct RegisterResponse {
    pub(crate) session: String,
    /// Auth type: "hub" for Hub API tokens, "cli" for legacy CLI session tokens.
    /// Old servers that don't return this field will deserialize as None.
    #[serde(default)]
    pub(crate) auth: Option<String>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct DeleteUserResponse {}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ChangePasswordRequest {
    pub(crate) current_password: String,
    pub(crate) new_password: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ChangePasswordResponse {}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct LoginRequest {
    pub(crate) username: String,
    pub(crate) password: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct LoginResponse {
    pub(crate) session: String,
    /// Auth type: "hub" for Hub API tokens, "cli" for legacy CLI session tokens.
    /// Old servers that don't return this field will deserialize as None.
    #[serde(default)]
    pub(crate) auth: Option<String>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct AddHistoryRequest {
    pub(crate) id: String,
    #[serde(with = "time::serde::rfc3339")]
    pub(crate) timestamp: OffsetDateTime,
    pub(crate) data: String,
    pub(crate) hostname: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct CountResponse {
    pub(crate) count: i64,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct SyncHistoryRequest {
    #[serde(with = "time::serde::rfc3339")]
    pub(crate) sync_ts: OffsetDateTime,
    #[serde(with = "time::serde::rfc3339")]
    pub(crate) history_ts: OffsetDateTime,
    pub(crate) host: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct SyncHistoryResponse {
    pub(crate) history: Vec<String>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ErrorResponse<'a> {
    pub(crate) reason: Cow<'a, str>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct IndexResponse {
    pub(crate) homage: String,
    pub(crate) version: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct StatusResponse {
    pub(crate) count: i64,
    pub(crate) username: String,
    pub(crate) deleted: Vec<String>,

    // These could/should also go on the index of the server
    // However, we do not request the server index as a part of normal sync
    // I'd rather slightly increase the size of this response, than add an extra HTTP request
    pub(crate) page_size: i64, // max page size supported by the server
    pub(crate) version: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct DeleteHistoryRequest {
    pub(crate) client_id: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct MessageResponse {
    pub(crate) message: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct MeResponse {
    pub(crate) username: String,
}

// Hub CLI authentication types

/// Response from POST /auth/cli/code - generates a code for CLI auth
#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct CliCodeResponse {
    pub(crate) code: String,
}

/// Response from GET /auth/cli/verify?code=<code> - polls for authorization
#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct CliVerifyResponse {
    /// Session token, present only when authorization is complete
    pub(crate) token: Option<String>,
    pub(crate) success: Option<bool>,
    pub(crate) error: Option<String>,
}