multichat-ts 0.0.93 → 0.0.95

package/.prettierrc

@@ -1,7 +1,7 @@
-{
-	"useTabs": true,
-	"singleQuote": true,
-	"semi": true,
-	"trailingComma": "all",
-	"printWidth": 100
-}
+{
+	"useTabs": true,
+	"singleQuote": true,
+	"semi": true,
+	"trailingComma": "all",
+	"printWidth": 100
+}

package/dist/kick.js

@@ -121,7 +121,7 @@ export class KickPusher {
     onChatMessage(data) {
         this.public_listeners.raw_message?.(data);
         const text = data.content;
-        const emote_matches = [...data.content.matchAll(/\[emote:\d+:[a-zA-Z0-9]*\]/g)];
+        const emote_matches = [...data.content.matchAll(/\[emote:\d+:.+\]/g)];
         const body = [];
         emote_matches.forEach((match) => {
             const emote_string = match[0];

package/dist/twitch.d.ts

@@ -6,24 +6,40 @@ type EventCallbackFunctions = {
     delete_message: (data: DeleteMessage) => unknown;
     event: (event: Event) => unknown;
     raw_message: (message: IRC_Message) => unknown;
+    connected: () => unknown;
+    auth_error: () => unknown;
 };
 type EventNames = keyof EventCallbackFunctions;
 export declare class TwitchIRC {
     channel_name?: string;
+    auth?: {
+        username: string;
+        token: string;
+    } | undefined;
+    bot_name?: string;
+    bot_token?: string;
     private assets;
     latency: number;
     private ping;
     private public_listeners;
     socket?: WebSocket;
-    ws?: WebSocket | undefined;
-    constructor(ws?: WebSocket);
+    wsCustom?: WebSocket | undefined;
+    constructor(options: {
+        ws?: WebSocket;
+        auth?: {
+            username: string;
+            token: string;
+        };
+    });
     setBadges(badges: BadgeURLsBySetIDOrSetIDAndVersion): void;
     setExternalEmotes(external_emotes: EmoteURLsByName): void;
     getStoredBadges(): BadgeURLsBySetIDOrSetIDAndVersion;
     getStoredExternalEmotes(): EmoteURLsByName;
+    authenticate(username: string, token: string): void;
     connect(channel?: {
         channelName?: string;
     }): void;
+    send(message: string, replyParentMessageId?: string): void;
     disconnect(): void;
     on<EventName extends EventNames>(event_name: EventName, callback_fn: EventCallbackFunctions[EventName]): void;
     isConnected(): this is {
@@ -34,7 +50,7 @@ export declare class TwitchIRC {
     private onOpen;
     private onClose;
     private sendPing;
-    private send;
+    private sendIRC;
     private onMessage;
 }
 type IRC_Message = {
@@ -63,6 +79,7 @@ declare const RAW_TAGS: {
     readonly PART: readonly [];
     readonly PING: readonly [];
     readonly PONG: readonly [];
+    readonly '001': readonly [];
     readonly PRIVMSG: readonly ["badge-info", "badges", "bits", "color", "display-name", "emotes", "emote-only", "id", "mod", "custom-reward-id", "reply-thread-parent-display-name", "reply-thread-parent-user-id", "pinned-chat-paid-amount", "pinned-chat-paid-currency", "pinned-chat-paid-exponent", "pinned-chat-paid-level", "pinned-chat-paid-is-system-message", "reply-parent-msg-id", "reply-parent-user-id", "reply-parent-user-login", "reply-parent-display-name", "reply-parent-msg-body", "reply-thread-parent-msg-id", "reply-thread-parent-user-login", "room-id", "subscriber", "tmi-sent-ts", "turbo", "user-id", "user-type", "vip", "client-nonce", "first-msg", "flags", "returning-chatter"];
     readonly RECONNECT: readonly [];
     readonly ROOMSTATE: readonly ["emote-only", "followers-only", "r9k", "room-id", "slow", "subs-only"];

package/dist/twitch.js

@@ -5,6 +5,9 @@ const PING_INTERVAL_MS = 30_000;
 const PING_TIMEOUT_MS = 10_000;
 export class TwitchIRC {
     channel_name;
+    auth;
+    bot_name;
+    bot_token;
     assets = {
         external_emotes: {},
         badges: {},
@@ -13,9 +16,10 @@ export class TwitchIRC {
     ping = {};
     public_listeners = {};
     socket;
-    ws;
-    constructor(ws) {
-        this.ws = ws;
+    wsCustom;
+    constructor(options) {
+        this.wsCustom = options.ws;
+        this.auth = options.auth;
     }
     setBadges(badges) {
         this.assets.badges = { ...badges, ...this.assets.badges };
@@ -29,6 +33,10 @@ export class TwitchIRC {
     getStoredExternalEmotes() {
         return this.assets.external_emotes;
     }
+    authenticate(username, token) {
+        this.bot_name = username;
+        this.bot_token = token;
+    }
     connect(channel) {
         if (channel?.channelName)
             this.channel_name = channel.channelName;
@@ -37,13 +45,21 @@ export class TwitchIRC {
         console.log(`connecting to ${this.channel_name}...`);
         this.socket?.close();
         this.socket = new WebSocket('wss://irc-ws.chat.twitch.tv', null, {
-            WebSocket: this.ws,
+            WebSocket: this.wsCustom,
         });
         this.socket.onopen = () => this.onOpen();
         this.socket.onclose = () => this.onClose();
         this.socket.onmessage = (event) => this.onMessage(event);
     }
+    send(message, replyParentMessageId) {
+        if (this.auth === undefined)
+            return console.error('No Auth Information');
+        if (!this.isConnected())
+            return console.error('Not Connected');
+        this.socket.send(`${replyParentMessageId ? `@reply-parent-msg-id=${replyParentMessageId} ` : ''}PRIVMSG #${this.channel_name} :${message}`);
+    }
     disconnect() {
+        this.socket?.send(`Part #${this.channel_name}`);
         this.socket?.close();
     }
     on(event_name, callback_fn) {
@@ -53,11 +69,18 @@ export class TwitchIRC {
         return !!this.socket && this.socket.readyState === WebSocket.OPEN;
     }
     onOpen() {
-        this.send('CAP REQ :twitch.tv/commands twitch.tv/tags');
-        this.send(`PASS ${ANONYMOUS_IRC_PASS}`);
-        this.send(`NICK ${ANONYMOUS_IRC_LOGIN}`);
-        this.send(`JOIN #${this.channel_name}`);
-        console.log(`Connected to Twitch IRC as Anonymous (${this.channel_name})`);
+        this.sendIRC('CAP REQ :twitch.tv/commands twitch.tv/tags');
+        if (this.auth !== undefined) {
+            this.sendIRC(`PASS oauth:${this.auth.token}`);
+            this.sendIRC(`NICK ${this.auth.username}`);
+            this.sendIRC(`JOIN #${this.channel_name}`);
+        }
+        else {
+            this.sendIRC(`PASS ${ANONYMOUS_IRC_PASS}`);
+            this.sendIRC(`NICK ${ANONYMOUS_IRC_LOGIN}`);
+            this.sendIRC(`JOIN #${this.channel_name}`);
+        }
+        this.public_listeners.connected?.();
         if (this.ping.interval)
             clearInterval(this.ping.interval);
         this.sendPing();
@@ -68,7 +91,7 @@ export class TwitchIRC {
         clearTimeout(this.ping.timeout);
     }
     sendPing() {
-        this.send('PING');
+        this.sendIRC('PING');
         this.ping.lastSentTimestamp = Date.now();
         if (this.ping.timeout)
             clearTimeout(this.ping.timeout);
@@ -77,10 +100,9 @@ export class TwitchIRC {
             this.connect();
         }, PING_TIMEOUT_MS);
     }
-    send(irc_message) {
-        if (!this.isConnected()) {
-            throw new Error('Not connected');
-        }
+    sendIRC(irc_message) {
+        if (!this.isConnected())
+            return console.error('Not Connected');
         this.socket?.send(irc_message);
     }
     onMessage(event) {
@@ -100,7 +122,21 @@ export class TwitchIRC {
                     break;
                 }
                 case 'PING': {
-                    this.send('PONG');
+                    this.sendIRC('PONG');
+                    break;
+                }
+                case '001': {
+                    console.log(`Connected to Twitch IRC as ${this.auth?.username ?? 'Anonymous'} (${this.channel_name})`);
+                    this.public_listeners.connected?.();
+                    break;
+                }
+                case 'NOTICE': {
+                    if (message.params[0] === 'Login authentication failed' ||
+                        message.params[0] === 'Improperly formatted auth') {
+                        clearTimeout(this.ping.timeout);
+                        this.disconnect();
+                        this.public_listeners.auth_error?.();
+                    }
                     break;
                 }
                 case 'CLEARCHAT': {
@@ -249,7 +285,7 @@ function parseIRCLine(line) {
     const command = components[componentIndex];
     componentIndex++;
     let channel = '';
-    if (components[componentIndex].startsWith('#'))
+    if (components[componentIndex]?.startsWith('#'))
         channel = components[componentIndex].slice(1);
     componentIndex++;
     const params = [];
@@ -317,6 +353,7 @@ const RAW_TAGS = {
     PART: [],
     PING: [],
     PONG: [],
+    '001': [],
     PRIVMSG: [
         'badge-info',
         'badges',

package/package.json

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

package/src/default/index.ts

@@ -1,173 +1,173 @@
-export * from './kick.js';
-export * from './twitch.js';
-
-export type Message = {
-	body: BodyComponent[];
-	channel: {
-		room_id: string;
-		name: string;
-	};
-	id: string;
-	raw_text: string;
-	timestamp_sent: number;
-	resubscription?: {
-		id: string;
-		months: number;
-		subscribed_since_timestamp: string;
-	};
-	user: {
-		badges: Badge[];
-		color: string;
-		id: string;
-		username: string;
-		display_name: string;
-		roles: {
-			[role in 'vip' | 'moderator' | 'turbo' | 'admin' | 'global_moderator' | 'staff']?: boolean;
-		};
-	};
-};
-
-export type ClearMessages = {
-	channel: {
-		room_id: string;
-		name: string;
-	};
-	user?: {
-		id: string;
-		username: string;
-	};
-	timeout_duration_seconds?: number | undefined;
-	timestamp_sent: number;
-};
-
-export type DeleteMessage = {
-	channel: {
-		room_id?: string;
-		name: string;
-	};
-	user?: {
-		username: string;
-	};
-	id: string;
-	raw_text: string;
-	timestamp_sent: number;
-};
-
-type EventData = {
-	subscription: {
-		months: number;
-		streak?: number;
-		subscription_plan: {
-			type: 'prime' | 1000 | 2000 | 3000;
-			name: string;
-		};
-		gift_upgrade?: {
-			gift_total: number;
-			promo_name: string;
-			sender: {
-				username: string;
-				display_name: string;
-			};
-		};
-	};
-	gift: {
-		months: number;
-		recipient: {
-			id: string;
-			username: string;
-			display_name: string;
-		};
-		subscription_plan: {
-			type: 'prime' | 1000 | 2000 | 3000;
-			name: string;
-		};
-	};
-	raid: {
-		sender: {
-			username: string;
-			display_name: string;
-			viewer_count: number;
-		};
-	};
-};
-
-export type Event = {
-	[E in keyof EventData]: {
-		type: E;
-		body: BodyComponent[];
-		channel: {
-			room_id: string;
-			name: string;
-		};
-		id: string;
-		raw_text: string;
-		system_message: string;
-		timestamp_sent: number;
-		user: {
-			badges: Badge[];
-			color: string;
-			id: string;
-			username: string;
-			display_name: string;
-			roles: {
-				[role in
-					| 'moderator'
-					| 'subscriber'
-					| 'turbo'
-					| 'admin'
-					| 'global_moderator'
-					| 'staff']?: boolean;
-			};
-		};
-		data: EventData[E];
-	};
-}[keyof EventData];
-
-export type BodyComponentEmote = {
-	end_exclusive: number;
-	start_inclusive: number;
-	type: 'emote';
-	url: string;
-};
-
-export type BodyComponent =
-	| {
-			end_exclusive: number;
-			label: string;
-			start_inclusive: number;
-			type: 'link';
-			url: string;
-	  }
-	| {
-			end_exclusive: number;
-			start_inclusive: number;
-			text: string;
-			type: 'text';
-	  }
-	| BodyComponentEmote;
-
-type Badge = {
-	info?: string | undefined;
-	set_id: string;
-	url: string;
-};
-
-export type BadgeURLsByNameOrCount = {
-	[badge_name: string]:
-		| string
-		| {
-				[badge_count: number]: string;
-		  };
-};
-
-export type BadgeURLsBySetIDOrSetIDAndVersion = {
-	[set_id: string]:
-		| {
-				[version: string]: string;
-		  }
-		| string;
-};
-
-export type EmoteURLsByName = {
-	[emote_name: string]: string;
-};
+export * from './kick.js';
+export * from './twitch.js';
+
+export type Message = {
+	body: BodyComponent[];
+	channel: {
+		room_id: string;
+		name: string;
+	};
+	id: string;
+	raw_text: string;
+	timestamp_sent: number;
+	resubscription?: {
+		id: string;
+		months: number;
+		subscribed_since_timestamp: string;
+	};
+	user: {
+		badges: Badge[];
+		color: string;
+		id: string;
+		username: string;
+		display_name: string;
+		roles: {
+			[role in 'vip' | 'moderator' | 'turbo' | 'admin' | 'global_moderator' | 'staff']?: boolean;
+		};
+	};
+};
+
+export type ClearMessages = {
+	channel: {
+		room_id: string;
+		name: string;
+	};
+	user?: {
+		id: string;
+		username: string;
+	};
+	timeout_duration_seconds?: number | undefined;
+	timestamp_sent: number;
+};
+
+export type DeleteMessage = {
+	channel: {
+		room_id?: string;
+		name: string;
+	};
+	user?: {
+		username: string;
+	};
+	id: string;
+	raw_text: string;
+	timestamp_sent: number;
+};
+
+type EventData = {
+	subscription: {
+		months: number;
+		streak?: number;
+		subscription_plan: {
+			type: 'prime' | 1000 | 2000 | 3000;
+			name: string;
+		};
+		gift_upgrade?: {
+			gift_total: number;
+			promo_name: string;
+			sender: {
+				username: string;
+				display_name: string;
+			};
+		};
+	};
+	gift: {
+		months: number;
+		recipient: {
+			id: string;
+			username: string;
+			display_name: string;
+		};
+		subscription_plan: {
+			type: 'prime' | 1000 | 2000 | 3000;
+			name: string;
+		};
+	};
+	raid: {
+		sender: {
+			username: string;
+			display_name: string;
+			viewer_count: number;
+		};
+	};
+};
+
+export type Event = {
+	[E in keyof EventData]: {
+		type: E;
+		body: BodyComponent[];
+		channel: {
+			room_id: string;
+			name: string;
+		};
+		id: string;
+		raw_text: string;
+		system_message: string;
+		timestamp_sent: number;
+		user: {
+			badges: Badge[];
+			color: string;
+			id: string;
+			username: string;
+			display_name: string;
+			roles: {
+				[role in
+					| 'moderator'
+					| 'subscriber'
+					| 'turbo'
+					| 'admin'
+					| 'global_moderator'
+					| 'staff']?: boolean;
+			};
+		};
+		data: EventData[E];
+	};
+}[keyof EventData];
+
+export type BodyComponentEmote = {
+	end_exclusive: number;
+	start_inclusive: number;
+	type: 'emote';
+	url: string;
+};
+
+export type BodyComponent =
+	| {
+			end_exclusive: number;
+			label: string;
+			start_inclusive: number;
+			type: 'link';
+			url: string;
+	  }
+	| {
+			end_exclusive: number;
+			start_inclusive: number;
+			text: string;
+			type: 'text';
+	  }
+	| BodyComponentEmote;
+
+type Badge = {
+	info?: string | undefined;
+	set_id: string;
+	url: string;
+};
+
+export type BadgeURLsByNameOrCount = {
+	[badge_name: string]:
+		| string
+		| {
+				[badge_count: number]: string;
+		  };
+};
+
+export type BadgeURLsBySetIDOrSetIDAndVersion = {
+	[set_id: string]:
+		| {
+				[version: string]: string;
+		  }
+		| string;
+};
+
+export type EmoteURLsByName = {
+	[emote_name: string]: string;
+};