multichat-ts 0.0.1

package/dist/twitch.js

@@ -0,0 +1,403 @@
+import { WebSocket } from 'partysocket';
+import {} from './index';
+const ANONYMOUS_IRC_PASS = 'SCHMOOPIIE';
+const ANONYMOUS_IRC_LOGIN = 'justinfan1234';
+const PING_INTERVAL_MS = 30_000;
+const PING_TIMEOUT_MS = 10_000;
+export class TwitchIRC {
+    channel_name;
+    assets = {
+        external_emotes: {},
+        badges: {},
+    };
+    latency = 0;
+    ping = {};
+    public_listeners = {};
+    socket;
+    connect(channel) {
+        if (channel?.channelName)
+            this.channel_name = channel.channelName;
+        if (!this.channel_name)
+            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.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();
+    }
+    on(event_name, callback_fn) {
+        this.public_listeners[event_name] = callback_fn;
+    }
+    isConnected() {
+        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})`);
+        if (this.ping.interval)
+            clearInterval(this.ping.interval);
+        this.sendPing();
+        this.ping.interval = setInterval(() => this.sendPing(), PING_INTERVAL_MS);
+    }
+    onClose() {
+        clearInterval(this.ping.interval);
+        clearTimeout(this.ping.timeout);
+    }
+    sendPing() {
+        this.send('PING');
+        this.ping.lastSentTimestamp = Date.now();
+        if (this.ping.timeout)
+            clearTimeout(this.ping.timeout);
+        this.ping.timeout = setTimeout(() => {
+            console.error('PING Timeout, reconnecting...');
+            this.connect();
+        }, PING_TIMEOUT_MS);
+    }
+    send(irc_message) {
+        if (!this.isConnected()) {
+            throw new Error('Not connected');
+        }
+        this.socket?.send(irc_message);
+    }
+    onMessage(event) {
+        if (!event.data)
+            return;
+        const lines = String(event.data).trim().split('\r\n');
+        const messages = lines.map(parseIRCLine);
+        messages.forEach((message) => {
+            switch (message.command) {
+                case 'PONG': {
+                    if (!this.ping.lastSentTimestamp)
+                        return console.error('got PONG without sending PING');
+                    clearInterval(this.ping.timeout);
+                    this.latency = Date.now() - this.ping.lastSentTimestamp;
+                    this.ping.lastSentTimestamp = undefined;
+                    break;
+                }
+                case 'PING': {
+                    this.send('PONG');
+                    break;
+                }
+                case 'CLEARCHAT': {
+                    const { channel, tags } = message;
+                    if (!tags)
+                        return;
+                    this.public_listeners.clear_messages?.({
+                        channel: {
+                            name: channel,
+                            room_id: tags['room-id'] ?? 'unknown',
+                        },
+                        timestamp_sent: Number(tags['tmi-sent-ts']),
+                        timeout_duration_seconds: tags['ban-duration']
+                            ? Number(tags['ban-duration'])
+                            : undefined,
+                    });
+                    break;
+                }
+                case 'PRIVMSG': {
+                    const { channel, params, tags } = message;
+                    if (!tags || !tags['user-id'] || !tags['id'] || !tags['room-id'])
+                        return;
+                    const text = params[0];
+                    if (!text)
+                        return;
+                    const body = [];
+                    tags.emotes?.split('/').forEach((raw_emote_string) => {
+                        const [emote_id, raw_emote_positions_string] = raw_emote_string.split(':');
+                        if (!emote_id || !raw_emote_positions_string)
+                            return;
+                        const raw_emote_positions = raw_emote_positions_string.split(',');
+                        raw_emote_positions.forEach((raw_emote_position) => {
+                            const [emote_start, emote_end] = raw_emote_position.split('-');
+                            if (!emote_start || !emote_end)
+                                return;
+                            body.push({
+                                type: 'emote',
+                                start_inclusive: +emote_start,
+                                end_exclusive: +emote_end + 1,
+                                url: `https://static-cdn.jtvnw.net/emoticons/v2/${emote_id}/default/dark/1.0`,
+                            });
+                        });
+                    });
+                    body.sort((a, b) => a.start_inclusive - b.start_inclusive);
+                    const old_body_length = body.length;
+                    if (old_body_length > 0) {
+                        body.forEach((segment, index) => {
+                            const previous_segment = body[index - 1];
+                            const text_start_inclusive = previous_segment?.end_exclusive !== undefined
+                                ? previous_segment.end_exclusive + 1
+                                : 0;
+                            const text_end_exclusive = Math.max(0, segment.start_inclusive);
+                            if (text_end_exclusive - text_start_inclusive > 0) {
+                                body.push({
+                                    type: 'text',
+                                    text: text.slice(text_start_inclusive, text_end_exclusive),
+                                    start_inclusive: text_start_inclusive,
+                                    end_exclusive: text_end_exclusive,
+                                });
+                            }
+                            if (index === old_body_length - 1 && segment.end_exclusive < text.length - 1) {
+                                body.push({
+                                    type: 'text',
+                                    text: text.slice(segment.end_exclusive),
+                                    start_inclusive: segment.end_exclusive,
+                                    end_exclusive: text.length,
+                                });
+                            }
+                        });
+                    }
+                    else {
+                        body.push({
+                            type: 'text',
+                            text,
+                            start_inclusive: 0,
+                            end_exclusive: text.length,
+                        });
+                    }
+                    body.sort((a, b) => a.start_inclusive - b.start_inclusive);
+                    const badge_info = {};
+                    tags['badge-info']?.split(',').forEach((badge) => {
+                        const [set_id, info] = badge.split('/');
+                        if (!set_id || !info)
+                            return;
+                        badge_info[set_id] = info;
+                    });
+                    this.public_listeners.message?.({
+                        body: body,
+                        channel: {
+                            room_id: tags['room-id'],
+                            name: channel,
+                        },
+                        id: tags.id,
+                        raw_text: text,
+                        timestamp_sent: Number(tags['tmi-sent-ts']),
+                        user: {
+                            badges: tags.badges?.split(',').flatMap((badge) => {
+                                const [set_id, version] = badge.split('/');
+                                if (!set_id || !version)
+                                    return [];
+                                const url = this.assets.badges[set_id]?.[version];
+                                if (!url)
+                                    return [];
+                                return {
+                                    info: badge_info[set_id],
+                                    set_id,
+                                    url,
+                                };
+                            }) ?? [],
+                            color: tags.color ?? '#FFFFFF',
+                            id: tags['user-id'],
+                            username: 'IDK',
+                            display_name: tags['display-name'] ?? 'Unknown',
+                            roles: {},
+                        },
+                    });
+                    break;
+                }
+            }
+        });
+    }
+}
+function parseIRCLine(line) {
+    const components = line.split(' ');
+    let componentIndex = 0;
+    let raw_tags_component;
+    let source;
+    if (components[componentIndex].startsWith('@')) {
+        raw_tags_component = components[componentIndex].slice(1);
+        componentIndex++;
+    }
+    if (components[componentIndex].startsWith(':')) {
+        source = parseSource(components[componentIndex].slice(1));
+        componentIndex++;
+    }
+    const command = components[componentIndex];
+    componentIndex++;
+    let channel = '';
+    if (components[componentIndex].startsWith('#'))
+        channel = components[componentIndex].slice(1);
+    componentIndex++;
+    const params = [];
+    while (components[componentIndex] !== undefined) {
+        const param = components[componentIndex];
+        if (param.startsWith(':')) {
+            params.push(components.slice(componentIndex).join(' ').slice(1));
+            componentIndex = -1;
+        }
+        else {
+            params.push(param);
+            componentIndex++;
+        }
+    }
+    const tags = raw_tags_component ? parseTags(raw_tags_component, command) : undefined;
+    return {
+        channel,
+        command,
+        params,
+        source,
+        tags,
+    };
+}
+function parseTags(component, command) {
+    const tags = {};
+    component.split(';').forEach((raw_tag) => {
+        const [key, value] = raw_tag.split('=');
+        if (RAW_TAGS[command].findIndex((el) => el === key) === -1)
+            console.warn(`[${command}] Unknown Tag: ${raw_tag}`);
+        tags[key] = value;
+    });
+    return tags;
+}
+function parseSource(component) {
+    let user = undefined;
+    let host = component;
+    let nick = undefined;
+    if (component.includes('!'))
+        [nick, host] = component.split('!');
+    if (host?.includes('@'))
+        [user, host] = host.split('@');
+    return {
+        host: host ?? 'unknown',
+        nick,
+        user,
+    };
+}
+const RAW_TAGS = {
+    CLEARCHAT: ['ban-duration', 'room-id', 'target-user-id', 'tmi-sent-ts'],
+    CLEARMSG: ['login', 'room-id', 'target-msg-id', 'tmi-sent-ts'],
+    GLOBALUSERSTATE: [
+        'badge-info',
+        'badges',
+        'color',
+        'display-name',
+        'emote-sets',
+        'turbo',
+        'user-id',
+        'user-type',
+    ],
+    HOSTTARGET: [],
+    NOTICE: ['msg-id', 'target-user-id'],
+    PART: [],
+    PING: [],
+    PONG: [],
+    PRIVMSG: [
+        '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',
+        ],
+    ],
+    RECONNECT: [],
+    ROOMSTATE: ['emote-only', 'followers-only', 'r9k', 'room-id', 'slow', 'subs-only'],
+    USERNOTICE: [
+        'badge-info',
+        'badges',
+        'color',
+        'display-name',
+        'emotes',
+        'id',
+        'login',
+        'mod',
+        'msg-id',
+        'room-id',
+        'subscriber',
+        'system-msg',
+        'tmi-sent-ts',
+        'turbo',
+        'user-id',
+        'user-type',
+        'vip',
+        'flags',
+        ...[
+            'msg-param-cumulative-months',
+            'msg-param-displayName',
+            'msg-param-login',
+            'msg-param-multimonth-duration',
+            'msg-param-multimonth-tenure',
+            'msg-param-was-gifted=false',
+            'msg-param-months',
+            'msg-param-promo-gift-total',
+            'msg-param-promo-name',
+            'msg-param-recipient-display-name',
+            'msg-param-recipient-id',
+            'msg-param-recipient-user-name',
+            'msg-param-sender-login',
+            'msg-param-sender-name',
+            'msg-param-should-share-streak',
+            'msg-param-streak-months',
+            'msg-param-sub-plan',
+            'msg-param-sub-plan-name',
+            'msg-param-viewerCount',
+            'msg-param-ritual-name',
+            'msg-param-threshold',
+            'msg-param-gift-months',
+            'msg-param-was-gifted',
+            'msg-param-community-gift-id',
+            'msg-param-mass-gift-count',
+            'msg-param-origin-id',
+        ],
+    ],
+    USERSTATE: [
+        'badge-info',
+        'badges',
+        'color',
+        'display-name',
+        'emote-sets',
+        'id',
+        'mod',
+        'subscriber',
+        'turbo',
+        'user-type',
+    ],
+    WHISPER: [
+        'badges',
+        'color',
+        'display-name',
+        'emotes',
+        'message-id',
+        'thread-id',
+        'turbo',
+        'user-id',
+        'user-type',
+    ],
+};

