@overlaysymphony/twitch 0.2.1 → 0.2.3

package/src/eventsub/events/channel.charity_campaign.start-1.ts

@@ -0,0 +1,76 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.charity_campaign.start": ChannelCharityCampaignStart
+  }
+}
+
+/** Channel Charity Campaign Start v1: When the broadcaster starts a charity campaign. */
+type ChannelCharityCampaignStart = EventConfig<{
+  Type: "channel.charity_campaign.start"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster starts a charity campaign. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they start a charity campaign. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when the broadcaster starts a charity campaign. */
+  Event: {
+    /** An ID that identifies the charity campaign. */
+    id: string
+    /** An ID that identifies the broadcaster that's running the campaign. */
+    broadcaster_id: string
+    /** The broadcaster's login name. */
+    broadcaster_login: string
+    /** The broadcaster's display name. */
+    broadcaster_name: string
+    /** The charity's name. */
+    charity_name: string
+    /** A description of the charity. */
+    charity_description: string
+    /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
+    charity_logo: string
+    /** A URL to the charity's website. */
+    charity_website: string
+    /** An object that contains the current amount of donations that the campaign has received. */
+    current_amount: {
+      /** The monetary amount. The amount is specified in the currency's minor unit. */
+      value: number
+      /**
+       * The number of decimal places used by the currency.
+       *
+       * value / 10^decimal_places
+       */
+      decimal_places: number
+      /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
+      currency: string
+    }
+    /** An object that contains the campaign's target fundraising goal. */
+    target_amount: {
+      /** The monetary amount. The amount is specified in the currency's minor unit. */
+      value: number
+      /**
+       * The number of decimal places used by the currency.
+       *
+       * value / 10^decimal_places
+       */
+      decimal_places: number
+      /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
+      currency: string
+    }
+    /** The UTC timestamp (in RFC3339 format) of when the broadcaster started the campaign. */
+    started_at: string
+  }
+}>
+
+registerEvent("channel.charity_campaign.start", {
+  scopes: ["channel:read:charity"],
+  subscriber: (userId) => ({
+    type: "channel.charity_campaign.start",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.charity_campaign.stop-1.ts

@@ -0,0 +1,76 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.charity_campaign.stop": ChannelCharityCampaignStop
+  }
+}
+
+/** Channel Charity Campaign Stop v1: When the broadcaster stops a charity campaign. */
+type ChannelCharityCampaignStop = EventConfig<{
+  Type: "channel.charity_campaign.stop"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster stops a charity campaign. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they stop a charity campaign. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when the broadcaster stops a charity campaign. */
+  Event: {
+    /** An ID that identifies the charity campaign. */
+    id: string
+    /** An ID that identifies the broadcaster that ran the campaign. */
+    broadcaster_id: string
+    /** The broadcaster's login name. */
+    broadcaster_login: string
+    /** The broadcaster's display name. */
+    broadcaster_name: string
+    /** The charity's name. */
+    charity_name: string
+    /** A description of the charity. */
+    charity_description: string
+    /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
+    charity_logo: string
+    /** A URL to the charity's website. */
+    charity_website: string
+    /** An object that contains the final amount of donations that the campaign received. */
+    current_amount: {
+      /** The monetary amount. The amount is specified in the currency's minor unit. */
+      value: number
+      /**
+       * The number of decimal places used by the currency.
+       *
+       * value / 10^decimal_places
+       */
+      decimal_places: number
+      /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
+      currency: string
+    }
+    /** An object that contains the campaign's target fundraising goal. */
+    target_amount: {
+      /** The monetary amount. The amount is specified in the currency's minor unit. */
+      value: number
+      /**
+       * The number of decimal places used by the currency.
+       *
+       * value / 10^decimal_places
+       */
+      decimal_places: number
+      /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
+      currency: string
+    }
+    /** The UTC timestamp (in RFC3339 format) of when the broadcaster stopped the campaign. */
+    stopped_at: string
+  }
+}>
+
+registerEvent("channel.charity_campaign.stop", {
+  scopes: ["channel:read:charity"],
+  subscriber: (userId) => ({
+    type: "channel.charity_campaign.stop",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.chat.clear-1.ts

@@ -0,0 +1,41 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.chat.clear": ChannelChatClear
+  }
+}
+
+/** Channel Chat Clear v1: When a moderator or bot has cleared all messages from the chat room. */
+type ChannelChatClear = EventConfig<{
+  Type: "channel.chat.clear"
+  Version: "1"
+  /** The conditions to listen for when a moderator or bot has cleared all messages from the chat room. */
+  Condition: {
+    /** User ID of the channel to receive chat clear events for. */
+    broadcaster_user_id: string
+    /** The user ID to read chat as. */
+    user_id: string
+  }
+  /** The event fired when a moderator or bot has cleared all messages from the chat room. */
+  Event: {
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+  }
+}>
+
+registerEvent("channel.chat.clear", {
+  scopes: ["user:read:chat"],
+  subscriber: (userId) => ({
+    type: "channel.chat.clear",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.chat.clear_user_messages-1.ts

@@ -0,0 +1,47 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.chat.clear_user_messages": ChannelChatClearUserMessages
+  }
+}
+
+/** Channel Chat Clear User Messages v1: When a moderator or bot has cleared all messages from a specific user. */
+type ChannelChatClearUserMessages = EventConfig<{
+  Type: "channel.chat.clear_user_messages"
+  Version: "1"
+  /** The conditions to listen for when a moderator or bot has cleared all messages from a specific user. */
+  Condition: {
+    /** User ID of the channel to receive chat clear user messages events for. */
+    broadcaster_user_id: string
+    /** The user ID to read chat as. */
+    user_id: string
+  }
+  /** The event fired when a moderator or bot has cleared all messages from a specific user. */
+  Event: {
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+    /** The ID of the user that was banned or put in a timeout. All of their messages are deleted. */
+    target_user_id: string
+    /** The user name of the user that was banned or put in a timeout. */
+    target_user_name: string
+    /** The user login of the user that was banned or put in a timeout. */
+    target_user_login: string
+  }
+}>
+
+registerEvent("channel.chat.clear_user_messages", {
+  scopes: ["user:read:chat"],
+  subscriber: (userId) => ({
+    type: "channel.chat.clear_user_messages",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,160 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.chat.message": ChannelChatMessage
+  }
+}
+
+/** Channel Chat Message v1: When a user sends a message to a specific chat room. */
+type ChannelChatMessage = EventConfig<{
+  Type: "channel.chat.message"
+  Version: "1"
+  /** The conditions to listen for when a user sends a message to a specific chat room. */
+  Condition: {
+    /** The User ID of the channel to receive chat message events for. */
+    broadcaster_user_id: string
+    /** The User ID to read chat as. */
+    user_id: string
+  }
+  /** The event fired when a user sends a message to a specific chat room. */
+  Event: {
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+    /** The user ID of the user that sent the message. */
+    chatter_user_id: string
+    /** The user name of the user that sent the message. */
+    chatter_user_name: string
+    /** The user login of the user that sent the message. */
+    chatter_user_login: string
+    /** A UUID that identifies the message. */
+    message_id: string
+    /** The structured chat message. */
+    message: {
+      /** 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
+         * - mention
+         */
+        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: number
+          /** The tier level of the cheermote. */
+          tier: number
+        }
+        /** 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
+          /** The ID of the broadcaster who owns the emote. */
+          owner_id: string
+          /**
+           * The formats that the emote is available in.
+           * - animated - An animated GIF is available for this emote.
+           * - static - A static PNG file is available for this emote.
+           */
+          format: string[]
+        }
+        /** Metadata pertaining to the mention. */
+        mention?: {
+          /** The user ID of the mentioned user. */
+          user_id: string
+          /** The user name of the mentioned user. */
+          user_name: string
+          /** The user login of the mentioned user. */
+          user_login: string
+        }
+      }>
+    }
+    /** The type of message. Possible values: <ul><li>text</li><li>channel_points_highlighted</li><li>channel_points_sub_only</li><li>user_intro</li><li>power_ups_message_effect</li><li>power_ups_gigantified_emote</li></ul> */
+    message_type: string
+    /** List of chat badges. */
+    badges: Array<{
+      /** An ID that identifies this set of chat badges. */
+      set_id: string
+      /** An ID that identifies this version of the badge. The ID can be any value. */
+      id: string
+      /** Contains metadata related to the chat badges in the badges tag. Currently, this tag contains metadata only for subscriber badges, to indicate the number of months the user has been a subscriber. */
+      info: string
+    }>
+    /** Metadata if this message is a cheer. */
+    cheer?: {
+      /** The amount of Bits the user cheered. */
+      bits: number
+    }
+    /** The color of the user's name in the chat room. This is a hexadecimal RGB color code in the form, #&lt;RGB&gt;. This tag may be empty if it is never set. */
+    color: string
+    /** Metadata if this message is a reply. */
+    reply?: {
+      /** An ID that uniquely identifies the parent message that this message is replying to. */
+      parent_message_id: string
+      /** The message body of the parent message. */
+      parent_message_body: string
+      /** User ID of the sender of the parent message. */
+      parent_user_id: string
+      /** User name of the sender of the parent message. */
+      parent_user_name: string
+      /** User login of the sender of the parent message. */
+      parent_user_login: string
+      /** An ID that identifies the parent message of the reply thread. */
+      thread_message_id: string
+      /** User ID of the sender of the thread's parent message. */
+      thread_user_id: string
+      /** User name of the sender of the thread's parent message. */
+      thread_user_name: string
+      /** User login of the sender of the thread's parent message. */
+      thread_user_login: string
+    }
+    /** The ID of a channel points custom reward that was redeemed. */
+    channel_points_custom_reward_id?: string
+    /** The broadcaster user ID of the channel the message was sent from. Is null when the message happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster. */
+    source_broadcaster_user_id?: string
+    /** The user name of the broadcaster of the channel the message was sent from. Is null when the message happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster. */
+    source_broadcaster_user_name?: string
+    /** The login of the broadcaster of the channel the message was sent from. Is null when the message happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster. */
+    source_broadcaster_user_login?: string
+    /** The UUID that identifies the source message from the channel the message was sent from. Is null when the message happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster. */
+    source_message_id?: string
+    /** The list of chat badges for the chatter in the channel the message was sent from. Is null when the message happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster. */
+    source_badges?: {
+      /** The ID that identifies this set of chat badges. */
+      set_id: string
+      /** The ID that identifies this version of the badge. The ID can be any value. */
+      id: string
+      /** Contains metadata related to the chat badges in the badges tag. Currently, this tag contains metadata only for subscriber badges, to indicate the number of months the user has been a subscriber. */
+      info: string
+    }
+    /** Determines if a message delivered during a shared chat session is only sent to the source channel. Has no effect if the message is not sent during a shared chat session. */
+    is_source_only?: boolean
+  }
+}>
+
+registerEvent("channel.chat.message", {
+  scopes: ["user:read:chat"],
+  subscriber: (userId) => ({
+    type: "channel.chat.message",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.chat.message_delete-1.ts

@@ -0,0 +1,49 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.chat.message_delete": ChannelChatMessageDelete
+  }
+}
+
+/** Channel Chat Message Delete v1: When a moderator has removed a specific message. */
+type ChannelChatMessageDelete = EventConfig<{
+  Type: "channel.chat.message_delete"
+  Version: "1"
+  /** The conditions to listen for when a moderator has removed a specific message. */
+  Condition: {
+    /** User ID of the channel to receive chat message delete events for. */
+    broadcaster_user_id: string
+    /** The user ID to read chat as. */
+    user_id: string
+  }
+  /** The event fired when a moderator has removed a specific message. */
+  Event: {
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+    /** The ID of the user whose message was deleted. */
+    target_user_id: string
+    /** The user name of the user whose message was deleted. */
+    target_user_name: string
+    /** The user login of the user whose message was deleted. */
+    target_user_login: string
+    /** A UUID that identifies the message that was removed. */
+    message_id: string
+  }
+}>
+
+registerEvent("channel.chat.message_delete", {
+  scopes: ["user:read:chat"],
+  subscriber: (userId) => ({
+    type: "channel.chat.message_delete",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      user_id: userId,
+    },
+  }),
+})