@overlaysymphony/twitch 0.2.1 → 0.2.3

package/src/eventsub/events/user.whisper.message-1.ts

@@ -0,0 +1,51 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "user.whisper.message": UserWhisperMessage
+  }
+}
+
+/** User Whisper Message v1: When a user receives a whisper. */
+type UserWhisperMessage = EventConfig<{
+  Type: "user.whisper.message"
+  Version: "1"
+  /** The conditions to listen for when a user receives a whisper. */
+  Condition: {
+    /** The user_id of the person receiving whispers. */
+    user_id: string
+  }
+  /** The event fired when a user receives a whisper. */
+  Event: {
+    /** The ID of the user sending the message. */
+    from_user_id: string
+    /** The name of the user sending the message. */
+    from_user_name: string
+    /** The login of the user sending the message. */
+    from_user_login: string
+    /** The ID of the user receiving the message. */
+    to_user_id: string
+    /** The name of the user receiving the message. */
+    to_user_name: string
+    /** The login of the user receiving the message. */
+    to_user_login: string
+    /** The whisper ID. */
+    whisper_id: string
+    /** Object containing whisper information. */
+    whisper: {
+      /** The body of the whisper message. */
+      text: string
+    }
+  }
+}>
+
+registerEvent("user.whisper.message", {
+  scopes: ["user:manage:whispers", "user:read:whispers"],
+  subscriber: (userId) => ({
+    type: "user.whisper.message",
+    version: "1",
+    condition: {
+      user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events-helpers.ts

@@ -1,29 +1,57 @@
-export interface BaseSubscription<
-  Type = unknown,
-  Version = unknown,
-  Condition = unknown,
-> {
-  type: Type
-  version: Version
-  condition: Condition
-}
-
-export interface NotificationMessage<
-  Subscription extends BaseSubscription,
-  Event,
-> {
-  type: "notification"
-  metadata: {
-    message_id: string
-    message_type: "notification"
-    message_timestamp: Date
-    subscription_type: Subscription["type"]
-    subscription_version: Subscription["version"]
+export type EventConfig<
+  Config extends {
+    Type: string
+    Version: string
+    Condition: {}
+    Event: {}
+  },
+> = Config & {
+  Subscription: {
+    type: Config["Type"]
+    version: Config["Version"]
+    condition: Config["Condition"]
   }
-  payload: {
+  Payload: {
     id: string
-    type: Subscription["type"]
-    subscription: Subscription
-    event: Event
+    type: Config["Type"]
+    subscription: {
+      type: Config["Type"]
+      version: Config["Version"]
+      condition: Config["Condition"]
+    }
+    event: Config["Event"]
   }
 }
+
+export interface EventConfigs {}
+
+export type EventType = keyof EventConfigs
+export type EventPayload<Type extends EventType = EventType> =
+  EventConfigs[Type]["Payload"]
+
+const events: {
+  [Type in EventType]?: {
+    scopes: string[]
+    subscriber: (userId: string) => EventConfigs[Type]["Subscription"]
+  }
+} = {}
+
+export function registerEvent<Type extends EventType>(
+  type: Type,
+  config: {
+    scopes: string[]
+    subscriber: (userId: string) => EventConfigs[Type]["Subscription"]
+  },
+): void {
+  // @ts-expect-error too complex for typescript
+  events[type] = config
+}
+
+export function buildSubscription<Type extends EventType>(
+  type: Type,
+  userId: string,
+): EventConfigs[Type]["Subscription"] {
+  if (!events[type]) throw new Error(`Event ${type} is not registered.`)
+
+  return events[type].subscriber(userId)
+}

package/src/eventsub/eventsub.ts

@@ -1,87 +1,50 @@
-import createDefer from "@overlaysymphony/core/libs/defer"
-import createPubSub from "@overlaysymphony/core/libs/pubsub"
-
-import { type Authentication } from "../authentication/index.js"
-import { createSubscription } from "../helix/subscriptions/index.js"
+import "./events/index.ts"
 
-import {
-  type TwitchNotificationMessage,
-  type TwitchSubscriptionType,
-} from "./events/index.js"
-import { type TwitchMessage } from "./messages.js"
+import createDefer from "@overlaysymphony/core/libs/defer"
+import createEvents, { type Events } from "@overlaysymphony/core/libs/events"
 
-type EventSubListener = (
-  callback: (event: TwitchNotificationMessage["payload"]) => void,
-) => () => void
+import { type Authentication } from "../authentication/index.ts"
+import { createSubscription } from "../helix/subscriptions/index.ts"
 
-type EventSubSubscriber = <
-  EventType extends TwitchSubscriptionType,
-  Event extends TwitchNotificationMessage<EventType>["payload"],
->(
-  types: EventType[],
-  callback: (event: Event) => void,
-) => () => void
+import { type EventPayload, buildSubscription } from "./events-helpers.ts"
+import { type TwitchMessage } from "./messages.ts"
 
-export interface TwitchEventSub {
-  listen: EventSubListener
-  subscribe: EventSubSubscriber
-}
+export type TwitchEventSub = Events<EventPayload>
 
-export async function createEventSub(
+export default async function createEventSub(
   authentication: Authentication,
 ): Promise<TwitchEventSub> {
-  const { promise, resolve } = createDefer<string>()
-
-  const pubsub = createPubSub<TwitchNotificationMessage["payload"]>()
-  const socket = new WebSocket("wss://eventsub.wss.twitch.tv/ws")
-
-  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 promise.then((sessionId) => {
-    const subscriptions: Partial<Record<TwitchSubscriptionType, boolean>> = {}
-
-    const listen: EventSubListener = (callback) => {
-      return pubsub.subscribe((event) => {
-        callback(event)
-      })
-    }
-
-    const subscribe: EventSubSubscriber = (types, callback) => {
-      for (const type of types) {
-        if (!subscriptions[type]) {
-          subscriptions[type] = true
-          void createSubscription(sessionId, authentication, type)
+  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
         }
-      }
 
-      return pubsub.subscribe((event) => {
-        // @ts-expect-error: generic events are complicated
-        if (types.includes(event.type)) {
-          // @ts-expect-error: generic events are complicated
-          callback(event)
+        if (data.type === "notification") {
+          data.payload.id = data.metadata.message_id
+          data.payload.type = data.payload.subscription.type
+
+          pubsub.dispatch(data.payload)
+          return
         }
       })
-    }
 
-    return {
-      listen,
-      subscribe,
-    }
-  })
+      return await promise
+    },
+    async (pubsub, sessionId, type) => {
+      await createSubscription(
+        authentication,
+        { method: "websocket", session_id: sessionId },
+        buildSubscription(type, authentication.user.id),
+      )
+    },
+  )
 }

package/src/eventsub/index.ts

@@ -1,7 +1,9 @@
-export type {
-  TwitchSubscriptionType,
-  TwitchSubscription,
-  TwitchNotificationMessage,
-} from "./events/index.js"
+export {
+  type EventConfig,
+  type EventConfigs,
+  type EventType,
+  registerEvent,
+} from "./events-helpers.ts"
 
-export * from "./eventsub.js"
+export { default } from "./eventsub.ts"
+export * from "./eventsub.ts"

package/src/eventsub/messages.ts

@@ -1,6 +1,6 @@
-import { type TwitchNotificationMessage } from "./events/index.js"
+import { type EventConfigs, type EventType } from "./events-helpers.ts"
 
-export interface SessionWelcomeMessage {
+export type SessionWelcomeMessage = {
   type: "session_welcome"
   metadata: {
     message_id: string
@@ -18,7 +18,7 @@ export interface SessionWelcomeMessage {
   }
 }
 
-export interface SessionKeepaliveMessage {
+export type SessionKeepaliveMessage = {
   type: "session_keepalive"
   metadata: {
     message_id: string
@@ -28,7 +28,19 @@ export interface SessionKeepaliveMessage {
   payload: Record<string, never>
 }
 
+export type NotificationMessage<Type extends EventType = EventType> = {
+  type: "notification"
+  metadata: {
+    message_id: string
+    message_type: "notification"
+    message_timestamp: Date
+    subscription_type: EventConfigs[Type]["Type"]
+    subscription_version: EventConfigs[Type]["Version"]
+  }
+  payload: EventConfigs[Type]["Payload"]
+}
+
 export type TwitchMessage =
   | SessionWelcomeMessage
   | SessionKeepaliveMessage
-  | TwitchNotificationMessage
+  | NotificationMessage

package/src/helix/channel-points/custom-rewards.ts

@@ -1,5 +1,5 @@
-import { type Authentication } from "../../authentication/index.js"
-import { helix } from "../helix.js"
+import { type Authentication } from "../../authentication/index.ts"
+import { helix } from "../helix.ts"
 
 interface CustomReward {
   broadcaster_id: string
@@ -51,7 +51,7 @@ export async function getCustomRewards(
       broadcaster_id: string
     }
   >(authentication, {
-    method: "get",
+    method: "GET",
     path: "/channel_points/custom_rewards",
     params: {
       broadcaster_id: authentication.user.id,

package/src/helix/channel-points/index.ts

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

package/src/helix/helix.ts

@@ -1,6 +1,6 @@
 import querystring from "@overlaysymphony/core/libs/querystring"
 
-import { type Authentication } from "../authentication/index.js"
+import { type Authentication } from "../authentication/index.ts"
 
 export async function helix<
   Data = never,

package/src/helix/subscriptions/index.ts

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

package/src/helix/subscriptions/subscriptions.ts

@@ -1,11 +1,7 @@
-import { type Authentication } from "../../authentication/index.js"
-import {
-  type TwitchSubscription,
-  type TwitchSubscriptionType,
-  buildSubscription,
-} from "../../eventsub/events/index.js"
-import { type BaseSubscription } from "../../eventsub/events-helpers.js"
-import { helix } from "../helix.js"
+import { type Authentication } from "../../authentication/index.ts"
+import { type EventConfigs, type EventType } from "../../eventsub/index.ts"
+
+import { helix } from "../helix.ts"
 
 interface SubscriptionWebhookTransport {
   method: "webhook"
@@ -22,15 +18,15 @@ type SubscriptionTransport =
   | SubscriptionWebhookTransport
   | SubscriptionWebsocketTransport
 
-export interface SubscriptionRequest<Subscription extends BaseSubscription> {
-  type: Subscription["type"]
-  version: Subscription["version"]
-  condition: Subscription["condition"]
+interface SubscriptionRequest<Type extends EventType> {
+  type: EventConfigs[Type]["Type"]
+  version: EventConfigs[Type]["Version"]
+  condition: EventConfigs[Type]["Condition"]
   transport: SubscriptionTransport
 }
 
-export type ActiveSubscription<Subscription extends BaseSubscription> =
-  Subscription & {
+type ActiveSubscription<Type extends EventType> =
+  EventConfigs[Type]["Subscription"] & {
     id: string
     status:
       | "enabled"
@@ -53,60 +49,57 @@ export type ActiveSubscription<Subscription extends BaseSubscription> =
     transport: SubscriptionTransport
   }
 
-export async function createSubscription<
-  Type extends TwitchSubscriptionType,
-  Subscription extends TwitchSubscription<Type>,
->(
-  sessionId: string,
+export async function createSubscription<Type extends EventType>(
   authentication: Authentication,
-  type: Type,
-): Promise<ActiveSubscription<Subscription>> {
-  const subscription = buildSubscription(type, authentication.user.id)
-
-  const [activeSubscription] = await helix(authentication, {
-    method: "post",
+  transport: SubscriptionTransport,
+  subscription: EventConfigs[Type]["Subscription"],
+): Promise<ActiveSubscription<Type>> {
+  const [activeSubscription] = await helix<
+    ActiveSubscription<EventType>,
+    never,
+    never,
+    SubscriptionRequest<EventType>
+  >(authentication, {
+    method: "POST",
     path: "/eventsub/subscriptions",
     body: {
       ...subscription,
-      transport: {
-        method: "websocket" as const,
-        session_id: sessionId,
-      },
+      transport,
     },
   })
 
   return activeSubscription
 }
 
-export async function deleteSubscription(
-  authentication: Authentication,
-  id: string,
-): Promise<void> {
-  await helix<never, never, { id: string }>(authentication, {
-    method: "delete",
-    path: "/eventsub/subscriptions",
-    params: {
-      id,
-    },
-  })
-}
-
 export async function getSubscriptions(
   authentication: Authentication,
-): Promise<Array<ActiveSubscription<TwitchSubscription>>> {
+): Promise<Array<ActiveSubscription<EventType>>> {
   const subscriptions = await helix<
-    ActiveSubscription<TwitchSubscription>,
+    ActiveSubscription<EventType>,
     never,
     {
-      status?: ActiveSubscription<TwitchSubscription>["status"]
-      type?: TwitchSubscriptionType
+      status?: ActiveSubscription<EventType>["status"]
+      type?: EventType
       user_id?: string
       after?: string
     }
   >(authentication, {
-    method: "get",
+    method: "GET",
     path: "/eventsub/subscriptions",
   })
 
   return subscriptions
 }
+
+export async function deleteSubscription(
+  authentication: Authentication,
+  id: string,
+): Promise<void> {
+  await helix<never, never, { id: string }>(authentication, {
+    method: "DELETE",
+    path: "/eventsub/subscriptions",
+    params: {
+      id,
+    },
+  })
+}

package/src/helix/users/index.ts

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

package/src/helix/users/users.ts

@@ -1,5 +1,5 @@
-import { type Authentication } from "../../authentication/index.js"
-import { helix } from "../helix.js"
+import { type Authentication } from "../../authentication/index.ts"
+import { helix } from "../helix.ts"
 
 export interface TwitchUser {
   id: string
@@ -25,7 +25,7 @@ export async function getUsers(
   const data = await helix<TwitchUser, RawUser>(
     authentication,
     {
-      method: "get",
+      method: "GET",
       path: "/users",
       params: {
         id,

package/src/helpers/alerts/alerts.ts

@@ -1,16 +1,16 @@
 import createQueue, { type Queue } from "@overlaysymphony/core/libs/queue"
 
-import { type TwitchNotificationMessage } from "../../eventsub/events/index.js"
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type EventPayload } from "../../eventsub/events-helpers.ts"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
-export type Alert = TwitchNotificationMessage<
+export type Alert = EventPayload<
   | "channel.cheer"
   | "channel.follow"
   | "channel.raid"
   | "channel.subscribe"
   | "channel.subscription.gift"
   | "channel.subscription.message"
->["payload"]
+>
 
 export const mapTypeToPriority = {
   "channel.follow": 0,
@@ -25,7 +25,7 @@ export function onAlert(
   eventsub: TwitchEventSub,
   handleAlert: (alert: Alert) => void,
 ): void {
-  eventsub.subscribe(
+  eventsub.on(
     [
       "channel.cheer",
       "channel.follow",

package/src/helpers/alerts/index.ts

@@ -1,2 +1,2 @@
-export { default } from "./alerts.js"
-export * from "./alerts.js"
+export { default } from "./alerts.ts"
+export * from "./alerts.ts"

package/src/helpers/charity/charity.ts

@@ -1,4 +1,4 @@
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
 export interface Charity {
   name: string
@@ -42,7 +42,7 @@ export function onCharity(
     targetAmount: 0,
   }
 
-  eventsub.subscribe(
+  eventsub.on(
     [
       "channel.charity_campaign.start",
       "channel.charity_campaign.progress",

package/src/helpers/charity/index.ts

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

package/src/helpers/goal/goal.ts

@@ -1,4 +1,4 @@
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
 export interface Goal {
   type: string
@@ -24,7 +24,7 @@ export function onGoal(
     targetAmount: 0,
   }
 
-  eventsub.subscribe(
+  eventsub.on(
     ["channel.goal.begin", "channel.goal.progress", "channel.goal.end"],
     (payload) => {
       goal.type = payload.event.type

package/src/helpers/goal/index.ts

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

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

@@ -1,4 +1,4 @@
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
 export interface HypeTrain {
   level: number
@@ -27,7 +27,7 @@ export function onHypeTrain(
     goal: 0,
   }
 
-  eventsub.subscribe(
+  eventsub.on(
     [
       "channel.hype_train.begin",
       "channel.hype_train.progress",

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

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

package/src/helpers/poll/index.ts

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

package/src/helpers/poll/poll.ts

@@ -1,4 +1,4 @@
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
 export interface Poll {
   id: string
@@ -31,7 +31,7 @@ export function onPoll(
     endsAt: undefined,
   }
 
-  eventsub.subscribe(
+  eventsub.on(
     ["channel.poll.begin", "channel.poll.progress", "channel.poll.end"],
     (payload) => {
       // Twitch sometimes sends duplicate end events.
@@ -66,7 +66,7 @@ export function onPoll(
         payload.type === "channel.poll.begin" ||
         payload.type === "channel.poll.progress"
       ) {
-        poll.endsAt = payload.event.ends_at
+        poll.endsAt = new Date(payload.event.ends_at)
       } else {
         poll.endsAt = undefined
       }

package/src/helpers/prediction/index.ts

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

package/src/helpers/prediction/prediction.ts

@@ -1,4 +1,4 @@
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
 export interface Prediction {
   title: string
@@ -32,7 +32,7 @@ export function onPrediction(
     locksAt: new Date(""),
   }
 
-  eventsub.subscribe(
+  eventsub.on(
     [
       "channel.prediction.begin",
       "channel.prediction.progress",
@@ -55,7 +55,7 @@ export function onPrediction(
         payload.type === "channel.prediction.begin" ||
         payload.type === "channel.prediction.progress"
       ) {
-        prediction.locksAt = payload.event.locks_at
+        prediction.locksAt = new Date(payload.event.locks_at)
       } else {
         prediction.locksAt = undefined
       }

package/src/helpers/redemption/index.ts

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