rustauth-core 0.2.0

Core types and primitives for RustAuth.
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
141
142
143
144
145
146
147
148
149
150

//! Static inventory of route DTO serde policies (`rustauth-core/src/api/routes/`).
//!
//! Update this table when adding or changing request/response structs. The test
//! fails if the inventory length drifts without an intentional update.

#[allow(dead_code)]
struct RouteDtoInventory {
    route: &'static str,
    struct_name: &'static str,
    direction: &'static str,
    serde_policy: &'static str,
}

const ROUTE_DTO_INVENTORY: &[RouteDtoInventory] = &[
    RouteDtoInventory {
        route: "POST /sign-in/email",
        struct_name: "SignInEmailBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\" + callbackURL rename",
    },
    RouteDtoInventory {
        route: "POST /sign-in/email",
        struct_name: "AuthTokenUserBody",
        direction: "response",
        serde_policy: "user via user_output_value (HttpUser camelCase)",
    },
    RouteDtoInventory {
        route: "GET|POST /get-session",
        struct_name: "SessionUserBody",
        direction: "response",
        serde_policy: "needsRefresh rename + session/user via output helpers",
    },
    RouteDtoInventory {
        route: "POST /sign-up/email",
        struct_name: "SignUpEmailBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\" + callbackURL rename",
    },
    RouteDtoInventory {
        route: "POST /sign-up/email",
        struct_name: "AuthTokenUserBody",
        direction: "response",
        serde_policy: "user via user_output_value (HttpUser camelCase)",
    },
    RouteDtoInventory {
        route: "POST /update-user",
        struct_name: "UpdateUserBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\" + flatten extra",
    },
    RouteDtoInventory {
        route: "POST /change-password",
        struct_name: "ChangePasswordBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "POST /set-password",
        struct_name: "SetPasswordBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "POST /request-password-reset",
        struct_name: "RequestPasswordResetBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "POST /reset-password",
        struct_name: "ResetPasswordBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "POST /change-email",
        struct_name: "ChangeEmailBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "POST /delete-user",
        struct_name: "DeleteUserBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "POST /send-verification-email",
        struct_name: "SendVerificationEmailBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "GET /list-accounts",
        struct_name: "AccountResponse",
        direction: "response",
        serde_policy: "rename_all = \"camelCase\"",
    },
    RouteDtoInventory {
        route: "GET /list-sessions",
        struct_name: "Session list",
        direction: "response",
        serde_policy: "session_to_http_value per entry",
    },
    RouteDtoInventory {
        route: "POST /sign-in/social",
        struct_name: "SocialSignInBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\" + callbackURL rename",
    },
    RouteDtoInventory {
        route: "POST /sign-in/social",
        struct_name: "SocialSessionBody",
        direction: "response",
        serde_policy: "user Value via user_response_value (HttpUser camelCase)",
    },
    RouteDtoInventory {
        route: "POST /link-social",
        struct_name: "LinkSocialBody",
        direction: "request",
        serde_policy: "rename_all = \"camelCase\" + callbackURL rename",
    },
    RouteDtoInventory {
        route: "POST /verify-email",
        struct_name: "VerifyEmailResponse",
        direction: "response",
        serde_policy: "user Value via user_response_value",
    },
    RouteDtoInventory {
        route: "POST /change-email",
        struct_name: "ChangeEmailResponse",
        direction: "response",
        serde_policy: "user Value via user_response_value",
    },
    RouteDtoInventory {
        route: "*",
        struct_name: "ApiErrorResponse",
        direction: "response",
        serde_policy: "snake_case + rename originalMessage",
    },
];

#[test]
fn route_dto_inventory_has_expected_entry_count() {
    assert_eq!(
        ROUTE_DTO_INVENTORY.len(),
        21,
        "update ROUTE_DTO_INVENTORY and docs/http-json-conventions.md when adding DTOs"
    );
}