@overlaysymphony/twitch 0.3.3 → 0.4.0

package/src/eventsub/eventsub.ts

@@ -9,42 +9,60 @@ import { createSubscription } from "../helix/subscriptions/index.ts"
 import { type EventPayload, buildSubscription } from "./events-helpers.ts"
 import { type TwitchMessage } from "./messages.ts"
 
-export type TwitchEventSub = Events<EventPayload>
+export type TwitchEventSub = Events<EventPayload> & {
+  targetUserId: string
+}
 
+// TODO: connection instead of authentication
 export default async function createEventSub(
   authentication: Authentication,
+  targetUserId?: string,
 ): Promise<TwitchEventSub> {
-  return createEvents<EventPayload, string>(
-    async (pubsub) => {
-      const socket = new WebSocket("wss://eventsub.wss.twitch.tv/ws")
-
-      const { promise, resolve } = createDefer<string>()
-      socket.addEventListener("message", ({ data: rawData }) => {
-        const data = JSON.parse(rawData as string) as TwitchMessage
-        data.type = data.metadata.message_type
-
-        if (data.type === "session_welcome") {
-          resolve(data.payload.session.id)
-          return
-        }
-
-        if (data.type === "notification") {
-          data.payload.id = data.metadata.message_id
-          data.payload.type = data.payload.subscription.type
-
-          pubsub.dispatch(data.payload)
-          return
-        }
-      })
-
-      return await promise
-    },
-    async (pubsub, sessionId, type) => {
-      await createSubscription(
-        authentication,
-        { method: "websocket", session_id: sessionId },
-        buildSubscription(type, authentication.user.id),
-      )
-    },
-  )
+  const currentUserId = authentication.user.id
+  targetUserId ??= currentUserId
+
+  return {
+    targetUserId,
+    ...(await createEvents<EventPayload, string>(
+      async (pubsub) => {
+        const socket = new WebSocket("wss://eventsub.wss.twitch.tv/ws")
+
+        const { promise, resolve } = createDefer<string>()
+        socket.addEventListener("message", ({ data: rawData }) => {
+          const data = JSON.parse(rawData as string) as TwitchMessage
+          data.type = data.metadata.message_type
+
+          if (data.type === "session_welcome") {
+            resolve(data.payload.session.id)
+            return
+          }
+
+          if (data.type === "notification") {
+            data.payload.id = data.metadata.message_id
+            data.payload.type = data.payload.subscription.type
+
+            pubsub.dispatch(data.payload)
+            return
+          }
+        })
+
+        return await promise
+      },
+      async (pubsub, sessionId, type) => {
+        await createSubscription(
+          authentication,
+          { method: "websocket", session_id: sessionId },
+          buildSubscription(type, currentUserId, targetUserId),
+        )
+      },
+      (type) => {
+        const subscription = buildSubscription(
+          type,
+          currentUserId,
+          targetUserId,
+        )
+        return `${type}-${JSON.stringify(subscription)}`
+      },
+    )),
+  }
 }

package/src/eventsub/index.ts

@@ -1,6 +1,7 @@
 export {
   type EventConfig,
   type EventConfigs,
+  type EventPayload,
   type EventType,
   registerEvent,
 } from "./events-helpers.ts"

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/index.ts

@@ -0,0 +1 @@
+export { helix as default } from "./helix.ts"

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,48 @@ export async function getUser(
     created_at: new Date(created_at),
   }
 }
