@overlaysymphony/twitch 0.1.0

package/src/chat/parser.ts

@@ -0,0 +1,265 @@
+import { ChatEvent, ChatEventSource } from "./interfaces/index.js"
+
+// Parses an IRC message and returns a JSON object with the message's
+// component parts (tags, source (nick and host), command, parameters).
+// from https://dev.twitch.tv/docs/irc/example-parser/
+
+export default function parseEvent(input: string): ChatEvent | undefined {
+  let tags: Record<string, unknown> | undefined = undefined
+  let source: ChatEventSource | undefined = undefined
+
+  let idx = 0
+
+  // tags
+  if (input[idx] === "@") {
+    const endIdx = input.indexOf(" ", idx)
+    tags = parseTags(input.slice(idx + 1, endIdx))
+    idx = endIdx + 1
+  }
+
+  // source
+  if (input[idx] === ":") {
+    const endIdx = input.indexOf(" ", idx)
+    source = parseSource(input.slice(idx + 1, endIdx))
+    idx = endIdx + 1
+
+    if (source.user && tags?.["display-name"]) {
+      source.user = tags["display-name"] as string
+    }
+  }
+
+  // core
+  try {
+    const hasParameters = input.indexOf(":", idx) > -1
+    if (hasParameters) {
+      const endIdx = input.indexOf(":", idx)
+
+      const message = parseCore(
+        input.slice(idx, endIdx - 1),
+        input.slice(endIdx + 1),
+      )
+
+      return {
+        ...message,
+        source,
+        // @ts-ignore
+        tags,
+      }
+    } else {
+      const message = parseCore(input.slice(idx, input.length), "")
+
+      return {
+        ...message,
+        source,
+        // @ts-ignore
+        tags,
+      }
+    }
+  } catch (e) {
+    return undefined
+  }
+}
+
+function parseSource(input: string): ChatEventSource {
+  const parts = input.split("!")
+
+  if (parts.length === 1) {
+    return {
+      host: parts[0],
+    }
+  }
+
+  return {
+    host: parts[1],
+    user: parts[0],
+  }
+}
+
+function parseTags(input: string): Record<string, unknown> {
+  const tags: Record<string, unknown> = {}
+
+  const parsedTags = input.split(";")
+  for (const tag of parsedTags) {
+    const [dashKey, value] = tag.split("=")
+    const key = toCamelCase(dashKey)
+
+    if (!value) {
+      tags[key] = undefined
+      continue
+    }
+
+    if (key === "badges" || key === "badgeInfo") {
+      const dict: Record<string, number> = {}
+
+      const badges = value.split(",")
+      for (const badge of badges) {
+        const parts = badge.split("/")
+        dict[parts[0]] = parseInt(parts[1])
+      }
+
+      tags[key] = dict
+      continue
+    }
+
+    if (key === "emotes") {
+      const dict: Record<string, Array<[string, string]>> = {}
+
+      const emotes = value.split("/")
+      for (const emote of emotes) {
+        const [id, rawPositions] = emote.split(":")
+        dict[id] = []
+
+        const positions = rawPositions.split(",")
+        for (const position of positions) {
+          const positionParts = position.split("-")
+          dict[id].push([positionParts[0], positionParts[1]])
+        }
+      }
+
+      tags[key] = dict
+      continue
+    }
+
+    if (key === "emoteSets") {
+      tags[key] = value.split(",")
+      continue
+    }
+
+    if (
+      key === "banDuration" ||
+      key === "pinnedChatPaidAmount" ||
+      key === "pinnedChatPaidExponent" ||
+      key === "slow" ||
+      false
+    ) {
+      tags[key] = parseInt(value)
+      continue
+    }
+
+    if (
+      key === "firstMsg" ||
+      key === "mod" ||
+      key === "vip" ||
+      key === "subscriber" ||
+      key === "turbo" ||
+      key === "emoteOnly" ||
+      key === "followersOnly" ||
+      key === "subsOnly" ||
+      key === "pinnedChatPaidIsSystemMessage" ||
+      false
+    ) {
+      tags[key] = !!parseInt(value)
+      continue
+    }
+
+    tags[key] = value
+  }
+
+  return tags
+}
+
+function parseCore(inputEvent: string, parameters: string): ChatEvent {
+  const [type, ...parts] = inputEvent.split(" ")
+
+  switch (type) {
+    case "PING":
+      // @ts-ignore
+      return {
+        type,
+        message: parameters,
+      }
+
+    case "001":
+      // @ts-ignore
+      return {
+        type,
+        channel: parts[0],
+        message: parameters,
+      }
+
+    case "CAP":
+      // @ts-ignore
+      return {
+        type,
+        enabled: parts[1] === "ACK",
+        nickname: parts[0],
+        capabilities: parameters.split(" "),
+      }
+
+    case "JOIN":
+    case "PART":
+      // @ts-ignore
+      return {
+        type,
+        channel: parts[0],
+      }
+
+    case "GLOBALUSERSTATE":
+    case "RECONNECT":
+      // @ts-ignore
+      return {
+        type,
+      }
+
+    case "CLEARCHAT":
+    case "HOSTTARGET":
+    case "NOTICE":
+    case "ROOMSTATE":
+    case "USERSTATE":
+      // @ts-ignore
+      return {
+        type,
+        channel: parts[0],
+      }
+
+    case "CLEARMSG":
+    case "USERNOTICE":
+      // @ts-ignore
+      return {
+        type,
+        channel: parts[0],
+      }
+
+    case "PRIVMSG":
+    case "WHISPER":
+      if (parameters[0] === "!") {
+        const index = parameters.indexOf(" ")
+
+        // @ts-ignore
+        return {
+          type: `${type}-COMMAND`,
+          channel: parts[0],
+          command: parameters.slice(1, index > -1 ? index : undefined),
+          parameters: index > -1 ? parameters.slice(index + 1) : undefined,
+        }
+      } else {
+        // @ts-ignore
+        return {
+          type,
+          channel: parts[0],
+          message: parameters,
+        }
+      }
+
+    // Ignoring all other numeric messages.
+    case "002":
+    case "003":
+    case "004":
+    case "353": // Tells you who else is in the chat room you're joining.
+    case "366":
+    case "372":
+    case "375":
+    case "376":
+      throw new Error(`Ignored message: ${type}`)
+
+    case "421":
+      throw new Error(`Unsupported message: ${type}`)
+
+    default:
+      throw new Error(`Unknown message: ${type}`)
+  }
+}
+
+function toCamelCase(dashedCase: string): string {
+  return dashedCase.replace(/[-:]([a-z])/g, (_, b) => `${b.toUpperCase()}`)
+}

