@overlaysymphony/twitch 0.2.0 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@overlaysymphony/twitch",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "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.1.0"
+    "@overlaysymphony/core": "0.2.0"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^2.1.2",
@@ -22,6 +22,7 @@
     "eslint": "^9.19.0",
     "prettier": "^3.4.2",
     "typescript": "^5.7.2",
+    "vite": "^6.2.1",
     "vitest": "^2.1.2",
     "@overlaysymphony/tooling": "0.0.0"
   },
@@ -32,8 +33,6 @@
     "lint-prettier": "prettier --check .",
     "lint-depcheck": "depcheck .",
     "test": "vitest",
-    "dev": "echo TODO",
-    "clean": "rm -rf node_modules/.cache tsconfig.tsbuildinfo dist",
-    "build": "echo TODO"
+    "clean": "rm -rf node_modules/.cache tsconfig.tsbuildinfo"
   }
 }

package/src/authentication/authentication.ts

@@ -1,8 +1,8 @@
 import { type TwitchUser, getUsers } from "../helix/users/index.js"
 
 export interface Authentication {
-  clientId: string
   tokenType: "bearer"
+  clientId: string
   accessToken: string
   scope: string[]
   expires: Date
@@ -69,6 +69,32 @@ export async function getAuthentication(
   }
 }
 
