chore: abstract user emotes call to API wrapper

Author: zunderscore

src/backend/chat/chat-helpers.ts

@@ -82,21 +82,17 @@ class FirebotChatHelpers {
 
         try {
             let streamerEmotes: HelixEmoteBase[] = [];
-            let botEmotes: HelixEmoteBase[] = [];
 
             if (this._getAllTwitchEmotes) {
                 logger.debug(`Caching all available Twitch emotes for streamer ${streamer.username}`);
 
                 // This includes: global, streamer channel, all channels streamer is subscribed to, etc.
                 // This may take SEVERAL calls so it can take several seconds to complete
-                streamerEmotes = await client.chat.getUserEmotesPaginated(streamer.userId).getAll();
+                streamerEmotes = await twitchApi.chat.getAllUserEmotes();
 
                 if (!streamerEmotes) {
                     return;
                 }
-
-                // Make sure to remove any duplicates, because Twitch does that for some reason
-                streamerEmotes = streamerEmotes.filter((emote, index, arr) => arr.findIndex(e => emote.id === e.id) === index);
             } else {
                 logger.debug(`Caching Twitch channel emotes for ${streamer.username}`);
                 const channelEmotes = await client.chat.getChannelEmotes(streamer.userId);
@@ -120,11 +116,7 @@ class FirebotChatHelpers {
                 if (bot.loggedIn) {
                     logger.debug(`Caching all available Twitch emotes for bot ${bot.username}`);
 
-                    const botClient = twitchApi.botClient;
-                    if (botClient != null) {
-                        botEmotes = await botClient.chat.getUserEmotesPaginated(bot.userId, streamer.userId).getAll();
-                        this._twitchEmotes.bot = botEmotes.filter((emote, index, arr) => arr.findIndex(e => emote.id === e.id) === index);
-                    }
+                    this._twitchEmotes.bot = await twitchApi.chat.getAllUserEmotes("bot") ?? [];
                 } else {
                     logger.debug("Bot account not logged in; Skipping Twitch bot emotes");
                 }

src/backend/twitch-api/resource/chat.ts

@@ -1,6 +1,14 @@
 import logger from '../../logwrapper';
 import accountAccess from "../../common/account-access";
-import { ApiClient, HelixChatAnnouncementColor, HelixChatChatter, HelixSendChatAnnouncementParams, HelixSentChatMessage, HelixUpdateChatSettingsParams } from "@twurple/api";
+import {
+    ApiClient,
+    HelixChatAnnouncementColor,
+    HelixChatChatter,
+    HelixSendChatAnnouncementParams,
+    HelixSentChatMessage,
+    HelixUpdateChatSettingsParams,
+    HelixUserEmote
+} from "@twurple/api";
 
 interface ResultWithError<TResult, TError> {
     success: boolean;
@@ -321,4 +329,36 @@ export class TwitchChatApi {
             return null;
         }
     }
+
+    /**
+     * Gets all emotes that can be used on Twitch by the specified Firebot account.
+     *
+     * @param account Either `streamer` or `bot`
+     * @returns An array of {@link HelixUserEmote} containing all the emotes the user can use on Twitch, or null if the request failed
+     */
+    async getAllUserEmotes(account: "streamer" | "bot" = "streamer"): Promise<HelixUserEmote[]> {
+        const streamerUserId = accountAccess.getAccounts().streamer.userId;
+        let userId = streamerUserId;
+        let client = this._streamerClient;
+
+        if (account === "bot") {
+            const bot = accountAccess.getAccounts().bot;
+            if (bot.loggedIn !== true) {
+                return [];
+            }
+
+            userId = bot.userId;
+            client = this._botClient;
+        }
+
+        try {
+            const emotes = await client.chat.getUserEmotesPaginated(userId, streamerUserId).getAll();
+
+            // Filter out any duplicates that may come back from the API
+            return emotes.filter((emote, index, arr) => arr.findIndex(e => emote.id === e.id) === index);
+        } catch (error) {
+            logger.error(`Error getting all user emotes for ${account}`, error.message);
+            return null;
+        }
+    }
 }