@overlaysymphony/twitch 0.3.2 → 0.3.4

package/package.json

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

package/src/authentication/authentication.ts

@@ -1,4 +1,4 @@
-import { type TwitchUser, getUser } from "../helix/users/index.ts"
+import { type TwitchUser, getCurrentUser } from "../helix/users/index.ts"
 
 export interface Authentication {
   tokenType: "bearer"
@@ -61,7 +61,7 @@ export async function getAuthentication(
     return undefined
   }
 
-  const user = await getUser(authentication as Authentication)
+  const user = await getCurrentUser(authentication as Authentication)
   if (!user) {
     return undefined
   }

package/src/chat/chat.ts

@@ -7,7 +7,7 @@ type ChatMessage = EventPayload<"channel.chat.message">["event"]
 type ChatCommand = ChatMessage & {
   message: {
     command: string
-    parameters?: string[]
+    parameters?: string
   } & ChatMessage["message"]
 }
 
@@ -46,6 +46,8 @@ export default async function createChat(
 
   const onMessage: ChatMessageSubscriber = (callback) => {
     return eventsub.on(["channel.chat.message"], (payload) => {
+      if (payload.event.broadcaster_user_id !== authentication.user.id) return
+
       callback(payload.event)
     })
   }
@@ -54,15 +56,13 @@ export default async function createChat(
     const regex = /^\s*!([a-z0-9]+)(?:\s+(.+))?$/i
 
     return onMessage((payload) => {
-      const [, command, text] =
+      const [, command, parameters] =
         payload.message.text.match(regex) ?? ([] as Array<string | undefined>)
 
       if (command !== name) {
         return
       }
 
-      const parameters = text?.split(" ")
-
       callback({
         ...payload,
         message: {

package/src/chat/pronouns.ts

@@ -33,17 +33,17 @@ const pronouns: Record<string, Pronouns> = {
   },
   shethem: {
     subject: "she",
-    object: "they",
+    object: "them",
     posessive: "their",
   },
   hethem: {
     subject: "he",
-    object: "they",
+    object: "them",
     posessive: "their",
   },
   heshe: {
     subject: "he",
-    object: "she",
+    object: "her",
     posessive: "their",
   },
   xexem: {
@@ -123,10 +123,7 @@ export async function getUserPronouns(
 export async function getPronouns(
   login: string,
   fallback: keyof typeof pronouns = "theythem",
-): Promise<{
-  subject: string
-  object: string
-}> {
+): Promise<Pronouns> {
   if (!(login in cache)) {
     try {
       const id = await getUserPronouns(login)

package/src/helix/chat/emotes.ts

@@ -1,34 +1,37 @@
 import { type Authentication } from "../../authentication/index.ts"
 import { helix } from "../helix.ts"
 
-interface ChannelEmote {
-  id: string /** An ID that identifies this emote. */
-  name: string /** The name of the emote. This is the name that viewers type in the chat window to get the emote to appear. */
-  image: () => string /** A generator for the image URLs for the emote. */
-  tier: string /** The subscriber tier at which the emote is unlocked. This field contains the tier information only if emote_type is set to subscriptions, otherwise, it's an empty string. */
-  emote_type: string /** The type of emote. Possible values are:\n* bitstier — A custom Bits tier emote.\n* follower — A custom follower emote.\n* subscriptions — A custom subscriber emote. */
-  emote_set_id: string /** An ID that identifies the emote set that the emote belongs to. */
-  format: string[] /** The formats that the emote is available in. Possible values are:\n* animated — An animated GIF is available for this emote.\n* static — A static PNG file is available for this emote. */
-  scale: string[] /** The sizes that the emote is available in.\n* 1.0 — A small version (28px x 28px) is available.\n* 2.0 — A medium version (56px x 56px) is available.\n* 3.0 — A large version (112px x 112px) is available. */
-  theme_mode: string[] /** The background themes that the emote is available in. Possible values are:\n* dark\n* light */
+interface Emote {
+  /** An ID that identifies this emote. */
+  id: string
+  /** The name of the emote. This is the name that viewers type in the chat window to get the emote to appear. */
+  name: string
+  /** A generator for the image URLs for the emote. */
+  image: (config?: { format?: string; mode?: string; scale?: string }) => string
+  /** The subscriber tier at which the emote is unlocked. This field contains the tier information only if emote_type is set to subscriptions, otherwise, it's an empty string. */
+  tier: string
+  /** The type of emote. Possible values are:\n* bitstier — A custom Bits tier emote.\n* follower — A custom follower emote.\n* subscriptions — A custom subscriber emote. */
+  emote_type: string
+  /** An 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. Possible values are:\n* animated — An animated GIF is available for this emote.\n* static — A static PNG file is available for this emote. */
+  format: string[]
+  /** The sizes that the emote is available in.\n* 1.0 — A small version (28px x 28px) is available.\n* 2.0 — A medium version (56px x 56px) is available.\n* 3.0 — A large version (112px x 112px) is available. */
+  scale: string[]
+  /** The background themes that the emote is available in. Possible values are:\n* dark\n* light */
+  theme_mode: string[]
 }
 
 interface ChannelEmoteResponse {
-  data: Array<
-    Omit<ChannelEmote, "image"> & {
-      images: {
-        url_1x: string
-        url_2x: string
-        url_4x: string
-      }
-    }
-  >
+  data: Array<Omit<Emote, "image" | "owner_id">>
   template: string
 }
 
 export async function getChannelEmotes(
   authentication: Authentication,
-): Promise<ChannelEmote[]> {
+): Promise<Emote[]> {
   const { data: emotes, template } = await helix<
     ChannelEmoteResponse,
     {
@@ -42,8 +45,42 @@ export async function getChannelEmotes(
     },
   })
 
-  return emotes.map(({ images, ...emote }) => ({
+  return emotes.map((emote) => ({
+    owner_id: authentication.user.id,
+    ...emote,
+    image: ({ format, mode, scale } = {}) =>
+      template
+        .replace("{{id}}", emote.id)
+        .replace("{{format}}", format ?? emote.format[0])
+        .replace("{{theme_mode}}", mode ?? emote.theme_mode[0])
+        .replace("{{scale}}", scale ?? emote.scale[emote.scale.length - 1]),
+  }))
+}
+
+export async function getUserEmotes(
+  authentication: Authentication,
+): Promise<Emote[]> {
+  const { data: emotes, template } = await helix<
+    ChannelEmoteResponse,
+    {
+      user_id: string
+    }
+  >(authentication, {
+    method: "GET",
+    path: "/chat/emotes/user",
+    params: {
+      user_id: authentication.user.id,
+    },
+  })
+
+  return emotes.map((emote) => ({
+    owner_id: authentication.user.id,
     ...emote,
-    image: () => template,
+    image: ({ format, mode, scale } = {}) =>
+      template
+        .replace("{{id}}", emote.id)
+        .replace("{{format}}", format ?? emote.format[0])
+        .replace("{{theme_mode}}", mode ?? emote.theme_mode[0])
+        .replace("{{scale}}", scale ?? emote.scale[emote.scale.length - 1]),
   }))
 }

package/src/helix/streams/index.ts

@@ -0,0 +1 @@
+export * from "./streams.ts"

package/src/helix/streams/streams.ts

@@ -0,0 +1,48 @@
+import { type Authentication } from "../../authentication/index.ts"
+import { helix } from "../helix.ts"
+
+export interface TwitchStream {
+  id: string
+  user_id: string
+  user_login: string
+  user_name: string
+  game_id: string
+  game_name: string
+  type: string
+  title: string
+  tags: string[]
+  viewer_count: number
+  started_at: string
+  language: string
+  thumbnail_url: string
+}
+
+interface StreamsResponse {
+  data: TwitchStream[]
+}
+
+export async function getStream(
+  authentication: Authentication,
+  login?: string | string[],
+  id?: string | string[],
+): Promise<TwitchStream | undefined> {
+  if (!login && !id) return undefined
+
+  if (typeof login === "string" && login.startsWith("@")) {
+    login = login.slice(1)
+  }
+
+  const { data: streams } = await helix<
+    StreamsResponse,
+    { user_id?: string | string[]; user_login?: string | string[] }
+  >(authentication, {
+    method: "GET",
+    path: "/users",
+    params: {
+      user_id: id,
+      user_login: login,
+    },
+  })
+
+  return streams[0]
+}

package/src/helix/users/users.ts

@@ -26,6 +26,12 @@ export async function getUser(
   login?: string | string[],
   id?: string | string[],
 ): Promise<TwitchUser | undefined> {
+  if (!login && !id) return undefined
+
+  if (typeof login === "string" && login.startsWith("@")) {
+    login = login.slice(1)
+  }
+
   const { data: users } = await helix<
     UsersResponse,
     { id?: string | string[]; login?: string | string[] }
@@ -45,3 +51,19 @@ export async function getUser(
     created_at: new Date(created_at),
   }
 }
+
+export async function getCurrentUser(
+  authentication: Authentication,
+): Promise<TwitchUser | undefined> {
+  const { data: users } = await helix<UsersResponse>(authentication, {
+    method: "GET",
+    path: "/users",
+  })
+
+  const [{ created_at, ...user }] = users
+
+  return {
+    ...user,
+    created_at: new Date(created_at),
+  }
+}

package/src/helpers/alerts/alerts.ts

@@ -47,7 +47,7 @@ export function onAlert(
 
 export default function createAlertQueue(
   eventsub: TwitchEventSub,
-  handleAlert: (alert: Alert) => void,
+  handleAlert: (alert: Alert) => unknown,
 ): Queue<Alert>["dismiss"] {
   const queue = createQueue<Alert>()
   queue.listen(handleAlert)