@overlaysymphony/twitch 0.2.1 → 0.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@overlaysymphony/twitch",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Twitch module for the OverlaySymphony interactive streaming framework.",
   "homepage": "https://github.com/OverlaySymphony/overlaysymphony",
   "type": "module",
@@ -14,7 +14,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@overlaysymphony/core": "0.2.0"
+    "@overlaysymphony/core": "0.2.1"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^2.1.2",

package/src/authentication/authentication.ts

@@ -1,4 +1,4 @@
-import { type TwitchUser, getUsers } from "../helix/users/index.js"
+import { type TwitchUser, getUsers } from "../helix/users/index.ts"
 
 export interface Authentication {
   tokenType: "bearer"

package/src/authentication/index.ts

@@ -1 +1 @@
-export * from "./authentication.js"
+export * from "./authentication.ts"

package/src/chat/chat.ts

@@ -1,13 +1,13 @@
 import createDefer from "@overlaysymphony/core/libs/defer"
 import createPubSub from "@overlaysymphony/core/libs/pubsub"
 
-import { type Authentication } from "../authentication/index.js"
+import { type Authentication } from "../authentication/index.ts"
 
 import {
   type TwitchChatEvent,
   type TwitchChatEventType,
-} from "./interfaces/index.js"
-import parseCommand from "./parser.js"
+} from "./interfaces/index.ts"
+import parseCommand from "./parser.ts"
 
 type ChatListener = (callback: (event: TwitchChatEvent) => void) => () => void
 
@@ -44,7 +44,7 @@ export interface TwitchChat {
   onCommand: ChatCommandSubscriber
 }
 
