refactor chatwidget code, add prefetching emotes

This commit is contained in:
2025-07-22 18:40:57 +01:00
parent fb6091c9c0
commit cc3176ea2f
15 changed files with 180 additions and 129 deletions

View File

@@ -0,0 +1,28 @@
import { EventSubChannelChatMessageEvent, EventSubChannelChatMessageDeleteEvent, EventSubChannelBanEvent } from "@twurple/eventsub-base";
import { sendTwitchChatEvent } from "./widgetServerFunctions";
export async function addMessageToChatWidget(msg: EventSubChannelChatMessageEvent) {
await sendTwitchChatEvent({
function: 'createMessage',
messageParts: msg.messageParts,
displayName: msg.chatterDisplayName,
chatterId: msg.chatterId,
chatterColor: msg.color,
messageId: msg.messageId,
badgeData: msg.badges
});
};
export async function deleteMessageFromChatWidget(msg: EventSubChannelChatMessageDeleteEvent) {
await sendTwitchChatEvent({
function: 'deleteMessage',
messageId: msg.messageId
})
};
export async function deleteBannedUserMessagesFromChatWidget(msg: EventSubChannelBanEvent) {
sendTwitchChatEvent({
function: 'userBan',
chatterId: msg.userId
});
}

View File

@@ -0,0 +1,78 @@
export type createMessageEvent = {
function: 'createMessage';
messageParts: EventSubChatMessagePart[];
messageId: string;
displayName: string;
chatterId: string;
chatterColor: null | string;
badgeData: Record<string, string>;
};
export type deleteMessageEvent = {
function: 'deleteMessage';
messageId: string;
};
export type userBanEvent = {
function: 'userBan';
chatterId: string;
};
export type serverNotificationEvent = {
function: 'serverNotification';
message: string;
};
export type twitchEventData =
createMessageEvent
| deleteMessageEvent
| userBanEvent
| serverNotificationEvent;
// The types below are taken straight from @twurple/eventsub-base
// I would import this from the package, but that's impossible
export interface EventSubChatMessageTextPart {
type: 'text';
text: string;
}
export interface EventSubChatMessageCheermote {
prefix: string;
bits: number;
tier: number;
}
export interface EventSubChatMessageCheermotePart {
type: 'cheermote';
text: string;
cheermote: EventSubChatMessageCheermote;
}
export interface EventSubChatMessageEmote {
id: string;
emote_set_id: string;
owner_id: string;
format: string[];
}
export interface EventSubChatMessageEmotePart {
type: 'emote';
text: string;
emote: EventSubChatMessageEmote;
}
export interface EventSubChatMessageMention {
user_id: string;
user_name: string;
user_login: string;
}
export interface EventSubChatMessageMentionPart {
type: 'mention';
text: string;
mention: EventSubChatMessageMention;
}
export type EventSubChatMessagePart =
| EventSubChatMessageTextPart
| EventSubChatMessageCheermotePart
| EventSubChatMessageEmotePart
| EventSubChatMessageMentionPart;

View File

@@ -0,0 +1,74 @@
import { streamerId, chatterApi } from "../..";
type badgeObject = {
[key: string]: {
[key: string]: string;
};
};
type emoteObject = {
[key: string]: string;
};
export async function getBadges() {
const globalBadges = chatterApi.chat.getGlobalBadges();
const channelBadges = chatterApi.chat.getChannelBadges(streamerId);
const rawBadges = await Promise.all([globalBadges, channelBadges]);
const newObj: badgeObject = {};
parseRawBadges(newObj, rawBadges[0]);
parseRawBadges(newObj, rawBadges[1]);
return Response.json(newObj);
};
export async function getExternalEmotes() {
const [bttvglobal, bttvuser, ffzglobal, ffzuser, seventvglobal, seventvuser] = await Promise.all([
fetch("https://api.betterttv.net/3/cached/emotes/global").then(a => a.json() as any),
fetch("https://api.betterttv.net/3/cached/users/twitch/" + streamerId).then(a => a.json() as any),
fetch("https://api.frankerfacez.com/v1/set/global").then(a => a.json() as any),
fetch("https://api.frankerfacez.com/v1/room/id/" + streamerId).then(a => a.json() as any),
fetch("https://7tv.io/v3/emote-sets/global").then(a => a.json() as any),
fetch("https://7tv.io/v3/users/twitch/" + streamerId).then(a => a.json() as any)
]);
const emotes: emoteObject = {};
for (const a of bttvglobal) {
emotes[a.code] = `https://cdn.betterttv.net/emote/${a.id}/3x.${a.imageType}`;
};
for (const a of bttvuser.sharedEmotes) {
emotes[a.code] = `https://cdn.betterttv.net/emote/${a.id}/3x.${a.imageType}`;
};
for (const a of ffzglobal.default_sets) {
for (const b of ffzglobal.sets[a].emoticons) {
emotes[b.name] = `https://cdn.frankerfacez.com/emote/${b.id}/4`;
};
};
for (const a of ffzuser.sets[ffzuser.room.set].emoticons) {
emotes[a.name] = `https://cdn.frankerfacez.com/emote/${a.id}/4`;
}
for (const a of seventvglobal.emotes) {
emotes[a.name] = `https://cdn.7tv.app/emote/${a.id}/4x.avif`;
};
for (const a of seventvuser.emote_set.emotes) {
emotes[a.name] = `https://cdn.7tv.app/emote/${a.id}/4x.avif`;
};
return Response.json(emotes);
}
import { HelixChatBadgeSet } from "@twurple/api";
function parseRawBadges(returnobj: badgeObject, data: HelixChatBadgeSet[]) {
for (const badge of data) {
if (!returnobj[badge.id]) returnobj[badge.id] = {};
for (const version of badge.versions) {
returnobj[badge.id]![version.id] = version.getImageUrl(4);
};
};
};
import server from "..";
import type { twitchEventData } from "./websockettypes";
export async function sendTwitchChatEvent(event: twitchEventData) {
server.publish('twitchchat', JSON.stringify(event));
};

