mdcs-sdk 0.1.3

High-level SDK for building collaborative applications with the Carnelia MDCS
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

//! MDCS SDK - High-level SDK for building collaborative applications
//!
//! This SDK provides a simple, ergonomic API for building real-time
//! collaborative applications using the MDCS (Merkle-Delta CRDT Store).
//!
//! # Quick Start
//!
//! ```rust
//! use mdcs_sdk::{Client, ClientConfig};
//!
//! // Create a client with a unique replica ID
//! let config = ClientConfig {
//!     user_name: "Alice".to_string(),
//!     ..Default::default()
//! };
//! let client = Client::new_with_memory_transport(config);
//!
//! // Create a collaborative session
//! let session = client.create_session("my-session");
//!
//! // Open a text document
//! let doc = session.open_text_doc("meeting-notes");
//!
//! // Edit the document
//! doc.write().insert(0, "# Meeting Notes\n");
//!
//! // Read the content
//! let content = doc.read().get_text();
//! ```
//!
//! # Architecture
//!
//! The SDK is organized into several modules:
//!
//! - [`client`] - Main entry point for creating and managing collaborative sessions
//! - [`document`] - Document types (text, rich text, JSON)
//! - [`presence`] - Real-time cursor and user presence
//! - [`sync`] - Network synchronization and peer management
//! - [`network`] - Network transport abstractions
//! - [`session`] - Session management for collaborative editing
//! - [`error`] - Error types

pub mod client;
pub mod document;
pub mod error;
pub mod network;
pub mod presence;
pub mod session;
pub mod sync;

// Re-exports for convenience
pub use client::{Client, ClientConfig, ClientConfigBuilder};
pub use document::{CollaborativeDoc, DocEvent, JsonDoc, RichTextDoc, TextDoc};
pub use error::{Result, SdkError};
pub use network::{MemoryTransport, Message, NetworkTransport, Peer, PeerId, PeerState};
pub use presence::{Awareness, AwarenessEvent, CursorInfo, UserPresenceInfo};
pub use session::{Session, SessionEvent};
pub use sync::{SyncConfig, SyncConfigBuilder, SyncEvent, SyncManager};

// Re-export commonly used types from mdcs-db
pub use mdcs_db::{
    json_crdt::{JsonPath, JsonValue},
    presence::{Cursor, UserId, UserInfo, UserStatus},
    rich_text::MarkType,
};

/// Prelude module for convenient imports.
pub mod prelude {
    pub use crate::client::{Client, ClientConfig};
    pub use crate::document::{CollaborativeDoc, JsonDoc, RichTextDoc, TextDoc};
    pub use crate::error::SdkError;
    pub use crate::network::{NetworkTransport, Peer, PeerId};
    pub use crate::presence::{Awareness, CursorInfo};
    pub use crate::session::Session;
    pub use crate::sync::{SyncConfig, SyncManager};
}