multichat-ts 0.0.2 → 0.0.3

package/README.md

@@ -40,14 +40,17 @@ kick_chat.on('message', (message) => {
 
 ```svelte
 <script lang="ts">
-	import { TwitchIRC, type Message, KickPusher } from 'multichat-ts';
+	import { TwitchIRC, type Message } from 'multichat-ts';
 
 	let messages: Message[] = $state([]);
 
 	const twitch_chat = new TwitchIRC();
+	$effect(() => {
+		twitch_chat.connect({
+			channelName: 'piratesoftware'
+		});
 
-	twitch_chat.connect({
-		channelName: 'piratesoftware'
+		return () => twitch_chat.disconnect();
 	});
 
 	twitch_chat.on('message', (message) => {

package/dist/index.d.ts

@@ -134,10 +134,9 @@ export type BadgeURLsByNameOrCount = {
         [badge_count: number]: string;
     };
 };
-export type BadgeURLsBySetIDAndVersionID = {
-    [badge_set_id: string]: {
-        [badge_version_id: string]: string;
-    };
+type StringOrAny = '*' | (string & Record<never, never>);
+export type BadgeURLsBySetIDAndVersionIDOrAny = {
+    [badge_set_id: string]: Record<StringOrAny, string>;
 };
 export type EmoteURLsByName = {
     [emote_name: string]: string;

package/dist/twitch.d.ts

@@ -1,5 +1,5 @@
 import { WebSocket } from 'partysocket';
-import { type ClearMessages, type DeleteMessage, type Message, type Event, type EmoteURLsByName, type BadgeURLsBySetIDAndVersionID } from './index.js';
+import { type ClearMessages, type DeleteMessage, type Message, type Event, type EmoteURLsByName, type BadgeURLsBySetIDAndVersionIDOrAny } from './index.js';
 type EventCallbackFunctions = {
     message: (data: Message) => unknown;
     clear_messages: (data: ClearMessages) => unknown;
@@ -11,12 +11,14 @@ export declare class TwitchIRC {
     channel_name?: string;
     assets: {
         external_emotes: EmoteURLsByName;
-        badges: BadgeURLsBySetIDAndVersionID;
+        badges: BadgeURLsBySetIDAndVersionIDOrAny;
     };
     latency: number;
     private ping;
     private public_listeners;
     socket?: WebSocket;
+    ws?: WebSocket | undefined;
+    constructor(ws?: WebSocket);
     connect(channel?: {
         channelName?: string;
     }): void;

package/dist/twitch.js

@@ -13,6 +13,10 @@ export class TwitchIRC {
     ping = {};
     public_listeners = {};
     socket;
+    ws;
+    constructor(ws) {
+        this.ws = ws;
+    }
     connect(channel) {
         if (channel?.channelName)
             this.channel_name = channel.channelName;
@@ -20,11 +24,12 @@ export class TwitchIRC {
             return console.error('channel_name not specified');
         console.log(`connecting to ${this.channel_name}...`);
         this.socket?.close();
-        this.socket = new WebSocket('wss://irc-ws.chat.twitch.tv');
+        this.socket = new WebSocket('wss://irc-ws.chat.twitch.tv', null, {
+            WebSocket: this.ws,
+        });
         this.socket.onopen = () => this.onOpen();
         this.socket.onclose = () => this.onClose();
         this.socket.onmessage = (event) => this.onMessage(event);
-        console.log(parseIRCLine(`@badge-info=;badges=turbo/1;color=#9ACD32;display-name=TestChannel;emotes=;id=3d830f12-795c-447d-af3c-ea05e40fbddb;login=testchannel;mod=0;msg-id=raid;msg-param-displayName=TestChannel;msg-param-login=testchannel;msg-param-viewerCount=15;room-id=33332222;subscriber=0;system-msg=15\sraiders\sfrom\sTestChannel\shave\sjoined\n!;tmi-sent-ts=1507246572675;turbo=1;user-id=123456;user-type= :tmi.twitch.tv USERNOTICE #othertestchannel`));
     }
     disconnect() {
         this.socket?.close();
@@ -183,7 +188,7 @@ export class TwitchIRC {
                                 const [set_id, version] = badge.split('/');
                                 if (!set_id || !version)
                                     return [];
-                                const url = this.assets.badges[set_id]?.[version];
+                                const url = this.assets.badges[set_id]?.[version] ?? this.assets.badges[set_id]?.['*'];
                                 if (!url)
                                     return [];
                                 return {
@@ -194,7 +199,7 @@ export class TwitchIRC {
                             }) ?? [],
                             color: tags.color ?? '#FFFFFF',
                             id: tags['user-id'],
-                            username: 'IDK',
+                            username: (tags['display-name'] ?? 'Unknown').toLowerCase(),
                             display_name: tags['display-name'] ?? 'Unknown',
                             roles: {},
                         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multichat-ts",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "description": "Receive type-safe realtime events for chat-related messages on multiple platforms (Twitch, Kick)",
   "repository": {

package/src/index.ts

@@ -155,10 +155,10 @@ export type BadgeURLsByNameOrCount = {
 		  };
 };
 
-export type BadgeURLsBySetIDAndVersionID = {
-	[badge_set_id: string]: {
-		[badge_version_id: string]: string;
-	};
+type StringOrAny = '*' | (string & Record<never, never>);
+
+export type BadgeURLsBySetIDAndVersionIDOrAny = {
+	[badge_set_id: string]: Record<StringOrAny, string>;
 };
 
 export type EmoteURLsByName = {

package/src/twitch.ts

@@ -7,7 +7,7 @@ import {
 	type Message,
 	type Event,
 	type EmoteURLsByName,
-	type BadgeURLsBySetIDAndVersionID,
+	type BadgeURLsBySetIDAndVersionIDOrAny,
 } from './index.js';
 
 const ANONYMOUS_IRC_PASS = 'SCHMOOPIIE';
@@ -28,7 +28,7 @@ export class TwitchIRC {
 	public channel_name?: string;
 	public assets: {
 		external_emotes: EmoteURLsByName;
-		badges: BadgeURLsBySetIDAndVersionID;
+		badges: BadgeURLsBySetIDAndVersionIDOrAny;
 	} = {
 		external_emotes: {},
 		badges: {},
@@ -44,6 +44,11 @@ export class TwitchIRC {
 	private public_listeners: Partial<EventCallbackFunctions> = {};
 
 	public socket?: WebSocket;
+	public ws?: WebSocket | undefined;
+
+	constructor(ws?: WebSocket) {
+		this.ws = ws;
+	}
 
 	public connect(channel?: { channelName?: string }) {
 		if (channel?.channelName) this.channel_name = channel.channelName;
@@ -53,17 +58,12 @@ export class TwitchIRC {
 
 		this.socket?.close();
 
-		this.socket = new WebSocket('wss://irc-ws.chat.twitch.tv');
+		this.socket = new WebSocket('wss://irc-ws.chat.twitch.tv', null, {
+			WebSocket: this.ws,
+		});
 		this.socket.onopen = () => this.onOpen();
 		this.socket.onclose = () => this.onClose();
 		this.socket.onmessage = (event) => this.onMessage(event);
-
-		console.log(
-			parseIRCLine(
-				// eslint-disable-next-line no-useless-escape
-				`@badge-info=;badges=turbo/1;color=#9ACD32;display-name=TestChannel;emotes=;id=3d830f12-795c-447d-af3c-ea05e40fbddb;login=testchannel;mod=0;msg-id=raid;msg-param-displayName=TestChannel;msg-param-login=testchannel;msg-param-viewerCount=15;room-id=33332222;subscriber=0;system-msg=15\sraiders\sfrom\sTestChannel\shave\sjoined\n!;tmi-sent-ts=1507246572675;turbo=1;user-id=123456;user-type= :tmi.twitch.tv USERNOTICE #othertestchannel`,
-			),
-		);
 	}
 
 	public disconnect() {
@@ -244,7 +244,8 @@ export class TwitchIRC {
 									const [set_id, version] = badge.split('/');
 									if (!set_id || !version) return [];
 
-									const url = this.assets.badges[set_id]?.[version];
+									const url =
+										this.assets.badges[set_id]?.[version] ?? this.assets.badges[set_id]?.['*'];
 									if (!url) return [];
 
 									return {
@@ -255,7 +256,7 @@ export class TwitchIRC {
 								}) ?? [],
 							color: tags.color ?? '#FFFFFF',
 							id: tags['user-id'],
-							username: 'IDK',
+							username: (tags['display-name'] ?? 'Unknown').toLowerCase(),
 							display_name: tags['display-name'] ?? 'Unknown',
 							roles: {},
 						},