@overlaysymphony/twitch 0.1.0

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

@@ -0,0 +1,62 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ShoutoutCreateType = "channel.shoutout.create"
+type ShoutoutCreateVersion = "1"
+
+/** The parameters under which an event fires when The broadcaster sends a Shoutout. */
+export interface ShoutoutCreateCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user ID of the moderator or broadcaster. */
+  moderator_user_id: string
+}
+
+/** The event information when The broadcaster sends a Shoutout. */
+export interface ShoutoutCreateEvent {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  broadcaster_user_name: string
+  /** The user ID of the broadcaster that received the shoutout. */
+  to_broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  to_broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  to_broadcaster_user_name: string
+  /** The user ID of 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 user login of the moderator. */
+  moderator_user_login: string
+  /** The user name of the moderator. */
+  moderator_user_name: string
+  /** Integer. The number of users that were watching the broadcaster's stream at the time of the shoutout. */
+  viewer_count: number
+  /** The time the moderator sent the shoutout. */
+  started_at: Date
+  /** The time the broadcaster may send a shoutout to a different broadcaster. */
+  cooldown_ends_at: Date
+  /** The time the broadcaster may send another shoutout to the broadcaster in to_broadcaster_user_id. */
+  target_cooldown_ends_at: Date
+}
+
+/** The event notification received when The broadcaster sends a Shoutout. */
+export type ShoutoutCreateSubscription = BaseSubscription<
+  ShoutoutCreateType,
+  ShoutoutCreateVersion,
+  ShoutoutCreateCondition
+>
+
+export function makeShoutoutCreateSubscription(
+  userId: string,
+): ShoutoutCreateSubscription {
+  return {
+    type: "channel.shoutout.create",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,52 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ShoutoutReceiveType = "channel.shoutout.receive"
+type ShoutoutReceiveVersion = "1"
+
+/** The parameters under which an event fires when The broadcaster receives a Shoutout. */
+export interface ShoutoutReceiveCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user ID of the moderator or broadcaster. */
+  moderator_user_id: string
+}
+
+/** The event information when The broadcaster receives a Shoutout. */
+export interface ShoutoutReceiveEvent {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  broadcaster_user_name: string
+  /** The user ID of the broadcaster that sent the shoutout. */
+  from_broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  from_broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  from_broadcaster_user_name: string
+  /** Integer. The number of users that were watching the from-broadcaster's stream at the time of the shoutout. */
+  viewer_count: number
+  /** The time the moderator sent the shoutout. */
+  started_at: Date
+}
+
+/** The event notification received when The broadcaster receives a Shoutout. */
+export type ShoutoutReceiveSubscription = BaseSubscription<
+  ShoutoutReceiveType,
+  ShoutoutReceiveVersion,
+  ShoutoutReceiveCondition
+>
+
+export function makeShoutoutReceiveSubscription(
+  userId: string,
+): ShoutoutReceiveSubscription {
+  return {
+    type: "channel.shoutout.receive",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,49 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelSubscribeType = "channel.subscribe"
+type ChannelSubscribeVersion = "1"
+
+/** The parameters under which an event fires when A user subscribes. This does not include resubscribes. */
+export interface ChannelSubscribeCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when A user subscribes. This does not include resubscribes. */
+export interface ChannelSubscribeEvent {
+  /** The user ID of the user who subscribed. */
+  user_id: string
+  /** The user login of the user who subscribed. */
+  user_login: string
+  /** The user name of the user who subscribed. */
+  user_name: string
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  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
+}
+
+/** The event notification received when A user subscribes. This does not include resubscribes. */
+export type ChannelSubscribeSubscription = BaseSubscription<
+  ChannelSubscribeType,
+  ChannelSubscribeVersion,
+  ChannelSubscribeCondition
+>
+
+export function makeChannelSubscribeSubscription(
+  userId: string,
+): ChannelSubscribeSubscription {
+  return {
+    type: "channel.subscribe",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,49 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelSubscriptionEndType = "channel.subscription.end"
+type ChannelSubscriptionEndVersion = "1"
+
+/** The parameters under which an event fires when A subscription ends. */
+export interface ChannelSubscriptionEndCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when A subscription ends. */
+export interface ChannelSubscriptionEndEvent {
+  /** The user ID of the user whose subscription ended. */
+  user_id: string
+  /** The user login of the user whose subscription ended. */
+  user_login: string
+  /** The user name of the user whose subscription ended. */
+  user_name: string
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  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
+}
+
+/** The event notification received when A subscription ends. */
+export type ChannelSubscriptionEndSubscription = BaseSubscription<
+  ChannelSubscriptionEndType,
+  ChannelSubscriptionEndVersion,
+  ChannelSubscriptionEndCondition
+>
+
+export function makeChannelSubscriptionEndSubscription(
+  userId: string,
+): ChannelSubscriptionEndSubscription {
+  return {
+    type: "channel.subscription.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,53 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelSubscriptionGiftType = "channel.subscription.gift"
+type ChannelSubscriptionGiftVersion = "1"
+
+/** The parameters under which an event fires when A user gives a gift subscription to one or more users. */
+export interface ChannelSubscriptionGiftCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when A user gives a gift subscription to one or more users. */
+export interface ChannelSubscriptionGiftEvent {
+  /** 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 name of the user who sent the gift. Set to null if it was an anonymous subscription gift. */
+  user_name: string
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  broadcaster_user_name: string
+  /** Integer. The number of subscriptions in the subscription gift. */
+  total: number
+  /** The tier of the subscriptions in the subscription gift. */
+  tier: string
+  /** Integer. 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
+}
+
+/** The event notification received when A user gives a gift subscription to one or more users. */
+export type ChannelSubscriptionGiftSubscription = BaseSubscription<
+  ChannelSubscriptionGiftType,
+  ChannelSubscriptionGiftVersion,
+  ChannelSubscriptionGiftCondition
+>
+
+export function makeChannelSubscriptionGiftSubscription(
+  userId: string,
+): ChannelSubscriptionGiftSubscription {
+  return {
+    type: "channel.subscription.gift",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,67 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelSubscriptionMessageType = "channel.subscription.message"
+type ChannelSubscriptionMessageVersion = "1"
+
+/** The parameters under which an event fires when A user sends a resubscription chat message. */
+export interface ChannelSubscriptionMessageCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when A user sends a resubscription chat message. */
+export interface ChannelSubscriptionMessageEvent {
+  /** 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 name of the user who a resubscription chat message. */
+  user_name: string
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  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: Array<{
+      /** Integer. The index of where the Emote starts in the text. */
+      begin: number
+      /** Integer. The index of where the Emote ends in the text. */
+      end: number
+      /** The emote ID. */
+      id: string
+    }>
+  }
+  /** Integer. The total number of months the user is subscribed to the channel. */
+  cumulative_months: number
+  /** Integer. The number of consecutive months the user's current subscription is active. This value is null if the user has opted out of sharing this information. */
+  streak_months: number
+  /** Integer. The month duration of the subscription. */
+  duration_months: number
+}
+
+/** The event notification received when A user sends a resubscription chat message. */
+export type ChannelSubscriptionMessageSubscription = BaseSubscription<
+  ChannelSubscriptionMessageType,
+  ChannelSubscriptionMessageVersion,
+  ChannelSubscriptionMessageCondition
+>
+
+export function makeChannelSubscriptionMessageSubscription(
+  userId: string,
+): ChannelSubscriptionMessageSubscription {
+  return {
+    type: "channel.subscription.message",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

package/src/eventsub/events/channel.unban.ts

@@ -0,0 +1,51 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelUnbanType = "channel.unban"
+type ChannelUnbanVersion = "1"
+
+/** The parameters under which an event fires when A moderator unbans a user. */
+export interface ChannelUnbanCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when A moderator unbans a user. */
+export interface ChannelUnbanEvent {
+  /** The user ID of the user who was unbanned. */
+  user_id: string
+  /** The user login of the user who was unbanned. */
+  user_login: string
+  /** The user name of the user who was unbanned. */
+  user_name: string
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  broadcaster_user_name: string
+  /** The user ID of the issuer of the unban. */
+  moderator_user_id: string
+  /** The user login of the issuer of the unban. */
+  moderator_user_login: string
+  /** The user name of the issuer of the unban. */
+  moderator_user_name: string
+}
+
+/** The event notification received when A moderator unbans a user. */
+export type ChannelUnbanSubscription = BaseSubscription<
+  ChannelUnbanType,
+  ChannelUnbanVersion,
+  ChannelUnbanCondition
+>
+
+export function makeChannelUnbanSubscription(
+  userId: string,
+): ChannelUnbanSubscription {
+  return {
+    type: "channel.unban",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

package/src/eventsub/events/channel.update.ts

@@ -0,0 +1,49 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelUpdateType = "channel.update"
+type ChannelUpdateVersion = "2"
+
+/** The parameters under which an event fires when The broadcaster updates their channel properties. e.g., category, title, content classification labels, broadcast, or language. */
+export interface ChannelUpdateCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when The broadcaster updates their channel properties. e.g., category, title, content classification labels, broadcast, or language. */
+export interface ChannelUpdateEvent {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** The user login of the broadcaster. */
+  broadcaster_user_login: string
+  /** The user name of the broadcaster. */
+  broadcaster_user_name: string
+  /** The channel's stream title. */
+  title: string
+  /** The channel's broadcast language. */
+  language: string
+  /** The channel's category ID. */
+  category_id: string
+  /** The category name. */
+  category_name: string
+  /** Array of content classification label IDs currently applied on the Channel. */
+  content_classification_labels: string[]
+}
+
+/** The event notification received when The broadcaster updates their channel properties. e.g., category, title, content classification labels, broadcast, or language. */
+export type ChannelUpdateSubscription = BaseSubscription<
+  ChannelUpdateType,
+  ChannelUpdateVersion,
+  ChannelUpdateCondition
+>
+
+export function makeChannelUpdateSubscription(
+  userId: string,
+): ChannelUpdateSubscription {
+  return {
+    type: "channel.update",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}