@overlaysymphony/twitch 0.2.1 → 0.2.3

package/src/eventsub/events/channel.hype_train.progress-2.ts

@@ -0,0 +1,90 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.hype_train.progress": ChannelHypeTrainProgress
+  }
+}
+
+/** Channel Hype Train Progress v2: When a Hype Train makes progress on the specified channel. */
+type ChannelHypeTrainProgress = EventConfig<{
+  Type: "channel.hype_train.progress"
+  Version: "2"
+  /** The conditions to listen for when a Hype Train makes progress on the specified channel. */
+  Condition: {
+    /** The ID of the broadcaster that you want to get Hype Train progress notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a Hype Train makes progress on the specified channel. */
+  Event: {
+    /** The Hype Train ID. */
+    id: 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 current level of the Hype Train. */
+    level: number
+    /** Total points contributed to the Hype Train. */
+    total: number
+    /** The number of points contributed to the Hype Train at the current level. */
+    progress: number
+    /** The number of points required to reach the next level. */
+    goal: number
+    /** The contributors with the most points contributed. */
+    top_contributions: {
+      /** The ID of the user that made the contribution. */
+      user_id: string
+      /** The user's login name. */
+      user_login: string
+      /** The user's display name. */
+      user_name: string
+      /**
+       * The contribution method used. Possible values are:
+       * - bits - Bits contributions with Cheering, Power-ups, and Extensions.
+       * - subscription - Subscription activity like subscribing or gifting subscriptions.
+       * - other - Covers other contribution methods not listed.
+       */
+      type: string
+      /** The total amount contributed. If type is bits, total represents the amount of Bits used. If type is subscription, total is 500, 1000, or 2500 to represent tier 1, 2, or 3 subscriptions, respectively. */
+      total: number
+    }
+    /** The most recent contribution. */
+    last_contribution: {
+      /** The ID of the user that made the contribution. */
+      user_id: string
+      /** The user's login name. */
+      user_login: string
+      /** The user's display name. */
+      user_name: string
+      /**
+       * The contribution method used. Possible values are:
+       * - bits — Cheering with Bits.
+       * - subscription — Subscription activity like subscribing or gifting subscriptions.
+       * - other — Covers other contribution methods not listed.
+       */
+      type: string
+      /** The total amount contributed. If type is bits, total represents the amount of Bits used. If type is subscription, total is 500, 1000, or 2500 to represent tier 1, 2, or 3 subscriptions, respectively. */
+      total: number
+    }
+    /** The time when the Hype Train started. */
+    started_at: string
+    /** The time when the Hype Train expires. The expiration is extended when the Hype Train reaches a new level. */
+    expires_at: string
+    /** Indicates if the Hype Train is a Golden Kappa Train. */
+    is_golden_kappa_train: boolean
+  }
+}>
+
+registerEvent("channel.hype_train.progress", {
+  scopes: ["channel:read:hype"],
+  subscriber: (userId) => ({
+    type: "channel.hype_train.progress",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.moderate-2.ts

@@ -0,0 +1,258 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.moderate": ChannelModerate
+  }
+}
+
+/** Channel Moderate v2: When a moderator performs a moderation action in a channel. Includes warnings. */
+type ChannelModerate = EventConfig<{
+  Type: "channel.moderate"
+  Version: "2"
+  /** The conditions to listen for when a moderator performs a moderation action in a channel. Includes warnings. */
+  Condition: {
+    /** The user ID of the broadcaster. */
+    broadcaster_user_id: string
+    /** The user ID of the moderator. */
+    moderator_user_id: string
+  }
+  /** The event fired when a moderator performs a moderation action in a channel. Includes warnings. */
+  Event: {
+    /** The ID of the broadcaster. */
+    broadcaster_user_id: string
+    /** The login of the broadcaster. */
+    broadcaster_user_login: string
+    /** The user name of the broadcaster. */
+    broadcaster_user_name: string
+    /** The channel in which the action originally occurred. Is the same as the broadcaster_user_id if not in shared chat. */
+    source_broadcaster_user_id: string
+    /** The channel in which the action originally occurred. Is the same as the broadcaster_user_login if not in shared chat. */
+    source_broadcaster_user_login: string
+    /** The channel in which the action originally occurred. Is null when the moderator action 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 ID of the moderator who performed the action. */
+    moderator_user_id: string
+    /** The login of the moderator. */
+    moderator_user_login: string
+    /** The user name of the moderator. */
+    moderator_user_name: string
+    /**
+     * The type of action: Possible values are:
+     * - ban
+     * - timeout
+     * - unban
+     * - untimeout
+     * - clear
+     * - emoteonly
+     * - emoteonlyoff
+     * - followers
+     * - followersoff
+     * - uniquechat
+     * - uniquechatoff
+     * - slow
+     * - slowoff
+     * - subscribers
+     * - subscribersoff
+     * - unraid
+     * - delete
+     * - unvip
+     * - vip
+     * - raid
+     * - add_blocked_term
+     * - add_permitted_term
+     * - remove_blocked_term
+     * - remove_permitted_term
+     * - mod
+     * - unmod
+     * - approve_unban_request
+     * - deny_unban_request
+     * - shared_chat_ban
+     * - shared_chat_timeout
+     * - shared_chat_untimeout
+     * - shared_chat_unban
+     * - shared_chat_delete
+     */
+    action: string
+    /** Optional.. Metadata associated with the followers command. */
+    followers?: {
+      /** The length of time, in minutes, that the followers must have followed the broadcaster to participate in the chat room. */
+      follow_duration_minutes: number
+    }
+    /** Metadata associated with the slow command. */
+    slow?: {
+      /** The amount of time, in seconds, that users need to wait between sending messages. */
+      wait_time_seconds: number
+    }
+    /** Metadata associated with the vip command. */
+    vip?: {
+      /** The ID of the user gaining VIP status. */
+      user_id: string
+      /** The login of the user gaining VIP status. */
+      user_login: string
+      /** The user name of the user gaining VIP status. */
+      user_name: string
+    }
+    /** Metadata associated with the unvip command. */
+    unvip?: {
+      /** The ID of the user losing VIP status. */
+      user_id: string
+      /** The login of the user losing VIP status. */
+      user_login: string
+      /** The user name of the user losing VIP status. */
+      user_name: string
+    }
+    /** Metadata associated with the mod command. */
+    mod?: {
+      /** The ID of the user gaining mod status. */
+      user_id: string
+      /** The login of the user gaining mod status. */
+      user_login: string
+      /** The user name of the user gaining mod status. */
+      user_name: string
+    }
+    /** Metadata associated with the unmod command. */
+    unmod?: {
+      /** The ID of the user losing mod status. */
+      user_id: string
+      /** The login of the user losing mod status. */
+      user_login: string
+      /** The user name of the user losing mod status. */
+      user_name: string
+    }
+    /** Metadata associated with the ban command. */
+    ban?: {
+      /** The ID of the user being banned. */
+      user_id: string
+      /** The login of the user being banned. */
+      user_login: string
+      /** The user name of the user being banned. */
+      user_name: string
+      /** Reason given for the ban. */
+      reason?: string
+    }
+    /** Metadata associated with the unban command. */
+    unban?: {
+      /** The ID of the user being unbanned. */
+      user_id: string
+      /** The login of the user being unbanned. */
+      user_login: string
+      /** The user name of the user being unbanned. */
+      user_name: string
+    }
+    /** Optional.. Metadata associated with the timeout command. */
+    timeout?: {
+      /** The ID of the user being timed out. */
+      user_id: string
+      /** The login of the user being timed out. */
+      user_login: string
+      /** The user name of the user being timed out. */
+      user_name: string
+      /** Optional.. The reason given for the timeout. */
+      reason?: string
+      /** The time at which the timeout ends. */
+      expires_at: string
+    }
+    /** Metadata associated with the untimeout command. */
+    untimeout?: {
+      /** The ID of the user being untimed out. */
+      user_id: string
+      /** The login of the user being untimed out. */
+      user_login: string
+      /** The user name of the user untimed out. */
+      user_name: string
+    }
+    /** Optional.. Metadata associated with the raid command. */
+    raid?: {
+      /** The ID of the user being raided. */
+      user_id: string
+      /** The login of the user being raided. */
+      user_login: string
+      /** The user name of the user raided. */
+      user_name: string
+      /** The viewer count. */
+      viewer_count: number
+    }
+    /** Metadata associated with the unraid command. */
+    unraid?: {
+      /** The ID of the user no longer being raided. */
+      user_id: string
+      /** The login of the user no longer being raided. */
+      user_login: string
+      /** The user name of the no longer user raided. */
+      user_name: string
+    }
+    /** Metadata associated with the delete command. */
+    delete?: {
+      /** The ID of the user whose message is being deleted. */
+      user_id: string
+      /** The login of the user. */
+      user_login: string
+      /** The user name of the user. */
+      user_name: string
+      /** The ID of the message being deleted. */
+      message_id: string
+      /** The message body of the message being deleted. */
+      message_body: string
+    }
+    /** Metadata associated with the automod terms changes. */
+    automod_terms?: {
+      /** Either "add" or "remove". */
+      action: string
+      /** Either "blocked" or "permitted". */
+      list: string
+      /** Terms being added or removed. */
+      terms: string[]
+      /** Whether the terms were added due to an Automod message approve/deny action. */
+      from_automod: boolean
+    }
+    /** Metadata associated with an unban request. */
+    unban_request?: {
+      /** Whether or not the unban request was approved or denied. */
+      is_approved: boolean
+      /** The ID of the banned user. */
+      user_id: string
+      /** The login of the user. */
+      user_login: string
+      /** The user name of the user. */
+      user_name: string
+      /** The message included by the moderator explaining their approval or denial. */
+      moderator_message: string
+    }
+    /** Information about the shared_chat_ban event. Is null if action is not shared_chat_ban . This field has the same information as the ban field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition. */
+    shared_chat_ban?: object
+    /** Information about the shared_chat_unban event. Is null if action is not shared_chat_unban . This field has the same information as the unban field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition. */
+    shared_chat_unban?: object
+    /** Information about the shared_chat_timeout event. Is null if action is not shared_chat_timeout . This field has the same information as the timeout field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition. */
+    shared_chat_timeout?: object
+    /** Information about the shared_chat_untimeout event. Is null if action is not shared_chat_untimeout . This field has the same information as the untimeout field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition. */
+    shared_chat_untimeout?: object
+    /** Information about the shared_chat_delete event. Is null if action is not shared_chat_delete . This field has the same information as the delete field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition. */
+    shared_chat_delete?: object
+  }
+}>
+
+registerEvent("channel.moderate", {
+  scopes: [
+    "moderator:manage:banned",
+    "moderator:manage:blocked",
+    "moderator:manage:chat",
+    "moderator:manage:unban",
+    "moderator:manage:warnings",
+    "moderator:read:banned",
+    "moderator:read:blocked",
+    "moderator:read:chat",
+    "moderator:read:moderators",
+    "moderator:read:unban",
+    "moderator:read:vips",
+    "moderator:read:warnings",
+  ],
+  subscriber: (userId) => ({
+    type: "channel.moderate",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.moderator.add-1.ts

@@ -0,0 +1,44 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.moderator.add": ChannelModeratorAdd
+  }
+}
+
+/** Channel Moderator Add v1: When moderator privileges were added to a user on the specified channel. */
+type ChannelModeratorAdd = EventConfig<{
+  Type: "channel.moderator.add"
+  Version: "1"
+  /** The conditions to listen for when moderator privileges were added to a user on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to get moderator addition notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when moderator privileges were added to a user on the specified channel. */
+  Event: {
+    /** 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 user ID of the new moderator. */
+    user_id: string
+    /** The user login of the new moderator. */
+    user_login: string
+    /** The display name of the new moderator. */
+    user_name: string
+  }
+}>
+
+registerEvent("channel.moderator.add", {
+  scopes: ["moderation:read"],
+  subscriber: (userId) => ({
+    type: "channel.moderator.add",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.moderator.remove-1.ts

@@ -0,0 +1,44 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.moderator.remove": ChannelModeratorRemove
+  }
+}
+
+/** Channel Moderator Remove v1: When moderator privileges were removed from a user on the specified channel. */
+type ChannelModeratorRemove = EventConfig<{
+  Type: "channel.moderator.remove"
+  Version: "1"
+  /** The conditions to listen for when moderator privileges were removed from a user on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to get moderator removal notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when moderator privileges were removed from a user on the specified channel. */
+  Event: {
+    /** 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 user ID of the removed moderator. */
+    user_id: string
+    /** The user login of the removed moderator. */
+    user_login: string
+    /** The display name of the removed moderator. */
+    user_name: string
+  }
+}>
+
+registerEvent("channel.moderator.remove", {
+  scopes: ["moderation:read"],
+  subscriber: (userId) => ({
+    type: "channel.moderator.remove",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,73 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.poll.begin": ChannelPollBegin
+  }
+}
+
+/** Channel Poll Begin v1: When a poll started on the specified channel. */
+type ChannelPollBegin = EventConfig<{
+  Type: "channel.poll.begin"
+  Version: "1"
+  /** The conditions to listen for when a poll started on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID of the channel for which "poll begin" notifications will be received. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a poll started on the specified channel. */
+  Event: {
+    /** ID of the poll. */
+    id: 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
+    /** Question displayed for the poll. */
+    title: string
+    /** An array of choices for the poll. */
+    choices: Array<{
+      /** ID for the choice. */
+      id: string
+      /** Text displayed for the choice. */
+      title: string
+      /** Not used; will be set to 0. */
+      bits_votes: number
+      /** Number of votes received via Channel Points. */
+      channel_points_votes: number
+      /** Total number of votes received for the choice across all methods of voting. */
+      votes: number
+    }>
+    /** Not supported. */
+    bits_voting: {
+      /** Not used; will be set to false. */
+      is_enabled: boolean
+      /** Not used; will be set to 0. */
+      amount_per_vote: number
+    }
+    /** The Channel Points voting settings for the poll. */
+    channel_points_voting: {
+      /** Indicates if Channel Points can be used for voting. */
+      is_enabled: boolean
+      /** Number of Channel Points required to vote once with Channel Points. */
+      amount_per_vote: number
+    }
+    /** The time the poll started. */
+    started_at: string
+    /** The time the poll will end. */
+    ends_at: string
+  }
+}>
+
+registerEvent("channel.poll.begin", {
+  scopes: ["channel:manage:polls", "channel:read:polls"],
+  subscriber: (userId) => ({
+    type: "channel.poll.begin",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,75 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.poll.end": ChannelPollEnd
+  }
+}
+
+/** Channel Poll End v1: When a poll ended on the specified channel. */
+type ChannelPollEnd = EventConfig<{
+  Type: "channel.poll.end"
+  Version: "1"
+  /** The conditions to listen for when a poll ended on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID of the channel for which "poll end" notifications will be received. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a poll ended on the specified channel. */
+  Event: {
+    /** ID of the poll. */
+    id: 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
+    /** Question displayed for the poll. */
+    title: string
+    /** An array of choices for the poll. Includes vote counts. */
+    choices: Array<{
+      /** ID for the choice. */
+      id: string
+      /** Text displayed for the choice. */
+      title: string
+      /** Not used; will be set to 0. */
+      bits_votes: number
+      /** Number of votes received via Channel Points. */
+      channel_points_votes: number
+      /** Total number of votes received for the choice across all methods of voting. */
+      votes: number
+    }>
+    /** Not supported. */
+    bits_voting: {
+      /** Not used; will be set to false. */
+      is_enabled: boolean
+      /** Not used; will be set to 0. */
+      amount_per_vote: number
+    }
+    /** The Channel Points voting settings for the poll. */
+    channel_points_voting: {
+      /** Indicates if Channel Points can be used for voting. */
+      is_enabled: boolean
+      /** Number of Channel Points required to vote once with Channel Points. */
+      amount_per_vote: number
+    }
+    /** The status of the poll. Valid values are completed, archived, and terminated. */
+    status: string
+    /** The time the poll started. */
+    started_at: string
+    /** The time the poll ended. */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.poll.end", {
+  scopes: ["channel:manage:polls", "channel:read:polls"],
+  subscriber: (userId) => ({
+    type: "channel.poll.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.poll.progress-1.ts

@@ -0,0 +1,73 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.poll.progress": ChannelPollProgress
+  }
+}
+
+/** Channel Poll Progress v1: When users respond to a poll on the specified channel. */
+type ChannelPollProgress = EventConfig<{
+  Type: "channel.poll.progress"
+  Version: "1"
+  /** The conditions to listen for when users respond to a poll on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID of the channel for which "poll progress" notifications will be received. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when users respond to a poll on the specified channel. */
+  Event: {
+    /** ID of the poll. */
+    id: 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
+    /** Question displayed for the poll. */
+    title: string
+    /** An array of choices for the poll. Includes vote counts. */
+    choices: Array<{
+      /** ID for the choice. */
+      id: string
+      /** Text displayed for the choice. */
+      title: string
+      /** Not used; will be set to 0. */
+      bits_votes: number
+      /** Number of votes received via Channel Points. */
+      channel_points_votes: number
+      /** Total number of votes received for the choice across all methods of voting. */
+      votes: number
+    }>
+    /** Not supported. */
+    bits_voting: {
+      /** Not used; will be set to false. */
+      is_enabled: boolean
+      /** Not used; will be set to 0. */
+      amount_per_vote: number
+    }
+    /** The Channel Points voting settings for the poll. */
+    channel_points_voting: {
+      /** Indicates if Channel Points can be used for voting. */
+      is_enabled: boolean
+      /** Number of Channel Points required to vote once with Channel Points. */
+      amount_per_vote: number
+    }
+    /** The time the poll started. */
+    started_at: string
+    /** The time the poll will end. */
+    ends_at: string
+  }
+}>
+
+registerEvent("channel.poll.progress", {
+  scopes: ["channel:manage:polls", "channel:read:polls"],
+  subscriber: (userId) => ({
+    type: "channel.poll.progress",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})