package/eslint.config.mjs

@@ -0,0 +1,12 @@
+import js from '@eslint/js'
+import prettier from 'eslint-config-prettier'
+import ts from 'typescript-eslint'
+
+export default [
+	js.configs.recommended,
+	...ts.configs.recommended,
+	prettier,
+	{
+		ignores: ['dist/'],
+	}
+]

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "multichat-ts",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "Receive real-time events for chat-related messages and events on multiple platforms (Twitch, Kick)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0Abdullah/multichat-ts.git"
+  },
+  "homepage": "https://github.com/0Abdullah/multichat-ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "keywords": [
+    "chat",
+    "multichat",
+    "twitch",
+    "kick",
+    "realtime",
+    "irc",
+    "pusher",
+    "typescript",
+    "ts"
+  ],
+  "author": {
+    "name": "Abdullah",
+    "url": "https://github.com/0Abdullah"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^9.10.0",
+    "@types/node": "^22.5.4",
+    "eslint": "^9.10.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.4.0"
+  },
+  "dependencies": {
+    "partysocket": "^1.0.2",
+    "pusher-js": "8.4.0-rc2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --check src",
+    "format:fix": "prettier --write src"
+  }
+}

package/src/index.ts

@@ -0,0 +1,166 @@
+export * from './kick';
+export * from './twitch';
+
+export type Message = {
+	body: BodyComponent[];
+	channel: {
+		room_id: string;
+		name: string;
+	};
+	id: string;
+	raw_text: string;
+	timestamp_sent: number;
+	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 BadgeURLsBySetIDAndVersionID = {
+	[badge_set_id: string]: {
+		[badge_version_id: string]: string;
+	};
+};
+
+export type EmoteURLsByName = {
+	[emote_name: string]: string;
+};