jarvis-social

Social features — presence, chat, channels, and collaboration

Overview

The jarvis-social crate provides social and collaboration features:

• Presence tracking (who’s online)
• Real-time chat
• Channels and direct messages
• Game invites and pokes
• Experimental: Voice chat, screen sharing, pair programming

Public API

Identity

Represents the local user.

use jarvis_social::Identity;

let identity = Identity {
    user_id: "user_123".to_string(),
    display_name: "Alice".to_string(),
};

PresenceClient

Manages presence tracking via Supabase Realtime.

use jarvis_social::{PresenceClient, PresenceConfig};

let config = PresenceConfig {
    supabase_url: "https://xxx.supabase.co".to_string(),
    supabase_anon_key: "eyJ...".to_string(),
    channel_name: "jarvis:presence".to_string(),
};

let client = PresenceClient::new(config);
client.connect(identity).await?;

PresenceConfig · struct

Show Fields

supabase_url · string · required

Supabase project URL.

supabase_anon_key · string · required

Supabase anonymous API key.

channel_name · string · required

Realtime channel name for presence.

PresenceEvent

Events emitted by the presence system.

PresenceEvent · enum

• UserJoined { user: OnlineUser } — A user came online
• UserLeft { user_id: String } — A user went offline
• UserUpdated { user: OnlineUser } — A user’s status/activity changed
• Snapshot { users: Vec<OnlineUser> } — Full list of online users

Protocol Types

UserStatus

User presence status.

UserStatus · enum

• Online — Available
• Idle — Away from keyboard
• InGame — Playing a game
• InSkill — Using an AI skill
• DoNotDisturb — Do not disturb
• Away — Away

OnlineUser

Information about an online user.

OnlineUser · struct

Show Fields

user_id · string · required

Unique user ID.

display_name · string · required

User’s display name.

status · UserStatus · required

Current status.

activity · Option<string>

Current activity description (e.g., “Playing Wordle”).

Chat

ChatHistory

Manages chat message history.

use jarvis_social::{ChatHistory, ChatHistoryConfig, ChatMessage};

let config = ChatHistoryConfig {
    max_messages: 1000,
    persist_to_disk: true,
};

let mut history = ChatHistory::new(config);
history.add_message(ChatMessage {
    user_id: "user_123".to_string(),
    display_name: "Alice".to_string(),
    content: "Hello!".to_string(),
    timestamp: chrono::Utc::now().to_rfc3339(),
});

ChatMessage · struct

Show Fields

user_id · string · required

ID of the user who sent the message.

display_name · string · required

Display name of the sender.

content · string · required

Message content.

timestamp · string · required

ISO 8601 timestamp.

Channels

ChannelManager

Manages multiple chat channels.

use jarvis_social::{ChannelManager, Channel};

let mut manager = ChannelManager::new();
manager.create_channel("general".to_string());
manager.join_channel("general");

Channel · struct

Represents a chat channel.

Show Fields

name · string · required

Channel name (e.g., general, random).

members · Vec<string> · required

List of user IDs in this channel.

Broadcast Payloads

These payloads are sent via Supabase Realtime broadcasts.

ActivityUpdatePayload

ActivityUpdatePayload · struct

Show Fields

user_id · string · required

User ID.

display_name · string · required

Display name.

status · UserStatus · required

New status.

activity · Option<string>

Activity description.

GameInvitePayload

GameInvitePayload · struct

Show Fields

user_id · string · required

Inviter’s user ID.

display_name · string · required

Inviter’s display name.

game · string · required

Game name (e.g., wordle, tetris).

code · Option<string>

Optional game room code.

PokePayload

PokePayload · struct

Show Fields

user_id · string · required

Poker’s user ID.

display_name · string · required

Poker’s display name.

target_user_id · string · required

Target user ID.

ChatMessagePayload

ChatMessagePayload · struct

Show Fields

user_id · string · required

Sender’s user ID.

display_name · string · required

Sender’s display name.

channel · string · required

Channel name.

content · string · required

Message content.

timestamp · string · required

ISO 8601 timestamp.

reply_to · Option<string>

Optional message ID this is replying to.

Experimental Features

These features require the experimental-collab feature flag.

Voice Chat

#[cfg(feature = "experimental-collab")]
use jarvis_social::{VoiceManager, VoiceConfig, VoiceRoom};

let config = VoiceConfig::default();
let manager = VoiceManager::new(config);

Screen Sharing

#[cfg(feature = "experimental-collab")]
use jarvis_social::{ScreenShareManager, ScreenShareConfig, ShareQuality};

let config = ScreenShareConfig {
    quality: ShareQuality::High,
    frame_rate: 30,
};
let manager = ScreenShareManager::new(config);

Pair Programming

#[cfg(feature = "experimental-collab")]
use jarvis_social::{PairManager, PairConfig, PairRole, PairSession};

let config = PairConfig::default();
let manager = PairManager::new(config);

PairRole · enum

• Driver — Has control of the terminal
• Navigator — Can view and suggest

Usage Example

use jarvis_social::{
    PresenceClient, PresenceConfig, PresenceEvent,
    Identity, UserStatus
};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = PresenceConfig {
        supabase_url: std::env::var("SUPABASE_URL")?,
        supabase_anon_key: std::env::var("SUPABASE_KEY")?,
        channel_name: "jarvis:presence".to_string(),
    };
    
    let identity = Identity {
        user_id: "alice_123".to_string(),
        display_name: "Alice".to_string(),
    };
    
    let mut client = PresenceClient::new(config);
    client.connect(identity).await?;
    
    // Update status
    client.update_status(UserStatus::Online, Some("Coding in Rust")).await?;
    
    // Listen for events
    while let Some(event) = client.next_event().await {
        match event {
            PresenceEvent::UserJoined { user } => {
                println!("{} joined", user.display_name);
            }
            PresenceEvent::UserLeft { user_id } => {
                println!("User {} left", user_id);
            }
            _ => {}
        }
    }
    
    Ok(())
}

Related

• Presence Configuration — Supabase settings
• Livechat Configuration — Chat server settings