-export async function createChat(
+export default async function createChat(
   authentication: Authentication,
   channel: string = authentication.user.login,
 ): Promise<TwitchChat> {

package/src/chat/helpers.ts

@@ -12,7 +12,7 @@ export function isBroadcaster(event: ApplicableChatEvent): boolean | null {
 
   if (typeof broadcaster === "undefined") return null
 
-  return !!broadcaster
+  return broadcaster
 }
 
 export function isMod(event: ApplicableChatEvent): boolean | null {

package/src/chat/index.ts

@@ -1,7 +1,8 @@
 export type {
   TwitchChatEventType,
   TwitchChatEvent,
-} from "./interfaces/index.js"
+} from "./interfaces/index.ts"
 
-export * from "./chat.js"
-export * from "./helpers.js"
+export { default } from "./chat.ts"
+export * from "./chat.ts"
+export * from "./helpers.ts"

package/src/chat/interfaces/index.ts

@@ -1,6 +1,6 @@
-import { type ChatEvent } from "./events.js"
+import { type ChatEvent } from "./events.ts"
 
-export type { ChatEvent, ChatEventSource } from "./events.js"
+export type { ChatEvent, ChatEventSource } from "./events.ts"
 
 export type TwitchChatEventType = ChatEvent["type"]
 

package/src/chat/parser.ts

@@ -1,4 +1,4 @@
-import { type ChatEvent, type ChatEventSource } from "./interfaces/index.js"
+import { type ChatEvent, type ChatEventSource } from "./interfaces/index.ts"
 
 // Parses an IRC message and returns a JSON object with the message's
 // component parts (tags, source (nick and host), command, parameters).

package/src/eventsub/events/automod.message.hold-2.ts

@@ -0,0 +1,81 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "automod.message.hold": AutomodMessageHold
+  }
+}
+
+/** Automod Message Hold v2: When the user's message is caught by automod for review.  Only public blocked terms trigger notifications, not private ones. */
+type AutomodMessageHold = EventConfig<{
+  Type: "automod.message.hold"
+  Version: "2"
+  /** The conditions to listen for when the user's message is caught by automod for review.  Only public blocked terms trigger notifications, not private ones. */
+  Condition: {
+    /** User ID of the broadcaster (channel). */
+    broadcaster_user_id: string
+    /** User ID of the moderator. */
+    moderator_user_id: string
+  }
+  /** The event fired when the user's message is caught by automod for review.  Only public blocked terms trigger notifications, not private ones. */
+  Event: {
+    /** The ID of the broadcaster specified in the request. */
+    broadcaster_user_id: string
+    /** The login of the broadcaster specified in the request. */
+    broadcaster_user_login: string
+    /** The user name of the broadcaster specified in the request. */
+    broadcaster_user_name: string
+    /** The message sender's user ID. */
+    user_id: string
+    /** The message sender's login name. */
+    user_login: string
+    /** The message sender's display name. */
+    user_name: string
+    /** The ID of the message that was flagged by automod. */
+    message_id: string
+    /** The body of the message. */
+    message: {
+      /** The contents of the message caught by automod. */
+      text: string
+      /** Metadata surrounding the potential inappropriate fragments of the message. */
+      fragments: Array<{
+        /** Message text in a fragment. */
+        text: string
+        /** Metadata pertaining to the emote. */
+        emote?: {
+          /** An ID that uniquely identifies this emote. */
+          id: string
+          /** An ID that identifies the emote set that the emote belongs to. */
+          emote_set_id: string
+        }
+        /** Metadata pertaining to the cheermote. */
+        cheermote?: {
+          /** The name portion of the Cheermote string that you use in chat to cheer Bits. The full Cheermote string is the concatenation of {prefix} + {number of Bits}. */
+          prefix: string
+          /** The amount of Bits cheered. */
+          bits: number
+          /** The tier level of the cheermote. */
+          tier: number
+        }
+      }>
+    }
+    /** The category of the message. */
+    category: string
+    /** The level of severity. Measured between 1 to 4. */
+    level: number
+    /** The timestamp of when automod saved the message. */
+    held_at: string
+  }
+}>
+
+registerEvent("automod.message.hold", {
+  scopes: ["moderator:manage:automod"],
+  subscriber: (userId) => ({
+    type: "automod.message.hold",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/automod.message.update-2.ts

@@ -0,0 +1,94 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "automod.message.update": AutomodMessageUpdate
+  }
+}
+
+/** Automod Message Update v2: When a message in the automod queue had its status changed. Only public blocked terms trigger notifications, not private ones. */
+type AutomodMessageUpdate = EventConfig<{
+  Type: "automod.message.update"
+  Version: "2"
+  /** The conditions to listen for when a message in the automod queue had its status changed. Only public blocked terms trigger notifications, not private ones. */
+  Condition: {
+    /** User ID of the broadcaster (channel). Maximum:1. */
+    broadcaster_user_id: string
+    /** User ID of the moderator. */
+    moderator_user_id: string
+  }
+  /** The event fired when a message in the automod queue had its status changed. Only public blocked terms trigger notifications, not private ones. */
+  Event: {
+    /** The ID of the broadcaster specified in the request. */
+    broadcaster_user_id: string
+    /** The login of the broadcaster specified in the request. */
+    broadcaster_user_login: string
+    /** The user name of the broadcaster specified in the request. */
+    broadcaster_user_name: string
+    /** The message sender's user ID. */
+    user_id: string
+    /** The message sender's login name. */
+    user_login: string
+    /** The message sender's display name. */
+    user_name: string
+    /** The ID of the moderator. */
+    moderator_user_id: string
+    /** TThe moderator's user name. */
+    moderator_user_name: string
+    /** The login of the moderator. */
+    moderator_user_login: string
+    /** The ID of the message that was flagged by automod. */
+    message_id: string
+    /** The body of the message. */
+    message: {
+      /** The contents of the message caught by automod. */
+      text: string
+      /** Metadata surrounding the potential inappropriate fragments of the message. */
+      fragments: Array<{
+        /** Message text in a fragment. */
+        text: string
+        /** Metadata pertaining to the emote. */
+        emote?: {
+          /** An ID that uniquely identifies this emote. */
+          id: string
+          /** An ID that identifies the emote set that the emote belongs to. */
+          emote_set_id: string
+        }
+        /** Metadata pertaining to the cheermote. */
+        cheermote?: {
+          /** The name portion of the Cheermote string that you use in chat to cheer Bits. The full Cheermote string is the concatenation of {prefix} + {number of Bits}. */
+          prefix: string
+          /** The amount of Bits cheered. */
+          bits: number
+          /** The tier level of the cheermote. */
+          tier: number
+        }
+      }>
+    }
+    /** The category of the message. */
+    category: string
+    /** The level of severity. Measured between 1 to 4. */
+    level: number
+    /**
+     * The message's status. Possible values are:
+     * - Approved
+     * - Denied
+     * - Expired
+     */
+    status: string
+    /** The timestamp of when automod saved the message. */
+    held_at: string
+  }
+}>
+
+registerEvent("automod.message.update", {
+  scopes: ["moderator:manage:automod"],
+  subscriber: (userId) => ({
+    type: "automod.message.update",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/automod.settings.update-1.ts

@@ -0,0 +1,65 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "automod.settings.update": AutomodSettingsUpdate
+  }
+}
+
+/** Automod Settings Update v1: When the broadcaster's automod settings are updated. */
+type AutomodSettingsUpdate = EventConfig<{
+  Type: "automod.settings.update"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster's automod settings are updated. */
+  Condition: {
+    /** User ID of the broadcaster (channel). Maximum:1. */
+    broadcaster_user_id: string
+    /** User ID of the moderator. */
+    moderator_user_id: string
+  }
+  /** The event fired when the broadcaster's automod settings are updated. */
+  Event: {
+    /** The ID of the broadcaster specified in the request. */
+    broadcaster_user_id: string
+    /** The login of the broadcaster specified in the request. */
+    broadcaster_user_login: string
+    /** The user name of the broadcaster specified in the request. */
+    broadcaster_user_name: string
+    /** The ID of the moderator who changed the channel settings. */
+    moderator_user_id: string
+    /** The moderator's login. */
+    moderator_user_login: string
+    /** The moderator's user name. */
+    moderator_user_name: string
+    /** The Automod level for hostility involving name calling or insults. */
+    bullying: number
+    /** The default AutoMod level for the broadcaster. This field is null if the broadcaster has set one or more of the individual settings. */
+    overall_level: number
+    /** The Automod level for discrimination against disability. */
+    disability: number
+    /** The Automod level for racial discrimination. */
+    race_ethnicity_or_religion: number
+    /** The Automod level for discrimination against women. */
+    misogyny: number
+    /** The AutoMod level for discrimination based on sexuality, sex, or gender. */
+    sexuality_sex_or_gender: number
+    /** The Automod level for hostility involving aggression. */
+    aggression: number
+    /** The Automod level for sexual content. */
+    sex_based_terms: number
+    /** The Automod level for profanity. */
+    swearing: number
+  }
+}>
+
+registerEvent("automod.settings.update", {
+  scopes: ["moderator:read:automod"],
+  subscriber: (userId) => ({
+    type: "automod.settings.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/automod.terms.update-1.ts

@@ -0,0 +1,59 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "automod.terms.update": AutomodTermsUpdate
+  }
+}
+
+/** Automod Terms Update v1: When the broadcaster's automod terms are updated. Changes to private terms are not sent. */
+type AutomodTermsUpdate = EventConfig<{
+  Type: "automod.terms.update"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster's automod terms are updated. Changes to private terms are not sent. */
+  Condition: {
+    /** User ID of the broadcaster (channel). Maximum:1. */
+    broadcaster_user_id: string
+    /** User ID of the moderator creating the subscription. Maximum:1 */
+    moderator_user_id: string
+  }
+  /** The event fired when the broadcaster's automod terms are updated. Changes to private terms are not sent. */
+  Event: {
+    /** The ID of the broadcaster specified in the request. */
+    broadcaster_user_id: string
+    /** The login of the broadcaster specified in the request. */
+    broadcaster_user_login: string
+    /** The user name of the broadcaster specified in the request. */
+    broadcaster_user_name: string
+    /** The ID of the moderator who changed the channel settings. */
+    moderator_user_id: string
+    /** The moderator's login. */
+    moderator_user_login: string
+    /** The moderator's user name. */
+    moderator_user_name: string
+    /**
+     * The status change applied to the terms. Possible options are:
+     * - add_permitted
+     * - remove_permitted
+     * - add_blocked
+     * - remove_blocked
+     */
+    action: string
+    /** Indicates whether this term was added due to an Automod message approve/deny action. */
+    from_automod: boolean
+    /** The list of terms that had a status change. */
+    terms: string[]
+  }
+}>
+
+registerEvent("automod.terms.update", {
+  scopes: ["moderator:manage:automod"],
+  subscriber: (userId) => ({
+    type: "automod.terms.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,50 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.ad_break.begin": ChannelAdBreakBegin
+  }
+}
+
+/** Channel Ad Break Begin v1: When a midroll commercial break has started running. */
+type ChannelAdBreakBegin = EventConfig<{
+  Type: "channel.ad_break.begin"
+  Version: "1"
+  /** The conditions to listen for when a midroll commercial break has started running. */
+  Condition: {
+    /** The ID of the broadcaster that you want to get Channel Ad Break begin notifications for. Maximum: 1 */
+    broadcaster_id: string
+  }
+  /** The event fired when a midroll commercial break has started running. */
+  Event: {
+    /** Length in seconds of the mid-roll ad break requested */
+    duration_seconds: number
+    /** The UTC timestamp of when the ad break began, in RFC3339 format. Note that there is potential delay between this event, when the streamer requested the ad break, and when the viewers will see ads. */
+    started_at: string
+    /** Indicates if the ad was automatically scheduled via Ads Manager */
+    is_automatic: boolean
+    /** The broadcaster's user ID for the channel the ad was run on. */
+    broadcaster_user_id: string
+    /** The broadcaster's user login for the channel the ad was run on. */
+    broadcaster_user_login: string
+    /** The broadcaster's user display name for the channel the ad was run on. */
+    broadcaster_user_name: string
+    /** The ID of the user that requested the ad. For automatic ads, this will be the ID of the broadcaster. */
+    requester_user_id: string
+    /** The login of the user that requested the ad. */
+    requester_user_login: string
+    /** The display name of the user that requested the ad. */
+    requester_user_name: string
+  }
+}>
+
+registerEvent("channel.ad_break.begin", {
+  scopes: ["channel:read:ads"],
+  subscriber: (userId) => ({
+    type: "channel.ad_break.begin",
+    version: "1",
+    condition: {
+      broadcaster_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,58 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.ban": ChannelBan
+  }
+}
+
+/** Channel Ban v1: When a viewer is banned from the specified channel. */
+type ChannelBan = EventConfig<{
+  Type: "channel.ban"
+  Version: "1"
+  /** The conditions to listen for when a viewer is banned from the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to get ban notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a viewer is banned from the specified channel. */
+  Event: {
+    /** The user ID for the user who was banned on the specified channel. */
+    user_id: string
+    /** The user login for the user who was banned on the specified channel. */
+    user_login: string
+    /** The user display name for the user who was banned on the specified channel. */
+    user_name: 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 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 UTC date and time (in RFC3339 format) of when the user was banned or put in a timeout. */
+    banned_at: string
+    /** The UTC date and time (in RFC3339 format) of when the timeout ends. Is null if the user was banned instead of put in a timeout. */
+    ends_at: string
+    /** Indicates whether the ban is permanent (true) or a timeout (false). If true, ends_at will be null. */
+    is_permanent: boolean
+  }
+}>
+
+registerEvent("channel.ban", {
+  scopes: ["channel:moderate"],
+  subscriber: (userId) => ({
+    type: "channel.ban",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.bits.use-1.ts

@@ -0,0 +1,112 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.bits.use": ChannelBitsUse
+  }
+}
+
+/** Channel Bits Use v1: When Bits are used on a channel. */
+type ChannelBitsUse = EventConfig<{
+  Type: "channel.bits.use"
+  Version: "1"
+  /** The conditions to listen for when Bits are used on a channel. */
+  Condition: {
+    /** The user ID of the channel broadcaster. Maximum: 1. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when Bits are used on a channel. */
+  Event: {
+    /** The User ID of the channel where the Bits were redeemed. */
+    broadcaster_user_id: string
+    /** The login of the channel where the Bits were used. */
+    broadcaster_user_login: string
+    /** The display name of the channel where the Bits were used. */
+    broadcaster_user_name: string
+    /** The User ID of the redeeming user. */
+    user_id: string
+    /** The login name of the redeeming user. */
+    user_login: string
+    /** The display name of the redeeming user. */
+    user_name: string
+    /** The number of Bits used. */
+    bits: number
+    /**
+     * Possible values are:
+     * - cheer
+     * - power_up
+     */
+    type: string
+    /** An object that contains the user message and emote information needed to recreate the message. */
+    message?: {
+      /** The chat message in plain text. */
+      text: string
+      /** The ordered list of chat message fragments. */
+      fragments: Array<{
+        /** The message text in fragment. */
+        text: string
+        /**
+         * The type of message fragment. Possible values are:
+         * - text
+         * - cheermote
+         * - emote
+         */
+        type: string
+        /** The metadata pertaining to the emote. */
+        emote?: {
+          /** The ID that uniquely identifies this emote. */
+          id: string
+          /** The ID that identifies the emote set that the emote belongs to. */
+          emote_set_id: string
+          /** The ID of the broadcaster who owns the emote. */
+          owner_id: string
+          /**
+           * The formats that the emote is available in.
+           * - animated - An animated GIF is available for this emote.
+           * - static - A static PNG file is available for this emote.
+           */
+          format: string[]
+        }
+        /** The metadata pertaining to the cheermote. */
+        cheermote?: {
+          /** The name portion of the Cheermote string that you use in chat to cheer Bits. The full Cheermote string is the concatenation of {prefix} + {number of Bits}. */
+          prefix: string
+          /** The amount of Bits cheered. */
+          bits: number
+          /** The tier level of the cheermote. */
+          tier: number
+        }
+      }>
+    }
+    /** Data about Power-up. */
+    power_up?: {
+      /**
+       * Possible values:
+       * - message_effect
+       * - celebration
+       * - gigantify_an_emote
+       */
+      type: string
+      /** Emote associated with the reward. */
+      emote?: {
+        /** The ID that uniquely identifies this emote. */
+        id: string
+        /** The human readable emote token. */
+        name: string
+      }
+      /** The ID of the message effect. */
+      message_effect_id?: string
+    }
+  }
+}>
+
+registerEvent("channel.bits.use", {
+  scopes: ["bits:read"],
+  subscriber: (userId) => ({
+    type: "channel.bits.use",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})