+
+export async function getUsers(
+  authentication: Authentication,
+  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[] }
+  >(authentication, {
+    method: "GET",
+    path: "/users",
+    params: {
+      id,
+      login,
+    },
+  })
+
+  return users.map(({ created_at, ...user }) => ({
+    ...user,
+    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

@@ -24,8 +24,8 @@ export const mapTypeToPriority = {
 export function onAlert(
   eventsub: TwitchEventSub,
   handleAlert: (alert: Alert) => void,
-): void {
-  eventsub.on(
+): () => void {
+  return eventsub.on(
     [
       "channel.cheer",
       "channel.follow",
@@ -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)

package/src/helpers/charity/charity.ts

@@ -31,7 +31,7 @@ export function onCharity(
     trigger: "progress" | "start" | "stop",
   ) => void,
   handleDonation: (donation: CharityDonation, charity: Charity) => void,
-): void {
+): () => void {
   const charity: Charity = {
     name: "",
     description: "",
@@ -42,7 +42,7 @@ export function onCharity(
     targetAmount: 0,
   }
 
-  eventsub.on(
+  return eventsub.on(
     [
       "channel.charity_campaign.start",
       "channel.charity_campaign.progress",

package/src/helpers/goal/goal.ts

@@ -16,7 +16,7 @@ const mapTypeToTrigger = {
 export function onGoal(
   eventsub: TwitchEventSub,
   handleGoal: (goal: Goal, trigger: "begin" | "progress" | "end") => void,
-): void {
+): () => void {
   const goal: Goal = {
     type: "",
     description: "",
@@ -24,7 +24,7 @@ export function onGoal(
     targetAmount: 0,
   }
 
-  eventsub.on(
+  return eventsub.on(
     ["channel.goal.begin", "channel.goal.progress", "channel.goal.end"],
     (payload) => {
       goal.type = payload.event.type

package/src/helpers/hype-train/hype-train.ts

@@ -19,7 +19,7 @@ export function onHypeTrain(
     hypeTrain: HypeTrain,
     trigger: "begin" | "progress" | "end",
   ) => void,
-): void {
+): () => void {
   const hypeTrain: HypeTrain = {
     level: 0,
     total: 0,
@@ -27,7 +27,7 @@ export function onHypeTrain(
     goal: 0,
   }
 
-  eventsub.on(
+  return eventsub.on(
     [
       "channel.hype_train.begin",
       "channel.hype_train.progress",

package/src/helpers/poll/poll.ts

@@ -23,7 +23,7 @@ const mapTypeToTrigger = {
 export function onPoll(
   eventsub: TwitchEventSub,
   handlePoll: (poll: Poll, trigger: "begin" | "progress" | "end") => void,
-): void {
+): () => void {
   const poll: Poll = {
     id: "",
     title: "",
@@ -31,7 +31,7 @@ export function onPoll(
     endsAt: undefined,
   }
 
-  eventsub.on(
+  return eventsub.on(
     ["channel.poll.begin", "channel.poll.progress", "channel.poll.end"],
     (payload) => {
       // Twitch sometimes sends duplicate end events.

package/src/helpers/prediction/prediction.ts

@@ -25,14 +25,14 @@ export function onPrediction(
     prediction: Prediction,
     trigger: "begin" | "progress" | "lock" | "end",
   ) => void,
-): void {
+): () => void {
   const prediction: Prediction = {
     title: "",
     outcomes: [],
     locksAt: new Date(""),
   }
 
-  eventsub.on(
+  return eventsub.on(
     [
       "channel.prediction.begin",
       "channel.prediction.progress",

package/src/helpers/redemption/redemption.ts

@@ -29,7 +29,7 @@ export function onRedemption(
   ...config:
     | [string, (redemption: Redemption) => void]
     | [(redemption: Redemption) => void]
-): void {
+): () => void {
   const id = typeof config[0] === "string" ? config[0] : undefined
   const handleRedemption =
     typeof config[0] === "function"
@@ -38,7 +38,7 @@ export function onRedemption(
         ? config[1]
         : undefined
 
-  eventsub.on(
+  return eventsub.on(
     ["channel.channel_points_custom_reward_redemption.add"],
     (payload) => {
       if (typeof id === "undefined" || payload.event.reward.id === id) {

package/src/helpers/status/status.ts

@@ -13,7 +13,7 @@ export interface Status {
 export function onStatus(
   eventsub: TwitchEventSub,
   handleStatus: (status: Status) => void,
-): void {
+): () => void {
   const status: Status = {
     online: false,
     shieldMode: false,
@@ -22,7 +22,7 @@ export function onStatus(
     labels: [],
   }
 
-  eventsub.on(
+  return eventsub.on(
     [
       "channel.update",
       "stream.online",