Merge pull request #452 from twitch-rs/feat/more-eventsub

feat: `channel.shared_chat.*`

Cargo.toml

@@ -120,6 +120,7 @@ pubsub = [
 
 eventsub = [
     "serde_json/raw_value",
+    "twitch_types/chat",
     "twitch_types/emote",
     "twitch_types/eventsub",
     "twitch_types/goal",

src/eventsub/channel/mod.rs

@@ -18,6 +18,7 @@ pub mod hypetrain;
 pub mod poll;
 pub mod prediction;
 pub mod raid;
+pub mod shared_chat;
 pub mod shield_mode;
 pub mod shoutout;
 pub mod subscribe;
@@ -104,6 +105,12 @@ pub use prediction::{ChannelPredictionProgressV1, ChannelPredictionProgressV1Pay
 #[doc(inline)]
 pub use raid::{ChannelRaidV1, ChannelRaidV1Payload};
 #[doc(inline)]
+pub use shared_chat::{ChannelSharedChatBeginV1, ChannelSharedChatBeginV1Payload};
+#[doc(inline)]
+pub use shared_chat::{ChannelSharedChatEndV1, ChannelSharedChatEndV1Payload};
+#[doc(inline)]
+pub use shared_chat::{ChannelSharedChatUpdateV1, ChannelSharedChatUpdateV1Payload};
+#[doc(inline)]
 pub use shield_mode::{ChannelShieldModeBeginV1, ChannelShieldModeBeginV1Payload};
 #[doc(inline)]
 pub use shield_mode::{ChannelShieldModeEndV1, ChannelShieldModeEndV1Payload};

src/eventsub/channel/shared_chat/begin.rs

@@ -0,0 +1,134 @@
+#![doc(alias = "channel.shared_chat.begin")]
+//! A channel becomes active in an active shared chat session.
+
+use super::*;
+
+/// [`channel.shared_chat.begin`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshared_chatbegin): a channel becomes active in an active shared chat session.
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(feature = "typed-builder", derive(typed_builder::TypedBuilder))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
+#[non_exhaustive]
+pub struct ChannelSharedChatBeginV1 {
+    /// The User ID of the channel to receive shared chat session begin events for.
+    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
+    pub broadcaster_user_id: types::UserId,
+}
+
+impl ChannelSharedChatBeginV1 {
+    /// The User ID of the channel to receive shared chat session begin events for.
+    pub fn broadcaster_user_id(broadcaster_user_id: impl Into<types::UserId>) -> Self {
+        Self {
+            broadcaster_user_id: broadcaster_user_id.into(),
+        }
+    }
+}
+
+impl EventSubscription for ChannelSharedChatBeginV1 {
+    type Payload = ChannelSharedChatBeginV1Payload;
+
+    const EVENT_TYPE: EventType = EventType::ChannelSharedChatBegin;
+    #[cfg(feature = "twitch_oauth2")]
+    const SCOPE: twitch_oauth2::Validator = twitch_oauth2::validator![];
+    const VERSION: &'static str = "1";
+}
+
+/// [`channel.shared_chat.begin`](ChannelSharedChatBeginV1) response payload.
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
+#[non_exhaustive]
+pub struct ChannelSharedChatBeginV1Payload {
+    /// The unique identifier for the shared chat session.
+    pub session_id: types::SharedChatSessionId,
+    /// The User ID of the channel in the subscription condition which is now active in the shared chat session.
+    pub broadcaster_user_id: types::UserId,
+    /// The display name of the channel in the subscription condition which is now active in the shared chat session.
+    pub broadcaster_user_name: types::DisplayName,
+    /// The user login of the channel in the subscription condition which is now active in the shared chat session.
+    pub broadcaster_user_login: types::UserName,
+    /// The User ID of the host channel.
+    pub host_broadcaster_user_id: types::UserId,
+    /// The display name of the host channel.
+    pub host_broadcaster_user_name: types::DisplayName,
+    /// The user login of the host channel.
+    pub host_broadcaster_user_login: types::UserName,
+    /// The list of participants in the session.
+    pub participants: Vec<Participant>,
+}
+
+#[cfg(test)]
+#[test]
+fn parse_payload() {
+    use crate::eventsub::{Event, Message};
+
+    let payload = r##"
+    {
+        "subscription": {
+            "id": "bf0602d2-5b39-4ece-b1a4-44191d52df6b",
+            "status": "enabled",
+            "type": "channel.shared_chat.begin",
+            "version": "1",
+            "condition": {
+                "broadcaster_user_id": "1971641"
+            },
+            "transport": {
+                "method": "websocket",
+                "session_id": "AgoQOtgGkFvXRlSkij343CndhIGY2VsbC1h"
+            },
+            "created_at": "2023-10-06T18:04:38.807682738Z",
+            "cost": 0
+        },
+        "event": {
+            "session_id": "2b64a92a-dbb8-424e-b1c3-304423ba1b6f",
+            "broadcaster_user_id": "1971641",
+            "broadcaster_user_login": "streamer",
+            "broadcaster_user_name": "streamer",
+            "host_broadcaster_user_id": "1971641",
+            "host_broadcaster_user_login": "streamer",
+            "host_broadcaster_user_name": "streamer",
+            "participants": [
+                {
+                    "broadcaster_user_id": "1971641",
+                    "broadcaster_user_name": "streamer",
+                    "broadcaster_user_login": "streamer"
+                },
+                {
+                    "broadcaster_user_id": "112233",
+                    "broadcaster_user_name": "streamer33",
+                    "broadcaster_user_login": "streamer33"
+                }
+            ]
+        }
+    }
+    "##;
+
+    let val = Event::parse(payload).unwrap();
+    crate::tests::roundtrip(&val);
+
+    let Event::ChannelSharedChatBeginV1(val) = val else {
+        panic!("invalid event type");
+    };
+    let Message::Notification(notif) = val.message else {
+        panic!("invalid message type");
+    };
+
+    assert_eq!(notif.broadcaster_user_id.as_str(), "1971641");
+    assert_eq!(notif.broadcaster_user_id, notif.host_broadcaster_user_id);
+    assert_eq!(
+        notif.broadcaster_user_login,
+        notif.host_broadcaster_user_login
+    );
+    assert_eq!(
+        notif.broadcaster_user_name,
+        notif.host_broadcaster_user_name
+    );
+    assert_eq!(
+        notif.session_id.as_str(),
+        "2b64a92a-dbb8-424e-b1c3-304423ba1b6f"
+    );
+    assert_eq!(notif.participants.len(), 2);
+    assert_eq!(
+        notif.participants[0].broadcaster_user_id.as_str(),
+        "1971641"
+    );
+    assert_eq!(notif.participants[1].broadcaster_user_id.as_str(), "112233");
+}

src/eventsub/channel/shared_chat/end.rs

@@ -0,0 +1,114 @@
+#![doc(alias = "channel.shared_chat.end")]
+//! A channel leaves a shared chat session or the session ends.
+
+use super::*;
+
+/// [`channel.shared_chat.end`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshared_chatend): a channel leaves a shared chat session or the session ends.
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(feature = "typed-builder", derive(typed_builder::TypedBuilder))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
+#[non_exhaustive]
+pub struct ChannelSharedChatEndV1 {
+    /// The User ID of the channel to receive shared chat session end events for.
+    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
+    pub broadcaster_user_id: types::UserId,
+}
+
+impl ChannelSharedChatEndV1 {
+    /// The User ID of the channel to receive shared chat session end events for.
+    pub fn broadcaster_user_id(broadcaster_user_id: impl Into<types::UserId>) -> Self {
+        Self {
+            broadcaster_user_id: broadcaster_user_id.into(),
+        }
+    }
+}
+
+impl EventSubscription for ChannelSharedChatEndV1 {
+    type Payload = ChannelSharedChatEndV1Payload;
+
+    const EVENT_TYPE: EventType = EventType::ChannelSharedChatEnd;
+    #[cfg(feature = "twitch_oauth2")]
+    const SCOPE: twitch_oauth2::Validator = twitch_oauth2::validator![];
+    const VERSION: &'static str = "1";
+}
+
+/// [`channel.shared_chat.end`](ChannelSharedChatEndV1) response payload.
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
+#[non_exhaustive]
+pub struct ChannelSharedChatEndV1Payload {
+    /// The unique identifier for the shared chat session.
+    pub session_id: types::SharedChatSessionId,
+    /// The User ID of the channel in the subscription condition which is no longer active in the shared chat session.
+    pub broadcaster_user_id: types::UserId,
+    /// The display name of the channel in the subscription condition which is no longer active in the shared chat session.
+    pub broadcaster_user_name: types::DisplayName,
+    /// The user login of the channel in the subscription condition which is no longer active in the shared chat session.
+    pub broadcaster_user_login: types::UserName,
+    /// The User ID of the host channel.
+    pub host_broadcaster_user_id: types::UserId,
+    /// The display name of the host channel.
+    pub host_broadcaster_user_name: types::DisplayName,
+    /// The user login of the host channel.
+    pub host_broadcaster_user_login: types::UserName,
+}
+
+#[cfg(test)]
+#[test]
+fn parse_payload() {
+    use crate::eventsub::{Event, Message};
+
+    let payload = r##"
+    {
+        "subscription": {
+            "id": "84a875f1-1dc0-43b2-8ed3-d7db4d650c37",
+            "status": "enabled",
+            "type": "channel.shared_chat.end",
+            "version": "1",
+            "condition": {
+                "broadcaster_user_id": "112233"
+            },
+            "transport": {
+                "method": "websocket",
+                "session_id": "AgoQOtgGkFvXRlSkij343CndhIGY2VsbC1h"
+            },
+            "created_at": "2023-10-06T18:04:38.807682738Z",
+            "cost": 0
+        },
+        "event": {
+            "session_id": "2b64a92a-dbb8-424e-b1c3-304423ba1b6f",
+            "broadcaster_user_id": "1971641",
+            "broadcaster_user_login": "streamer",
+            "broadcaster_user_name": "streamer",
+            "host_broadcaster_user_id": "1971641",
+            "host_broadcaster_user_login": "streamer",
+            "host_broadcaster_user_name": "streamer"
+        }
+    }
+    "##;
+
+    let val = Event::parse(payload).unwrap();
+    crate::tests::roundtrip(&val);
+
+    let Event::ChannelSharedChatEndV1(val) = val else {
+        panic!("invalid event type");
+    };
+    let Message::Notification(notif) = val.message else {
+        panic!("invalid message type");
+    };
+
+    assert_eq!(notif.broadcaster_user_id.as_str(), "1971641");
+    assert_eq!(notif.broadcaster_user_id, notif.host_broadcaster_user_id);
+    assert_eq!(
+        notif.broadcaster_user_login,
+        notif.host_broadcaster_user_login
+    );
+    assert_eq!(
+        notif.broadcaster_user_name,
+        notif.host_broadcaster_user_name
+    );
+    assert_eq!(
+        notif.session_id.as_str(),
+        "2b64a92a-dbb8-424e-b1c3-304423ba1b6f"
+    );
+}

src/eventsub/channel/shared_chat/mod.rs

@@ -0,0 +1,29 @@
+#![doc(alias = "channel.shared_chat")]
+//! Events related to shared chat
+use super::{EventSubscription, EventType};
+use crate::types;
+use serde_derive::{Deserialize, Serialize};
+
+pub mod begin;
+pub mod end;
+pub mod update;
+
+#[doc(inline)]
+pub use begin::{ChannelSharedChatBeginV1, ChannelSharedChatBeginV1Payload};
+#[doc(inline)]
+pub use end::{ChannelSharedChatEndV1, ChannelSharedChatEndV1Payload};
+#[doc(inline)]
+pub use update::{ChannelSharedChatUpdateV1, ChannelSharedChatUpdateV1Payload};
+
+/// A participant in a shared chat session
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
+#[non_exhaustive]
+pub struct Participant {
+    /// The User ID of the participant channel.
+    pub broadcaster_user_id: types::UserId,
+    /// The display name of the participant channel.
+    pub broadcaster_user_name: types::UserName,
+    /// The user login of the participant channel.
+    pub broadcaster_user_login: types::DisplayName,
+}