pubky 0.10.0-alpha.0

Pubky SDK
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

//! Deep link related module.
//! Contains the following:
//! - `SigninDeepLink` - A deep link for signing into a Pubky homeserver (legacy cookie flow).
//! - `SignupDeepLink` - A deep link for signing up to a Pubky homeserver (legacy cookie flow).
//! - `SigninGrantDeepLink` - A deep link for signing in via the grant flow.
//! - `SignupGrantDeepLink` - A deep link for signing up via the grant flow.
//! - `SeedExportDeepLink` - A deep link for exporting a user secret to a signer like Pubky Ring.
//! - `DeepLink` - A parsed Pubky deep link.
//! - `DeepLinkParseError` - Errors that can occur when parsing a deep link.
//! - `DEEP_LINK_SCHEMES` - Supported deep link schemes.
//!
//! A deep link is used either on a phone directly or in the browser as a QR code
//! to communicate with a Pubky Signer like Pubky Ring.

mod deep_link;
mod error;
mod query_params;
mod schemes;
mod seed_export;
mod signin;
mod signin_grant;
mod signup;
mod signup_grant;
mod typed_deep_link;

/// Supported deep link schemes.
pub const DEEP_LINK_SCHEMES: [&str; 2] = ["pubkyauth", "pubkyring"];

pub use deep_link::DeepLink;
pub use error::DeepLinkParseError;
pub use schemes::DeepLinkScheme;
pub use seed_export::{SecretExportIntent, SeedExportDeepLink, SeedExportParams};
pub use signin::{SigninDeepLink, SigninIntent, SigninParams};
pub use signin_grant::{SigninGrantDeepLink, SigninGrantIntent, SigninGrantParams};
pub use signup::{SignupDeepLink, SignupIntent, SignupParams};
pub use signup_grant::{SignupGrantDeepLink, SignupGrantIntent, SignupGrantParams};
pub use typed_deep_link::{DeepLinkIntent, DeepLinkParams, TypedDeepLink};