@overlaysymphony/twitch 0.2.2 → 0.3.0

package/src/chat/interfaces/events.ts

@@ -1,269 +0,0 @@
-export interface ChatEventSource {
-  host: string
-  user?: string
-}
-
-type AllOrNothing<T> = T | Partial<Record<keyof T, undefined>>
-
-type TagUserType = "staff" | "global_mod" | "admin" | undefined
-type TagBadges = Record<string, number>
-type TagBadgeInfo = Record<string, number>
-type TagEmotes = Record<
-  string,
-  Array<[startPosition: string, endPosition: string]>
->
-
-export interface PingEvent {
-  type: "PING"
-  message: string
-  source?: ChatEventSource
-}
-
-export interface WelcomeEvent {
-  type: "001" // Logged in (successfully authenticated)
-  channel: string
-  message: string
-  source?: ChatEventSource
-}
-
-export interface CapabilitiesEvent {
-  type: "CAP"
-  enabled: boolean
-  nickname: string
-  capabilities: string[]
-  source?: ChatEventSource
-}
-
-export interface JoinEvent {
-  type: "JOIN"
-  channel: string
-  source?: ChatEventSource
-}
-
-export interface PartEvent {
-  type: "PART"
-  channel: string
-  source?: ChatEventSource
-}
-
-export interface GlobalUserStateEvent {
-  type: "GLOBALUSERSTATE"
-  tags?: {
-    userId: string
-    userType: TagUserType
-    displayName?: string
-    color?: string
-    badges?: TagBadges
-    badgeInfo?: TagBadgeInfo
-    emoteSets?: string[]
-  }
-  source?: ChatEventSource
-}
-
-export interface ReconnectEvent {
-  type: "RECONNECT"
-  source?: ChatEventSource
-}
-
-export interface ClearChatEvent {
-  type: "CLEARCHAT"
-  channel: string
-  tags?: {
-    roomId: string
-    targetUserId: string
-    banDuration: number
-  }
-  source?: ChatEventSource
-}
-
-export interface HostTargetEvent {
-  type: "HOSTTARGET"
-  channel: string
-  source?: ChatEventSource
-}
-
-export interface NoticeEvent {
-  type: "NOTICE"
-  channel: string
-  tags?: {
-    msgId: string
-    targetUserId: string
-  }
-  source?: ChatEventSource
-}
-
-export interface RoomStateEvent {
-  type: "ROOMSTATE"
-  channel: string
-  tags?: {
-    roomId: string
-    slow: number
-    emoteOnly: boolean
-    followersOnly: boolean
-    subsOnly: boolean
-  }
-  source?: ChatEventSource
-}
-
-export interface UserStateEvent {
-  type: "USERSTATE"
-  channel: string
-  tags?: {
-    id: string
-    userId: string
-    userType: TagUserType
-    displayName?: string
-    color?: string
-    badges?: TagBadges
-    badgeInfo?: TagBadgeInfo
-    emoteSets?: string[]
-
-    mod: boolean
-    subscriber: boolean
-    vip: boolean
-    turbo: boolean
-  }
-  source?: ChatEventSource
-}
-
-export interface ClearMessageEvent {
-  type: "CLEARMSG"
-  channel: string
-  tags?: {
-    login: string
-    roomId: string
-    targetMsgId?: string
-  }
-  source?: ChatEventSource
-}
-
-export interface UserNoticeEvent {
-  type: "USERNOTICE"
-  channel: string
-  tags?: {
-    id: string
-    userId: string
-    userType: TagUserType
-    displayName?: string
-    login: string
-    color?: string
-    badges?: TagBadges
-    badgeInfo?: TagBadgeInfo
-    emotes?: TagEmotes
-    roomId: string
-    systemMsg: string
-    msgId:
-      | "sub"
-      | "resub"
-      | "subgift"
-      | "submysterygift"
-      | "giftpaidupgrade"
-      | "rewardgift"
-      | "anongiftpaidupgrade"
-      | "raid"
-      | "unraid"
-      | "ritual"
-      | "bitsbadgetier"
-
-    mod: boolean
-    subscriber: boolean
-    vip: boolean
-    turbo: boolean
-  }
-  source?: ChatEventSource
-}
-
-export interface ChatMessageEvent {
-  type: "PRIVMSG"
-  channel: string
-  message: string
-  tags?: {
-    id: string
-    userId: string
-    userType: TagUserType
-    displayName?: string
-    color?: string
-    badges?: TagBadges
-    badgeInfo?: TagBadgeInfo
-    emotes?: TagEmotes
-    roomId: string
-
-    firstMsg: boolean
-    mod: boolean
-    subscriber: boolean
-    vip: boolean
-    turbo: boolean
-  } & AllOrNothing<{
-    replyThreadParentMsgId: string
-    replyThreadParentUserLogin: string
-    replyParentMsgId: string
-    replyParentUserId: string
-    replyParentUserLogin: string
-    replyParentDisplayName: string
-    replyParentMsgBody: string
-  }> &
-    AllOrNothing<{
-      pinnedChatPaidIsSystemMessage: boolean
-      pinnedChatPaidLevel: string
-      pinnedChatPaidAmount: number
-      pinnedChatPaidExponent: number
-      pinnedChatPaidCurrency: string
-    }>
-  source?: ChatEventSource
-}
-
-export interface WhisperMessageEvent {
-  type: "WHISPER"
-  channel: string
-  message: string
-  tags?: {
-    messageId: string
-    threadId: string
-    userId: string
-    userType: TagUserType
-    displayName?: string
-    color?: string
-    badges?: TagBadges
-    emotes?: TagEmotes
-    turbo: boolean
-  }
-  source?: ChatEventSource
-}
-
-export interface ChatCommandEvent {
-  type: "PRIVMSG-COMMAND"
-  channel: string
-  command: string
-  parameters?: string
-  tags?: ChatMessageEvent["tags"]
-  source?: ChatEventSource
-}
-
-export interface WhisperCommandEvent {
-  type: "WHISPER-COMMAND"
-  channel: string
-  command: string
-  parameters?: string
-  tags?: WhisperMessageEvent["tags"]
-  source?: ChatEventSource
-}
-
-export type ChatEvent =
-  | PingEvent
-  | WelcomeEvent
-  | CapabilitiesEvent
-  | JoinEvent
-  | PartEvent
-  | GlobalUserStateEvent
-  | ReconnectEvent
-  | ClearChatEvent
-  | HostTargetEvent
-  | NoticeEvent
-  | RoomStateEvent
-  | UserStateEvent
-  | ClearMessageEvent
-  | UserNoticeEvent
-  | ChatMessageEvent
-  | WhisperMessageEvent
-  | ChatCommandEvent
-  | WhisperCommandEvent

