@overlaysymphony/twitch 0.2.2 → 0.3.0

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,62 @@ export type ActiveSubscription<Subscription extends BaseSubscription> =
     transport: SubscriptionTransport
   }
 
-export async function createSubscription<
-  Type extends TwitchSubscriptionType,
-  Subscription extends TwitchSubscription<Type>,
->(
-  sessionId: string,
-  authentication: Authentication,
-  type: Type,
-): Promise<ActiveSubscription<Subscription>> {
-  const subscription = buildSubscription(type, authentication.user.id)
+type ActiveSubscriptionResponse<Type extends EventType> = {
+  data: Array<ActiveSubscription<Type>>
+}
 
-  const [activeSubscription] = await helix(authentication, {
-    method: "post",
+export async function createSubscription<Type extends EventType>(
+  authentication: Authentication,
+  transport: SubscriptionTransport,
+  subscription: EventConfigs[Type]["Subscription"],
+): Promise<ActiveSubscription<Type>> {
+  const {
+    data: [activeSubscription],
+  } = await helix<
+    ActiveSubscriptionResponse<EventType>,
+    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>>> {
-  const subscriptions = await helix<
-    ActiveSubscription<TwitchSubscription>,
+): Promise<Array<ActiveSubscription<EventType>>> {
+  const { data: subscriptions } = await helix<
+    ActiveSubscriptionResponse<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, { 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
@@ -13,8 +13,12 @@ export interface TwitchUser {
   created_at: Date
 }
 
-type RawUser = Omit<TwitchUser, "created_at"> & {
-  created_at: string
+interface UsersResponse {
+  data: Array<
+    Omit<TwitchUser, "created_at"> & {
+      created_at: string
+    }
+  >
 }
 
 export async function getUsers(
@@ -22,21 +26,20 @@ export async function getUsers(
   id?: string | string[],
   login?: string | string[],
 ): Promise<TwitchUser[]> {
-  const data = await helix<TwitchUser, RawUser>(
-    authentication,
-    {
-      method: "get",
-      path: "/users",
-      params: {
-        id,
-        login,
-      },
+  const { data: users } = await helix<
+    UsersResponse,
+    { id?: string | string[]; login?: string | string[] }
+  >(authentication, {
+    method: "GET",
+    path: "/users",
+    params: {
+      id,
+      login,
     },
-    ({ created_at, ...data }) => ({
-      ...data,
-      created_at: new Date(created_at),
-    }),
-  )
+  })
 
-  return data
+  return users.map(({ created_at, ...user }) => ({
+    ...user,
+    created_at: new Date(created_at),
+  }))
 }

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"

package/src/helpers/redemption/redemption.ts

@@ -1,4 +1,4 @@
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
 export interface Redemption {
   id: string
@@ -38,7 +38,7 @@ export function onRedemption(
         ? config[1]
         : undefined
 
-  eventsub.subscribe(
+  eventsub.on(
     ["channel.channel_points_custom_reward_redemption.add"],
     (payload) => {
       if (typeof id === "undefined" || payload.event.reward.id === id) {

package/src/helpers/status/index.ts

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

package/src/helpers/status/status.ts

@@ -1,4 +1,4 @@
-import { type TwitchEventSub } from "../../eventsub/index.js"
+import { type TwitchEventSub } from "../../eventsub/index.ts"
 
 export interface Status {
   online: boolean
@@ -22,7 +22,7 @@ export function onStatus(
     labels: [],
   }
 
-  eventsub.subscribe(
+  eventsub.on(
     [
       "channel.update",
       "stream.online",

package/src/ui/authentication.ts

@@ -2,7 +2,7 @@ import {
   clearCachedAuthentication,
   getAuthentication,
   popupAuthentication,
-} from "../authentication/index.js"
+} from "../authentication/index.ts"
 
 declare global {
   interface Window {

package/src/ui/popup.ts

@@ -3,11 +3,27 @@ import querystring from "@overlaysymphony/core/libs/querystring"
 import {
   type BareAuthentication,
   validateAuthentication,
-} from "../authentication/index.js"
+} from "../authentication/index.ts"
+
+const status = document.getElementById("status")
+const statuses = {
+  error: "Something went wrong.",
+  initializing: "Initializing Twitch authentication.",
+  validating: "Validating Twitch authenticate.",
+  ready: "Twitch authentication validated. You may close this window.",
+}
+function updateStatus(key: keyof typeof statuses, message?: string) {
+  if (!status) return
+
+  status.innerText = statuses[key] + (message ? ` ${message}` : "")
+}
 
 const state = getState()
 
 if (state.step === "initial") {
+  updateStatus("initializing")
+  setTimeout(() => updateStatus("error"), 500)
+
   initiateAuthentication(
     state.clientId,
     `${window.location.origin}${window.location.pathname}`,
@@ -16,14 +32,21 @@ if (state.step === "initial") {
 }
 
 if (state.step === "token") {
+  updateStatus("validating")
+
   const authentication = await authenticateResult(state.clientId, state)
   const opener = window.opener as Window | undefined
   opener?.postMessage({ type: "authentication", authentication }, "*")
+
+  updateStatus("ready")
   window.close()
 }
 
 if (state.step === "error") {
-  alert(`${state.error}. ${state.description ?? ""}`)
+  updateStatus(
+    "error",
+    `${state.error}${state.description ? `: ${state.description}` : "."}`,
+  )
 }
 
 function getState():
@@ -62,7 +85,7 @@ function getState():
           !scope ? "Missing scope." : "",
           !clientId ? "Missing state." : "",
         ]
-          .filter(Boolean)
+          .filter((value) => !!value)
           .join(" "),
       }
     }