pubky 0.7.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
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

#![doc = include_str!("../README.md")]
#![deny(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]
#![allow(
    clippy::multiple_crate_versions,
    reason = "workspace dependencies still require distinct versions"
)]
#![cfg_attr(
    target_arch = "wasm32",
    allow(clippy::future_not_send, reason = "WASM futures are single-threaded")
)]

mod pubky;

mod actors;
mod client;
pub mod errors;
mod macros;

mod util;

pub mod prelude;

// --- PUBLIC API EXPORTS ---
// SDK facade
#[doc(inline)]
pub use pubky::Pubky;
// Transport
#[doc(inline)]
pub use client::core::{PubkyHttpClient, PubkyHttpClientBuilder};
// High level actors
#[doc(inline)]
pub use actors::Pkdns;
#[doc(inline)]
pub use actors::PubkySession;
#[doc(inline)]
pub use actors::PubkySigner;
#[doc(inline)]
pub use actors::deep_links;
#[doc(inline)]
pub use actors::{AuthFlowKind, PubkyAuthFlow};
#[doc(inline)]
pub use actors::{Event, EventCursor, EventStreamBuilder, EventType};
#[doc(inline)]
pub use actors::{PublicStorage, SessionStorage};

// Error and global client
#[doc(inline)]
pub use errors::{BuildError, Error, Result};

// Export common types and constants
#[doc(inline)]
pub use crate::actors::storage::{
    list::ListBuilder,
    resource::{IntoPubkyResource, IntoResourcePath, resolve_pubky},
    resource::{PubkyResource, ResourcePath},
    stats::ResourceStats,
};
#[doc(inline)]
#[allow(
    deprecated,
    reason = "Re-exporting deprecated public API for backwards compat"
)]
pub use actors::DEFAULT_HTTP_RELAY;
pub use actors::pkdns::DEFAULT_STALE_AFTER;
#[doc(inline)]
pub use actors::{DEFAULT_HTTP_RELAY_INBOX, EncryptedHttpRelayInboxChannel, HttpRelayInboxChannel};
#[doc(inline)]
pub use pkarr;

// Re-exports
#[doc(inline)]
pub use pubky_common::{
    auth::AuthToken,
    capabilities::{Capabilities, Capability},
    crypto::{Keypair, PublicKey},
    recovery_file,
};
pub use reqwest::{Method, StatusCode};