multichat-ts 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,80 @@
+# multichat-ts
+
+Receive type-safe realtime events for chat-related messages on multiple platforms (Twitch, Kick)
+
+## Usage
+
+```sh
+pnpm install multichat-ts # or (npm, bun, deno, etc) install
+```
+
+```ts
+import { TwitchIRC, KickPusher } from 'multichat-ts';
+
+const twitch_chat = new TwitchIRC();
+const kick_chat = new KickPusher();
+
+twitch_chat.connect({
+	channelName: 'piratesoftware',
+});
+
+kick_chat.connect({
+	channelName: 'xqc',
+});
+
+// set custom badge assets or external emotes (ffz, bttv, 7tv, etc)
+twitch_chat.assets.external_emotes = {
+	OMEGALUL: 'https://cdn.frankerfacez.com/emoticon/128054/1',
+};
+
+twitch_chat.on('message', (message) => {
+	console.log('new twitch message', message.raw_text, message);
+});
+
+kick_chat.on('message', (message) => {
+	console.log('new twitch message', message.raw_text, message);
+});
+```
+
+### Example usage with Svelte 5
+
+```svelte
+<script lang="ts">
+	import { TwitchIRC, type Message } from 'multichat-ts';
+
+	let messages: Message[] = $state([]);
+
+	const twitch_chat = new TwitchIRC();
+	$effect(() => {
+		twitch_chat.connect({
+			channelName: 'piratesoftware'
+		});
+
+		return () => twitch_chat.disconnect();
+	});
+
+	twitch_chat.on('message', (message) => {
+		messages.push(message);
+	});
+
+	twitch_chat.on('clear_messages', (data) => {
+		if (data.user !== undefined) {
+			messages.filter((message) => message.user.id !== data.user!.id);
+		} else {
+			messages.filter((message) => message.channel.room_id !== data.channel.room_id);
+		}
+	});
+
+	twitch_chat.on('delete_message', (message_data) => {
+		messages.filter((message) => message.id !== message_data.id);
+	});
+</script>
+
+<ul>
+	{#each messages as message}
+		<li>{message.user.display_name}: {message.raw_text}</li>
+	{/each}
+</ul>
+```
+
+MIT

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export * from './kick';
-export * from './twitch';
+export * from './kick.js';
+export * from './twitch.js';
 export type Message = {
     body: BodyComponent[];
     channel: {
@@ -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/index.js

@@ -1,2 +1,2 @@
-export * from './kick';
-export * from './twitch';
+export * from './kick.js';
+export * from './twitch.js';

package/dist/kick.d.ts

@@ -1,5 +1,5 @@
 import Pusher from 'pusher-js';
-import { type BadgeURLsByNameOrCount, type EmoteURLsByName, type Message } from './index';
+import { type BadgeURLsByNameOrCount, type EmoteURLsByName, type Message } from './index.js';
 type EventCallbackFunctions = {
     message: (data: Message) => unknown;
 };

package/dist/kick.js

@@ -1,5 +1,4 @@
 import Pusher from 'pusher-js';
-import {} from './index';
 const DEFAULT_KICK_PUSHER_KEY = '32cbd69e4b950bf97679';
 export class KickPusher {
     kick_pusher_key = DEFAULT_KICK_PUSHER_KEY;

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';
+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

@@ -1,5 +1,4 @@
 import { WebSocket } from 'partysocket';
-import {} from './index';
 const ANONYMOUS_IRC_PASS = 'SCHMOOPIIE';
 const ANONYMOUS_IRC_LOGIN = 'justinfan1234';
 const PING_INTERVAL_MS = 30_000;
@@ -14,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;
@@ -21,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();
@@ -184,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 {
@@ -195,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,8 +1,8 @@
 {
   "name": "multichat-ts",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
-  "description": "Receive real-time events for chat-related messages and events on multiple platforms (Twitch, Kick)",
+  "description": "Receive type-safe realtime events for chat-related messages on multiple platforms (Twitch, Kick)",
   "repository": {
     "type": "git",
     "url": "https://github.com/0Abdullah/multichat-ts.git"

package/src/index.ts

@@ -1,5 +1,5 @@
-export * from './kick';
-export * from './twitch';
+export * from './kick.js';
+export * from './twitch.js';
 
 export type Message = {
 	body: BodyComponent[];
@@ -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/kick.ts

@@ -5,7 +5,7 @@ import {
 	type BodyComponent,
 	type EmoteURLsByName,
 	type Message,
-} from './index';
+} from './index.js';
 
 type EventCallbackFunctions = {
 	message: (data: Message) => unknown;

package/src/twitch.ts

@@ -7,8 +7,8 @@ import {
 	type Message,
 	type Event,
 	type EmoteURLsByName,
-	type BadgeURLsBySetIDAndVersionID,
-} from './index';
+	type BadgeURLsBySetIDAndVersionIDOrAny,
+} from './index.js';
 
 const ANONYMOUS_IRC_PASS = 'SCHMOOPIIE';
 const ANONYMOUS_IRC_LOGIN = 'justinfan1234';
@@ -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: {},
 						},

package/tsconfig.json

@@ -1,45 +1,45 @@
 {
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig to read more about this file */
 
-    /* Language and Environment */
-    "target": "ESNext",
+		/* Language and Environment */
+		"target": "ESNext",
 
-    /* Modules */
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
+		/* Modules */
+		"module": "ESNext",
+		"moduleResolution": "Bundler",
 
-    /* JavaScript Support */
-    "checkJs": true,
+		/* JavaScript Support */
+		"checkJs": true,
 
-    /* Emit */
-    "declaration": true,
-    "outDir": "dist",
-    "removeComments": true,
+		/* Emit */
+		"declaration": true,
+		"outDir": "dist",
+		"removeComments": true,
 
-    /* Interop Constraints */
-    "isolatedModules": true,
-    "verbatimModuleSyntax": true,
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
+		/* Interop Constraints */
+		"isolatedModules": true,
+		"verbatimModuleSyntax": false,
+		"allowSyntheticDefaultImports": true,
+		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
 
-    /* Type Checking */
-    "strict": true,
-    "strictNullChecks": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "exactOptionalPropertyTypes": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "allowUnusedLabels": false,
-    "allowUnreachableCode": false,
+		/* Type Checking */
+		"strict": true,
+		"strictNullChecks": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"exactOptionalPropertyTypes": true,
+		"noImplicitReturns": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUncheckedIndexedAccess": true,
+		"noImplicitOverride": true,
+		"noPropertyAccessFromIndexSignature": true,
+		"allowUnusedLabels": false,
+		"allowUnreachableCode": false,
 
-    /* Completeness */
-    "skipLibCheck": true
-  },
-  "include": ["src"]
+		/* Completeness */
+		"skipLibCheck": true
+	},
+	"include": ["src"]
 }