package/src/chat/interfaces/index.ts

@@ -1,9 +0,0 @@
-import { type ChatEvent } from "./events.js"
-
-export type { ChatEvent, ChatEventSource } from "./events.js"
-
-export type TwitchChatEventType = ChatEvent["type"]
-
-export type TwitchChatEvent<
-  Type extends TwitchChatEventType = TwitchChatEventType,
-> = Extract<ChatEvent, { type: Type }>

package/src/chat/parser.ts

@@ -1,254 +0,0 @@
-import { type ChatEvent, type 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.includes(":", idx)
-    if (hasParameters) {
-      const endIdx = input.indexOf(":", idx)
-
-      const message = parseCore(
-        input.slice(idx, endIdx - 1),
-        input.slice(endIdx + 1),
-      )
-
-      return {
-        ...message,
-        source,
-        // @ts-expect-error: generic objects are complicated
-        tags,
-      }
-    } else {
-      const message = parseCore(input.slice(idx, input.length), "")
-
-      return {
-        ...message,
-        source,
-        // @ts-expect-error: generic objects are complicated
-        tags,
-      }
-    }
-  } catch (error) {
-    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"
-    ) {
-      tags[key] = parseInt(value)
-      continue
-    }
-
-    if (
-      key === "firstMsg" ||
-      key === "mod" ||
-      key === "vip" ||
-      key === "subscriber" ||
-      key === "turbo" ||
-      key === "emoteOnly" ||
-      key === "followersOnly" ||
-      key === "subsOnly" ||
-      key === "pinnedChatPaidIsSystemMessage"
-    ) {
-      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":
-      return {
-        type,
-        message: parameters,
-      }
-
-    case "001":
-      return {
-        type,
-        channel: parts[0],
-        message: parameters,
-      }
-
-    case "CAP":
-      return {
-        type,
-        enabled: parts[1] === "ACK",
-        nickname: parts[0],
-        capabilities: parameters.split(" "),
-      }
-
-    case "JOIN":
-    case "PART":
-      return {
-        type,
-        channel: parts[0],
-      }
-
-    case "GLOBALUSERSTATE":
-    case "RECONNECT":
-      return {
-        type,
-      }
-
-    case "CLEARCHAT":
-    case "HOSTTARGET":
-    case "NOTICE":
-    case "ROOMSTATE":
-    case "USERSTATE":
-      return {
-        type,
-        channel: parts[0],
-      }
-
-    case "CLEARMSG":
-    case "USERNOTICE":
-      return {
-        type,
-        channel: parts[0],
-      }
-
-    case "PRIVMSG":
-    case "WHISPER":
-      if (parameters.startsWith("!")) {
-        const index = parameters.indexOf(" ")
-
-        return {
-          type: `${type}-COMMAND`,
-          channel: parts[0],
-          command: parameters.slice(1, index > -1 ? index : undefined),
-          parameters: index > -1 ? parameters.slice(index + 1) : undefined,
-        }
-      } else {
-        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: string) => b.toUpperCase())
-}

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

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

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

@@ -1,29 +0,0 @@
-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
-}