@overlaysymphony/twitch 0.2.1 → 0.2.3

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

@@ -1,49 +0,0 @@
-import { type 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

@@ -1,49 +0,0 @@
-import { type 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

@@ -1,53 +0,0 @@
-import { type 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

@@ -1,67 +0,0 @@
-import { type 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

@@ -1,51 +0,0 @@
-import { type 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

@@ -1,49 +0,0 @@
-import { type 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,
-    },
-  }
-}

package/src/eventsub/events/stream.offline.ts

@@ -1,39 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type StreamOfflineType = "stream.offline"
-type StreamOfflineVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster stops a stream. */
-export interface StreamOfflineCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when The broadcaster stops a stream. */
-export interface StreamOfflineEvent {
-  /** 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 event notification received when The broadcaster stops a stream. */
-export type StreamOfflineSubscription = BaseSubscription<
-  StreamOfflineType,
-  StreamOfflineVersion,
-  StreamOfflineCondition
->
-
-export function makeStreamOfflineSubscription(
-  userId: string,
-): StreamOfflineSubscription {
-  return {
-    type: "stream.offline",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/stream.online.ts

@@ -1,45 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type StreamOnlineType = "stream.online"
-type StreamOnlineVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster starts a stream. */
-export interface StreamOnlineCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when The broadcaster starts a stream. */
-export interface StreamOnlineEvent {
-  /** The ID of the stream. */
-  id: 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 stream type. Valid values are: live, playlist, watch_party, premiere, rerun. */
-  type: string
-  /** The time the stream went online. */
-  started_at: Date
-}
-
-/** The event notification received when The broadcaster starts a stream. */
-export type StreamOnlineSubscription = BaseSubscription<
-  StreamOnlineType,
-  StreamOnlineVersion,
-  StreamOnlineCondition
->
-
-export function makeStreamOnlineSubscription(
-  userId: string,
-): StreamOnlineSubscription {
-  return {
-    type: "stream.online",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

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

@@ -1,45 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type UserUpdateType = "user.update"
-type UserUpdateVersion = "1"
-
-/** The parameters under which an event fires when A user updateds their account. */
-export interface UserUpdateCondition {
-  /** The user ID. */
-  user_id: string
-}
-
-/** The event information when A user updateds their account. */
-export interface UserUpdateEvent {
-  /** The user ID of the user who was updated. */
-  user_id: string
-  /** The user login of the user who was updated. */
-  user_login: string
-  /** The user name of the user who was updated. */
-  user_name: string
-  /** The user email address. The event includes the user's email address only if the app used to request this event type includes the user:read:email scope for the user; otherwise, the field is set to an empty string. See Create EventSub Subscription. */
-  email: string
-  /** A Boolean value that determines whether Twitch has verified the user's email address. Is true if Twitch has verified the email address; otherwise, false.\n\nNOTE: Ignore this field if the email field contains an empty string. */
-  email_verified: boolean
-  /** The user description. */
-  description: string
-}
-
-/** The event notification received when A user updateds their account. */
-export type UserUpdateSubscription = BaseSubscription<
-  UserUpdateType,
-  UserUpdateVersion,
-  UserUpdateCondition
->
-
-export function makeUserUpdateSubscription(
-  userId: string,
-): UserUpdateSubscription {
-  return {
-    type: "user.update",
-    version: "1",
-    condition: {
-      user_id: userId,
-    },
-  }
-}