agentzero-channels 0.3.0

AgentZero — modular AI-agent runtime and tool framework
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

pub mod channel_setup;
pub mod helpers;

// ---------------------------------------------------------------------------
// Macro 1: channel_stub! — one-liner for unimplemented channels
// Generates struct, descriptor, and async Channel impl that bail!s.
// ---------------------------------------------------------------------------

#[allow(unused_macros)]
macro_rules! channel_stub {
    ($name:ident, $descriptor:ident, $id:literal, $display:literal) => {
        #[allow(dead_code)]
        pub struct $name;

        pub const $descriptor: crate::ChannelDescriptor = crate::ChannelDescriptor {
            id: $id,
            display_name: $display,
        };

        #[async_trait::async_trait]
        impl crate::Channel for $name {
            fn name(&self) -> &str {
                $id
            }

            async fn send(&self, _message: &crate::SendMessage) -> anyhow::Result<()> {
                anyhow::bail!("channel `{}` is not implemented yet", $id)
            }

            async fn listen(
                &self,
                _tx: tokio::sync::mpsc::Sender<crate::ChannelMessage>,
            ) -> anyhow::Result<()> {
                anyhow::bail!("channel `{}` is not implemented yet", $id)
            }

            async fn health_check(&self) -> bool {
                false
            }
        }
    };
}

#[allow(unused_imports)]
pub(crate) use channel_stub;

// ---------------------------------------------------------------------------
// Macro 2: channel_meta! — descriptor const for implemented channels.
// The struct and Channel impl are written manually in the same file.
// ---------------------------------------------------------------------------

macro_rules! channel_meta {
    ($descriptor:ident, $id:literal, $display:literal) => {
        pub const $descriptor: crate::ChannelDescriptor = crate::ChannelDescriptor {
            id: $id,
            display_name: $display,
        };
    };
}

pub(crate) use channel_meta;

// ---------------------------------------------------------------------------
// Macro 3: channel_catalog! — auto-wires module tree + catalog array.
// Adding a new channel = add one line here + create the file.
// ---------------------------------------------------------------------------

macro_rules! channel_catalog {
    ($( $module:ident => ($name:ident, $descriptor:ident) ),+ $(,)?) => {
        $(mod $module;)+

        $(#[allow(unused_imports)] pub use $module::$name;)+
        $(use $module::$descriptor;)+

        pub const CHANNEL_CATALOG: &[crate::ChannelDescriptor] = &[
            $($descriptor,)+
        ];
    };
}

// ---------------------------------------------------------------------------
// Channel catalog — the single place to register all channels.
// To add a new channel:
//   1. Create src/channels/my_channel.rs with channel_stub! or channel_meta!
//   2. Add one line below: my_channel => (MyChannel, MY_CHANNEL_DESCRIPTOR),
// ---------------------------------------------------------------------------

channel_catalog!(
    cli               => (CliChannel, CLI_DESCRIPTOR),
    telegram          => (TelegramChannel, TELEGRAM_DESCRIPTOR),
    discord           => (DiscordChannel, DISCORD_DESCRIPTOR),
    slack             => (SlackChannel, SLACK_DESCRIPTOR),
    mattermost        => (MattermostChannel, MATTERMOST_DESCRIPTOR),
    imessage          => (ImessageChannel, IMESSAGE_DESCRIPTOR),
    matrix            => (MatrixChannel, MATRIX_DESCRIPTOR),
    signal            => (SignalChannel, SIGNAL_DESCRIPTOR),
    whatsapp          => (WhatsappChannel, WHATSAPP_DESCRIPTOR),
    mqtt              => (MqttChannel, MQTT_DESCRIPTOR),
    transcription     => (TranscriptionChannel, TRANSCRIPTION_DESCRIPTOR),
    whatsapp_storage  => (WhatsappStorageChannel, WHATSAPP_STORAGE_DESCRIPTOR),
    whatsapp_web      => (WhatsappWebChannel, WHATSAPP_WEB_DESCRIPTOR),
    linq              => (LinqChannel, LINQ_DESCRIPTOR),
    wati              => (WatiChannel, WATI_DESCRIPTOR),
    nextcloud_talk    => (NextcloudTalkChannel, NEXTCLOUD_TALK_DESCRIPTOR),
    email             => (EmailChannel, EMAIL_DESCRIPTOR),
    irc               => (IrcChannel, IRC_DESCRIPTOR),
    lark              => (LarkChannel, LARK_DESCRIPTOR),
    feishu            => (FeishuChannel, FEISHU_DESCRIPTOR),
    dingtalk          => (DingtalkChannel, DINGTALK_DESCRIPTOR),
    qq_official       => (QqOfficialChannel, QQ_OFFICIAL_DESCRIPTOR),
    nostr             => (NostrChannel, NOSTR_DESCRIPTOR),
    clawdtalk         => (ClawdtalkChannel, CLAWDTALK_DESCRIPTOR),
    webhook           => (WebhookChannel, WEBHOOK_DESCRIPTOR),
    napcat            => (NapcatChannel, NAPCAT_DESCRIPTOR),
    acp               => (AcpChannel, ACP_DESCRIPTOR),
);