package/src/eventsub/events/channel.ad_break.begin.ts

@@ -0,0 +1,51 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelAdBreakBeginType = "channel.ad_break.begin"
+type ChannelAdBreakBeginVersion = "beta"
+
+/** The parameters under which an event fires when A midroll commercial break starts running. */
+export interface ChannelAdBreakBeginCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_id: string
+}
+
+/** The event information when A midroll commercial break starts running. */
+export interface ChannelAdBreakBeginEvent {
+  /** Integer. Length in seconds of the mid-roll ad break requested. */
+  length_seconds: number
+  /** The time the ad break began. Note that there is potential delay between this event, when the streamer requested the ad break, and when the viewers will see ads. */
+  timestamp: Date
+  /** Indicates if the ad was automatically scheduled via Ads Manager. */
+  is_automatic: boolean
+  /** 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 user who requested the ad. For automatic ads, this will be the ID of the broadcaster. */
+  requester_user_id: string
+  /** The user name of the user who requested the ad. */
+  requester_user_name: string
+  /** The user login of the user who requested the ad. */
+  requester_user_login: string
+}
+
+/** The event notification received when A midroll commercial break starts running. */
+export type ChannelAdBreakBeginSubscription = BaseSubscription<
+  ChannelAdBreakBeginType,
+  ChannelAdBreakBeginVersion,
+  ChannelAdBreakBeginCondition
+>
+
+export function makeChannelAdBreakBeginSubscription(
+  userId: string,
+): ChannelAdBreakBeginSubscription {
+  return {
+    type: "channel.ad_break.begin",
+    version: "beta",
+    condition: {
+      broadcaster_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,59 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+type ChannelBanType = "channel.ban"
+type ChannelBanVersion = "1"
+
+/** The parameters under which an event fires when A moderator bans a user. */
+export interface ChannelBanCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when A moderator bans a user. */
+export interface ChannelBanEvent {
+  /** The user ID of the user who was banned. */
+  user_id: string
+  /** The user login of the user who was banned. */
+  user_login: string
+  /** The user name of the user who was banned. */
+  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 ban. */
+  moderator_user_id: string
+  /** The user login of the issuer of the ban. */
+  moderator_user_login: string
+  /** The user name of the issuer of the ban. */
+  moderator_user_name: string
+  /** The reason behind the ban. */
+  reason: string
+  /** The time the user was banned or put in a timeout. */
+  banned_at: Date
+  /** The time the timeout ends. Is null if the user was banned instead of put in a timeout. */
+  ends_at: Date
+  /** Indicates whether the ban is permanent (true) or a timeout (false). If true, ends_at will be null. */
+  is_permanent: boolean
+}
+
+/** The event notification received when A moderator bans a user. */
+export type ChannelBanSubscription = BaseSubscription<
+  ChannelBanType,
+  ChannelBanVersion,
+  ChannelBanCondition
+>
+
+export function makeChannelBanSubscription(
+  userId: string,
+): ChannelBanSubscription {
+  return {
+    type: "channel.ban",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

package/src/eventsub/events/channel.channel_points_custom_reward._.ts

@@ -0,0 +1,29 @@
+export interface ChannelPointsCustomRewardGlobalCooldown {
+  /** Is the setting enabled. */
+  is_enabled: boolean
+  /** Integer. The cooldown in seconds. */
+  seconds: number
+}
+
+export interface ChannelPointsCustomRewardMaxPerStream {
+  /** Is the setting enabled. */
+  is_enabled: boolean
+  /** Integer. The max per stream limit. */
+  value: number
+}
+
+export interface ChannelPointsCustomRewardMaxPerUserPerStream {
+  /** Is the setting enabled. */
+  is_enabled: boolean
+  /** Integer. The max per user per stream limit. */
+  value: number
+}
+
+export interface ChannelPointsCustomRewardImage {
+  /** URL for the image at 1x size. */
+  url_1x: string
+  /** URL for the image at 2x size. */
+  url_2x: string
+  /** URL for the image at 3x size. */
+  url_4x: string
+}

package/src/eventsub/events/channel.channel_points_custom_reward.add.ts

@@ -0,0 +1,75 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+import { ChannelPointsCustomRewardGlobalCooldown, ChannelPointsCustomRewardImage, ChannelPointsCustomRewardMaxPerStream, ChannelPointsCustomRewardMaxPerUserPerStream } from "./channel.channel_points_custom_reward._.js"
+
+type ChannelPointsCustomRewardAddType = "channel.channel_points_custom_reward.add"
+type ChannelPointsCustomRewardAddVersion = "1"
+
+/** The parameters under which an event fires when The broadcaster creates a custom channel points reward. */
+export interface ChannelPointsCustomRewardAddCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+}
+
+/** The event information when The broadcaster creates a custom channel points reward. */
+export interface ChannelPointsCustomRewardAddEvent {
+  /** The reward identifier. */
+  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
+  /** Is the reward currently enabled. If false, the reward won't show up to viewers. */
+  is_enabled: boolean
+  /** Is the reward currently paused. If true, viewers can't redeem. */
+  is_paused: boolean
+  /** Is the reward currently in stock. If false, viewers can't redeem. */
+  is_in_stock: boolean
+  /** The reward title. */
+  title: string
+  /** Integer. The reward cost. */
+  cost: number
+  /** The reward description. */
+  prompt: string
+  /** Does the viewer need to enter information when redeeming the reward. */
+  is_user_input_required: boolean
+  /** Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status. */
+  should_redemptions_skip_request_queue: boolean
+  /** Whether a maximum per stream is enabled and what the maximum is. */
+  max_per_stream: ChannelPointsCustomRewardMaxPerStream
+  /** Whether a maximum per user per stream is enabled and what the maximum is. */
+  max_per_user_per_stream: ChannelPointsCustomRewardMaxPerUserPerStream
+  /** Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2. */
+  background_color: string
+  /** Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded. */
+  image: ChannelPointsCustomRewardImage
+  /** Set of default images of 1x, 2x and 4x sizes for the reward. */
+  default_image: ChannelPointsCustomRewardImage
+  /** Whether a cooldown is enabled and what the cooldown is in seconds. */
+  global_cooldown: ChannelPointsCustomRewardGlobalCooldown
+  /** The time the cooldown expires. null if the reward isn't on cooldown. */
+  cooldown_expires_at: Date
+  /** Integer. The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn't live or max_per_stream isn't enabled. */
+  redemptions_redeemed_current_stream: number
+}
+
+/** The event notification received when The broadcaster creates a custom channel points reward. */
+export type ChannelPointsCustomRewardAddSubscription = BaseSubscription<
+  ChannelPointsCustomRewardAddType,
+  ChannelPointsCustomRewardAddVersion,
+  ChannelPointsCustomRewardAddCondition
+>
+
+export function makeChannelPointsCustomRewardAddSubscription(
+  userId: string,
+): ChannelPointsCustomRewardAddSubscription {
+  return {
+    type: "channel.channel_points_custom_reward.add",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

package/src/eventsub/events/channel.channel_points_custom_reward.remove.ts

@@ -0,0 +1,77 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+import { ChannelPointsCustomRewardGlobalCooldown, ChannelPointsCustomRewardImage, ChannelPointsCustomRewardMaxPerStream, ChannelPointsCustomRewardMaxPerUserPerStream } from "./channel.channel_points_custom_reward._.js"
+
+type ChannelPointsCustomRewardRemoveType = "channel.channel_points_custom_reward.remove"
+type ChannelPointsCustomRewardRemoveVersion = "1"
+
+/** The parameters under which an event fires when The broadcaster removes a custom channel points reward. */
+export interface ChannelPointsCustomRewardRemoveCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** Optional. Specify a reward ID to only receive notifications for a specific reward. */
+  reward_id?: string
+}
+
+/** The event information when The broadcaster removes a custom channel points reward. */
+export interface ChannelPointsCustomRewardRemoveEvent {
+  /** The reward identifier. */
+  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
+  /** Is the reward currently enabled. If false, the reward won't show up to viewers. */
+  is_enabled: boolean
+  /** Is the reward currently paused. If true, viewers can't redeem. */
+  is_paused: boolean
+  /** Is the reward currently in stock. If false, viewers can't redeem. */
+  is_in_stock: boolean
+  /** The reward title. */
+  title: string
+  /** Integer. The reward cost. */
+  cost: number
+  /** The reward description. */
+  prompt: string
+  /** Does the viewer need to enter information when redeeming the reward. */
+  is_user_input_required: boolean
+  /** Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status. */
+  should_redemptions_skip_request_queue: boolean
+  /** Whether a maximum per stream is enabled and what the maximum is. */
+  max_per_stream: ChannelPointsCustomRewardMaxPerStream
+  /** Whether a maximum per user per stream is enabled and what the maximum is. */
+  max_per_user_per_stream: ChannelPointsCustomRewardMaxPerUserPerStream
+  /** Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2. */
+  background_color: string
+  /** Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded. */
+  image: ChannelPointsCustomRewardImage
+  /** Set of default images of 1x, 2x and 4x sizes for the reward. */
+  default_image: ChannelPointsCustomRewardImage
+  /** Whether a cooldown is enabled and what the cooldown is in seconds. */
+  global_cooldown: ChannelPointsCustomRewardGlobalCooldown
+  /** The time the cooldown expires. null if the reward isn't on cooldown. */
+  cooldown_expires_at: Date
+  /** Integer. The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn't live or max_per_stream isn't enabled. */
+  redemptions_redeemed_current_stream: number
+}
+
+/** The event notification received when The broadcaster removes a custom channel points reward. */
+export type ChannelPointsCustomRewardRemoveSubscription = BaseSubscription<
+  ChannelPointsCustomRewardRemoveType,
+  ChannelPointsCustomRewardRemoveVersion,
+  ChannelPointsCustomRewardRemoveCondition
+>
+
+export function makeChannelPointsCustomRewardRemoveSubscription(
+  userId: string,
+): ChannelPointsCustomRewardRemoveSubscription {
+  return {
+    type: "channel.channel_points_custom_reward.remove",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,77 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+import { ChannelPointsCustomRewardGlobalCooldown, ChannelPointsCustomRewardImage, ChannelPointsCustomRewardMaxPerStream, ChannelPointsCustomRewardMaxPerUserPerStream } from "./channel.channel_points_custom_reward._.js"
+
+type ChannelPointsCustomRewardUpdateType = "channel.channel_points_custom_reward.update"
+type ChannelPointsCustomRewardUpdateVersion = "1"
+
+/** The parameters under which an event fires when The broadcaster updates a custom channel points reward. */
+export interface ChannelPointsCustomRewardUpdateCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** Optional. Specify a reward ID to only receive notifications for a specific reward. */
+  reward_id?: string
+}
+
+/** The event information when The broadcaster updates a custom channel points reward. */
+export interface ChannelPointsCustomRewardUpdateEvent {
+  /** The reward identifier. */
+  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
+  /** Is the reward currently enabled. If false, the reward won't show up to viewers. */
+  is_enabled: boolean
+  /** Is the reward currently paused. If true, viewers can't redeem. */
+  is_paused: boolean
+  /** Is the reward currently in stock. If false, viewers can't redeem. */
+  is_in_stock: boolean
+  /** The reward title. */
+  title: string
+  /** Integer. The reward cost. */
+  cost: number
+  /** The reward description. */
+  prompt: string
+  /** Does the viewer need to enter information when redeeming the reward. */
+  is_user_input_required: boolean
+  /** Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status. */
+  should_redemptions_skip_request_queue: boolean
+  /** Whether a maximum per stream is enabled and what the maximum is. */
+  max_per_stream: ChannelPointsCustomRewardMaxPerStream
+  /** Whether a maximum per user per stream is enabled and what the maximum is. */
+  max_per_user_per_stream: ChannelPointsCustomRewardMaxPerUserPerStream
+  /** Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2. */
+  background_color: string
+  /** Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded. */
+  image: ChannelPointsCustomRewardImage
+  /** Set of default images of 1x, 2x and 4x sizes for the reward. */
+  default_image: ChannelPointsCustomRewardImage
+  /** Whether a cooldown is enabled and what the cooldown is in seconds. */
+  global_cooldown: ChannelPointsCustomRewardGlobalCooldown
+  /** The time the cooldown expires. null if the reward isn't on cooldown. */
+  cooldown_expires_at: Date
+  /** Integer. The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn't live or max_per_stream isn't enabled. */
+  redemptions_redeemed_current_stream: number
+}
+
+/** The event notification received when The broadcaster updates a custom channel points reward. */
+export type ChannelPointsCustomRewardUpdateSubscription = BaseSubscription<
+  ChannelPointsCustomRewardUpdateType,
+  ChannelPointsCustomRewardUpdateVersion,
+  ChannelPointsCustomRewardUpdateCondition
+>
+
+export function makeChannelPointsCustomRewardUpdateSubscription(
+  userId: string,
+): ChannelPointsCustomRewardUpdateSubscription {
+  return {
+    type: "channel.channel_points_custom_reward.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

package/src/eventsub/events/channel.channel_points_custom_reward_redemption._.ts

@@ -0,0 +1,10 @@
+export interface ChannelPointsCustomRewardRedemptionReward {
+  /** The reward identifier. */
+  id: string
+  /** The reward name. */
+  title: string
+  /** Integer. The reward cost. */
+  cost: number
+  /** The reward description. */
+  prompt: string
+}