surge-sdk 0.1.1-alpha.2

Rust SDK for Surge.sh API - programmatically manage static site deployments, domains, SSL, and DNS
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

/*
  src/lib.rs
*/
//! # Surge SDK for Rust
//!
//! A type-safe Rust interface for the [Surge.sh](https://surge.sh) API, enabling programmatic
//! management of static site deployments, domains, SSL certificates, and DNS records.
//!
//! ## Key Features
//! - 🚀 Zero-config publishing to `.surge.sh` domains
//! - 🔒 SSL certificate management (requires Pro account)
//! - 🌐 DNS and domain zone configuration
//! - 📊 Real-time deployment event streaming
//! - 🛠️ Async-first design using `reqwest` and `tokio`
//!
//! ## Quick Start
//! ```rust,no_run
//! use surge_sdk::{Config, SurgeSdk, Auth, SURGE_API};
//! use std::path::Path;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), surge_sdk::SurgeError> {
//!     let config = Config::new(SURGE_API, "0.1.0")?;
//!     let sdk = SurgeSdk::new(config)?;
//!     let auth = Auth::Token("your-api-token".into());
//!     
//!     sdk.publish(Path::new("./dist"), "your-domain.surge.sh", &auth, None, None).await?;
//!     Ok(())
//! }
//! ```

pub mod config;
pub mod error;
pub mod responses;
pub mod sdk;
pub mod stream;
pub mod types;
pub mod utils;

pub use config::Config;
pub use error::SurgeError;
pub use responses::*;
pub use sdk::SurgeSdk;
pub use stream::{calculate_metadata, publish};
// pub use stream::publish_wip;
pub use types::{Auth, Event};
pub use utils::{generate_domain, json_to_argv};

/// The default Surge.sh API endpoint
///
/// Used as the default base URL in [`Config`]:
/// ```rust
/// use surge_sdk::{Config, SURGE_API};
///
/// // These are equivalent:
/// let cfg1 = Config::new(SURGE_API, "0.1.0");
/// let cfg2 = Config::new("https://surge.surge.sh", "0.1.0");
/// ```
pub const SURGE_API: &str = "https://surge.surge.sh";