Move the LiveSocket and LiveChannel api into one central object.

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
 
       - uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ env.CARGO_MAKE_TOOLCHAIN }}
+          toolchain: nightly
           components: rustfmt
 
       - name: Cargo fmt

Cargo.toml

@@ -3,7 +3,7 @@ resolver = "2"
 members = ["crates/core", "crates/uniffi-bindgen", "crates/wasm"]
 
 [workspace.package]
-version = "0.4.0-rc-4"
+version = "0.4.0"
 rust-version = "1.64"
 authors = [
     "Paul Schoenfelder <[email protected]>",
@@ -23,7 +23,7 @@ edition = "2021"
 publish = false
 
 [workspace.dependencies]
-uniffi = "0.28.0"
+uniffi = "0.28.3"
 
 [profile.dev]
 split-debuginfo = "unpacked"

crates/core/Cargo.toml

@@ -20,7 +20,14 @@ name = "liveview_native_core"
 
 [features]
 default = ["liveview-channels-tls"]
-liveview-channels = ["phoenix_channels_client", "reqwest", "uniffi/tokio"]
+liveview-channels = [
+    "phoenix_channels_client",
+    "reqwest",
+    "uniffi/tokio",
+    "cookie_store",
+    "reqwest_cookie_store",
+    "tokio",
+]
 liveview-channels-tls = [
     "liveview-channels",
     "reqwest/native-tls-vendored",
@@ -37,6 +44,7 @@ browser = [
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+serde_urlencoded = "0.7.1"
 cranelift-entity = { version = "0.115" }
 fixedbitset = { version = "0.5" }
 fxhash = { version = "0.2" }
@@ -54,7 +62,13 @@ log = "0.4"
 reqwest = { version = "0.12.3", default-features = false, optional = true, features = [
     "cookies",
 ] }
+
+cookie_store = { version = "0.21.1", default-features = false, optional = true }
+reqwest_cookie_store = { version = "0.8.0", default-features = false, optional = true }
+env_logger = "0.11.1"
 uniffi = { workspace = true }
+
+tokio = { version = "1.42", features = ["full"], optional = true }
 phoenix_channels_client = { git = "https://github.com/liveview-native/phoenix-channels-client.git", branch = "main", optional = true, default-features = false }
 # This is for wasm support on phoenix-channels-client
 #phoenix_channels_client = { git = "https://github.com/liveview-native/phoenix-channels-client.git", branch = "simlay/webassembly-support", optional = true, default-features = false }
@@ -67,8 +81,6 @@ paste = { version = "1.0" }
 pretty_assertions = { version = "1.4.0" }
 text-diff = { version = "0.4.0" }
 uniffi = { workspace = true, features = ["bindgen-tests", "tokio"] }
-tokio = { version = "1.42", features = ["full"] }
-env_logger = "0.11.1"
 
 # For image generation for tests
 image = "0.25.1"

crates/core/src/callbacks.rs

@@ -0,0 +1,152 @@
+use std::sync::Arc;
+
+use crate::dom::{NodeData, NodeRef};
+
+/// Provides secure persistent storage for session data like cookies.
+/// Implementations should handle platform-specific storage (e.g. NSUserDefaults on iOS)
+/// and ensure data is stored securely as some of it may be session tokens.
+#[uniffi::export(callback_interface)]
+pub trait SecurePersistentStore: Send + Sync {
+    /// Removes the entry for the given key
+    fn remove_entry(&self, key: String);
+
+    /// Gets the value for the given key, or None if not found
+    fn get(&self, key: String) -> Option<Vec<u8>>;
+
+    /// Sets the value for the given key
+    fn set(&self, key: String, value: Vec<u8>);
+}
+
+#[uniffi::export(callback_interface)]
+pub trait NavEventHandler: Send + Sync {
+    /// This callback instruments events that occur when your user navigates to a
+    /// new view. You can add serialized metadata to these events as a byte buffer
+    /// through the [NavOptions] object.
+    fn handle_event(&self, event: NavEvent) -> HandlerResponse;
+}
+
+/// Unique id in the history stack
+pub type HistoryId = u64;
+
+/// User emitted response from [NavEventHandler::handle_event].
+/// Determines whether or not the default navigation action is taken.
+#[derive(uniffi::Enum, Clone, Debug, PartialEq, Default)]
+pub enum HandlerResponse {
+    #[default]
+    /// Return this to proceed as normal.
+    Default,
+    /// Return this to cancel the navigation before it occurs.
+    PreventDefault,
+}
+
+#[derive(uniffi::Enum, Clone, Debug, PartialEq)]
+pub enum NavEventType {
+    /// Pushing a new event onto the history stack
+    Push,
+    /// Replacing the most recent event on the history stack
+    Replace,
+    /// Reloading the view in place
+    Reload,
+    /// Skipping multiple items on the history stack, leaving them in tact.
+    Traverse,
+}
+
+#[derive(uniffi::Record, Clone, Debug, PartialEq)]
+pub struct NavHistoryEntry {
+    /// The target url.
+    pub url: String,
+    /// Unique id for this piece of nav entry state.
+    pub id: HistoryId,
+    /// state passed in by the user, to be passed in to the navigation event callback.
+    pub state: Option<Vec<u8>>,
+}
+
+impl NavHistoryEntry {
+    /// Create a new navigation history entry
+    pub fn new(url: String, id: HistoryId, state: Option<Vec<u8>>) -> Self {
+        Self { url, id, state }
+    }
+}
+
+/// An event emitted when the user navigates between views.
+#[derive(uniffi::Record, Clone, Debug, PartialEq)]
+pub struct NavEvent {
+    /// The type of event being emitted.
+    pub event: NavEventType,
+    /// True if from and to point to the same path.
+    pub same_document: bool,
+    /// The previous location of the page, if there was one.
+    pub from: Option<NavHistoryEntry>,
+    /// Destination URL.
+    pub to: NavHistoryEntry,
+    /// Additional user provided metadata handed to the event handler.
+    pub info: Option<Vec<u8>>,
+}
+
+#[derive(Copy, Clone, Debug, Eq, PartialEq, uniffi::Enum)]
+pub enum LiveChannelStatus {
+    /// [Channel] is waiting for the [Socket](crate::Socket) to
+    /// [Socket::connect](crate::Socket::connect) or automatically reconnect.
+    WaitingForSocketToConnect,
+    /// [Socket::status](crate::Socket::status) is
+    /// [SocketStatus::Connected](crate::SocketStatus::Connected) and [Channel] is waiting for
+    /// [Channel::join] to be called.
+    WaitingToJoin,
+    /// [Channel::join] was called and awaiting response from server.
+    Joining,
+    /// [Channel::join] was called previously, but the [Socket](crate::Socket) was disconnected and
+    /// reconnected.
+    WaitingToRejoin,
+    /// [Channel::join] was called and the server responded that the [Channel::topic] was joined
+    /// using [Channel::payload].
+    Joined,
+    /// [Channel::leave] was called and awaiting response from server.
+    Leaving,
+    /// [Channel::leave] was called and the server responded that the [Channel::topic] was left.
+    Left,
+    /// [Channel::shutdown] was called, but the async task hasn't exited yet.
+    ShuttingDown,
+    /// The async task has exited.
+    ShutDown,
+}
+
+#[repr(C)]
+#[derive(Copy, Clone, uniffi::Enum)]
+pub enum ChangeType {
+    Change = 0,
+    Add = 1,
+    Remove = 2,
+    Replace = 3,
+}
+
+#[derive(Copy, Clone, uniffi::Enum)]
+pub enum EventType {
+    Changed, // { change: ChangeType },
+}
+
+#[derive(Clone, uniffi::Enum)]
+pub enum ControlFlow {
+    ExitOk,
+    ExitErr(String),
+    ContinueListening,
+}
+
+/// Implements the change handling logic for inbound virtual dom
+/// changes. Your logic for handling document patches should go here.
+#[uniffi::export(callback_interface)]
+pub trait DocumentChangeHandler: Send + Sync {
+    /// This callback should implement your dom manipulation logic
+    /// after receiving patches from LVN.
+    fn handle_document_change(
+        &self,
+        change_type: ChangeType,
+        node_ref: Arc<NodeRef>,
+        node_data: NodeData,
+        parent: Option<Arc<NodeRef>>,
+    );
+
+    /// Called when the channel status changes. Background operations like [LiveChannel::merge_diffs]
+    /// will exit with a status based on the return [ControlFlow] of this callback.
+    /// TODO: this should be deprecated after core takes responsibility for channel clean up
+    fn handle_channel_status(&self, channel_status: LiveChannelStatus) -> ControlFlow;
+}