feat(sources): include source channel in events

Signed-off-by: Jordan Shatford <[email protected]>

.changeset/quiet-ears-brake.md

@@ -0,0 +1,5 @@
+---
+"@cq/sources": minor
+---
+
+feat: include source channel in events

packages/sources/src/twitch.ts

@@ -15,8 +15,12 @@ export class TwitchChatSource extends BaseClipSource {
     if (callback) {
       this.ctx = callback
     }
+    const ctx = await this.ctx()
+    if (ctx.username) {
+      this.channel = ctx.username
+    }
     try {
-      this.chat = new TwitchChat(await this.ctx())
+      this.chat = new TwitchChat(ctx)
     } catch (e) {
       this.handleError(e)
       return

packages/sources/src/types.ts

@@ -15,6 +15,7 @@ export enum ClipSourceStatus {
 export interface ClipSourceEvent<T = undefined> {
   timestamp: string
   source: ClipSource
+  channel: string
   data: T
 }
 
@@ -63,6 +64,8 @@ export abstract class BaseClipSource
 
   public status = ClipSourceStatus.UNKNOWN
 
+  protected channel = 'unknown'
+
   public abstract connect(callback?: ClipSourceCtxCallback): Promise<void>
   public abstract disconnect(): Promise<void>
 
@@ -75,6 +78,7 @@ export abstract class BaseClipSource
     this.emit('status', {
       timestamp: timestamp ?? this.timestamp(),
       source: this.name,
+      channel: this.channel,
       data: status
     })
   }
@@ -84,14 +88,15 @@ export abstract class BaseClipSource
     this.emit('error', {
       timestamp,
       source: this.name,
+      channel: this.channel,
       data: error
     })
     this.handleStatusUpdate(ClipSourceStatus.ERROR, timestamp)
   }
 
   protected handleConnected() {
     const timestamp = this.timestamp()
-    this.emit('connected', { timestamp, source: this.name, data: undefined })
+    this.emit('connected', { timestamp, source: this.name, channel: this.channel, data: undefined })
     this.handleStatusUpdate(ClipSourceStatus.CONNECTED, timestamp)
   }
 
@@ -100,6 +105,7 @@ export abstract class BaseClipSource
     this.emit('disconnected', {
       timestamp,
       source: this.name,
+      channel: this.channel,
       data: reason
     })
     this.handleStatusUpdate(ClipSourceStatus.DISCONNECTED, timestamp)
@@ -110,6 +116,7 @@ export abstract class BaseClipSource
     this.emit('message', {
       timestamp,
       source: this.name,
+      channel: this.channel,
       data: {
         ...message,
         urls: getAllURLsFromText(message.text)
@@ -123,6 +130,7 @@ export abstract class BaseClipSource
     this.emit('message-deleted', {
       timestamp,
       source: this.name,
+      channel: this.channel,
       data: {
         ...message,
         urls: getAllURLsFromText(message.text)
@@ -136,6 +144,7 @@ export abstract class BaseClipSource
     this.emit('user-timeout', {
       timestamp,
       source: this.name,
+      channel: this.channel,
       data: username
     })
     this.handleStatusUpdate(ClipSourceStatus.CONNECTED, timestamp)