@overlaysymphony/twitch 0.2.2 → 0.3.0

package/src/eventsub/events/channel.shared_chat.end-1.ts

@@ -0,0 +1,46 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shared_chat.end": ChannelSharedChatEnd
+  }
+}
+
+/** Channel Shared Chat End v1: When a channel leaves a shared chat session or the session ends. */
+type ChannelSharedChatEnd = EventConfig<{
+  Type: "channel.shared_chat.end"
+  Version: "1"
+  /** The conditions to listen for when a channel leaves a shared chat session or the session ends. */
+  Condition: {
+    /** The User ID of the channel to receive shared chat session end events for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a channel leaves a shared chat session or the session ends. */
+  Event: {
+    /** The unique identifier for the shared chat session. */
+    session_id: string
+    /** The User ID of the channel in the subscription condition which is no longer active in the shared chat session. */
+    broadcaster_user_id: string
+    /** The display name of the channel in the subscription condition which is no longer active in the shared chat session. */
+    broadcaster_user_name: string
+    /** The user login of the channel in the subscription condition which is no longer active in the shared chat session. */
+    broadcaster_user_login: string
+    /** The User ID of the host channel. */
+    host_broadcaster_user_id: string
+    /** The display name of the host channel. */
+    host_broadcaster_user_name: string
+    /** The user login of the host channel. */
+    host_broadcaster_user_login: string
+  }
+}>
+
+registerEvent("channel.shared_chat.end", {
+  scopes: [],
+  subscriber: (userId) => ({
+    type: "channel.shared_chat.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.shared_chat.update-1.ts

@@ -0,0 +1,55 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shared_chat.update": ChannelSharedChatUpdate
+  }
+}
+
+/** Channel Shared Chat Update v1: When the active shared chat session the channel is in changes. */
+type ChannelSharedChatUpdate = EventConfig<{
+  Type: "channel.shared_chat.update"
+  Version: "1"
+  /** The conditions to listen for when the active shared chat session the channel is in changes. */
+  Condition: {
+    /** The User ID of the channel to receive shared chat session update events for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when the active shared chat session the channel is in changes. */
+  Event: {
+    /** The unique identifier for the shared chat session. */
+    session_id: string
+    /** The User ID of the channel in the subscription condition. */
+    broadcaster_user_id: string
+    /** The display name of the channel in the subscription condition. */
+    broadcaster_user_name: string
+    /** The user login of the channel in the subscription condition. */
+    broadcaster_user_login: string
+    /** The User ID of the host channel. */
+    host_broadcaster_user_id: string
+    /** The display name of the host channel. */
+    host_broadcaster_user_name: string
+    /** The user login of the host channel. */
+    host_broadcaster_user_login: string
+    /** The list of participants in the session. */
+    participants: {
+      /** The User ID of the participant channel. */
+      broadcaster_user_id: string
+      /** The display name of the participant channel. */
+      broadcaster_user_name: string
+      /** The user login of the participant channel. */
+      broadcaster_user_login: string
+    }
+  }
+}>
+
+registerEvent("channel.shared_chat.update", {
+  scopes: [],
+  subscriber: (userId) => ({
+    type: "channel.shared_chat.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.shield_mode.begin-1.ts

@@ -0,0 +1,51 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shield_mode.begin": ChannelShieldModeBegin
+  }
+}
+
+/** Channel Shield Mode Begin v1: When the broadcaster activates Shield Mode. */
+type ChannelShieldModeBegin = EventConfig<{
+  Type: "channel.shield_mode.begin"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster activates Shield Mode. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they activate Shield Mode. */
+    broadcaster_user_id: string
+    /** The ID of the broadcaster or one of the broadcaster's moderators. */
+    moderator_user_id: string
+  }
+  /** The event fired when the broadcaster activates Shield Mode. */
+  Event: {
+    /** An ID that identifies the broadcaster whose Shield Mode status was updated. */
+    broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** An ID that identifies the moderator that updated the Shield Mode's status. If the broadcaster updated the status, this ID will be the same as broadcaster_user_id. */
+    moderator_user_id: string
+    /** The moderator's login name. */
+    moderator_user_login: string
+    /** The moderator's display name. */
+    moderator_user_name: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator activated Shield Mode. The object includes this field only for channel.shield_mode.begin events. */
+    started_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator deactivated Shield Mode. The object includes this field only for channel.shield_mode.end events. */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.shield_mode.begin", {
+  scopes: ["moderator:manage:shield", "moderator:read:shield"],
+  subscriber: (userId) => ({
+    type: "channel.shield_mode.begin",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.shield_mode.end-1.ts

@@ -0,0 +1,51 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shield_mode.end": ChannelShieldModeEnd
+  }
+}
+
+/** Channel Shield Mode End v1: When the broadcaster deactivates Shield Mode. */
+type ChannelShieldModeEnd = EventConfig<{
+  Type: "channel.shield_mode.end"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster deactivates Shield Mode. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they deactivate Shield Mode. */
+    broadcaster_user_id: string
+    /** The ID of the broadcaster or one of the broadcaster's moderators. */
+    moderator_user_id: string
+  }
+  /** The event fired when the broadcaster deactivates Shield Mode. */
+  Event: {
+    /** An ID that identifies the broadcaster whose Shield Mode status was updated. */
+    broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** An ID that identifies the moderator that updated the Shield Mode's status. If the broadcaster updated the status, this ID will be the same as broadcaster_user_id. */
+    moderator_user_id: string
+    /** The moderator's login name. */
+    moderator_user_login: string
+    /** The moderator's display name. */
+    moderator_user_name: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator activated Shield Mode. The object includes this field only for channel.shield_mode.begin events. */
+    started_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator deactivated Shield Mode. The object includes this field only for channel.shield_mode.end events. */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.shield_mode.end", {
+  scopes: ["moderator:manage:shield", "moderator:read:shield"],
+  subscriber: (userId) => ({
+    type: "channel.shield_mode.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.shoutout.create-1.ts

@@ -0,0 +1,61 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shoutout.create": ChannelShoutoutCreate
+  }
+}
+
+/** Channel Shoutout Create v1: When the specified broadcaster sends a Shoutout. */
+type ChannelShoutoutCreate = EventConfig<{
+  Type: "channel.shoutout.create"
+  Version: "1"
+  /** The conditions to listen for when the specified broadcaster sends a Shoutout. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they send a Shoutout. */
+    broadcaster_user_id: string
+    /** The ID of the broadcaster that gave the Shoutout or one of the broadcaster's moderators. */
+    moderator_user_id: string
+  }
+  /** The event fired when the specified broadcaster sends a Shoutout. */
+  Event: {
+    /** An ID that identifies the broadcaster that sent the Shoutout. */
+    broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** An ID that identifies the broadcaster that received the Shoutout. */
+    to_broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    to_broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    to_broadcaster_user_name: string
+    /** An ID that identifies the moderator that sent the Shoutout. If the broadcaster sent the Shoutout, this ID is the same as the ID in broadcaster_user_id. */
+    moderator_user_id: string
+    /** The moderator's login name. */
+    moderator_user_login: string
+    /** The moderator's display name. */
+    moderator_user_name: string
+    /** The number of users that were watching the broadcaster's stream at the time of the Shoutout. */
+    viewer_count: number
+    /** The UTC timestamp (in RFC3339 format) of when the moderator sent the Shoutout. */
+    started_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the broadcaster may send a Shoutout to a different broadcaster. */
+    cooldown_ends_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the broadcaster may send another Shoutout to the broadcaster in to_broadcaster_user_id. */
+    target_cooldown_ends_at: string
+  }
+}>
+
+registerEvent("channel.shoutout.create", {
+  scopes: ["moderator:manage:shoutouts", "moderator:read:shoutouts"],
+  subscriber: (userId) => ({
+    type: "channel.shoutout.create",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.shoutout.receive-1.ts

@@ -0,0 +1,51 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shoutout.receive": ChannelShoutoutReceive
+  }
+}
+
+/** Channel Shoutout Receive v1: When the specified broadcaster receives a Shoutout. */
+type ChannelShoutoutReceive = EventConfig<{
+  Type: "channel.shoutout.receive"
+  Version: "1"
+  /** The conditions to listen for when the specified broadcaster receives a Shoutout. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they receive a Shoutout. */
+    broadcaster_user_id: string
+    /** The ID of the broadcaster that received the Shoutout or one of the broadcaster's moderators. */
+    moderator_user_id: string
+  }
+  /** The event fired when the specified broadcaster receives a Shoutout. */
+  Event: {
+    /** An ID that identifies the broadcaster that received the Shoutout. */
+    broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** An ID that identifies the broadcaster that sent the Shoutout. */
+    from_broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    from_broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    from_broadcaster_user_name: string
+    /** The number of users that were watching the from-broadcaster's stream at the time of the Shoutout. */
+    viewer_count: number
+    /** The UTC timestamp (in RFC3339 format) of when the moderator sent the Shoutout. */
+    started_at: string
+  }
+}>
+
+registerEvent("channel.shoutout.receive", {
+  scopes: ["moderator:manage:shoutouts", "moderator:read:shoutouts"],
+  subscriber: (userId) => ({
+    type: "channel.shoutout.receive",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.subscribe-1.ts

@@ -0,0 +1,48 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.subscribe": ChannelSubscribe
+  }
+}
+
+/** Channel Subscribe v1: When the specified channel receives a subscriber. This does not include resubscribes. */
+type ChannelSubscribe = EventConfig<{
+  Type: "channel.subscribe"
+  Version: "1"
+  /** The conditions to listen for when the specified channel receives a subscriber. This does not include resubscribes. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to get subscribe notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when the specified channel receives a subscriber. This does not include resubscribes. */
+  Event: {
+    /** The user ID for the user who subscribed to the specified channel. */
+    user_id: string
+    /** The user login for the user who subscribed to the specified channel. */
+    user_login: string
+    /** The user display name for the user who subscribed to the specified channel. */
+    user_name: string
+    /** The requested broadcaster ID. */
+    broadcaster_user_id: string
+    /** The requested broadcaster login. */
+    broadcaster_user_login: string
+    /** The requested broadcaster display name. */
+    broadcaster_user_name: string
+    /** The tier of the subscription. Valid values are 1000, 2000, and 3000. */
+    tier: string
+    /** Whether the subscription is a gift. */
+    is_gift: boolean
+  }
+}>
+
+registerEvent("channel.subscribe", {
+  scopes: ["channel:read:subscriptions"],
+  subscriber: (userId) => ({
+    type: "channel.subscribe",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.subscription.end-1.ts

@@ -0,0 +1,48 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.subscription.end": ChannelSubscriptionEnd
+  }
+}
+
+/** Channel Subscription End v1: When a subscription to the specified channel ends. */
+type ChannelSubscriptionEnd = EventConfig<{
+  Type: "channel.subscription.end"
+  Version: "1"
+  /** The conditions to listen for when a subscription to the specified channel ends. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to get subscription end notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a subscription to the specified channel ends. */
+  Event: {
+    /** The user ID for the user whose subscription ended. */
+    user_id: string
+    /** The user login for the user whose subscription ended. */
+    user_login: string
+    /** The user display name for the user whose subscription ended. */
+    user_name: string
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The tier of the subscription that ended. Valid values are 1000, 2000, and 3000. */
+    tier: string
+    /** Whether the subscription was a gift. */
+    is_gift: boolean
+  }
+}>
+
+registerEvent("channel.subscription.end", {
+  scopes: ["channel:read:subscriptions"],
+  subscriber: (userId) => ({
+    type: "channel.subscription.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.subscription.gift-1.ts

@@ -0,0 +1,52 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.subscription.gift": ChannelSubscriptionGift
+  }
+}
+
+/** Channel Subscription Gift v1: When a viewer gives a gift subscription to one or more users in the specified channel. */
+type ChannelSubscriptionGift = EventConfig<{
+  Type: "channel.subscription.gift"
+  Version: "1"
+  /** The conditions to listen for when a viewer gives a gift subscription to one or more users in the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to get subscription gift notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a viewer gives a gift subscription to one or more users in the specified channel. */
+  Event: {
+    /** The user ID of the user who sent the subscription gift. Set to null if it was an anonymous subscription gift. */
+    user_id: string
+    /** The user login of the user who sent the gift. Set to null if it was an anonymous subscription gift. */
+    user_login: string
+    /** The user display name of the user who sent the gift. Set to null if it was an anonymous subscription gift. */
+    user_name: string
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The number of subscriptions in the subscription gift. */
+    total: number
+    /** The tier of subscriptions in the subscription gift. */
+    tier: string
+    /** The number of subscriptions gifted by this user in the channel. This value is null for anonymous gifts or if the gifter has opted out of sharing this information. */
+    cumulative_total: number
+    /** Whether the subscription gift was anonymous. */
+    is_anonymous: boolean
+  }
+}>
+
+registerEvent("channel.subscription.gift", {
+  scopes: ["channel:read:subscriptions"],
+  subscriber: (userId) => ({
+    type: "channel.subscription.gift",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.subscription.message-1.ts

@@ -0,0 +1,66 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.subscription.message": ChannelSubscriptionMessage
+  }
+}
+
+/** Channel Subscription Message v1: When a user sends a resubscription chat message in a specific channel. */
+type ChannelSubscriptionMessage = EventConfig<{
+  Type: "channel.subscription.message"
+  Version: "1"
+  /** The conditions to listen for when a user sends a resubscription chat message in a specific channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to get resubscription chat message notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a user sends a resubscription chat message in a specific channel. */
+  Event: {
+    /** The user ID of the user who sent a resubscription chat message. */
+    user_id: string
+    /** The user login of the user who sent a resubscription chat message. */
+    user_login: string
+    /** The user display name of the user who a resubscription chat message. */
+    user_name: string
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The tier of the user's subscription. */
+    tier: string
+    /** An object that contains the resubscription message and emote information needed to recreate the message. */
+    message: {
+      /** The text of the resubscription chat message. */
+      text: string
+      /** An array that includes the emote ID and start and end positions for where the emote appears in the text. */
+      emotes: {
+        /** The index of where the Emote starts in the text. */
+        begin: number
+        /** The index of where the Emote ends in the text. */
+        end: number
+        /** The emote ID. */
+        id: string
+      }
+    }
+    /** The total number of months the user has been subscribed to the channel. */
+    cumulative_months: number
+    /** The number of consecutive months the user's current subscription has been active. This value is null if the user has opted out of sharing this information. */
+    streak_months: number
+    /** The month duration of the subscription. */
+    duration_months: number
+  }
+}>
+
+registerEvent("channel.subscription.message", {
+  scopes: ["channel:read:subscriptions"],
+  subscriber: (userId) => ({
+    type: "channel.subscription.message",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.suspicious_user.message-1.ts

@@ -0,0 +1,85 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.suspicious_user.message": ChannelSuspiciousUserMessage
+  }
+}
+
+/** Channel Suspicious User Message v1: When a chat message has been sent by a suspicious user. */
+type ChannelSuspiciousUserMessage = EventConfig<{
+  Type: "channel.suspicious_user.message"
+  Version: "1"
+  /** The conditions to listen for when a chat message has been sent by a suspicious user. */
+  Condition: {
+    /** The ID of a user that has permission to moderate the broadcaster's channel and has granted your app permission to subscribe to this subscription type. */
+    moderator_user_id: string
+    /** User ID of the channel to receive chat message events for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a chat message has been sent by a suspicious user. */
+  Event: {
+    /** The ID of the channel where the treatment for a suspicious user was updated. */
+    broadcaster_user_id: string
+    /** The display name of the channel where the treatment for a suspicious user was updated. */
+    broadcaster_user_name: string
+    /** The login of the channel where the treatment for a suspicious user was updated. */
+    broadcaster_user_login: string
+    /** The user ID of the user that sent the message. */
+    user_id: string
+    /** The user name of the user that sent the message. */
+    user_name: string
+    /** The user login of the user that sent the message. */
+    user_login: string
+    /** The status set for the suspicious user. Can be the following: "none", "active_monitoring", or "restricted" */
+    low_trust_status: string
+    /** A list of channel IDs where the suspicious user is also banned. */
+    shared_ban_channel_ids: string[]
+    /** User types (if any) that apply to the suspicious user, can be "manually_added", "ban_evader", or "banned_in_shared_channel". */
+    types: string[]
+    /** A ban evasion likelihood value (if any) that as been applied to the user automatically by Twitch, can be "unknown", "possible", or "likely". */
+    ban_evasion_evaluation: string
+    /** The structured chat message. */
+    message: {
+      /** The UUID that identifies the message. */
+      message_id: string
+      /** The chat message in plain text. */
+      text: string
+      /** Ordered list of chat message fragments. */
+      fragments: Array<{
+        /** The type of message fragment. Possible values: -text -cheermote -emote */
+        type: string
+        /** Message text in fragment. */
+        text: string
+        /** Metadata pertaining to the cheermote. */
+        cheermote?: {
+          /** The name portion of the Cheermote string that you use in chat to cheer Bits. The full Cheermote string is the concatenation of {prefix} + {number of Bits}. */
+          prefix: string
+          /** The amount of Bits cheered. */
+          bits: string
+          /** The tier level of the cheermote. */
+          tier: string
+        }
+        /** Metadata pertaining to the emote. */
+        emote?: {
+          /** An ID that uniquely identifies this emote. */
+          id: string
+          /** An ID that identifies the emote set that the emote belongs to. */
+          emote_set_id: string
+        }
+      }>
+    }
+  }
+}>
+
+registerEvent("channel.suspicious_user.message", {
+  scopes: ["moderator:read:suspicious"],
+  subscriber: (userId) => ({
+    type: "channel.suspicious_user.message",
+    version: "1",
+    condition: {
+      moderator_user_id: userId,
+      broadcaster_user_id: userId,
+    },
+  }),
+})