+export async function setAuthentication(
+  clientId: string,
+  accessToken: string,
+  scope: string[] = [],
+): Promise<BareAuthentication | undefined> {
+  let authentication: BareAuthentication = {
+    tokenType: "bearer",
+    clientId,
+    accessToken,
+    scope,
+
+    // this is ignored and replaced by validateAuthentication
+    expires: new Date(),
+  }
+
+  try {
+    authentication = await validateAuthentication(authentication)
+  } catch (error) {
+    return undefined
+  }
+
+  setCachedAuthentication(authentication)
+
+  return authentication
+}
+
 export async function popupAuthentication(
   clientId: string,
   scopes: string[],

package/src/chat/helpers.ts

@@ -0,0 +1,36 @@
+interface ApplicableChatEvent {
+  tags?: {
+    mod?: boolean
+    badges?: {
+      broadcaster?: boolean
+    }
+  }
+}
+
+export function isBroadcaster(event: ApplicableChatEvent): boolean | null {
+  const broadcaster = event.tags?.badges?.broadcaster
+
+  if (typeof broadcaster === "undefined") return null
+
+  return !!broadcaster
+}
+
+export function isMod(event: ApplicableChatEvent): boolean | null {
+  const broadcaster = event.tags?.badges?.broadcaster
+  const mod = event.tags?.mod
+
+  if (typeof broadcaster === "undefined" || typeof mod === "undefined")
+    return null
+
+  return broadcaster || mod
+}
+
+export function isModOnly(event: ApplicableChatEvent): boolean | null {
+  const broadcaster = event.tags?.badges?.broadcaster
+  const mod = event.tags?.mod
+
+  if (typeof broadcaster === "undefined" || typeof mod === "undefined")
+    return null
+
+  return mod && !broadcaster
+}

package/src/chat/index.ts

@@ -4,3 +4,4 @@ export type {
 } from "./interfaces/index.js"
 
 export * from "./chat.js"
+export * from "./helpers.js"

package/src/eventsub/events/index.ts

@@ -276,7 +276,6 @@ export function buildSubscription<
   Subscription extends TwitchSubscription<Type>,
 >(type: Type, userId: string): Subscription {
   const creator = subscriptionBuilders[type]
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (!creator) {
     throw new Error(`Unknown type ${type}`)
   }

package/src/eventsub/eventsub.ts

@@ -66,8 +66,7 @@ export async function createEventSub(
       for (const type of types) {
         if (!subscriptions[type]) {
           subscriptions[type] = true
-          // eslint-disable-next-line @typescript-eslint/no-floating-promises
-          createSubscription(sessionId, authentication, type)
+          void createSubscription(sessionId, authentication, type)
         }
       }
 

package/src/helpers/poll/poll.ts

@@ -1,6 +1,7 @@
 import { type TwitchEventSub } from "../../eventsub/index.js"
 
 export interface Poll {
+  id: string
   title: string
   choices: Array<{
     id: string
@@ -10,7 +11,7 @@ export interface Poll {
     votesChannelPoints: number
     votesNormal: number
   }>
-  endsAt: Date
+  endsAt?: Date
 }
 
 const mapTypeToTrigger = {
@@ -24,14 +25,25 @@ export function onPoll(
   handlePoll: (poll: Poll, trigger: "begin" | "progress" | "end") => void,
 ): void {
   const poll: Poll = {
+    id: "",
     title: "",
     choices: [],
-    endsAt: new Date(""),
+    endsAt: undefined,
   }
 
   eventsub.subscribe(
     ["channel.poll.begin", "channel.poll.progress", "channel.poll.end"],
     (payload) => {
+      // Twitch sometimes sends duplicate end events.
+      if (payload.type === "channel.poll.end") {
+        // Skip if its already ended
+        if (typeof poll.endsAt === "undefined") return
+
+        // Skip if its for the wrong poll.
+        if (payload.event.id !== poll.id) return
+      }
+
+      poll.id = payload.event.id
       poll.title = payload.event.title
       poll.choices = payload.event.choices.map(
         ({
@@ -55,6 +67,8 @@ export function onPoll(
         payload.type === "channel.poll.progress"
       ) {
         poll.endsAt = payload.event.ends_at
+      } else {
+        poll.endsAt = undefined
       }
 
       handlePoll(poll, mapTypeToTrigger[payload.type])

package/src/helpers/redemption/redemption.ts

@@ -14,16 +14,35 @@ export interface Redemption {
   }
 }
 
+export function onRedemption(
+  eventsub: TwitchEventSub,
+  handleRedemption: (redemption: Redemption) => void,
+): void
 export function onRedemption(
   eventsub: TwitchEventSub,
   id: string,
   handleRedemption: (redemption: Redemption) => void,
+): void
+
+export function onRedemption(
+  eventsub: TwitchEventSub,
+  ...config:
+    | [string, (redemption: Redemption) => void]
+    | [(redemption: Redemption) => void]
 ): void {
+  const id = typeof config[0] === "string" ? config[0] : undefined
+  const handleRedemption =
+    typeof config[0] === "function"
+      ? config[0]
+      : typeof config[1] === "function"
+        ? config[1]
+        : undefined
+
   eventsub.subscribe(
     ["channel.channel_points_custom_reward_redemption.add"],
     (payload) => {
-      if (payload.event.reward.id === id) {
-        handleRedemption({
+      if (typeof id === "undefined" || payload.event.reward.id === id) {
+        handleRedemption?.({
           id: payload.event.id,
           userId: payload.event.user_id,
           userLogin: payload.event.user_login,

package/src/ui/authentication.ts

@@ -70,8 +70,7 @@ export class TwitchAuthentication extends HTMLElement {
     this.root = this.attachShadow({ mode: "open" })
     this.root.adoptedStyleSheets.push(stylesheet)
 
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    this.render()
+    void this.render()
   }
 
   get clientId(): string {

package/src/ui/popup.ts

@@ -17,8 +17,8 @@ if (state.step === "initial") {
 
 if (state.step === "token") {
   const authentication = await authenticateResult(state.clientId, state)
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-  window.opener.postMessage({ type: "authentication", authentication }, "*")
+  const opener = window.opener as Window | undefined
+  opener?.postMessage({ type: "authentication", authentication }, "*")
   window.close()
 }
 
@@ -144,8 +144,8 @@ async function authenticateResult(
   }
 
   const authentication = await validateAuthentication({
-    clientId,
     tokenType: result.token_type,
+    clientId,
     accessToken: result.access_token,
     scope: result.scope.split("+"),
   })

package/src/ui/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />