multichat-ts 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,77 @@
+# 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, KickPusher } from 'multichat-ts';
+
+	let messages: Message[] = $state([]);
+
+	const twitch_chat = new TwitchIRC();
+
+	twitch_chat.connect({
+		channelName: 'piratesoftware'
+	});
+
+	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: {

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 BadgeURLsBySetIDAndVersionID } from './index.js';
 type EventCallbackFunctions = {
     message: (data: Message) => unknown;
     clear_messages: (data: ClearMessages) => unknown;

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;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "multichat-ts",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "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[];

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

@@ -8,7 +8,7 @@ import {
 	type Event,
 	type EmoteURLsByName,
 	type BadgeURLsBySetIDAndVersionID,
-} from './index';
+} from './index.js';
 
 const ANONYMOUS_IRC_PASS = 'SCHMOOPIIE';
 const ANONYMOUS_IRC_LOGIN = 'justinfan1234';

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"]
 }