View File

@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>qwerinope's chat widget</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="./src/main.ts"></script>
</body>
</html>

View File

@@ -0,0 +1,122 @@
const popover = document.createElement('div')
Object.assign(popover.style, {
position: 'fixed',
top: '20px',
right: '20px',
background: 'rgba(0, 0, 0, 0.85)',
color: 'white',
padding: '10px 20px',
borderRadius: '5px',
fontSize: '9vmin',
zIndex: 9999
});
popover.textContent = 'Loading...'
document.body.appendChild(popover);
const [badges, emotes] = await Promise.all([
fetch(`http://${location.host}/chat/getBadges`).then(data => data.json()),
fetch(`http://${location.host}/chat/getEmotes`).then(data => data.json())
]);
await prefetchImages(Object.values(emotes));
popover.remove();
async function prefetchImages(urls: string[], maxRetries = 3, retryDelay = 500) {
const sleep = (ms: number) => new Promise(res => setTimeout(res, ms));
const loadImage = async (url: string) => {
for (let attempt = 1; attempt <= maxRetries; attempt++) {
try {
await new Promise((resolve, reject) => {
const img = new Image();
img.onload = () => resolve(true);
img.onerror = () => reject();
img.src = url;
});
} catch (err) {
if (attempt < maxRetries) await sleep(retryDelay);
};
};
};
await Promise.all(urls.map(url => loadImage(url)));
};
import { type createMessageEvent } from '../../websockettypes';
export function parseMessage(data: createMessageEvent): HTMLDivElement {
const parentDiv = document.createElement('div');
parentDiv.className = 'message';
// Badge Parsing
const badgeContainer = document.createElement('div');
badgeContainer.className = 'badgeContainer';
for (const badge of Object.entries(data.badgeData)) {
const badgeElement = document.createElement('img');
badgeElement.className = 'badgeElement';
const currentbadge = badges[badge[0]][badge[1]];
badgeElement.src = currentbadge;
badgeContainer.appendChild(badgeElement);
};
parentDiv.appendChild(badgeContainer);
const chatterName = document.createElement('span');
chatterName.style = `color: ${data.chatterColor ?? "#00ff00"}`;
chatterName.innerText = data.displayName;
chatterName.className = "chatterName";
parentDiv.appendChild(chatterName);
const seperator = document.createElement('span');
seperator.innerText = ":";
seperator.className = "chatMessageSeparator";
parentDiv.appendChild(seperator);
const textElement = document.createElement('div');
textElement.className = "chatMessage"
for (const messagePart of data.messageParts) {
let messageElement;
switch (messagePart.type) {
case 'text':
messageElement = document.createElement('div');
messageElement.className = "textMessage";
let temparray: string[] = [];
for (const part of messagePart.text.split(' ')) {
if (emotes[part]) {
const messagepart = document.createElement('span');
messagepart.className = 'textPart';
messagepart.innerText = temparray.join(' ');
messageElement.appendChild(messagepart);
temparray = []; // We flush the array of all pieces of text
const emotePart = document.createElement('img');
emotePart.className = 'emotePart';
emotePart.src = emotes[part];
messageElement.appendChild(emotePart);
} else {
temparray.push(part);
};
};
const finalmessagepart = document.createElement('span');
finalmessagepart.className = 'textPart';
finalmessagepart.innerText = temparray.join(' ');
messageElement.appendChild(finalmessagepart);
break;
case 'cheermote':
messageElement = document.createElement('img');
break;
case 'emote':
messageElement = document.createElement('img');
messageElement.className = "emoteMessage";
messageElement.src = `https://static-cdn.jtvnw.net/emoticons/v2/${messagePart.emote.id}/default/dark/3.0`;
break;
case 'mention':
messageElement = document.createElement('span');
messageElement.innerText = `Replying to ${messagePart.text}`;
messageElement.className = "replyMessage";
break;
};
textElement.appendChild(messageElement);
};
parentDiv.appendChild(textElement);
return parentDiv;
};

