tinychannels 0.1.0

Pluggable channel and messaging primitives for OpenHuman harness communication.
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
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Shared channel reference types.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

/// Catalog-driven channel descriptor. `id` is intentionally open-ended.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(default, rename_all = "camelCase")]
pub struct ChannelDescriptor {
    pub id: String,
    pub display_name: String,
    pub account_id: Option<String>,
    pub aliases: Vec<String>,
    pub metadata: BTreeMap<String, String>,
}

/// Reference to one channel/account surface.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(default, rename_all = "camelCase")]
pub struct ChannelRef {
    pub id: String,
    pub account_id: Option<String>,
}

/// Provider-neutral conversation kind.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ConversationKind {
    Dm,
    Group,
    Channel,
    Thread,
    #[default]
    Unknown,
}

impl ConversationKind {
    pub fn as_session_segment(self) -> &'static str {
        match self {
            Self::Dm => "dm",
            Self::Group => "group",
            Self::Channel => "channel",
            Self::Thread => "thread",
            Self::Unknown => "unknown",
        }
    }
}

/// Reference to an inbound or outbound conversation.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(default, rename_all = "camelCase")]
pub struct ConversationRef {
    pub kind: ConversationKind,
    pub id: String,
    pub scope_id: Option<String>,
    pub parent_id: Option<String>,
    pub thread_id: Option<String>,
    pub topic_id: Option<String>,
}

impl Default for ConversationRef {
    fn default() -> Self {
        Self {
            kind: ConversationKind::Unknown,
            id: String::new(),
            scope_id: None,
            parent_id: None,
            thread_id: None,
            topic_id: None,
        }
    }
}

/// Reference to the message sender.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(default, rename_all = "camelCase")]
pub struct SenderRef {
    pub id: String,
    pub alt_ids: Vec<String>,
    pub name: Option<String>,
    pub is_bot: bool,
    pub roles: Vec<String>,
}

/// Host-owned secret reference. Secret values never live in this crate's types.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(default, rename_all = "camelCase")]
pub struct SecretRef {
    pub id: String,
    pub label: Option<String>,
}