rustauth-plugins 0.2.0

Official RustAuth plugin modules.
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

//! Username plugin.

mod endpoints;
mod errors;
mod hooks;
mod options;
mod schema;

pub use errors::{
    EMAIL_NOT_VERIFIED, INVALID_DISPLAY_USERNAME, INVALID_USERNAME, INVALID_USERNAME_OR_PASSWORD,
    UNEXPECTED_ERROR, USERNAME_IS_ALREADY_TAKEN, USERNAME_TOO_LONG, USERNAME_TOO_SHORT,
};
pub use options::{
    UsernameOptions, UsernameOptionsBuilder, UsernameValidationError, ValidationOrder,
    ValidationPhase,
};
pub use schema::UsernameSchemaOptions;

use rustauth_core::plugin::AuthPlugin;

pub const UPSTREAM_PLUGIN_ID: &str = "username";

#[must_use]
pub fn username(options: UsernameOptions) -> AuthPlugin {
    let options = std::sync::Arc::new(options);
    let schema = options.schema.clone();
    let mut plugin = AuthPlugin::new(UPSTREAM_PLUGIN_ID)
        .with_version(crate::VERSION)
        .with_endpoint(endpoints::sign_in_username_endpoint(options.clone()))
        .with_endpoint(endpoints::is_username_available_endpoint(options.clone()))
        .with_database_hook(hooks::normalize_create_user_hook(options.clone()))
        .with_database_hook(hooks::normalize_update_user_hook(options.clone()))
        .with_before_hook(
            "/sign-up/email",
            hooks::sign_up_before_hook(options.clone()),
        )
        .with_before_hook("/update-user", hooks::update_user_before_hook(options))
        .with_schema(schema::username_field(&schema))
        .with_schema(schema::display_username_field(&schema));

    for error_code in errors::error_codes() {
        plugin = plugin.with_error_code(error_code);
    }

    plugin
}