View File

@@ -0,0 +1,38 @@
import './style.css';
import { type twitchEventData } from "../../websockettypes";
import { parseMessage } from './createMessage';
const socket = new WebSocket(`ws://${location.host}`);
socket.onopen = () => {
socket.send(JSON.stringify({
type: 'subscribe',
target: 'twitchchat'
}));
};
socket.onmessage = event => {
const data: twitchEventData = JSON.parse(event.data);
switch (data.function) {
case 'createMessage':
const newMessageElement = parseMessage(data);
newMessageElement.id = data.messageId;
newMessageElement.classList.add(data.chatterId);
document.querySelector("#message-container")?.appendChild(newMessageElement);
break;
case 'deleteMessage':
document.querySelectorAll(`#${CSS.escape(data.messageId)}`).forEach(msg => msg.remove());
break;
case 'userBan':
document.querySelectorAll(`.${CSS.escape(data.chatterId)}`).forEach(msg => msg.remove());
break;
case 'serverNotification':
console.log(data.message);
break;
};
};
document.querySelector<HTMLDivElement>('#app')!.innerHTML = `
<div id="message-container"></div>
`;

View File

@@ -0,0 +1,52 @@
:root {
font-family: system-ui, Avenir, Helvetica, Arial, sans-serif;
line-height: 1.5;
font-weight: 400;
color-scheme: light dark;
color: rgba(255, 255, 255, 0.87);
background-color: #242424;
font-synthesis: none;
text-rendering: optimizeLegibility;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
body {
margin: 0;
display: flex;
min-width: 320px;
min-height: 100vh;
}
#app {
max-width: 1280px;
margin: 0 auto;
padding: 2rem;
}
.message {
display: flex;
.chatMessage {
display: flex;
}
.replyMessage {
color: grey;
font-size: 2px;
}
padding: 2px;
}
img {
vertical-align: middle;
height: 18px;
padding: 1px;
}
.chatMessageSeparator {
margin-right: 5px
}

View File

@@ -0,0 +1,105 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2020", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "libReplacement": true, /* Enable lib replacement. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "esnext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
// "erasableSyntaxOnly": true, /* Do not allow runtime constructs that are not part of ECMAScript. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}

51
src/web/index.ts Normal file
View File

@@ -0,0 +1,51 @@
import logger from "../lib/logger";
import { getBadges, getExternalEmotes } from "./chatWidget/widgetServerFunctions";
import chatWidget from "./chatWidget/www/index.html";
import { sendTwitchChatEvent } from "./chatWidget/widgetServerFunctions";
const port = Number(process.env.WEB_PORT);
if (isNaN(port)) { logger.enverr("WEB_PORT"); process.exit(1); };
export default Bun.serve({
port,
fetch(request, server) {
if (server.upgrade(request)) return;
return new Response('oops', { status: 500 });
},
routes: {
"/chat": chatWidget,
"/chat/getBadges": getBadges,
"/chat/getEmotes": getExternalEmotes
},
websocket: {
open(_ws) {
sendTwitchChatEvent({
function: 'serverNotification',
message: 'Sucessfully opened websocket connection'
});
},
message(ws, omessage) {
const message = JSON.parse(omessage.toString());
if (!message.type) return;
switch (message.type) {
case 'subscribe':
if (!message.target) return;
ws.subscribe(message.target);
sendTwitchChatEvent({
function: 'serverNotification',
message: `Successfully subscribed to all ${message.target} events`
});
break;
};
},
close(ws) {
ws.close();
}
},
development: true,
error(error) {
logger.err(`Error at chatwidget server: ${error}`);
return new Response("Internal Server Error", { status: 500 })
},
});