From f3281d13419522cc034b5700006836f4725ffac8 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Thu, 14 Dec 2023 12:48:07 -0500 Subject: [PATCH 001/184] feat: Twitch Device Code Flow for login --- secrets.gpg | Bin 374 -> 371 bytes .../electron/events/when-ready.js | 4 +- src/backend/auth/auth-manager.js | 82 +++- src/backend/auth/auth.d.ts | 2 +- .../auth/firebot-device-auth-provider.ts | 141 +++++++ .../auth/firebot-static-auth-provider.ts | 45 --- src/backend/auth/twitch-auth.js | 217 ----------- src/backend/auth/twitch-auth.ts | 177 +++++++++ .../auth/twitch-device-auth-provider.ts | 361 ++++++++++++++++++ src/backend/chat/twitch-chat.ts | 10 +- src/backend/common/account-access.js | 2 +- src/backend/effects/builtin/http-request.js | 2 +- src/backend/twitch-api/api.ts | 9 +- .../twitch-api/pubsub/pubsub-client.js | 4 +- src/backend/twitch-api/resource/auth.ts | 40 ++ .../directives/modals/misc/botLoginModal.js | 50 --- .../modals/misc/twitch-login-modal.js | 85 +++++ src/gui/app/index.html | 4 +- src/gui/app/services/connection.service.js | 19 +- 19 files changed, 919 insertions(+), 335 deletions(-) create mode 100644 src/backend/auth/firebot-device-auth-provider.ts delete mode 100644 src/backend/auth/firebot-static-auth-provider.ts delete mode 100644 src/backend/auth/twitch-auth.js create mode 100644 src/backend/auth/twitch-auth.ts create mode 100644 src/backend/auth/twitch-device-auth-provider.ts create mode 100644 src/backend/twitch-api/resource/auth.ts delete mode 100644 src/gui/app/directives/modals/misc/botLoginModal.js create mode 100644 src/gui/app/directives/modals/misc/twitch-login-modal.js diff --git a/secrets.gpg b/secrets.gpg index ceb3316e745d515cf1bcb075b17f47c0f4a30de6..9225a6f8b2df2bb29753b7b366850510d5221e90 100644 GIT binary patch literal 371 zcmV-(0gV2P4Fm}T0;3WeQ*#l8_xjSnp#hlq7!bct=u?%y3~N`0a!h($AQHqG1ni#g zE{h88bBWKR^UpocHw#AIK(i=#@oXt8Kv!vT{~In&sCW9<3z9u}jGm<<2*f%!j9JYx z34>>~@QOSQ@VWrhZH6E?oQUV6q8jV-$I$QnCo?ILtF8H4k&q04@iTA%twMz#q3GPn z1P+B=Nrm5NvpFTzz(~}wJc#*JMgu&jM%O1by)~=4kV7(zYy(uTD~-0^Cjf1UViM*n z?|Ym>7@{L-L3C|XJiH8}Hwj#HE$i=a`1)rjs~L!yoabKb`!i>8|3~gWoiM zb5%DrQO1RqDX}%`JDkdbv>wkii51n`<5aG=dN)yAxaP)&e~bFkph3zo5ZSw`qNv`X z6Pbh3T=+75lSI&x;SQZRDerR#m9lf7!VJPEsl`f>B~8gvNFD&1$1`;crlbMIx=%vV zSgZ=Yg9ef0s9vW~(#?h7s0WF7UXatr!PUv3XuR{vYSfQERJ>|Cjwz!bcdY8AC~9zI`TlrD)K0R UM7FF;e(RhW;@9;ITHxf=eHGok-2eap diff --git a/src/backend/app-management/electron/events/when-ready.js b/src/backend/app-management/electron/events/when-ready.js index 908358d54..f1ece4bdb 100644 --- a/src/backend/app-management/electron/events/when-ready.js +++ b/src/backend/app-management/electron/events/when-ready.js @@ -38,8 +38,8 @@ exports.whenReady = async () => { const accountAccess = require("../../../common/account-access"); await accountAccess.updateAccountCache(false); - const firebotStaticAuthProvider = require("../../../auth/firebot-static-auth-provider"); - firebotStaticAuthProvider.setupStaticAuthProvider(); + const firebotDeviceAuthProvider = require("../../../auth/firebot-device-auth-provider"); + firebotDeviceAuthProvider.setupDeviceAuthProvider(); const connectionManager = require("../../../common/connection-manager"); diff --git a/src/backend/auth/auth-manager.js b/src/backend/auth/auth-manager.js index 9a8631233..60a715901 100644 --- a/src/backend/auth/auth-manager.js +++ b/src/backend/auth/auth-manager.js @@ -4,6 +4,7 @@ const EventEmitter = require("events"); const logger = require("../logwrapper"); const { settings } = require("../common/settings-access"); const OAuthClient = require("client-oauth2"); +const frontendCommunicator = require("../common/frontend-communicator"); const HTTP_PORT = settings.getWebServerPort(); @@ -27,14 +28,31 @@ class AuthManager extends EventEmitter { const oauthClient = this.buildOAuthClientForProvider(provider, redirectUri); - const authorizationUri = provider.auth.type === "token" - ? oauthClient.token.getUri() - : oauthClient.code.getUri(); + let authorizationUri = ""; + + switch (provider.auth.type) { + case "token": + authorizationUri = oauthClient.token.getUri(); + break; + + case "code": + authorizationUri = oauthClient.code.getUri(); + break; + + case "device": + authorizationUri = `${provider.auth.tokenHost}${provider.auth.authorizePath}`; + break; + } + + const tokenUri = provider.auth.type === "device" + ? `${provider.auth.tokenHost}${provider.auth.tokenPath ?? ""}` + : null; const authProvider = { id: provider.id, oauthClient: oauthClient, authorizationUri: authorizationUri, + tokenUri: tokenUri, redirectUri: redirectUri, details: provider }; @@ -64,7 +82,7 @@ class AuthManager extends EventEmitter { return new OAuthClient({ clientId: provider.client.id, - clientSecret: provider.auth.type === "token" ? null : provider.client.secret, + clientSecret: provider.auth.type === "code" ? provider.client.secret : null, accessTokenUri: provider.auth.type === "token" ? null : tokenUri, authorizationUri: authUri, redirectUri: redirectUri, @@ -114,4 +132,60 @@ class AuthManager extends EventEmitter { const manager = new AuthManager(); +frontendCommunicator.onAsync("begin-device-auth", async (providerId) => { + const provider = manager.getAuthProvider(providerId); + if (provider?.details?.auth?.type !== "device") { + return; + } + + const formData = new FormData(); + formData.append("client_id", provider.details.client.id); + formData.append("scopes", Array.isArray(provider.details.scopes) + ? provider.details.scopes.join(" ") + : provider.details.scopes); + + // Get the device auth request + const response = await fetch(provider.authorizationUri, { + method: "POST", + body: formData + }); + + if (response.ok) { + const deviceAuthData = await response.json(); + + frontendCommunicator.send("device-code-received", { + loginUrl: deviceAuthData.verification_uri, + code: deviceAuthData.user_code + }); + + const tokenRequestData = new FormData(); + tokenRequestData.append("client_id", provider.details.client.id); + tokenRequestData.append("scopes", Array.isArray(provider.details.scopes) + ? provider.details.scopes.join(" ") + : provider.details.scopes); + tokenRequestData.append("device_code", deviceAuthData.device_code); + tokenRequestData.append("grant_type", "urn:ietf:params:oauth:grant-type:device_code"); + + const tokenCheckInterval = setInterval(async () => { + const tokenResponse = await fetch(provider.tokenUri, { + method: "POST", + body: tokenRequestData + }); + + if (tokenResponse.ok) { + clearInterval(tokenCheckInterval); + const tokenData = await tokenResponse.json(); + + manager.successfulAuth(providerId, tokenData); + } + }, deviceAuthData.interval * 1000); + + frontendCommunicator.on("cancel-device-token-check", () => { + if (tokenCheckInterval) { + clearInterval(tokenCheckInterval); + } + }); + } +}); + module.exports = manager; \ No newline at end of file diff --git a/src/backend/auth/auth.d.ts b/src/backend/auth/auth.d.ts index a1a42fe00..1c940e1cb 100644 --- a/src/backend/auth/auth.d.ts +++ b/src/backend/auth/auth.d.ts @@ -8,7 +8,7 @@ export interface AuthProviderDefinition { secret?: string; }; auth: { - type: "code" | "token"; + type: "code" | "token" | "device"; tokenHost: string; authorizePath: string; tokenPath?: string; diff --git a/src/backend/auth/firebot-device-auth-provider.ts b/src/backend/auth/firebot-device-auth-provider.ts new file mode 100644 index 000000000..ea239123c --- /dev/null +++ b/src/backend/auth/firebot-device-auth-provider.ts @@ -0,0 +1,141 @@ +import logger from "../logwrapper"; +import accountAccess, { FirebotAccount } from "../common/account-access"; +import twitchAuth from "./twitch-auth"; +import TwitchApi from "../twitch-api/api"; +import { AuthDetails, AuthProviderDefinition } from "./auth"; +import { AccessToken, getExpiryDateOfAccessToken } from "@twurple/auth"; +import { DeviceAuthProvider } from "./twitch-device-auth-provider"; +import frontendCommunicator from "../common/frontend-communicator"; + +class FirebotDeviceAuthProvider { + streamerProvider: DeviceAuthProvider; + botProvider: DeviceAuthProvider; + + private onRefresh(accountType: "streamer" | "bot", userId: string, token: AccessToken): void { + const account: FirebotAccount = accountType === "streamer" + ? accountAccess.getAccounts().streamer + : accountAccess.getAccounts().bot; + + logger.debug(`Persisting ${accountType} access token`); + + const auth: AuthDetails = account.auth ?? { } as AuthDetails; + auth.access_token = token.accessToken; + auth.refresh_token = token.refreshToken; + auth.expires_in = token.expiresIn; + auth.obtainment_timestamp = token.obtainmentTimestamp; + auth.expires_at = getExpiryDateOfAccessToken({ + expiresIn: token.expiresIn, + obtainmentTimestamp: token.obtainmentTimestamp + }); + + account.auth = auth; + accountAccess.updateAccount(accountType, account, false); + } + + setupDeviceAuthProvider(): void { + if (accountAccess.getAccounts().streamer.loggedIn) { + const streamerAcccount = accountAccess.getAccounts().streamer; + + const scopes: string[] = Array.isArray(twitchAuth.streamerAccountProvider.scopes) + ? twitchAuth.streamerAccountProvider.scopes + : twitchAuth.streamerAccountProvider.scopes.split(" "); + + this.streamerProvider = new DeviceAuthProvider({ + userId: streamerAcccount.userId, + clientId: twitchAuth.twitchClientId, + accessToken: { + accessToken: streamerAcccount.auth.access_token, + refreshToken: streamerAcccount.auth.refresh_token, + expiresIn: streamerAcccount.auth.expires_in, + obtainmentTimestamp: streamerAcccount.auth.obtainment_timestamp ?? Date.now(), + scope: scopes + }, + scopes: scopes + }); + + this.streamerProvider.onRefresh((userId, token) => this.onRefresh("streamer", userId, token)); + } else { + this.streamerProvider = null; + } + + if (accountAccess.getAccounts().bot.loggedIn) { + const botAcccount = accountAccess.getAccounts().bot; + + const scopes: string[] = Array.isArray(twitchAuth.botAccountProvider.scopes) + ? twitchAuth.botAccountProvider.scopes + : twitchAuth.botAccountProvider.scopes.split(" "); + + this.botProvider = new DeviceAuthProvider({ + userId: botAcccount.userId, + clientId: twitchAuth.twitchClientId, + accessToken: { + accessToken: botAcccount.auth.access_token, + refreshToken: botAcccount.auth.refresh_token, + expiresIn: botAcccount.auth.expires_in, + obtainmentTimestamp: botAcccount.auth.obtainment_timestamp ?? Date.now(), + scope: scopes + }, + scopes: scopes + }); + + this.botProvider.onRefresh((userId, token) => this.onRefresh("bot", userId, token)); + } else { + this.botProvider = null; + } + + TwitchApi.setupApiClients(this.streamerProvider, this.botProvider); + } +} + +const isTwitchTokenDataValid = function(definition: AuthProviderDefinition, authDetails: AuthDetails): boolean { + const scopes = Array.isArray(definition.scopes) + ? definition.scopes + : definition.scopes.split(" "); + + return ( + // Ensure authDetails exist + authDetails && + + // Make sure we have a refresh token + authDetails.refresh_token && + + // Make sure there's at least some scopes + authDetails.scope && + authDetails.scope.length > 0 && + + // check all required scopes are present + scopes.every(scope => authDetails.scope.includes(scope)) + ); +}; + +const firebotDeviceAuthProvider = new FirebotDeviceAuthProvider(); + +accountAccess.events.on("account-update", () => { + firebotDeviceAuthProvider.setupDeviceAuthProvider(); +}); + +frontendCommunicator.onAsync("validate-twitch-account", async ({ accountType, authDetails }) => { + let definition: AuthProviderDefinition; + + switch (accountType) { + case "streamer": + definition = twitchAuth.streamerAccountProvider; + break; + + case "bot": + definition = twitchAuth.botAccountProvider; + break; + + default: + break; + } + + if (definition) { + return isTwitchTokenDataValid(definition, authDetails) + && await TwitchApi.auth.isTokenValid(accountType); + } + + return true; +}); + +export = firebotDeviceAuthProvider; \ No newline at end of file diff --git a/src/backend/auth/firebot-static-auth-provider.ts b/src/backend/auth/firebot-static-auth-provider.ts deleted file mode 100644 index 8fec5d001..000000000 --- a/src/backend/auth/firebot-static-auth-provider.ts +++ /dev/null @@ -1,45 +0,0 @@ -import accountAccess from "../common/account-access"; -import twitchAuth from "./twitch-auth"; -import TwitchApi from "../twitch-api/api"; -import { StaticAuthProvider } from "@twurple/auth"; - -class FirebotStaticAuthProvider { - streamerProvider: StaticAuthProvider; - botProvider: StaticAuthProvider; - - setupStaticAuthProvider(): void { - if (accountAccess.getAccounts().streamer.loggedIn) { - const streamerAcccount = accountAccess.getAccounts().streamer; - - this.streamerProvider = new StaticAuthProvider( - twitchAuth.TWITCH_CLIENT_ID, - streamerAcccount.auth.access_token, - twitchAuth.STREAMER_ACCOUNT_PROVIDER.scopes as string[] - ); - } else { - this.streamerProvider = null; - } - - if (accountAccess.getAccounts().bot.loggedIn) { - const botAcccount = accountAccess.getAccounts().bot; - - this.botProvider = new StaticAuthProvider( - twitchAuth.TWITCH_CLIENT_ID, - botAcccount.auth.access_token, - twitchAuth.BOT_ACCOUNT_PROVIDER.scopes as string[] - ); - } else { - this.botProvider = null; - } - - TwitchApi.setupApiClients(this.streamerProvider, this.botProvider); - } -} - -const firebotStaticAuthProvider = new FirebotStaticAuthProvider(); - -accountAccess.events.on("account-update", () => { - firebotStaticAuthProvider.setupStaticAuthProvider(); -}); - -export = firebotStaticAuthProvider; \ No newline at end of file diff --git a/src/backend/auth/twitch-auth.js b/src/backend/auth/twitch-auth.js deleted file mode 100644 index a35096c51..000000000 --- a/src/backend/auth/twitch-auth.js +++ /dev/null @@ -1,217 +0,0 @@ -"use strict"; - -const authManager = require("./auth-manager"); -const accountAccess = require("../common/account-access"); -const frontendCommunicator = require("../common/frontend-communicator"); -const logger = require("../logwrapper"); -const axios = require("axios").default; - -const { secrets } = require("../secrets-manager"); - -const TWITCH_CLIENT_ID = secrets.twitchClientId; - -exports.TWITCH_CLIENT_ID = TWITCH_CLIENT_ID; - -const HOST = "https://id.twitch.tv"; -const AUTHORIZE_PATH = "/oauth2/authorize"; - -const STREAMER_ACCOUNT_PROVIDER_ID = "twitch:streamer-account"; -const BOT_ACCOUNT_PROVIDER_ID = "twitch:bot-account"; - -/** - * @param {import("./auth").AuthProviderDefinition} definition - * @param {import("./auth").AuthDetails} authDetails - * @returns boolean - */ -const validator = function(definition, authDetails) { - return ( - // Ensure authDetails exist - authDetails && - - // Check for old auth code flow token - !authDetails.refresh_token && - - // Make sure there's at least some scopes - authDetails.scope && - authDetails.scope.length > 0 && - - // check all required scopes are present - definition.scopes.every(scope => authDetails.scope.includes(scope)) - ); -}; - -/** @type {import("./auth").AuthProviderDefinition} */ -const STREAMER_ACCOUNT_PROVIDER = { - id: STREAMER_ACCOUNT_PROVIDER_ID, - name: "Streamer Account", - client: { - id: TWITCH_CLIENT_ID - }, - auth: { - tokenHost: HOST, - authorizePath: AUTHORIZE_PATH, - type: "token" - }, - scopes: [ - 'bits:read', - 'channel:edit:commercial', - 'channel:manage:broadcast', - 'channel:manage:moderators', - 'channel:manage:polls', - 'channel:manage:predictions', - 'channel:manage:raids', - 'channel:manage:redemptions', - 'channel:manage:schedule', - 'channel:manage:videos', - 'channel:manage:vips', - 'channel:moderate', - 'channel:read:charity', - 'channel:read:editors', - 'channel:read:goals', - 'channel:read:hype_train', - 'channel:read:polls', - 'channel:read:predictions', - 'channel:read:redemptions', - 'channel:read:stream_key', - 'channel:read:subscriptions', - 'channel:read:vips', - 'channel_commercial', - 'channel_editor', - 'channel_read', - 'channel_subscriptions', - 'chat:edit', - 'chat:read', - 'clips:edit', - 'moderation:read', - 'moderator:manage:announcements', - 'moderator:manage:automod', - 'moderator:manage:automod_settings', - 'moderator:manage:banned_users', - 'moderator:manage:blocked_terms', - 'moderator:manage:chat_messages', - 'moderator:manage:chat_settings', - 'moderator:manage:shield_mode', - 'moderator:manage:shoutouts', - 'moderator:read:automod_settings', - 'moderator:read:blocked_terms', - 'moderator:read:chat_settings', - 'moderator:read:chatters', - 'moderator:read:followers', - 'moderator:read:shield_mode', - 'moderator:read:shoutouts', - 'user:edit:broadcast', - 'user:manage:blocked_users', - 'user:manage:whispers', - 'user:read:blocked_users', - 'user:read:broadcast', - 'user:read:follows', - 'user:read:subscriptions', - 'user_subscriptions', - 'user_follows_edit', - 'user_read', - 'whispers:edit', - 'whispers:read' - ] -}; - -/** @type {import("./auth").AuthProviderDefinition} */ -const BOT_ACCOUNT_PROVIDER = { - id: BOT_ACCOUNT_PROVIDER_ID, - name: "Bot Account", - client: { - id: TWITCH_CLIENT_ID - }, - auth: { - tokenHost: HOST, - authorizePath: AUTHORIZE_PATH, - type: "token" - }, - scopes: [ - 'channel:moderate', - 'chat:edit', - 'chat:read', - 'moderator:manage:announcements', - 'user:manage:whispers', - 'whispers:edit', - 'whispers:read', - 'channel_read' - ] -}; - -exports.STREAMER_ACCOUNT_PROVIDER = STREAMER_ACCOUNT_PROVIDER; -exports.BOT_ACCOUNT_PROVIDER = BOT_ACCOUNT_PROVIDER; - -exports.registerTwitchAuthProviders = () => { - authManager.registerAuthProvider(STREAMER_ACCOUNT_PROVIDER); - authManager.registerAuthProvider(BOT_ACCOUNT_PROVIDER); -}; - -async function getUserCurrent(accessToken) { - try { - const response = await axios.get('https://api.twitch.tv/helix/users', { - headers: { - 'Authorization': `Bearer ${accessToken}`, - 'User-Agent': 'Firebot v5', - 'Client-ID': TWITCH_CLIENT_ID - }, - responseType: "json" - }); - - if (response.status >= 200 && response.status <= 204) { - const userData = response.data; - if (userData.data && userData.data.length > 0) { - return userData.data[0]; - } - } - } catch (error) { - logger.error("Error getting current twitch user", error); - } - return null; -} - -authManager.on("auth-success", async authData => { - const { providerId, tokenData } = authData; - - if (providerId === STREAMER_ACCOUNT_PROVIDER_ID || providerId === BOT_ACCOUNT_PROVIDER_ID) { - const userData = await getUserCurrent(tokenData.access_token); - if (userData == null) { - return; - } - - const accountType = providerId === STREAMER_ACCOUNT_PROVIDER_ID ? "streamer" : "bot"; - const accountObject = { - username: userData.login, - displayName: userData.display_name, - channelId: userData.id, - userId: userData.id, - avatar: userData.profile_image_url, - broadcasterType: userData.broadcaster_type, - auth: tokenData - }; - - accountAccess.updateAccount(accountType, accountObject); - } -}); - -frontendCommunicator.on("validate-twitch-account", ({ accountType, authDetails }) => { - let definition; - - switch (accountType) { - case "streamer": - definition = STREAMER_ACCOUNT_PROVIDER; - break; - - case "bot": - definition = BOT_ACCOUNT_PROVIDER; - break; - - default: - break; - } - - if (definition) { - return validator(definition, authDetails); - } - - return true; -}); diff --git a/src/backend/auth/twitch-auth.ts b/src/backend/auth/twitch-auth.ts new file mode 100644 index 000000000..c165cfbfc --- /dev/null +++ b/src/backend/auth/twitch-auth.ts @@ -0,0 +1,177 @@ +import authManager from "./auth-manager"; +import accountAccess, { FirebotAccount } from "../common/account-access"; +import logger from "../logwrapper"; +import { secrets } from "../secrets-manager"; +import { AuthProviderDefinition } from "./auth"; + +const axios = require("axios").default; + +class TwitchAuthProviders { + private readonly _host = "https://id.twitch.tv"; + private readonly _authorizePath = "/oauth2/device"; + private readonly _tokenPath = "/oauth2/token"; + + readonly streamerAccountProviderId = "twitch:streamer-account"; + readonly botAccountProviderId = "twitch:bot-account"; + + readonly twitchClientId = secrets.twitchClientId; + + readonly streamerAccountProvider: AuthProviderDefinition = { + id: this.streamerAccountProviderId, + name: "Streamer Account", + client: { + id: this.twitchClientId + }, + auth: { + tokenHost: this._host, + authorizePath: this._authorizePath, + tokenPath: this._tokenPath, + type: "device" + }, + scopes: [ + 'bits:read', + 'channel:edit:commercial', + 'channel:manage:ads', + 'channel:manage:broadcast', + 'channel:manage:moderators', + 'channel:manage:polls', + 'channel:manage:predictions', + 'channel:manage:raids', + 'channel:manage:redemptions', + 'channel:manage:schedule', + 'channel:manage:videos', + 'channel:manage:vips', + 'channel:moderate', + 'channel:read:ads', + 'channel:read:charity', + 'channel:read:editors', + 'channel:read:goals', + 'channel:read:hype_train', + 'channel:read:polls', + 'channel:read:predictions', + 'channel:read:redemptions', + 'channel:read:stream_key', + 'channel:read:subscriptions', + 'channel:read:vips', + 'channel_commercial', + 'channel_editor', + 'channel_read', + 'channel_subscriptions', + 'chat:edit', + 'chat:read', + 'clips:edit', + 'moderation:read', + 'moderator:manage:announcements', + 'moderator:manage:automod', + 'moderator:manage:automod_settings', + 'moderator:manage:banned_users', + 'moderator:manage:blocked_terms', + 'moderator:manage:chat_messages', + 'moderator:manage:chat_settings', + 'moderator:manage:shield_mode', + 'moderator:manage:shoutouts', + 'moderator:read:automod_settings', + 'moderator:read:blocked_terms', + 'moderator:read:chat_settings', + 'moderator:read:chatters', + 'moderator:read:followers', + 'moderator:read:shield_mode', + 'moderator:read:shoutouts', + 'user:edit:broadcast', + 'user:manage:blocked_users', + 'user:manage:whispers', + 'user:read:blocked_users', + 'user:read:broadcast', + 'user:read:chat', + 'user:read:follows', + 'user:read:subscriptions', + 'user_subscriptions', + 'user_follows_edit', + 'user_read', + 'whispers:edit', + 'whispers:read' + ] + }; + + botAccountProvider: AuthProviderDefinition = { + id: this.botAccountProviderId, + name: "Bot Account", + client: { + id: this.twitchClientId + }, + auth: { + tokenHost: this._host, + authorizePath: this._authorizePath, + tokenPath: this._tokenPath, + type: "device" + }, + scopes: [ + 'channel:moderate', + 'chat:edit', + 'chat:read', + 'moderator:manage:announcements', + 'user:manage:whispers', + 'user:read:chat', + 'whispers:edit', + 'whispers:read', + 'channel_read' + ] + }; + + registerTwitchAuthProviders() { + authManager.registerAuthProvider(this.streamerAccountProvider); + authManager.registerAuthProvider(this.botAccountProvider); + }; +} + +async function getUserCurrent(accessToken: string) { + try { + const response = await axios.get('https://api.twitch.tv/helix/users', { + headers: { + 'Authorization': `Bearer ${accessToken}`, + 'User-Agent': 'Firebot v5', + 'Client-ID': this.twitchClientId + }, + responseType: "json" + }); + + if (response.status >= 200 && response.status <= 204) { + const userData = response.data; + if (userData.data && userData.data.length > 0) { + return userData.data[0]; + } + } + } catch (error) { + logger.error("Error getting current twitch user", error); + } + return null; +} + +const twitchAuthProviders = new TwitchAuthProviders(); + +authManager.on("auth-success", async authData => { + const { providerId, tokenData } = authData; + + if (providerId === twitchAuthProviders.streamerAccountProviderId + || providerId === twitchAuthProviders.botAccountProviderId) { + const userData = await getUserCurrent(tokenData.access_token); + if (userData == null) { + return; + } + + const accountType = providerId === twitchAuthProviders.streamerAccountProviderId ? "streamer" : "bot"; + const accountObject: FirebotAccount = { + username: userData.login, + displayName: userData.display_name, + channelId: userData.id, + userId: userData.id, + avatar: userData.profile_image_url, + broadcasterType: userData.broadcaster_type, + auth: tokenData + }; + + accountAccess.updateAccount(accountType, accountObject); + } +}); + +export = twitchAuthProviders; \ No newline at end of file diff --git a/src/backend/auth/twitch-device-auth-provider.ts b/src/backend/auth/twitch-device-auth-provider.ts new file mode 100644 index 000000000..5fca54fe1 --- /dev/null +++ b/src/backend/auth/twitch-device-auth-provider.ts @@ -0,0 +1,361 @@ +/** + * This file exists because there's currently no Twurple AuthProvider that supports Device Code Flow. + * Once one exists, this can go away. In the meantime, it stays in order to refresh tokens automagically. + */ + +import { Enumerable } from '@d-fischer/shared-utils'; +import { EventEmitter } from '@d-fischer/typed-event-emitter'; +import { CustomError, extractUserId, type UserIdResolvable } from '@twurple/common'; +import type { AccessToken, AccessTokenMaybeWithUserId, AccessTokenWithUserId, TokenInfoData } from '@twurple/auth'; +import { InvalidTokenError, TokenInfo } from '@twurple/auth'; +import type { AuthProvider } from '@twurple/auth'; +import { callTwitchApi, HttpStatusCodeError } from '@twurple/api-call'; + +const scopeEquivalencies = new Map([ + ['channel_commercial', ['channel:edit:commercial']], + ['channel_editor', ['channel:manage:broadcast']], + ['channel_read', ['channel:read:stream_key']], + ['channel_subscriptions', ['channel:read:subscriptions']], + ['user_blocks_read', ['user:read:blocked_users']], + ['user_blocks_edit', ['user:manage:blocked_users']], + ['user_follows_edit', ['user:edit:follows']], + ['user_read', ['user:read:email']], + ['user_subscriptions', ['user:read:subscriptions']], + ['user:edit:broadcast', ['channel:manage:broadcast', 'channel:manage:extensions']], +]); + +interface AccessTokenData { + access_token: string; + refresh_token: string; + expires_in?: number; + scope?: string[]; +} + +/** + * Thrown whenever you try to execute an action in the context of a user + * who is already known to have an invalid token saved in its {@link AuthProvider}. + */ +export class CachedRefreshFailureError extends CustomError { + constructor(public readonly userId: string) { + super(`The user context for the user ${userId} has been disabled. +This happened because the access token became invalid (e.g. by expiry) and refreshing it failed (e.g. because the account's password was changed). +The user will need to reauthenticate to continue.`); + } +} + +/** + * Gets information about an access token. + * + * @param accessToken The access token to get the information of. + * @param clientId The client ID of your application. + * + * You need to obtain one using one of the [Twitch OAuth flows](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/). + */ +async function getTokenInfo(accessToken: string, clientId?: string): Promise { + try { + const data = await callTwitchApi({ type: 'auth', url: 'validate' }, clientId, accessToken); + return new TokenInfo(data); + } catch (e) { + if (e instanceof HttpStatusCodeError && e.statusCode === 401) { + throw new InvalidTokenError({ cause: e }); + } + throw e; + } +} + +/** + * Compares scopes for a non-upgradable {@link AuthProvider} instance. + * + * @param scopesToCompare The scopes to compare against. + * @param requestedScopes The scopes you requested. + */ +function compareScopes(scopesToCompare: string[], requestedScopes?: string[]): void { + if (requestedScopes?.length) { + const scopes = new Set( + scopesToCompare.flatMap(scope => [scope, ...(scopeEquivalencies.get(scope) ?? [])]), + ); + + if (requestedScopes.every(scope => !scopes.has(scope))) { + const scopesStr = requestedScopes.join(', '); + throw new Error( + `This token does not have any of the requested scopes (${scopesStr}) and can not be upgraded. +If you need dynamically upgrading scopes, please implement the AuthProvider interface accordingly: + +\thttps://twurple.js.org/reference/auth/interfaces/AuthProvider.html`, + ); + } + } +} + +/** + * Compares scope sets for a non-upgradable {@link AuthProvider} instance. + * + * @param scopesToCompare The scopes to compare against. + * @param requestedScopeSets The scope sets you requested. + */ +function compareScopeSets(scopesToCompare: string[], requestedScopeSets: string[][]): void { + for (const requestedScopes of requestedScopeSets) { + compareScopes(scopesToCompare, requestedScopes); + } +} + +/** + * Compares scopes for a non-upgradable `AuthProvider` instance, loading them from the token if necessary, + * and returns them together with the user ID. + * + * @param clientId The client ID of your application. + * @param token The access token. + * @param userId The user ID that was already loaded. + * @param loadedScopes The scopes that were already loaded. + * @param requestedScopeSets The scope sets you requested. + */ +async function loadAndCompareTokenInfo( + clientId: string, + token: string, + userId?: string, + loadedScopes?: string[], + requestedScopeSets?: Array, +): Promise<[string[] | undefined, string]> { + // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing + if (requestedScopeSets?.length || !userId) { + const userInfo = await getTokenInfo(token, clientId); + if (!userInfo.userId) { + throw new Error('Trying to use an app access token as a user access token'); + } + + const scopesToCompare = loadedScopes ?? userInfo.scopes; + if (requestedScopeSets) { + compareScopeSets( + scopesToCompare, + requestedScopeSets.filter((val): val is string[] => Boolean(val)), + ); + } + + return [scopesToCompare, userInfo.userId]; + } + + return [loadedScopes, userId]; +} + +function createRefreshTokenQuery(clientId: string, refreshToken: string) { + return { + grant_type: 'refresh_token', + client_id: clientId, + refresh_token: refreshToken, + }; +} + +function createAccessTokenFromData(data: AccessTokenData): AccessToken { + return { + accessToken: data.access_token, + refreshToken: data.refresh_token || null, + scope: data.scope ?? [], + expiresIn: data.expires_in ?? null, + obtainmentTimestamp: Date.now(), + }; +} + +/** + * Refreshes an expired access token with your client credentials and the refresh token that was given by the initial authentication. + * + * @param clientId The client ID of your application. + * @param clientSecret The client secret of your application. + * @param refreshToken The refresh token. + */ +async function refreshUserToken( + clientId: string, + refreshToken: string, +): Promise { + return createAccessTokenFromData( + await callTwitchApi({ + type: 'auth', + url: 'token', + method: 'POST', + query: createRefreshTokenQuery(clientId, refreshToken), + }), + ); +} + +interface DeviceAuthProviderConfig { + userId: UserIdResolvable, + clientId: string, + accessToken: string | AccessToken, + scopes?: string[] +} + +/** + * An auth provider that always returns the same initially given credentials. + * + * This has the added benefit of refreshing tokens for Device Code Flow. + */ +export class DeviceAuthProvider extends EventEmitter implements AuthProvider { + /** @internal */ @Enumerable(false) private readonly _clientId: string; + /** @internal */ @Enumerable(false) private _accessToken: AccessToken; + private _userId?: string; + private _scopes?: string[]; + private readonly _cachedRefreshFailures = new Set(); + + /** + * Fires when a user token is refreshed. + * + * @param userId The ID of the user whose token was successfully refreshed. + * @param token The refreshed token data. + */ + readonly onRefresh = this.registerEvent<[userId: string, token: AccessToken]>(); + + /** + * Fires when a user token fails to refresh. + * + * @param userId The ID of the user whose token wasn't successfully refreshed. + */ + readonly onRefreshFailure = this.registerEvent<[userId: string]>(); + + /** + * Creates a new auth provider with static credentials. + * + * @param clientId The client ID of your application. + * @param accessToken The access token to provide. + * + * You need to obtain one using one of the [Twitch OAuth flows](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/). + * @param scopes The scopes the supplied token has. + * + * If this argument is given, the scopes need to be correct, or weird things might happen. If it's not (i.e. it's `undefined`), we fetch the correct scopes for you. + * + * If you can't exactly say which scopes your token has, don't use this parameter/set it to `undefined`. + */ + constructor(deviceAuthConfig: DeviceAuthProviderConfig) { + super(); + + this._userId = extractUserId(deviceAuthConfig.userId); + this._clientId = deviceAuthConfig.clientId; + this._accessToken = + typeof deviceAuthConfig.accessToken === 'string' + ? { + accessToken: deviceAuthConfig.accessToken, + refreshToken: null, + scope: deviceAuthConfig.scopes ?? [], + expiresIn: null, + obtainmentTimestamp: Date.now(), + } + : deviceAuthConfig.accessToken; + this._scopes = deviceAuthConfig.scopes; + } + + /** + * The client ID. + */ + get clientId(): string { + return this._clientId; + } + + /** + * Gets the static access token. + * + * If the current access token does not have the requested scopes, this method throws. + * This makes supplying an access token with the correct scopes from the beginning necessary. + * + * @param user Ignored. + * @param scopeSets The requested scopes. + */ + async getAccessTokenForUser( + user: UserIdResolvable, + ...scopeSets: Array + ): Promise { + return await this._getAccessToken(scopeSets); + } + + /** + * Gets the static access token. + * + * If the current access token does not have the requested scopes, this method throws. + * This makes supplying an access token with the correct scopes from the beginning necessary. + * + * @param intent Ignored. + * @param scopeSets The requested scopes. + */ + async getAccessTokenForIntent( + intent: string, + ...scopeSets: Array + ): Promise { + return await this._getAccessToken(scopeSets); + } + + /** + * Gets the static access token. + */ + async getAnyAccessToken(): Promise { + return await this._getAccessToken(); + } + + /** + * The scopes that are currently available using the access token. + */ + getCurrentScopesForUser(): string[] { + return this._scopes ?? []; + } + + /** + * Requests that the provider fetches a new token from Twitch for the given user. + * + * @param user The user to refresh the token for. + */ + async refreshAccessTokenForUser(user: UserIdResolvable): Promise { + const userId = extractUserId(user); + + if (this._cachedRefreshFailures.has(userId)) { + throw new CachedRefreshFailureError(userId); + } + + const previousTokenData = this._accessToken; + + if (!previousTokenData) { + throw new Error('Trying to refresh non-existent token'); + } + + const tokenData = await this._refreshUserTokenWithCallback(userId, previousTokenData.refreshToken!); + + this._accessToken = tokenData; + this.emit(this.onRefresh, userId, tokenData); + + return { + ...tokenData, + userId, + }; + } + + /** + * Requests that the provider fetches a new token from Twitch for the given intent. + * + * @param intent The intent to refresh the token for. + */ + async refreshAccessTokenForIntent(intent: string): Promise { + const userId = this._userId!; + + return await this.refreshAccessTokenForUser(userId); + } + + private async _getAccessToken(requestedScopeSets?: Array): Promise { + const [scopes, userId] = await loadAndCompareTokenInfo( + this._clientId, + this._accessToken.accessToken, + this._userId, + this._scopes, + requestedScopeSets, + ); + + this._scopes = scopes; + this._userId = userId; + + return { ...this._accessToken, userId }; + } + + private async _refreshUserTokenWithCallback(userId: string, refreshToken: string): Promise { + try { + return await refreshUserToken(this.clientId, refreshToken); + } catch (e) { + this._cachedRefreshFailures.add(userId); + this.emit(this.onRefreshFailure, userId); + throw e; + } + } +} \ No newline at end of file diff --git a/src/backend/chat/twitch-chat.ts b/src/backend/chat/twitch-chat.ts index d33a9bbb8..4c96aae6e 100644 --- a/src/backend/chat/twitch-chat.ts +++ b/src/backend/chat/twitch-chat.ts @@ -8,7 +8,7 @@ import commandHandler from "./commands/commandHandler"; import * as twitchSlashCommandHandler from "./twitch-slash-command-handler"; import logger from "../logwrapper"; -import firebotStaticAuthProvider from "../auth/firebot-static-auth-provider"; +import firebotDeviceAuthProvider from "../auth/firebot-device-auth-provider"; import accountAccess from "../common/account-access"; import frontendCommunicator from "../common/frontend-communicator"; import twitchEventsHandler from "../events/twitch-events"; @@ -80,8 +80,8 @@ class TwitchChat extends EventEmitter { return; } - const streamerAuthProvider = firebotStaticAuthProvider.streamerProvider; - const botAuthProvider = firebotStaticAuthProvider.botProvider; + const streamerAuthProvider = firebotDeviceAuthProvider.streamerProvider; + const botAuthProvider = firebotDeviceAuthProvider.botProvider; if (streamerAuthProvider == null && botAuthProvider == null) { return; } @@ -131,7 +131,7 @@ class TwitchChat extends EventEmitter { } }); - await this._streamerChatClient.connect(); + this._streamerChatClient.connect(); await chatHelpers.handleChatConnect(); @@ -164,7 +164,7 @@ class TwitchChat extends EventEmitter { twitchChatListeners.setupBotChatListeners(this._botChatClient); - await this._botChatClient.connect(); + this._botChatClient.connect(); } catch (error) { logger.error("Error joining streamers chat channel with Bot account", error); } diff --git a/src/backend/common/account-access.js b/src/backend/common/account-access.js index e6c8b5fbf..ec3d80830 100644 --- a/src/backend/common/account-access.js +++ b/src/backend/common/account-access.js @@ -18,7 +18,7 @@ const accountEvents = new EventEmitter(); * @property {string} avatar - The avatar url for the account * @property {string} broadcasterType - "partner", "affiliate" or "" * @property {import("../auth/auth").AuthDetails} auth - Auth token details for the account - * @property {boolean} loggedIn - If the account is linked/logged in + * @property {boolean=} loggedIn - If the account is linked/logged in */ diff --git a/src/backend/effects/builtin/http-request.js b/src/backend/effects/builtin/http-request.js index c13664ad9..e3d6ce2cc 100644 --- a/src/backend/effects/builtin/http-request.js +++ b/src/backend/effects/builtin/http-request.js @@ -235,7 +235,7 @@ const effect = { headers = { ...headers, 'Authorization': `Bearer ${accessToken}`, - 'Client-ID': twitchAuth.TWITCH_CLIENT_ID + 'Client-ID': twitchAuth.twitchClientId }; } diff --git a/src/backend/twitch-api/api.ts b/src/backend/twitch-api/api.ts index 48b5d86e9..20981410a 100644 --- a/src/backend/twitch-api/api.ts +++ b/src/backend/twitch-api/api.ts @@ -1,9 +1,10 @@ import { ApiClient } from "@twurple/api"; -import { StaticAuthProvider } from "@twurple/auth"; +import { AuthProvider } from "@twurple/auth"; import logger from "../logwrapper"; import accountAccess from "../common/account-access"; +import { TwitchAuthApi } from "./resource/auth"; import { TwitchBitsApi } from "./resource/bits"; import { TwitchCategoriesApi } from "./resource/categories"; import { TwitchChannelRewardsApi } from "./resource/channel-rewards"; @@ -19,7 +20,7 @@ class TwitchApi { private _streamerClient: ApiClient; private _botClient: ApiClient; - setupApiClients(streamerProvider: StaticAuthProvider, botProvider: StaticAuthProvider): void { + setupApiClients(streamerProvider: AuthProvider, botProvider: AuthProvider): void { if (!streamerProvider && !botProvider) { return; } @@ -50,6 +51,10 @@ class TwitchApi { return this._botClient; } + get auth() { + return new TwitchAuthApi(this._streamerClient, this._botClient); + } + get bits() { return new TwitchBitsApi(this._streamerClient, this._botClient); } diff --git a/src/backend/twitch-api/pubsub/pubsub-client.js b/src/backend/twitch-api/pubsub/pubsub-client.js index d2e56e7d3..b7a078e84 100644 --- a/src/backend/twitch-api/pubsub/pubsub-client.js +++ b/src/backend/twitch-api/pubsub/pubsub-client.js @@ -2,7 +2,7 @@ const logger = require("../../logwrapper"); const accountAccess = require("../../common/account-access"); const frontendCommunicator = require("../../common/frontend-communicator"); -const firebotStaticAuthProvider = require("../../auth/firebot-static-auth-provider"); +const firebotDeviceAuthProvider = require("../../auth/firebot-device-auth-provider"); const chatRolesManager = require("../../roles/chat-roles-manager"); const { PubSubClient } = require("@twurple/pubsub"); @@ -58,7 +58,7 @@ async function createClient() { logger.info("Connecting to Twitch PubSub..."); - const authProvider = firebotStaticAuthProvider.streamerProvider; + const authProvider = firebotDeviceAuthProvider.streamerProvider; pubSubClient = new PubSubClient({ authProvider }); diff --git a/src/backend/twitch-api/resource/auth.ts b/src/backend/twitch-api/resource/auth.ts new file mode 100644 index 000000000..91eec3007 --- /dev/null +++ b/src/backend/twitch-api/resource/auth.ts @@ -0,0 +1,40 @@ +import logger from '../../logwrapper'; +import accountAccess from "../../common/account-access"; +import { ApiClient } from "@twurple/api"; + +export class TwitchAuthApi { + streamerClient: ApiClient; + botClient: ApiClient; + + constructor(streamerClient: ApiClient, botClient: ApiClient) { + this.streamerClient = streamerClient; + this.botClient = botClient; + } + + async isTokenValid(type: "streamer" | "bot"): Promise { + try { + let userId: string, apiClient: ApiClient; + + switch (type) { + case "streamer": + userId = accountAccess.getAccounts().streamer.userId; + apiClient = this.streamerClient; + break; + + case "bot": + userId = accountAccess.getAccounts().bot.userId; + apiClient = this.botClient; + break; + } + + // This shouldn only happen if an account is not logged in + if (!userId || !apiClient) return false; + + const token = await apiClient.getTokenInfo(); + return token?.userId === userId; + } catch (error) { + logger.error(`Failed to validate token`, error.message); + return false; + } + } +}; \ No newline at end of file diff --git a/src/gui/app/directives/modals/misc/botLoginModal.js b/src/gui/app/directives/modals/misc/botLoginModal.js deleted file mode 100644 index 2e09dab07..000000000 --- a/src/gui/app/directives/modals/misc/botLoginModal.js +++ /dev/null @@ -1,50 +0,0 @@ -"use strict"; - -(function() { - angular.module("firebotApp") - .component("botLoginModal", { - template: ` -
-

Bot Account Login

- -
-
-
-

Please copy the below URL and paste it into an incognito window. This avoids unintentionally logging in with your streamer account.

-
- - - - -
-
-
-
- `, - bindings: { - resolve: "<", - close: "&", - dismiss: "&" - }, - controller: function($rootScope, settingsService, ngToast, backendCommunicator) { - const $ctrl = this; - - backendCommunicator.on("accountUpdate", accounts => { - if (accounts.bot.loggedIn) { - $ctrl.dismiss(); - } - }); - - $ctrl.botLoginUrl = `http://localhost:${settingsService.getWebServerPort()}/api/v1/auth?providerId=${encodeURIComponent("twitch:bot-account")}`; - - $ctrl.copy = function() { - $rootScope.copyTextToClipboard($ctrl.botLoginUrl); - - ngToast.create({ - className: 'success', - content: 'Bot login url copied!' - }); - }; - } - }); -}()); diff --git a/src/gui/app/directives/modals/misc/twitch-login-modal.js b/src/gui/app/directives/modals/misc/twitch-login-modal.js new file mode 100644 index 000000000..375de5b7a --- /dev/null +++ b/src/gui/app/directives/modals/misc/twitch-login-modal.js @@ -0,0 +1,85 @@ +"use strict"; + +(function() { + angular.module("firebotApp") + .component("twitchLoginModal", { + template: ` +
+ +

Twitch {{$ctrl.accountType}} Account Login

+
+
+
+
Loading...
+
+
+

Let's get you logged into your {{$ctrl.accountType}} account!

+

+ Please copy the below URL and paste it into a browser window to login to your Twitch {{$ctrl.accountType}} account. + When logging into your bot account, you may want to use an Incognito window. This avoids unintentionally logging in with your streamer account. +

+

When you login, please enter or verify the code below:

+

{{$ctrl.code}}

+
+ + + + +
+
Once you're logged in, this dialog will close automatically.
+
+
+
+ `, + bindings: { + resolve: "<", + close: "&", + dismiss: "&" + }, + controller: function($rootScope, ngToast, backendCommunicator) { + const $ctrl = this; + $ctrl.loaded = false; + + backendCommunicator.on("device-code-received", (details) => { + $ctrl.loaded = true; + $ctrl.loginUrl = details.loginUrl; + $ctrl.code = details.code; + }); + + backendCommunicator.on("accountUpdate", accounts => { + switch ($ctrl.accountType) { + case "streamer": + if (accounts.streamer.loggedIn) { + $ctrl.dismiss(); + } + break; + case "bot": + if (accounts.bot.loggedIn) { + $ctrl.dismiss(); + } + break; + default: + break; + } + }); + + $ctrl.loginUrl = "https://www.twitch.tv/activate"; + $ctrl.code = ""; + + $ctrl.copy = function() { + $rootScope.copyTextToClipboard($ctrl.loginUrl); + + ngToast.create({ + className: 'success', + content: 'Twitch login URL copied!' + }); + }; + + $ctrl.$onInit = function() { + $ctrl.accountType = $ctrl.resolve.accountType; + + backendCommunicator.fireEventAsync("begin-device-auth", `twitch:${$ctrl.accountType}-account`); + }; + } + }); +}()); diff --git a/src/gui/app/index.html b/src/gui/app/index.html index 859f72502..4e8766454 100644 --- a/src/gui/app/index.html +++ b/src/gui/app/index.html @@ -278,7 +278,6 @@ - @@ -296,6 +295,7 @@ + @@ -474,7 +474,7 @@

{{'MAIN.MANAGE_LOGINS' | tran
The following account(s) have been logged out because they are out of date:
- {{ invalidAccounts.join(", ") }} + {{ invalidAccounts.join(", ") }}

Please log back in to continue.
diff --git a/src/gui/app/services/connection.service.js b/src/gui/app/services/connection.service.js index 1ffd7ea80..f81aafabd 100644 --- a/src/gui/app/services/connection.service.js +++ b/src/gui/app/services/connection.service.js @@ -38,15 +38,28 @@ if (service.accounts.streamer.loggedIn) { service.logout(type); } else { - shell.openExternal(`http://localhost:${settingsService.getWebServerPort()}/api/v1/auth?providerId=${encodeURIComponent("twitch:streamer-account")}`); + utilityService.showModal({ + component: "twitchLoginModal", + resolveObj: { + accountType: () => type + }, + closeCallback: () => { + backendCommunicator.send("cancel-device-token-check"); + } + }); } } else if (type === "bot") { if (service.accounts.bot.loggedIn) { service.logout(type); } else { utilityService.showModal({ - component: "botLoginModal", - size: 'sm' + component: "twitchLoginModal", + resolveObj: { + accountType: () => type + }, + closeCallback: () => { + backendCommunicator.send("cancel-device-token-check"); + } }); } } From 4990442898a62c9295ac56dfc0435d581036ca78 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Thu, 14 Dec 2023 12:54:19 -0500 Subject: [PATCH 002/184] fix: minor refactor fix --- src/backend/auth/twitch-auth.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/backend/auth/twitch-auth.ts b/src/backend/auth/twitch-auth.ts index c165cfbfc..1bf8b2811 100644 --- a/src/backend/auth/twitch-auth.ts +++ b/src/backend/auth/twitch-auth.ts @@ -124,13 +124,15 @@ class TwitchAuthProviders { }; } +const twitchAuthProviders = new TwitchAuthProviders(); + async function getUserCurrent(accessToken: string) { try { const response = await axios.get('https://api.twitch.tv/helix/users', { headers: { 'Authorization': `Bearer ${accessToken}`, 'User-Agent': 'Firebot v5', - 'Client-ID': this.twitchClientId + 'Client-ID': twitchAuthProviders.twitchClientId }, responseType: "json" }); @@ -147,8 +149,6 @@ async function getUserCurrent(accessToken: string) { return null; } -const twitchAuthProviders = new TwitchAuthProviders(); - authManager.on("auth-success", async authData => { const { providerId, tokenData } = authData; From 658783e65fc7c2c924c75ddb555e518e24ab64e2 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Thu, 14 Dec 2023 12:48:07 -0500 Subject: [PATCH 003/184] feat: Twitch Device Code Flow for login --- secrets.gpg | Bin 374 -> 371 bytes .../electron/events/when-ready.js | 4 +- src/backend/auth/auth-manager.js | 82 +++- src/backend/auth/auth.d.ts | 2 +- .../auth/firebot-device-auth-provider.ts | 141 +++++++ .../auth/firebot-static-auth-provider.ts | 45 --- src/backend/auth/twitch-auth.js | 217 ----------- src/backend/auth/twitch-auth.ts | 177 +++++++++ .../auth/twitch-device-auth-provider.ts | 361 ++++++++++++++++++ src/backend/chat/twitch-chat.ts | 10 +- src/backend/common/account-access.js | 2 +- src/backend/effects/builtin/http-request.js | 2 +- src/backend/twitch-api/api.ts | 9 +- .../twitch-api/pubsub/pubsub-client.js | 4 +- src/backend/twitch-api/resource/auth.ts | 40 ++ .../directives/modals/misc/botLoginModal.js | 50 --- .../modals/misc/twitch-login-modal.js | 85 +++++ src/gui/app/index.html | 4 +- src/gui/app/services/connection.service.js | 19 +- 19 files changed, 919 insertions(+), 335 deletions(-) create mode 100644 src/backend/auth/firebot-device-auth-provider.ts delete mode 100644 src/backend/auth/firebot-static-auth-provider.ts delete mode 100644 src/backend/auth/twitch-auth.js create mode 100644 src/backend/auth/twitch-auth.ts create mode 100644 src/backend/auth/twitch-device-auth-provider.ts create mode 100644 src/backend/twitch-api/resource/auth.ts delete mode 100644 src/gui/app/directives/modals/misc/botLoginModal.js create mode 100644 src/gui/app/directives/modals/misc/twitch-login-modal.js diff --git a/secrets.gpg b/secrets.gpg index ceb3316e745d515cf1bcb075b17f47c0f4a30de6..9225a6f8b2df2bb29753b7b366850510d5221e90 100644 GIT binary patch literal 371 zcmV-(0gV2P4Fm}T0;3WeQ*#l8_xjSnp#hlq7!bct=u?%y3~N`0a!h($AQHqG1ni#g zE{h88bBWKR^UpocHw#AIK(i=#@oXt8Kv!vT{~In&sCW9<3z9u}jGm<<2*f%!j9JYx z34>>~@QOSQ@VWrhZH6E?oQUV6q8jV-$I$QnCo?ILtF8H4k&q04@iTA%twMz#q3GPn z1P+B=Nrm5NvpFTzz(~}wJc#*JMgu&jM%O1by)~=4kV7(zYy(uTD~-0^Cjf1UViM*n z?|Ym>7@{L-L3C|XJiH8}Hwj#HE$i=a`1)rjs~L!yoabKb`!i>8|3~gWoiM zb5%DrQO1RqDX}%`JDkdbv>wkii51n`<5aG=dN)yAxaP)&e~bFkph3zo5ZSw`qNv`X z6Pbh3T=+75lSI&x;SQZRDerR#m9lf7!VJPEsl`f>B~8gvNFD&1$1`;crlbMIx=%vV zSgZ=Yg9ef0s9vW~(#?h7s0WF7UXatr!PUv3XuR{vYSfQERJ>|Cjwz!bcdY8AC~9zI`TlrD)K0R UM7FF;e(RhW;@9;ITHxf=eHGok-2eap diff --git a/src/backend/app-management/electron/events/when-ready.js b/src/backend/app-management/electron/events/when-ready.js index 908358d54..f1ece4bdb 100644 --- a/src/backend/app-management/electron/events/when-ready.js +++ b/src/backend/app-management/electron/events/when-ready.js @@ -38,8 +38,8 @@ exports.whenReady = async () => { const accountAccess = require("../../../common/account-access"); await accountAccess.updateAccountCache(false); - const firebotStaticAuthProvider = require("../../../auth/firebot-static-auth-provider"); - firebotStaticAuthProvider.setupStaticAuthProvider(); + const firebotDeviceAuthProvider = require("../../../auth/firebot-device-auth-provider"); + firebotDeviceAuthProvider.setupDeviceAuthProvider(); const connectionManager = require("../../../common/connection-manager"); diff --git a/src/backend/auth/auth-manager.js b/src/backend/auth/auth-manager.js index 9a8631233..60a715901 100644 --- a/src/backend/auth/auth-manager.js +++ b/src/backend/auth/auth-manager.js @@ -4,6 +4,7 @@ const EventEmitter = require("events"); const logger = require("../logwrapper"); const { settings } = require("../common/settings-access"); const OAuthClient = require("client-oauth2"); +const frontendCommunicator = require("../common/frontend-communicator"); const HTTP_PORT = settings.getWebServerPort(); @@ -27,14 +28,31 @@ class AuthManager extends EventEmitter { const oauthClient = this.buildOAuthClientForProvider(provider, redirectUri); - const authorizationUri = provider.auth.type === "token" - ? oauthClient.token.getUri() - : oauthClient.code.getUri(); + let authorizationUri = ""; + + switch (provider.auth.type) { + case "token": + authorizationUri = oauthClient.token.getUri(); + break; + + case "code": + authorizationUri = oauthClient.code.getUri(); + break; + + case "device": + authorizationUri = `${provider.auth.tokenHost}${provider.auth.authorizePath}`; + break; + } + + const tokenUri = provider.auth.type === "device" + ? `${provider.auth.tokenHost}${provider.auth.tokenPath ?? ""}` + : null; const authProvider = { id: provider.id, oauthClient: oauthClient, authorizationUri: authorizationUri, + tokenUri: tokenUri, redirectUri: redirectUri, details: provider }; @@ -64,7 +82,7 @@ class AuthManager extends EventEmitter { return new OAuthClient({ clientId: provider.client.id, - clientSecret: provider.auth.type === "token" ? null : provider.client.secret, + clientSecret: provider.auth.type === "code" ? provider.client.secret : null, accessTokenUri: provider.auth.type === "token" ? null : tokenUri, authorizationUri: authUri, redirectUri: redirectUri, @@ -114,4 +132,60 @@ class AuthManager extends EventEmitter { const manager = new AuthManager(); +frontendCommunicator.onAsync("begin-device-auth", async (providerId) => { + const provider = manager.getAuthProvider(providerId); + if (provider?.details?.auth?.type !== "device") { + return; + } + + const formData = new FormData(); + formData.append("client_id", provider.details.client.id); + formData.append("scopes", Array.isArray(provider.details.scopes) + ? provider.details.scopes.join(" ") + : provider.details.scopes); + + // Get the device auth request + const response = await fetch(provider.authorizationUri, { + method: "POST", + body: formData + }); + + if (response.ok) { + const deviceAuthData = await response.json(); + + frontendCommunicator.send("device-code-received", { + loginUrl: deviceAuthData.verification_uri, + code: deviceAuthData.user_code + }); + + const tokenRequestData = new FormData(); + tokenRequestData.append("client_id", provider.details.client.id); + tokenRequestData.append("scopes", Array.isArray(provider.details.scopes) + ? provider.details.scopes.join(" ") + : provider.details.scopes); + tokenRequestData.append("device_code", deviceAuthData.device_code); + tokenRequestData.append("grant_type", "urn:ietf:params:oauth:grant-type:device_code"); + + const tokenCheckInterval = setInterval(async () => { + const tokenResponse = await fetch(provider.tokenUri, { + method: "POST", + body: tokenRequestData + }); + + if (tokenResponse.ok) { + clearInterval(tokenCheckInterval); + const tokenData = await tokenResponse.json(); + + manager.successfulAuth(providerId, tokenData); + } + }, deviceAuthData.interval * 1000); + + frontendCommunicator.on("cancel-device-token-check", () => { + if (tokenCheckInterval) { + clearInterval(tokenCheckInterval); + } + }); + } +}); + module.exports = manager; \ No newline at end of file diff --git a/src/backend/auth/auth.d.ts b/src/backend/auth/auth.d.ts index a1a42fe00..1c940e1cb 100644 --- a/src/backend/auth/auth.d.ts +++ b/src/backend/auth/auth.d.ts @@ -8,7 +8,7 @@ export interface AuthProviderDefinition { secret?: string; }; auth: { - type: "code" | "token"; + type: "code" | "token" | "device"; tokenHost: string; authorizePath: string; tokenPath?: string; diff --git a/src/backend/auth/firebot-device-auth-provider.ts b/src/backend/auth/firebot-device-auth-provider.ts new file mode 100644 index 000000000..ea239123c --- /dev/null +++ b/src/backend/auth/firebot-device-auth-provider.ts @@ -0,0 +1,141 @@ +import logger from "../logwrapper"; +import accountAccess, { FirebotAccount } from "../common/account-access"; +import twitchAuth from "./twitch-auth"; +import TwitchApi from "../twitch-api/api"; +import { AuthDetails, AuthProviderDefinition } from "./auth"; +import { AccessToken, getExpiryDateOfAccessToken } from "@twurple/auth"; +import { DeviceAuthProvider } from "./twitch-device-auth-provider"; +import frontendCommunicator from "../common/frontend-communicator"; + +class FirebotDeviceAuthProvider { + streamerProvider: DeviceAuthProvider; + botProvider: DeviceAuthProvider; + + private onRefresh(accountType: "streamer" | "bot", userId: string, token: AccessToken): void { + const account: FirebotAccount = accountType === "streamer" + ? accountAccess.getAccounts().streamer + : accountAccess.getAccounts().bot; + + logger.debug(`Persisting ${accountType} access token`); + + const auth: AuthDetails = account.auth ?? { } as AuthDetails; + auth.access_token = token.accessToken; + auth.refresh_token = token.refreshToken; + auth.expires_in = token.expiresIn; + auth.obtainment_timestamp = token.obtainmentTimestamp; + auth.expires_at = getExpiryDateOfAccessToken({ + expiresIn: token.expiresIn, + obtainmentTimestamp: token.obtainmentTimestamp + }); + + account.auth = auth; + accountAccess.updateAccount(accountType, account, false); + } + + setupDeviceAuthProvider(): void { + if (accountAccess.getAccounts().streamer.loggedIn) { + const streamerAcccount = accountAccess.getAccounts().streamer; + + const scopes: string[] = Array.isArray(twitchAuth.streamerAccountProvider.scopes) + ? twitchAuth.streamerAccountProvider.scopes + : twitchAuth.streamerAccountProvider.scopes.split(" "); + + this.streamerProvider = new DeviceAuthProvider({ + userId: streamerAcccount.userId, + clientId: twitchAuth.twitchClientId, + accessToken: { + accessToken: streamerAcccount.auth.access_token, + refreshToken: streamerAcccount.auth.refresh_token, + expiresIn: streamerAcccount.auth.expires_in, + obtainmentTimestamp: streamerAcccount.auth.obtainment_timestamp ?? Date.now(), + scope: scopes + }, + scopes: scopes + }); + + this.streamerProvider.onRefresh((userId, token) => this.onRefresh("streamer", userId, token)); + } else { + this.streamerProvider = null; + } + + if (accountAccess.getAccounts().bot.loggedIn) { + const botAcccount = accountAccess.getAccounts().bot; + + const scopes: string[] = Array.isArray(twitchAuth.botAccountProvider.scopes) + ? twitchAuth.botAccountProvider.scopes + : twitchAuth.botAccountProvider.scopes.split(" "); + + this.botProvider = new DeviceAuthProvider({ + userId: botAcccount.userId, + clientId: twitchAuth.twitchClientId, + accessToken: { + accessToken: botAcccount.auth.access_token, + refreshToken: botAcccount.auth.refresh_token, + expiresIn: botAcccount.auth.expires_in, + obtainmentTimestamp: botAcccount.auth.obtainment_timestamp ?? Date.now(), + scope: scopes + }, + scopes: scopes + }); + + this.botProvider.onRefresh((userId, token) => this.onRefresh("bot", userId, token)); + } else { + this.botProvider = null; + } + + TwitchApi.setupApiClients(this.streamerProvider, this.botProvider); + } +} + +const isTwitchTokenDataValid = function(definition: AuthProviderDefinition, authDetails: AuthDetails): boolean { + const scopes = Array.isArray(definition.scopes) + ? definition.scopes + : definition.scopes.split(" "); + + return ( + // Ensure authDetails exist + authDetails && + + // Make sure we have a refresh token + authDetails.refresh_token && + + // Make sure there's at least some scopes + authDetails.scope && + authDetails.scope.length > 0 && + + // check all required scopes are present + scopes.every(scope => authDetails.scope.includes(scope)) + ); +}; + +const firebotDeviceAuthProvider = new FirebotDeviceAuthProvider(); + +accountAccess.events.on("account-update", () => { + firebotDeviceAuthProvider.setupDeviceAuthProvider(); +}); + +frontendCommunicator.onAsync("validate-twitch-account", async ({ accountType, authDetails }) => { + let definition: AuthProviderDefinition; + + switch (accountType) { + case "streamer": + definition = twitchAuth.streamerAccountProvider; + break; + + case "bot": + definition = twitchAuth.botAccountProvider; + break; + + default: + break; + } + + if (definition) { + return isTwitchTokenDataValid(definition, authDetails) + && await TwitchApi.auth.isTokenValid(accountType); + } + + return true; +}); + +export = firebotDeviceAuthProvider; \ No newline at end of file diff --git a/src/backend/auth/firebot-static-auth-provider.ts b/src/backend/auth/firebot-static-auth-provider.ts deleted file mode 100644 index 8fec5d001..000000000 --- a/src/backend/auth/firebot-static-auth-provider.ts +++ /dev/null @@ -1,45 +0,0 @@ -import accountAccess from "../common/account-access"; -import twitchAuth from "./twitch-auth"; -import TwitchApi from "../twitch-api/api"; -import { StaticAuthProvider } from "@twurple/auth"; - -class FirebotStaticAuthProvider { - streamerProvider: StaticAuthProvider; - botProvider: StaticAuthProvider; - - setupStaticAuthProvider(): void { - if (accountAccess.getAccounts().streamer.loggedIn) { - const streamerAcccount = accountAccess.getAccounts().streamer; - - this.streamerProvider = new StaticAuthProvider( - twitchAuth.TWITCH_CLIENT_ID, - streamerAcccount.auth.access_token, - twitchAuth.STREAMER_ACCOUNT_PROVIDER.scopes as string[] - ); - } else { - this.streamerProvider = null; - } - - if (accountAccess.getAccounts().bot.loggedIn) { - const botAcccount = accountAccess.getAccounts().bot; - - this.botProvider = new StaticAuthProvider( - twitchAuth.TWITCH_CLIENT_ID, - botAcccount.auth.access_token, - twitchAuth.BOT_ACCOUNT_PROVIDER.scopes as string[] - ); - } else { - this.botProvider = null; - } - - TwitchApi.setupApiClients(this.streamerProvider, this.botProvider); - } -} - -const firebotStaticAuthProvider = new FirebotStaticAuthProvider(); - -accountAccess.events.on("account-update", () => { - firebotStaticAuthProvider.setupStaticAuthProvider(); -}); - -export = firebotStaticAuthProvider; \ No newline at end of file diff --git a/src/backend/auth/twitch-auth.js b/src/backend/auth/twitch-auth.js deleted file mode 100644 index a35096c51..000000000 --- a/src/backend/auth/twitch-auth.js +++ /dev/null @@ -1,217 +0,0 @@ -"use strict"; - -const authManager = require("./auth-manager"); -const accountAccess = require("../common/account-access"); -const frontendCommunicator = require("../common/frontend-communicator"); -const logger = require("../logwrapper"); -const axios = require("axios").default; - -const { secrets } = require("../secrets-manager"); - -const TWITCH_CLIENT_ID = secrets.twitchClientId; - -exports.TWITCH_CLIENT_ID = TWITCH_CLIENT_ID; - -const HOST = "https://id.twitch.tv"; -const AUTHORIZE_PATH = "/oauth2/authorize"; - -const STREAMER_ACCOUNT_PROVIDER_ID = "twitch:streamer-account"; -const BOT_ACCOUNT_PROVIDER_ID = "twitch:bot-account"; - -/** - * @param {import("./auth").AuthProviderDefinition} definition - * @param {import("./auth").AuthDetails} authDetails - * @returns boolean - */ -const validator = function(definition, authDetails) { - return ( - // Ensure authDetails exist - authDetails && - - // Check for old auth code flow token - !authDetails.refresh_token && - - // Make sure there's at least some scopes - authDetails.scope && - authDetails.scope.length > 0 && - - // check all required scopes are present - definition.scopes.every(scope => authDetails.scope.includes(scope)) - ); -}; - -/** @type {import("./auth").AuthProviderDefinition} */ -const STREAMER_ACCOUNT_PROVIDER = { - id: STREAMER_ACCOUNT_PROVIDER_ID, - name: "Streamer Account", - client: { - id: TWITCH_CLIENT_ID - }, - auth: { - tokenHost: HOST, - authorizePath: AUTHORIZE_PATH, - type: "token" - }, - scopes: [ - 'bits:read', - 'channel:edit:commercial', - 'channel:manage:broadcast', - 'channel:manage:moderators', - 'channel:manage:polls', - 'channel:manage:predictions', - 'channel:manage:raids', - 'channel:manage:redemptions', - 'channel:manage:schedule', - 'channel:manage:videos', - 'channel:manage:vips', - 'channel:moderate', - 'channel:read:charity', - 'channel:read:editors', - 'channel:read:goals', - 'channel:read:hype_train', - 'channel:read:polls', - 'channel:read:predictions', - 'channel:read:redemptions', - 'channel:read:stream_key', - 'channel:read:subscriptions', - 'channel:read:vips', - 'channel_commercial', - 'channel_editor', - 'channel_read', - 'channel_subscriptions', - 'chat:edit', - 'chat:read', - 'clips:edit', - 'moderation:read', - 'moderator:manage:announcements', - 'moderator:manage:automod', - 'moderator:manage:automod_settings', - 'moderator:manage:banned_users', - 'moderator:manage:blocked_terms', - 'moderator:manage:chat_messages', - 'moderator:manage:chat_settings', - 'moderator:manage:shield_mode', - 'moderator:manage:shoutouts', - 'moderator:read:automod_settings', - 'moderator:read:blocked_terms', - 'moderator:read:chat_settings', - 'moderator:read:chatters', - 'moderator:read:followers', - 'moderator:read:shield_mode', - 'moderator:read:shoutouts', - 'user:edit:broadcast', - 'user:manage:blocked_users', - 'user:manage:whispers', - 'user:read:blocked_users', - 'user:read:broadcast', - 'user:read:follows', - 'user:read:subscriptions', - 'user_subscriptions', - 'user_follows_edit', - 'user_read', - 'whispers:edit', - 'whispers:read' - ] -}; - -/** @type {import("./auth").AuthProviderDefinition} */ -const BOT_ACCOUNT_PROVIDER = { - id: BOT_ACCOUNT_PROVIDER_ID, - name: "Bot Account", - client: { - id: TWITCH_CLIENT_ID - }, - auth: { - tokenHost: HOST, - authorizePath: AUTHORIZE_PATH, - type: "token" - }, - scopes: [ - 'channel:moderate', - 'chat:edit', - 'chat:read', - 'moderator:manage:announcements', - 'user:manage:whispers', - 'whispers:edit', - 'whispers:read', - 'channel_read' - ] -}; - -exports.STREAMER_ACCOUNT_PROVIDER = STREAMER_ACCOUNT_PROVIDER; -exports.BOT_ACCOUNT_PROVIDER = BOT_ACCOUNT_PROVIDER; - -exports.registerTwitchAuthProviders = () => { - authManager.registerAuthProvider(STREAMER_ACCOUNT_PROVIDER); - authManager.registerAuthProvider(BOT_ACCOUNT_PROVIDER); -}; - -async function getUserCurrent(accessToken) { - try { - const response = await axios.get('https://api.twitch.tv/helix/users', { - headers: { - 'Authorization': `Bearer ${accessToken}`, - 'User-Agent': 'Firebot v5', - 'Client-ID': TWITCH_CLIENT_ID - }, - responseType: "json" - }); - - if (response.status >= 200 && response.status <= 204) { - const userData = response.data; - if (userData.data && userData.data.length > 0) { - return userData.data[0]; - } - } - } catch (error) { - logger.error("Error getting current twitch user", error); - } - return null; -} - -authManager.on("auth-success", async authData => { - const { providerId, tokenData } = authData; - - if (providerId === STREAMER_ACCOUNT_PROVIDER_ID || providerId === BOT_ACCOUNT_PROVIDER_ID) { - const userData = await getUserCurrent(tokenData.access_token); - if (userData == null) { - return; - } - - const accountType = providerId === STREAMER_ACCOUNT_PROVIDER_ID ? "streamer" : "bot"; - const accountObject = { - username: userData.login, - displayName: userData.display_name, - channelId: userData.id, - userId: userData.id, - avatar: userData.profile_image_url, - broadcasterType: userData.broadcaster_type, - auth: tokenData - }; - - accountAccess.updateAccount(accountType, accountObject); - } -}); - -frontendCommunicator.on("validate-twitch-account", ({ accountType, authDetails }) => { - let definition; - - switch (accountType) { - case "streamer": - definition = STREAMER_ACCOUNT_PROVIDER; - break; - - case "bot": - definition = BOT_ACCOUNT_PROVIDER; - break; - - default: - break; - } - - if (definition) { - return validator(definition, authDetails); - } - - return true; -}); diff --git a/src/backend/auth/twitch-auth.ts b/src/backend/auth/twitch-auth.ts new file mode 100644 index 000000000..c165cfbfc --- /dev/null +++ b/src/backend/auth/twitch-auth.ts @@ -0,0 +1,177 @@ +import authManager from "./auth-manager"; +import accountAccess, { FirebotAccount } from "../common/account-access"; +import logger from "../logwrapper"; +import { secrets } from "../secrets-manager"; +import { AuthProviderDefinition } from "./auth"; + +const axios = require("axios").default; + +class TwitchAuthProviders { + private readonly _host = "https://id.twitch.tv"; + private readonly _authorizePath = "/oauth2/device"; + private readonly _tokenPath = "/oauth2/token"; + + readonly streamerAccountProviderId = "twitch:streamer-account"; + readonly botAccountProviderId = "twitch:bot-account"; + + readonly twitchClientId = secrets.twitchClientId; + + readonly streamerAccountProvider: AuthProviderDefinition = { + id: this.streamerAccountProviderId, + name: "Streamer Account", + client: { + id: this.twitchClientId + }, + auth: { + tokenHost: this._host, + authorizePath: this._authorizePath, + tokenPath: this._tokenPath, + type: "device" + }, + scopes: [ + 'bits:read', + 'channel:edit:commercial', + 'channel:manage:ads', + 'channel:manage:broadcast', + 'channel:manage:moderators', + 'channel:manage:polls', + 'channel:manage:predictions', + 'channel:manage:raids', + 'channel:manage:redemptions', + 'channel:manage:schedule', + 'channel:manage:videos', + 'channel:manage:vips', + 'channel:moderate', + 'channel:read:ads', + 'channel:read:charity', + 'channel:read:editors', + 'channel:read:goals', + 'channel:read:hype_train', + 'channel:read:polls', + 'channel:read:predictions', + 'channel:read:redemptions', + 'channel:read:stream_key', + 'channel:read:subscriptions', + 'channel:read:vips', + 'channel_commercial', + 'channel_editor', + 'channel_read', + 'channel_subscriptions', + 'chat:edit', + 'chat:read', + 'clips:edit', + 'moderation:read', + 'moderator:manage:announcements', + 'moderator:manage:automod', + 'moderator:manage:automod_settings', + 'moderator:manage:banned_users', + 'moderator:manage:blocked_terms', + 'moderator:manage:chat_messages', + 'moderator:manage:chat_settings', + 'moderator:manage:shield_mode', + 'moderator:manage:shoutouts', + 'moderator:read:automod_settings', + 'moderator:read:blocked_terms', + 'moderator:read:chat_settings', + 'moderator:read:chatters', + 'moderator:read:followers', + 'moderator:read:shield_mode', + 'moderator:read:shoutouts', + 'user:edit:broadcast', + 'user:manage:blocked_users', + 'user:manage:whispers', + 'user:read:blocked_users', + 'user:read:broadcast', + 'user:read:chat', + 'user:read:follows', + 'user:read:subscriptions', + 'user_subscriptions', + 'user_follows_edit', + 'user_read', + 'whispers:edit', + 'whispers:read' + ] + }; + + botAccountProvider: AuthProviderDefinition = { + id: this.botAccountProviderId, + name: "Bot Account", + client: { + id: this.twitchClientId + }, + auth: { + tokenHost: this._host, + authorizePath: this._authorizePath, + tokenPath: this._tokenPath, + type: "device" + }, + scopes: [ + 'channel:moderate', + 'chat:edit', + 'chat:read', + 'moderator:manage:announcements', + 'user:manage:whispers', + 'user:read:chat', + 'whispers:edit', + 'whispers:read', + 'channel_read' + ] + }; + + registerTwitchAuthProviders() { + authManager.registerAuthProvider(this.streamerAccountProvider); + authManager.registerAuthProvider(this.botAccountProvider); + }; +} + +async function getUserCurrent(accessToken: string) { + try { + const response = await axios.get('https://api.twitch.tv/helix/users', { + headers: { + 'Authorization': `Bearer ${accessToken}`, + 'User-Agent': 'Firebot v5', + 'Client-ID': this.twitchClientId + }, + responseType: "json" + }); + + if (response.status >= 200 && response.status <= 204) { + const userData = response.data; + if (userData.data && userData.data.length > 0) { + return userData.data[0]; + } + } + } catch (error) { + logger.error("Error getting current twitch user", error); + } + return null; +} + +const twitchAuthProviders = new TwitchAuthProviders(); + +authManager.on("auth-success", async authData => { + const { providerId, tokenData } = authData; + + if (providerId === twitchAuthProviders.streamerAccountProviderId + || providerId === twitchAuthProviders.botAccountProviderId) { + const userData = await getUserCurrent(tokenData.access_token); + if (userData == null) { + return; + } + + const accountType = providerId === twitchAuthProviders.streamerAccountProviderId ? "streamer" : "bot"; + const accountObject: FirebotAccount = { + username: userData.login, + displayName: userData.display_name, + channelId: userData.id, + userId: userData.id, + avatar: userData.profile_image_url, + broadcasterType: userData.broadcaster_type, + auth: tokenData + }; + + accountAccess.updateAccount(accountType, accountObject); + } +}); + +export = twitchAuthProviders; \ No newline at end of file diff --git a/src/backend/auth/twitch-device-auth-provider.ts b/src/backend/auth/twitch-device-auth-provider.ts new file mode 100644 index 000000000..5fca54fe1 --- /dev/null +++ b/src/backend/auth/twitch-device-auth-provider.ts @@ -0,0 +1,361 @@ +/** + * This file exists because there's currently no Twurple AuthProvider that supports Device Code Flow. + * Once one exists, this can go away. In the meantime, it stays in order to refresh tokens automagically. + */ + +import { Enumerable } from '@d-fischer/shared-utils'; +import { EventEmitter } from '@d-fischer/typed-event-emitter'; +import { CustomError, extractUserId, type UserIdResolvable } from '@twurple/common'; +import type { AccessToken, AccessTokenMaybeWithUserId, AccessTokenWithUserId, TokenInfoData } from '@twurple/auth'; +import { InvalidTokenError, TokenInfo } from '@twurple/auth'; +import type { AuthProvider } from '@twurple/auth'; +import { callTwitchApi, HttpStatusCodeError } from '@twurple/api-call'; + +const scopeEquivalencies = new Map([ + ['channel_commercial', ['channel:edit:commercial']], + ['channel_editor', ['channel:manage:broadcast']], + ['channel_read', ['channel:read:stream_key']], + ['channel_subscriptions', ['channel:read:subscriptions']], + ['user_blocks_read', ['user:read:blocked_users']], + ['user_blocks_edit', ['user:manage:blocked_users']], + ['user_follows_edit', ['user:edit:follows']], + ['user_read', ['user:read:email']], + ['user_subscriptions', ['user:read:subscriptions']], + ['user:edit:broadcast', ['channel:manage:broadcast', 'channel:manage:extensions']], +]); + +interface AccessTokenData { + access_token: string; + refresh_token: string; + expires_in?: number; + scope?: string[]; +} + +/** + * Thrown whenever you try to execute an action in the context of a user + * who is already known to have an invalid token saved in its {@link AuthProvider}. + */ +export class CachedRefreshFailureError extends CustomError { + constructor(public readonly userId: string) { + super(`The user context for the user ${userId} has been disabled. +This happened because the access token became invalid (e.g. by expiry) and refreshing it failed (e.g. because the account's password was changed). +The user will need to reauthenticate to continue.`); + } +} + +/** + * Gets information about an access token. + * + * @param accessToken The access token to get the information of. + * @param clientId The client ID of your application. + * + * You need to obtain one using one of the [Twitch OAuth flows](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/). + */ +async function getTokenInfo(accessToken: string, clientId?: string): Promise { + try { + const data = await callTwitchApi({ type: 'auth', url: 'validate' }, clientId, accessToken); + return new TokenInfo(data); + } catch (e) { + if (e instanceof HttpStatusCodeError && e.statusCode === 401) { + throw new InvalidTokenError({ cause: e }); + } + throw e; + } +} + +/** + * Compares scopes for a non-upgradable {@link AuthProvider} instance. + * + * @param scopesToCompare The scopes to compare against. + * @param requestedScopes The scopes you requested. + */ +function compareScopes(scopesToCompare: string[], requestedScopes?: string[]): void { + if (requestedScopes?.length) { + const scopes = new Set( + scopesToCompare.flatMap(scope => [scope, ...(scopeEquivalencies.get(scope) ?? [])]), + ); + + if (requestedScopes.every(scope => !scopes.has(scope))) { + const scopesStr = requestedScopes.join(', '); + throw new Error( + `This token does not have any of the requested scopes (${scopesStr}) and can not be upgraded. +If you need dynamically upgrading scopes, please implement the AuthProvider interface accordingly: + +\thttps://twurple.js.org/reference/auth/interfaces/AuthProvider.html`, + ); + } + } +} + +/** + * Compares scope sets for a non-upgradable {@link AuthProvider} instance. + * + * @param scopesToCompare The scopes to compare against. + * @param requestedScopeSets The scope sets you requested. + */ +function compareScopeSets(scopesToCompare: string[], requestedScopeSets: string[][]): void { + for (const requestedScopes of requestedScopeSets) { + compareScopes(scopesToCompare, requestedScopes); + } +} + +/** + * Compares scopes for a non-upgradable `AuthProvider` instance, loading them from the token if necessary, + * and returns them together with the user ID. + * + * @param clientId The client ID of your application. + * @param token The access token. + * @param userId The user ID that was already loaded. + * @param loadedScopes The scopes that were already loaded. + * @param requestedScopeSets The scope sets you requested. + */ +async function loadAndCompareTokenInfo( + clientId: string, + token: string, + userId?: string, + loadedScopes?: string[], + requestedScopeSets?: Array, +): Promise<[string[] | undefined, string]> { + // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing + if (requestedScopeSets?.length || !userId) { + const userInfo = await getTokenInfo(token, clientId); + if (!userInfo.userId) { + throw new Error('Trying to use an app access token as a user access token'); + } + + const scopesToCompare = loadedScopes ?? userInfo.scopes; + if (requestedScopeSets) { + compareScopeSets( + scopesToCompare, + requestedScopeSets.filter((val): val is string[] => Boolean(val)), + ); + } + + return [scopesToCompare, userInfo.userId]; + } + + return [loadedScopes, userId]; +} + +function createRefreshTokenQuery(clientId: string, refreshToken: string) { + return { + grant_type: 'refresh_token', + client_id: clientId, + refresh_token: refreshToken, + }; +} + +function createAccessTokenFromData(data: AccessTokenData): AccessToken { + return { + accessToken: data.access_token, + refreshToken: data.refresh_token || null, + scope: data.scope ?? [], + expiresIn: data.expires_in ?? null, + obtainmentTimestamp: Date.now(), + }; +} + +/** + * Refreshes an expired access token with your client credentials and the refresh token that was given by the initial authentication. + * + * @param clientId The client ID of your application. + * @param clientSecret The client secret of your application. + * @param refreshToken The refresh token. + */ +async function refreshUserToken( + clientId: string, + refreshToken: string, +): Promise { + return createAccessTokenFromData( + await callTwitchApi({ + type: 'auth', + url: 'token', + method: 'POST', + query: createRefreshTokenQuery(clientId, refreshToken), + }), + ); +} + +interface DeviceAuthProviderConfig { + userId: UserIdResolvable, + clientId: string, + accessToken: string | AccessToken, + scopes?: string[] +} + +/** + * An auth provider that always returns the same initially given credentials. + * + * This has the added benefit of refreshing tokens for Device Code Flow. + */ +export class DeviceAuthProvider extends EventEmitter implements AuthProvider { + /** @internal */ @Enumerable(false) private readonly _clientId: string; + /** @internal */ @Enumerable(false) private _accessToken: AccessToken; + private _userId?: string; + private _scopes?: string[]; + private readonly _cachedRefreshFailures = new Set(); + + /** + * Fires when a user token is refreshed. + * + * @param userId The ID of the user whose token was successfully refreshed. + * @param token The refreshed token data. + */ + readonly onRefresh = this.registerEvent<[userId: string, token: AccessToken]>(); + + /** + * Fires when a user token fails to refresh. + * + * @param userId The ID of the user whose token wasn't successfully refreshed. + */ + readonly onRefreshFailure = this.registerEvent<[userId: string]>(); + + /** + * Creates a new auth provider with static credentials. + * + * @param clientId The client ID of your application. + * @param accessToken The access token to provide. + * + * You need to obtain one using one of the [Twitch OAuth flows](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/). + * @param scopes The scopes the supplied token has. + * + * If this argument is given, the scopes need to be correct, or weird things might happen. If it's not (i.e. it's `undefined`), we fetch the correct scopes for you. + * + * If you can't exactly say which scopes your token has, don't use this parameter/set it to `undefined`. + */ + constructor(deviceAuthConfig: DeviceAuthProviderConfig) { + super(); + + this._userId = extractUserId(deviceAuthConfig.userId); + this._clientId = deviceAuthConfig.clientId; + this._accessToken = + typeof deviceAuthConfig.accessToken === 'string' + ? { + accessToken: deviceAuthConfig.accessToken, + refreshToken: null, + scope: deviceAuthConfig.scopes ?? [], + expiresIn: null, + obtainmentTimestamp: Date.now(), + } + : deviceAuthConfig.accessToken; + this._scopes = deviceAuthConfig.scopes; + } + + /** + * The client ID. + */ + get clientId(): string { + return this._clientId; + } + + /** + * Gets the static access token. + * + * If the current access token does not have the requested scopes, this method throws. + * This makes supplying an access token with the correct scopes from the beginning necessary. + * + * @param user Ignored. + * @param scopeSets The requested scopes. + */ + async getAccessTokenForUser( + user: UserIdResolvable, + ...scopeSets: Array + ): Promise { + return await this._getAccessToken(scopeSets); + } + + /** + * Gets the static access token. + * + * If the current access token does not have the requested scopes, this method throws. + * This makes supplying an access token with the correct scopes from the beginning necessary. + * + * @param intent Ignored. + * @param scopeSets The requested scopes. + */ + async getAccessTokenForIntent( + intent: string, + ...scopeSets: Array + ): Promise { + return await this._getAccessToken(scopeSets); + } + + /** + * Gets the static access token. + */ + async getAnyAccessToken(): Promise { + return await this._getAccessToken(); + } + + /** + * The scopes that are currently available using the access token. + */ + getCurrentScopesForUser(): string[] { + return this._scopes ?? []; + } + + /** + * Requests that the provider fetches a new token from Twitch for the given user. + * + * @param user The user to refresh the token for. + */ + async refreshAccessTokenForUser(user: UserIdResolvable): Promise { + const userId = extractUserId(user); + + if (this._cachedRefreshFailures.has(userId)) { + throw new CachedRefreshFailureError(userId); + } + + const previousTokenData = this._accessToken; + + if (!previousTokenData) { + throw new Error('Trying to refresh non-existent token'); + } + + const tokenData = await this._refreshUserTokenWithCallback(userId, previousTokenData.refreshToken!); + + this._accessToken = tokenData; + this.emit(this.onRefresh, userId, tokenData); + + return { + ...tokenData, + userId, + }; + } + + /** + * Requests that the provider fetches a new token from Twitch for the given intent. + * + * @param intent The intent to refresh the token for. + */ + async refreshAccessTokenForIntent(intent: string): Promise { + const userId = this._userId!; + + return await this.refreshAccessTokenForUser(userId); + } + + private async _getAccessToken(requestedScopeSets?: Array): Promise { + const [scopes, userId] = await loadAndCompareTokenInfo( + this._clientId, + this._accessToken.accessToken, + this._userId, + this._scopes, + requestedScopeSets, + ); + + this._scopes = scopes; + this._userId = userId; + + return { ...this._accessToken, userId }; + } + + private async _refreshUserTokenWithCallback(userId: string, refreshToken: string): Promise { + try { + return await refreshUserToken(this.clientId, refreshToken); + } catch (e) { + this._cachedRefreshFailures.add(userId); + this.emit(this.onRefreshFailure, userId); + throw e; + } + } +} \ No newline at end of file diff --git a/src/backend/chat/twitch-chat.ts b/src/backend/chat/twitch-chat.ts index d33a9bbb8..4c96aae6e 100644 --- a/src/backend/chat/twitch-chat.ts +++ b/src/backend/chat/twitch-chat.ts @@ -8,7 +8,7 @@ import commandHandler from "./commands/commandHandler"; import * as twitchSlashCommandHandler from "./twitch-slash-command-handler"; import logger from "../logwrapper"; -import firebotStaticAuthProvider from "../auth/firebot-static-auth-provider"; +import firebotDeviceAuthProvider from "../auth/firebot-device-auth-provider"; import accountAccess from "../common/account-access"; import frontendCommunicator from "../common/frontend-communicator"; import twitchEventsHandler from "../events/twitch-events"; @@ -80,8 +80,8 @@ class TwitchChat extends EventEmitter { return; } - const streamerAuthProvider = firebotStaticAuthProvider.streamerProvider; - const botAuthProvider = firebotStaticAuthProvider.botProvider; + const streamerAuthProvider = firebotDeviceAuthProvider.streamerProvider; + const botAuthProvider = firebotDeviceAuthProvider.botProvider; if (streamerAuthProvider == null && botAuthProvider == null) { return; } @@ -131,7 +131,7 @@ class TwitchChat extends EventEmitter { } }); - await this._streamerChatClient.connect(); + this._streamerChatClient.connect(); await chatHelpers.handleChatConnect(); @@ -164,7 +164,7 @@ class TwitchChat extends EventEmitter { twitchChatListeners.setupBotChatListeners(this._botChatClient); - await this._botChatClient.connect(); + this._botChatClient.connect(); } catch (error) { logger.error("Error joining streamers chat channel with Bot account", error); } diff --git a/src/backend/common/account-access.js b/src/backend/common/account-access.js index e6c8b5fbf..ec3d80830 100644 --- a/src/backend/common/account-access.js +++ b/src/backend/common/account-access.js @@ -18,7 +18,7 @@ const accountEvents = new EventEmitter(); * @property {string} avatar - The avatar url for the account * @property {string} broadcasterType - "partner", "affiliate" or "" * @property {import("../auth/auth").AuthDetails} auth - Auth token details for the account - * @property {boolean} loggedIn - If the account is linked/logged in + * @property {boolean=} loggedIn - If the account is linked/logged in */ diff --git a/src/backend/effects/builtin/http-request.js b/src/backend/effects/builtin/http-request.js index c13664ad9..e3d6ce2cc 100644 --- a/src/backend/effects/builtin/http-request.js +++ b/src/backend/effects/builtin/http-request.js @@ -235,7 +235,7 @@ const effect = { headers = { ...headers, 'Authorization': `Bearer ${accessToken}`, - 'Client-ID': twitchAuth.TWITCH_CLIENT_ID + 'Client-ID': twitchAuth.twitchClientId }; } diff --git a/src/backend/twitch-api/api.ts b/src/backend/twitch-api/api.ts index 48b5d86e9..20981410a 100644 --- a/src/backend/twitch-api/api.ts +++ b/src/backend/twitch-api/api.ts @@ -1,9 +1,10 @@ import { ApiClient } from "@twurple/api"; -import { StaticAuthProvider } from "@twurple/auth"; +import { AuthProvider } from "@twurple/auth"; import logger from "../logwrapper"; import accountAccess from "../common/account-access"; +import { TwitchAuthApi } from "./resource/auth"; import { TwitchBitsApi } from "./resource/bits"; import { TwitchCategoriesApi } from "./resource/categories"; import { TwitchChannelRewardsApi } from "./resource/channel-rewards"; @@ -19,7 +20,7 @@ class TwitchApi { private _streamerClient: ApiClient; private _botClient: ApiClient; - setupApiClients(streamerProvider: StaticAuthProvider, botProvider: StaticAuthProvider): void { + setupApiClients(streamerProvider: AuthProvider, botProvider: AuthProvider): void { if (!streamerProvider && !botProvider) { return; } @@ -50,6 +51,10 @@ class TwitchApi { return this._botClient; } + get auth() { + return new TwitchAuthApi(this._streamerClient, this._botClient); + } + get bits() { return new TwitchBitsApi(this._streamerClient, this._botClient); } diff --git a/src/backend/twitch-api/pubsub/pubsub-client.js b/src/backend/twitch-api/pubsub/pubsub-client.js index d2e56e7d3..b7a078e84 100644 --- a/src/backend/twitch-api/pubsub/pubsub-client.js +++ b/src/backend/twitch-api/pubsub/pubsub-client.js @@ -2,7 +2,7 @@ const logger = require("../../logwrapper"); const accountAccess = require("../../common/account-access"); const frontendCommunicator = require("../../common/frontend-communicator"); -const firebotStaticAuthProvider = require("../../auth/firebot-static-auth-provider"); +const firebotDeviceAuthProvider = require("../../auth/firebot-device-auth-provider"); const chatRolesManager = require("../../roles/chat-roles-manager"); const { PubSubClient } = require("@twurple/pubsub"); @@ -58,7 +58,7 @@ async function createClient() { logger.info("Connecting to Twitch PubSub..."); - const authProvider = firebotStaticAuthProvider.streamerProvider; + const authProvider = firebotDeviceAuthProvider.streamerProvider; pubSubClient = new PubSubClient({ authProvider }); diff --git a/src/backend/twitch-api/resource/auth.ts b/src/backend/twitch-api/resource/auth.ts new file mode 100644 index 000000000..91eec3007 --- /dev/null +++ b/src/backend/twitch-api/resource/auth.ts @@ -0,0 +1,40 @@ +import logger from '../../logwrapper'; +import accountAccess from "../../common/account-access"; +import { ApiClient } from "@twurple/api"; + +export class TwitchAuthApi { + streamerClient: ApiClient; + botClient: ApiClient; + + constructor(streamerClient: ApiClient, botClient: ApiClient) { + this.streamerClient = streamerClient; + this.botClient = botClient; + } + + async isTokenValid(type: "streamer" | "bot"): Promise { + try { + let userId: string, apiClient: ApiClient; + + switch (type) { + case "streamer": + userId = accountAccess.getAccounts().streamer.userId; + apiClient = this.streamerClient; + break; + + case "bot": + userId = accountAccess.getAccounts().bot.userId; + apiClient = this.botClient; + break; + } + + // This shouldn only happen if an account is not logged in + if (!userId || !apiClient) return false; + + const token = await apiClient.getTokenInfo(); + return token?.userId === userId; + } catch (error) { + logger.error(`Failed to validate token`, error.message); + return false; + } + } +}; \ No newline at end of file diff --git a/src/gui/app/directives/modals/misc/botLoginModal.js b/src/gui/app/directives/modals/misc/botLoginModal.js deleted file mode 100644 index 2e09dab07..000000000 --- a/src/gui/app/directives/modals/misc/botLoginModal.js +++ /dev/null @@ -1,50 +0,0 @@ -"use strict"; - -(function() { - angular.module("firebotApp") - .component("botLoginModal", { - template: ` -
-

Bot Account Login

- -
-
-
-

Please copy the below URL and paste it into an incognito window. This avoids unintentionally logging in with your streamer account.

-
- - - - -
-
-
-
- `, - bindings: { - resolve: "<", - close: "&", - dismiss: "&" - }, - controller: function($rootScope, settingsService, ngToast, backendCommunicator) { - const $ctrl = this; - - backendCommunicator.on("accountUpdate", accounts => { - if (accounts.bot.loggedIn) { - $ctrl.dismiss(); - } - }); - - $ctrl.botLoginUrl = `http://localhost:${settingsService.getWebServerPort()}/api/v1/auth?providerId=${encodeURIComponent("twitch:bot-account")}`; - - $ctrl.copy = function() { - $rootScope.copyTextToClipboard($ctrl.botLoginUrl); - - ngToast.create({ - className: 'success', - content: 'Bot login url copied!' - }); - }; - } - }); -}()); diff --git a/src/gui/app/directives/modals/misc/twitch-login-modal.js b/src/gui/app/directives/modals/misc/twitch-login-modal.js new file mode 100644 index 000000000..375de5b7a --- /dev/null +++ b/src/gui/app/directives/modals/misc/twitch-login-modal.js @@ -0,0 +1,85 @@ +"use strict"; + +(function() { + angular.module("firebotApp") + .component("twitchLoginModal", { + template: ` +
+ +

Twitch {{$ctrl.accountType}} Account Login

+
+
+
+
Loading...
+
+
+

Let's get you logged into your {{$ctrl.accountType}} account!

+

+ Please copy the below URL and paste it into a browser window to login to your Twitch {{$ctrl.accountType}} account. + When logging into your bot account, you may want to use an Incognito window. This avoids unintentionally logging in with your streamer account. +

+

When you login, please enter or verify the code below:

+

{{$ctrl.code}}

+
+ + + + +
+
Once you're logged in, this dialog will close automatically.
+
+
+
+ `, + bindings: { + resolve: "<", + close: "&", + dismiss: "&" + }, + controller: function($rootScope, ngToast, backendCommunicator) { + const $ctrl = this; + $ctrl.loaded = false; + + backendCommunicator.on("device-code-received", (details) => { + $ctrl.loaded = true; + $ctrl.loginUrl = details.loginUrl; + $ctrl.code = details.code; + }); + + backendCommunicator.on("accountUpdate", accounts => { + switch ($ctrl.accountType) { + case "streamer": + if (accounts.streamer.loggedIn) { + $ctrl.dismiss(); + } + break; + case "bot": + if (accounts.bot.loggedIn) { + $ctrl.dismiss(); + } + break; + default: + break; + } + }); + + $ctrl.loginUrl = "https://www.twitch.tv/activate"; + $ctrl.code = ""; + + $ctrl.copy = function() { + $rootScope.copyTextToClipboard($ctrl.loginUrl); + + ngToast.create({ + className: 'success', + content: 'Twitch login URL copied!' + }); + }; + + $ctrl.$onInit = function() { + $ctrl.accountType = $ctrl.resolve.accountType; + + backendCommunicator.fireEventAsync("begin-device-auth", `twitch:${$ctrl.accountType}-account`); + }; + } + }); +}()); diff --git a/src/gui/app/index.html b/src/gui/app/index.html index 859f72502..4e8766454 100644 --- a/src/gui/app/index.html +++ b/src/gui/app/index.html @@ -278,7 +278,6 @@ - @@ -296,6 +295,7 @@ + @@ -474,7 +474,7 @@

{{'MAIN.MANAGE_LOGINS' | tran
The following account(s) have been logged out because they are out of date:
- {{ invalidAccounts.join(", ") }} + {{ invalidAccounts.join(", ") }}

Please log back in to continue.
diff --git a/src/gui/app/services/connection.service.js b/src/gui/app/services/connection.service.js index 1ffd7ea80..f81aafabd 100644 --- a/src/gui/app/services/connection.service.js +++ b/src/gui/app/services/connection.service.js @@ -38,15 +38,28 @@ if (service.accounts.streamer.loggedIn) { service.logout(type); } else { - shell.openExternal(`http://localhost:${settingsService.getWebServerPort()}/api/v1/auth?providerId=${encodeURIComponent("twitch:streamer-account")}`); + utilityService.showModal({ + component: "twitchLoginModal", + resolveObj: { + accountType: () => type + }, + closeCallback: () => { + backendCommunicator.send("cancel-device-token-check"); + } + }); } } else if (type === "bot") { if (service.accounts.bot.loggedIn) { service.logout(type); } else { utilityService.showModal({ - component: "botLoginModal", - size: 'sm' + component: "twitchLoginModal", + resolveObj: { + accountType: () => type + }, + closeCallback: () => { + backendCommunicator.send("cancel-device-token-check"); + } }); } } From 563223cb73daaef064565a67c8ea6a00717309a6 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Thu, 14 Dec 2023 12:54:19 -0500 Subject: [PATCH 004/184] fix: minor refactor fix --- src/backend/auth/twitch-auth.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/backend/auth/twitch-auth.ts b/src/backend/auth/twitch-auth.ts index c165cfbfc..1bf8b2811 100644 --- a/src/backend/auth/twitch-auth.ts +++ b/src/backend/auth/twitch-auth.ts @@ -124,13 +124,15 @@ class TwitchAuthProviders { }; } +const twitchAuthProviders = new TwitchAuthProviders(); + async function getUserCurrent(accessToken: string) { try { const response = await axios.get('https://api.twitch.tv/helix/users', { headers: { 'Authorization': `Bearer ${accessToken}`, 'User-Agent': 'Firebot v5', - 'Client-ID': this.twitchClientId + 'Client-ID': twitchAuthProviders.twitchClientId }, responseType: "json" }); @@ -147,8 +149,6 @@ async function getUserCurrent(accessToken: string) { return null; } -const twitchAuthProviders = new TwitchAuthProviders(); - authManager.on("auth-success", async authData => { const { providerId, tokenData } = authData; From c5c8d075621b39ef5f91091315a5f08437bf3e79 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Thu, 14 Dec 2023 14:36:14 -0500 Subject: [PATCH 005/184] fix: Twitch token validity check async --- src/gui/app/services/connection.service.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/gui/app/services/connection.service.js b/src/gui/app/services/connection.service.js index f81aafabd..4b405728a 100644 --- a/src/gui/app/services/connection.service.js +++ b/src/gui/app/services/connection.service.js @@ -75,11 +75,11 @@ } }; - service.validateAccounts = () => { + service.validateAccounts = async () => { const invalidAccounts = []; if (service.accounts["streamer"].loggedIn) { - if (!backendCommunicator.fireEventSync("validate-twitch-account", { + if (!await backendCommunicator.fireEventAsync("validate-twitch-account", { accountType: "streamer", authDetails: service.accounts["streamer"].auth })) { @@ -89,7 +89,7 @@ } if (service.accounts["bot"].loggedIn) { - if (!backendCommunicator.fireEventSync("validate-twitch-account", { + if (!await backendCommunicator.fireEventAsync("validate-twitch-account", { accountType: "bot", authDetails: service.accounts["bot"].auth })) { From 25b6bf6fd3aaa3dda2de6862aab859f18579c0a6 Mon Sep 17 00:00:00 2001 From: SReject Date: Thu, 14 Dec 2023 17:39:43 -0500 Subject: [PATCH 006/184] chore: update ecmascript version to 2022 --- .eslintrc.js | 2 +- tsconfig.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index 9389f46ca..48047cd2c 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -7,7 +7,7 @@ module.exports = { // "parser": "babel-parser", "parserOptions": { // "parser": "babel-parser", - "ecmaVersion": "2020" + "ecmaVersion": "2022" }, "env": { diff --git a/tsconfig.json b/tsconfig.json index e7dacca2a..4df69f1dd 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -16,7 +16,7 @@ "paths": { "*": ["node_modules/*"] }, - "target": "ES2020" + "target": "ES2022" }, "include": [ "src/**/*", From e285e9084f2d8e39d9d6a1f6a848757c7cd5967b Mon Sep 17 00:00:00 2001 From: Dennis Rijsdijk Date: Fri, 15 Dec 2023 17:53:41 +0100 Subject: [PATCH 007/184] feat: screenshot currently active scene --- .../obs/effects/take-obs-source-screenshot.ts | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/src/backend/integrations/builtin/obs/effects/take-obs-source-screenshot.ts b/src/backend/integrations/builtin/obs/effects/take-obs-source-screenshot.ts index 31a38dbaa..af0a91310 100644 --- a/src/backend/integrations/builtin/obs/effects/take-obs-source-screenshot.ts +++ b/src/backend/integrations/builtin/obs/effects/take-obs-source-screenshot.ts @@ -1,5 +1,5 @@ import { EffectType } from "../../../../../types/effects"; -import {OBSSource, OBSSourceScreenshotSettings, takeSourceScreenshot} from "../obs-remote"; +import {getCurrentSceneName, OBSSource, OBSSourceScreenshotSettings, takeSourceScreenshot} from "../obs-remote"; import * as fs from "fs"; import logger from "../../../../logwrapper"; @@ -10,6 +10,7 @@ export const TakeOBSSourceScreenshotEffectType: EffectType<{ height: number; width: number; quality: number; + useActiveScene: boolean; }> = { definition: { id: "firebot:obs-source-screenshot", @@ -20,13 +21,20 @@ export const TakeOBSSourceScreenshotEffectType: EffectType<{ }, optionsTemplate: ` - + {{$select.selected.name}} ({{$select.selected.type}})
+ +
+ +
@@ -36,7 +44,7 @@ export const TakeOBSSourceScreenshotEffectType: EffectType<{ Image Format
-
@@ -47,7 +55,8 @@ const deepmerge = require("deepmerge"); editLabel: "Edit", validationText: "Text cannot be empty", noneAddedText: "None saved", - noDuplicates: false + noDuplicates: false, + maxItems: undefined }; @@ -63,6 +72,10 @@ const deepmerge = require("deepmerge"); } }; + $ctrl.maxItemsReached = () => { + return $ctrl.settings.maxItems != null && $ctrl.model.length >= $ctrl.settings.maxItems; + }; + function openGetInputModal(model, isNew = true, cb) { utilityService.openGetInputModal( { From 426249db665f874088becd112a26a2a86c3283ed Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sat, 16 Dec 2023 17:17:55 -0500 Subject: [PATCH 011/184] feat: EventSub integration --- package-lock.json | 366 ++++++++++----- package.json | 9 +- src/backend/chat/chat-helpers.js | 12 +- .../chat-listeners/twitch-chat-listeners.js | 11 +- src/backend/chat/twitch-chat.ts | 3 - src/backend/common/connection-manager.js | 3 + src/backend/common/user-access.js | 1 - src/backend/effects/builtin-effect-loader.js | 20 +- .../effects/builtin/twitch-shoutout.ts | 54 --- ...pprove-reject-channel-reward-redemption.ts | 6 +- .../builtin/twitch/cancel-prediction.ts | 39 ++ .../effects/builtin/twitch/create-poll.ts | 85 ++++ .../builtin/twitch/create-prediction.ts | 73 +++ .../{ => twitch}/create-stream-marker.ts | 8 +- .../effects/builtin/twitch/end-poll.ts | 45 ++ .../effects/builtin/twitch/lock-prediction.ts | 39 ++ .../effects/builtin/{ => twitch}/raid.ts | 10 +- .../builtin/twitch/resolve-prediction.ts | 55 +++ .../effects/builtin/twitch/shoutout.ts | 55 +++ .../events/builtin/twitchEventSource.js | 391 +++++++++++++++- src/backend/events/twitch-events.js | 7 + src/backend/events/twitch-events/charity.ts | 88 ++++ src/backend/events/twitch-events/gift-sub.ts | 2 +- src/backend/events/twitch-events/goal.ts | 54 +++ .../events/twitch-events/hype-train.ts | 64 +++ src/backend/events/twitch-events/poll.ts | 67 +++ .../events/twitch-events/prediction.ts | 66 +++ src/backend/events/twitch-events/shoutout.ts | 23 + src/backend/events/twitch-events/stream.ts | 25 ++ .../events/twitch-events/viewer-arrived.ts | 2 +- .../events/twitch-events/viewer-timeout.ts | 2 +- src/backend/twitch-api/api.ts | 20 + .../twitch-api/eventsub/eventsub-client.ts | 417 ++++++++++++++++++ src/backend/twitch-api/follow-poll.js | 63 --- .../twitch-api/pubsub/pubsub-client.js | 69 --- src/backend/twitch-api/resource/auth.ts | 12 +- src/backend/twitch-api/resource/bits.ts | 10 +- src/backend/twitch-api/resource/categories.ts | 12 +- .../twitch-api/resource/channel-rewards.ts | 39 +- src/backend/twitch-api/resource/channels.ts | 30 +- src/backend/twitch-api/resource/charity.ts | 29 ++ src/backend/twitch-api/resource/chat.ts | 36 +- src/backend/twitch-api/resource/moderation.ts | 22 +- src/backend/twitch-api/resource/polls.ts | 71 +++ .../twitch-api/resource/predictions.ts | 99 +++++ src/backend/twitch-api/resource/streams.ts | 12 +- .../twitch-api/resource/subscriptions.ts | 47 ++ src/backend/twitch-api/resource/teams.ts | 12 +- src/backend/twitch-api/resource/users.ts | 22 +- src/backend/twitch-api/resource/whispers.ts | 14 +- .../variables/builtin-variable-loader.js | 18 +- .../builtin/charity-campaign-goal.ts | 37 ++ .../builtin/charity-campaign-total.ts | 37 ++ .../variables/builtin/charity-description.ts | 28 ++ src/backend/variables/builtin/charity-logo.ts | 28 ++ src/backend/variables/builtin/charity-name.ts | 28 ++ .../variables/builtin/charity-website.ts | 28 ++ .../variables/builtin/donation-amount.js | 3 +- .../variables/builtin/donation-from.js | 3 +- .../variables/builtin/hype-train-level.ts | 21 + .../variables/builtin/hype-train-percent.ts | 21 + src/backend/variables/builtin/moderator.js | 4 +- .../builtin/poll-winning-choice-name.ts | 22 + .../builtin/poll-winning-choice-votes.ts | 22 + .../prediction-winning-outcome-name.ts | 21 + src/backend/variables/builtin/sub-count.js | 34 -- src/backend/variables/builtin/sub-points.js | 49 -- .../variables/builtin/twitch/sub-count.ts | 17 + .../variables/builtin/twitch/sub-points.ts | 17 + src/backend/variables/builtin/viewer-count.ts | 21 + src/types/effects.d.ts | 1 + 71 files changed, 2644 insertions(+), 537 deletions(-) delete mode 100644 src/backend/effects/builtin/twitch-shoutout.ts rename src/backend/effects/builtin/{ => twitch}/approve-reject-channel-reward-redemption.ts (93%) create mode 100644 src/backend/effects/builtin/twitch/cancel-prediction.ts create mode 100644 src/backend/effects/builtin/twitch/create-poll.ts create mode 100644 src/backend/effects/builtin/twitch/create-prediction.ts rename src/backend/effects/builtin/{ => twitch}/create-stream-marker.ts (78%) create mode 100644 src/backend/effects/builtin/twitch/end-poll.ts create mode 100644 src/backend/effects/builtin/twitch/lock-prediction.ts rename src/backend/effects/builtin/{ => twitch}/raid.ts (87%) create mode 100644 src/backend/effects/builtin/twitch/resolve-prediction.ts create mode 100644 src/backend/effects/builtin/twitch/shoutout.ts create mode 100644 src/backend/events/twitch-events/charity.ts create mode 100644 src/backend/events/twitch-events/goal.ts create mode 100644 src/backend/events/twitch-events/hype-train.ts create mode 100644 src/backend/events/twitch-events/poll.ts create mode 100644 src/backend/events/twitch-events/prediction.ts create mode 100644 src/backend/events/twitch-events/shoutout.ts create mode 100644 src/backend/events/twitch-events/stream.ts create mode 100644 src/backend/twitch-api/eventsub/eventsub-client.ts delete mode 100644 src/backend/twitch-api/follow-poll.js create mode 100644 src/backend/twitch-api/resource/charity.ts create mode 100644 src/backend/twitch-api/resource/polls.ts create mode 100644 src/backend/twitch-api/resource/predictions.ts create mode 100644 src/backend/twitch-api/resource/subscriptions.ts create mode 100644 src/backend/variables/builtin/charity-campaign-goal.ts create mode 100644 src/backend/variables/builtin/charity-campaign-total.ts create mode 100644 src/backend/variables/builtin/charity-description.ts create mode 100644 src/backend/variables/builtin/charity-logo.ts create mode 100644 src/backend/variables/builtin/charity-name.ts create mode 100644 src/backend/variables/builtin/charity-website.ts create mode 100644 src/backend/variables/builtin/hype-train-level.ts create mode 100644 src/backend/variables/builtin/hype-train-percent.ts create mode 100644 src/backend/variables/builtin/poll-winning-choice-name.ts create mode 100644 src/backend/variables/builtin/poll-winning-choice-votes.ts create mode 100644 src/backend/variables/builtin/prediction-winning-outcome-name.ts delete mode 100644 src/backend/variables/builtin/sub-count.js delete mode 100644 src/backend/variables/builtin/sub-points.js create mode 100644 src/backend/variables/builtin/twitch/sub-count.ts create mode 100644 src/backend/variables/builtin/twitch/sub-points.ts create mode 100644 src/backend/variables/builtin/viewer-count.ts diff --git a/package-lock.json b/package-lock.json index cf909d0e2..6fe369ec5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,10 +12,11 @@ "@aws-sdk/client-polly": "^3.26.0", "@crowbartools/firebot-custom-scripts-types": "^5.53.2-6", "@nut-tree/nut-js": "^3.1.1", - "@twurple/api": "^6.0.9", - "@twurple/auth": "^6.0.9", - "@twurple/chat": "^6.0.9", - "@twurple/pubsub": "^6.0.9", + "@twurple/api": "^7.0.6", + "@twurple/auth": "^7.0.6", + "@twurple/chat": "^7.0.6", + "@twurple/eventsub-ws": "^7.0.6", + "@twurple/pubsub": "^7.0.6", "@zunderscore/elgato-light-control": "^1.1.2", "angular": "^1.8.0", "angular-animate": "^1.7.8", @@ -1113,15 +1114,14 @@ } }, "node_modules/@d-fischer/connection": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/@d-fischer/connection/-/connection-8.0.2.tgz", - "integrity": "sha512-ZMUZS06pPgaUACIiXUIN/dXCrFUnKCALOvCcskLKSqhz7P/qOple949TnTE319Zokc63Pz+XTMiSW0vhinvlfw==", + "version": "8.0.5", + "resolved": "https://registry.npmjs.org/@d-fischer/connection/-/connection-8.0.5.tgz", + "integrity": "sha512-F/rMmwVTE9/Rq2BzEU8CRoEVRvpUiSvazt56XgRp15oAbT9GC4D4CIfd4YlPxD5j63ueUjs0b+RDEN7BULrpRQ==", "dependencies": { "@d-fischer/isomorphic-ws": "^7.0.0", "@d-fischer/logger": "^4.2.1", "@d-fischer/shared-utils": "^3.5.0", "@d-fischer/typed-event-emitter": "^3.3.0", - "@types/node": "^16.7.10", "@types/ws": "^8.5.4", "tslib": "^2.4.1", "ws": "^8.11.0" @@ -1130,11 +1130,6 @@ "url": "https://github.com/sponsors/d-fischer" } }, - "node_modules/@d-fischer/connection/node_modules/@types/node": { - "version": "16.18.12", - "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.12.tgz", - "integrity": "sha512-vzLe5NaNMjIE3mcddFVGlAXN1LEWueUsMsOJWaT6wWMJGyljHAWHznqfnKUQWGzu7TLPrGvWdNAsvQYW+C0xtw==" - }, "node_modules/@d-fischer/cross-fetch": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/@d-fischer/cross-fetch/-/cross-fetch-4.1.0.tgz", @@ -1230,11 +1225,10 @@ "integrity": "sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==" }, "node_modules/@d-fischer/shared-utils": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/@d-fischer/shared-utils/-/shared-utils-3.5.0.tgz", - "integrity": "sha512-Aa3Rg0iijXubxGH/ux3s6ITOMDOpA7dI/WvTCigGKI62QtfTsfutL1j8S7H4y6zPnI7Im2yro7QMozDJgceYkg==", + "version": "3.6.3", + "resolved": "https://registry.npmjs.org/@d-fischer/shared-utils/-/shared-utils-3.6.3.tgz", + "integrity": "sha512-Lz+Qk1WJLVoeREOHPZcIDTHOoxecxMSG2sq+x1xWYCH1exqiMKMMx06pXdy15UzHG7ohvQRNXk2oHqZ9EOl9jQ==", "dependencies": { - "@types/node": "^14.11.2", "tslib": "^2.4.1" }, "funding": { @@ -1242,11 +1236,10 @@ } }, "node_modules/@d-fischer/typed-event-emitter": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/@d-fischer/typed-event-emitter/-/typed-event-emitter-3.3.0.tgz", - "integrity": "sha512-A8cFoHtzUgk4JHIsyEB+7SegBjyOmNxeTl2BwU+VVcbnyNCXfbFdC0fUYZTls7bdEpqH1GSBw9nlo2zk8ttQNw==", + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/@d-fischer/typed-event-emitter/-/typed-event-emitter-3.3.2.tgz", + "integrity": "sha512-M+fZQxiAA6UTwaTNeDhNoQcQG+eg9B85cNTw4FwwmN0ZEi6IfvXS0cnLFW1Ec86TdnFkoQ1VHxGx4pTtKPVe1Q==", "dependencies": { - "@types/node": "^14.11.2", "tslib": "^2.4.0" }, "funding": { @@ -2238,22 +2231,22 @@ } }, "node_modules/@nut-tree/libnut": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/@nut-tree/libnut/-/libnut-2.5.1.tgz", - "integrity": "sha512-W41FRAuA2fT7Y44+9A59NWzYhNA6Qibuvxgx9Sf5bQ5QrLIAyKGWjRpW/doUXaTAwUOvcqg7TC2w7jrn9nwkAA==", + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/@nut-tree/libnut/-/libnut-2.5.2.tgz", + "integrity": "sha512-IwlGgalGQjjCrbPq52HTLtsR6MRsGJ6c4GhgHmgwJPD/yBVCzsU5EA2rwDgjKSgK+jiLOpykySDZQ+owhyd1zw==", "dependencies": { - "@nut-tree/libnut-darwin": "2.5.1", - "@nut-tree/libnut-linux": "2.5.1", - "@nut-tree/libnut-win32": "2.5.1" + "@nut-tree/libnut-darwin": "2.5.2", + "@nut-tree/libnut-linux": "2.5.2", + "@nut-tree/libnut-win32": "2.5.2" }, "engines": { "node": ">=10.15.3" } }, "node_modules/@nut-tree/libnut-darwin": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/@nut-tree/libnut-darwin/-/libnut-darwin-2.5.1.tgz", - "integrity": "sha512-JIr5Plmm9n5aoOAmwjghCtbmOY4FzOTypRN/mlb5N+68aX+w5RpgOV2HXmcQPbtqYTTOoSEGRBdzK8M36KHRsw==", + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/@nut-tree/libnut-darwin/-/libnut-darwin-2.5.2.tgz", + "integrity": "sha512-OKqCgpBbZj2oNQkLM+mM7TyiLBAQsRyN7Q5UXVKbyXnzcQTU1FZBJ1mLGvdfzzspajznL3Mkl08AQE+xYYbTMw==", "cpu": [ "x64", "arm64" @@ -2274,9 +2267,9 @@ } }, "node_modules/@nut-tree/libnut-linux": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/@nut-tree/libnut-linux/-/libnut-linux-2.5.1.tgz", - "integrity": "sha512-2rXZsOpx5U6cJE1zGfrDa6fGaAr1cQFJInsmpV55vg93/k0X5RY6iXLNbBXot/NBJKrTcQRIHeKpffLRk8fKPg==", + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/@nut-tree/libnut-linux/-/libnut-linux-2.5.2.tgz", + "integrity": "sha512-uY6XDuNE8soYRUhV23g6KQN5BRR43MYNLyPnrrQa5Wtfgm6oW9kBRu6JtkWz6Fn6trAWrVAKnbPoTiEgHuGz9w==", "cpu": [ "x64", "arm64" @@ -2297,9 +2290,9 @@ } }, "node_modules/@nut-tree/libnut-win32": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/@nut-tree/libnut-win32/-/libnut-win32-2.5.1.tgz", - "integrity": "sha512-Y95nMNM6WeioPrfzsGjvzUxtIQGYXfooFjSEUaGOA3pxP6bQlmfhVPYZrxwYtFr7mDoxHE9/PrDg1qiYtYhZkw==", + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/@nut-tree/libnut-win32/-/libnut-win32-2.5.2.tgz", + "integrity": "sha512-cnNAQ0pzUMH7hrSjTWRiFfXid3sbSZ78jpv1rA154dlka3wqo6m1OtaX4PLVQK4irZl5REz74iPdHcjeTy9rtg==", "cpu": [ "x64", "arm64" @@ -2319,10 +2312,23 @@ "@nut-tree/node-mac-permissions": "2.2.1" } }, + "node_modules/@nut-tree/node-mac-permissions": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/@nut-tree/node-mac-permissions/-/node-mac-permissions-2.2.1.tgz", + "integrity": "sha512-yoijwCqt2yS9UFTv7THGUwZgy2D2TorN703QpYNOergbTJ6vEmeG379pIZDfBuvf56n24RMzKJVoSqr9WIq/Yw==", + "optional": true, + "os": [ + "darwin" + ], + "dependencies": { + "bindings": "1.5.0", + "node-addon-api": "5.0.0" + } + }, "node_modules/@nut-tree/nut-js": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/@nut-tree/nut-js/-/nut-js-3.1.1.tgz", - "integrity": "sha512-0o+9docVUTgbJ4dA+lYT9LHIHf5rpV3IlTxHsx9hlwsFOiIbxOHB98+/+1IcQpHrAjRF/MhzQ8lVpFud+5hTGw==", + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@nut-tree/nut-js/-/nut-js-3.1.2.tgz", + "integrity": "sha512-hi7DBZz9O/t4goeQu3hKeauQbb0PcBmurScl3/t5L3I1pub3ibV24sft8KNSS3INKnGCj7I3Ma5iNHQ24g+95g==", "cpu": [ "x64", "arm64" @@ -2333,9 +2339,9 @@ "win32" ], "dependencies": { - "@nut-tree/libnut": "2.5.1", + "@nut-tree/libnut": "2.5.2", "clipboardy": "2.3.0", - "jimp": "0.16.2", + "jimp": "0.16.13", "node-abort-controller": "2.0.0" } }, @@ -2372,17 +2378,19 @@ "integrity": "sha512-OvjF+z51L3ov0OyAU0duzsYuvO01PH7x4t6DJx+guahgTnBHkhJdG7soQeTSFLWN3efnHyibZ4Z8l2EuWwJN3A==" }, "node_modules/@twurple/api": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/api/-/api-6.0.9.tgz", - "integrity": "sha512-ZWiMEG7hc6p0m0fxyR5iqYWy1wY2d30COQ4rvdh6FatYc9lb95nIy7BY9NCRdvH0l1GZaADzMhUu+NrVihBEIg==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/api/-/api-7.0.6.tgz", + "integrity": "sha512-Fe8haADUI+m4juCuNxtkWBX2HkCU6FA2+2Biq2/KRTp50FVRCeOBdDQpkdM4r+T2KE0NaiTpiH2rtaRodkR/gQ==", "dependencies": { "@d-fischer/cache-decorators": "^3.0.0", + "@d-fischer/cross-fetch": "^5.0.1", "@d-fischer/detect-node": "^3.0.1", "@d-fischer/logger": "^4.2.1", "@d-fischer/rate-limiter": "^0.7.2", - "@d-fischer/shared-utils": "^3.4.0", - "@twurple/api-call": "6.0.9", - "@twurple/common": "6.0.9", + "@d-fischer/shared-utils": "^3.6.1", + "@d-fischer/typed-event-emitter": "^3.3.1", + "@twurple/api-call": "7.0.6", + "@twurple/common": "7.0.6", "retry": "^0.13.1", "tslib": "^2.0.3" }, @@ -2390,7 +2398,7 @@ "url": "https://github.com/sponsors/d-fischer" }, "peerDependencies": { - "@twurple/auth": "6.0.9" + "@twurple/auth": "7.0.6" } }, "node_modules/@twurple/api-call": { @@ -2409,16 +2417,23 @@ "url": "https://github.com/sponsors/d-fischer" } }, + "node_modules/@twurple/api/node_modules/@d-fischer/cross-fetch": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/@d-fischer/cross-fetch/-/cross-fetch-5.0.3.tgz", + "integrity": "sha512-PAxxY2MJff3DUZP6uYWAo0gvp7lGry8SjZ07H661RBnJviy91o+NWR5C7E67dMvrSGvfA1kZC0xrwk+v4eTcMA==", + "dependencies": { + "node-fetch": "^2.6.12" + } + }, "node_modules/@twurple/api/node_modules/@twurple/api-call": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/api-call/-/api-call-6.0.9.tgz", - "integrity": "sha512-9X6usnG7JudEkwCar/OqTn5GgqFYR9sSzuWfe87fKjYv8W6oac2Rze4TBgNQ8pQrHHNDjRTEW2Ra8xhGBjoYGQ==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/api-call/-/api-call-7.0.6.tgz", + "integrity": "sha512-3E9IAJRyRLji9bjmZzicWv/wP9aGVdIDkzaX4WaK3sTRC9EkZ3nWIxSj0WmJ977O2lDsUkpgxzwmskuDqdaTrQ==", "dependencies": { - "@d-fischer/cross-fetch": "^4.0.2", + "@d-fischer/cross-fetch": "^5.0.1", "@d-fischer/qs": "^7.0.2", - "@d-fischer/shared-utils": "^3.4.0", - "@twurple/common": "6.0.9", - "@types/node-fetch": "^2.5.7", + "@d-fischer/shared-utils": "^3.6.1", + "@twurple/common": "7.0.6", "tslib": "^2.0.3" }, "funding": { @@ -2426,11 +2441,11 @@ } }, "node_modules/@twurple/api/node_modules/@twurple/common": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/common/-/common-6.0.9.tgz", - "integrity": "sha512-PKMXI5krHCaZT274vi4cBZn7t4Nq2zJc8illBr/inHwuuG6GYhFzRs5hBLdl5GL+F3hSyDpiD5MNLGLsfKPkWg==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/common/-/common-7.0.6.tgz", + "integrity": "sha512-38cufsx5k1ruUNrorXsiyTVBnFCXPFgr+MMkpMoFnh3T5G9drT3RkmE6Ss7oeaK6Glr/ihQNIPL6NzTJkGmXhA==", "dependencies": { - "@d-fischer/shared-utils": "^3.4.0", + "@d-fischer/shared-utils": "^3.6.1", "klona": "^2.0.4", "tslib": "^2.0.3" }, @@ -2438,6 +2453,25 @@ "url": "https://github.com/sponsors/d-fischer" } }, + "node_modules/@twurple/api/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, "node_modules/@twurple/api/node_modules/retry": { "version": "0.13.1", "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", @@ -2447,30 +2481,38 @@ } }, "node_modules/@twurple/auth": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/auth/-/auth-6.0.9.tgz", - "integrity": "sha512-t9vFmiVD0QKsWjAYAQ0NnpeGFtxiTi3R+dIBASwYbadSbnNTIQtocW3csD2b+pUb4dzsRMNwhz8eWiUY/Lc03w==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/auth/-/auth-7.0.6.tgz", + "integrity": "sha512-kgjSdLRW9NKk9LD8dySkgjXDxzJQFAiNIBZFbQNgTqSn7A2ZwaxmapIxy7FcHyGV0MdRtimScnRbKK9Nm089Xw==", "dependencies": { "@d-fischer/logger": "^4.2.1", - "@d-fischer/shared-utils": "^3.4.0", - "@twurple/api-call": "6.0.9", - "@twurple/common": "6.0.9", + "@d-fischer/shared-utils": "^3.6.1", + "@d-fischer/typed-event-emitter": "^3.3.1", + "@twurple/api-call": "7.0.6", + "@twurple/common": "7.0.6", "tslib": "^2.0.3" }, "funding": { "url": "https://github.com/sponsors/d-fischer" } }, + "node_modules/@twurple/auth/node_modules/@d-fischer/cross-fetch": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/@d-fischer/cross-fetch/-/cross-fetch-5.0.3.tgz", + "integrity": "sha512-PAxxY2MJff3DUZP6uYWAo0gvp7lGry8SjZ07H661RBnJviy91o+NWR5C7E67dMvrSGvfA1kZC0xrwk+v4eTcMA==", + "dependencies": { + "node-fetch": "^2.6.12" + } + }, "node_modules/@twurple/auth/node_modules/@twurple/api-call": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/api-call/-/api-call-6.0.9.tgz", - "integrity": "sha512-9X6usnG7JudEkwCar/OqTn5GgqFYR9sSzuWfe87fKjYv8W6oac2Rze4TBgNQ8pQrHHNDjRTEW2Ra8xhGBjoYGQ==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/api-call/-/api-call-7.0.6.tgz", + "integrity": "sha512-3E9IAJRyRLji9bjmZzicWv/wP9aGVdIDkzaX4WaK3sTRC9EkZ3nWIxSj0WmJ977O2lDsUkpgxzwmskuDqdaTrQ==", "dependencies": { - "@d-fischer/cross-fetch": "^4.0.2", + "@d-fischer/cross-fetch": "^5.0.1", "@d-fischer/qs": "^7.0.2", - "@d-fischer/shared-utils": "^3.4.0", - "@twurple/common": "6.0.9", - "@types/node-fetch": "^2.5.7", + "@d-fischer/shared-utils": "^3.6.1", + "@twurple/common": "7.0.6", "tslib": "^2.0.3" }, "funding": { @@ -2478,11 +2520,11 @@ } }, "node_modules/@twurple/auth/node_modules/@twurple/common": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/common/-/common-6.0.9.tgz", - "integrity": "sha512-PKMXI5krHCaZT274vi4cBZn7t4Nq2zJc8illBr/inHwuuG6GYhFzRs5hBLdl5GL+F3hSyDpiD5MNLGLsfKPkWg==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/common/-/common-7.0.6.tgz", + "integrity": "sha512-38cufsx5k1ruUNrorXsiyTVBnFCXPFgr+MMkpMoFnh3T5G9drT3RkmE6Ss7oeaK6Glr/ihQNIPL6NzTJkGmXhA==", "dependencies": { - "@d-fischer/shared-utils": "^3.4.0", + "@d-fischer/shared-utils": "^3.6.1", "klona": "^2.0.4", "tslib": "^2.0.3" }, @@ -2490,34 +2532,53 @@ "url": "https://github.com/sponsors/d-fischer" } }, + "node_modules/@twurple/auth/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, "node_modules/@twurple/chat": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/chat/-/chat-6.0.9.tgz", - "integrity": "sha512-sRaO4p3UYgzEorsOYPPHsM+FebzEEg2dIum7bFIbg8OsqyESqMcTcsfeLMgxJjnncDmT4uZ3cdpVGntsqfQPsw==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/chat/-/chat-7.0.6.tgz", + "integrity": "sha512-sHfJ6oYb8+++qX8KGlKOlkkJnXbCHmslRwv5xMr88eze/4x/URcx+nHGTcRpzgk0qtSDdIDfCFcH2t/TWE5lBw==", "dependencies": { "@d-fischer/cache-decorators": "^3.0.0", "@d-fischer/deprecate": "^2.0.2", "@d-fischer/logger": "^4.2.1", "@d-fischer/rate-limiter": "^0.7.2", - "@d-fischer/shared-utils": "^3.4.0", + "@d-fischer/shared-utils": "^3.6.1", "@d-fischer/typed-event-emitter": "^3.3.0", - "@twurple/common": "6.0.9", - "ircv3": "^0.31.6", + "@twurple/common": "7.0.6", + "ircv3": "^0.32.3", "tslib": "^2.0.3" }, "funding": { "url": "https://github.com/sponsors/d-fischer" }, "peerDependencies": { - "@twurple/auth": "6.0.9" + "@twurple/auth": "7.0.6" } }, "node_modules/@twurple/chat/node_modules/@twurple/common": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/common/-/common-6.0.9.tgz", - "integrity": "sha512-PKMXI5krHCaZT274vi4cBZn7t4Nq2zJc8illBr/inHwuuG6GYhFzRs5hBLdl5GL+F3hSyDpiD5MNLGLsfKPkWg==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/common/-/common-7.0.6.tgz", + "integrity": "sha512-38cufsx5k1ruUNrorXsiyTVBnFCXPFgr+MMkpMoFnh3T5G9drT3RkmE6Ss7oeaK6Glr/ihQNIPL6NzTJkGmXhA==", "dependencies": { - "@d-fischer/shared-utils": "^3.4.0", + "@d-fischer/shared-utils": "^3.6.1", "klona": "^2.0.4", "tslib": "^2.0.3" }, @@ -2538,31 +2599,95 @@ "url": "https://github.com/sponsors/d-fischer" } }, + "node_modules/@twurple/eventsub-base": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/eventsub-base/-/eventsub-base-7.0.6.tgz", + "integrity": "sha512-itUQo5c1mZdXpukVC51ZOoWQo+0pBjydbjSVxZ+BBD95a7WmOAnp4FNKl8caqfSlzQaqA7GvmTJCiPreXin3qw==", + "dependencies": { + "@d-fischer/logger": "^4.2.1", + "@d-fischer/shared-utils": "^3.6.1", + "@d-fischer/typed-event-emitter": "^3.3.0", + "@twurple/api": "7.0.6", + "@twurple/auth": "7.0.6", + "@twurple/common": "7.0.6", + "tslib": "^2.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + } + }, + "node_modules/@twurple/eventsub-base/node_modules/@twurple/common": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/common/-/common-7.0.6.tgz", + "integrity": "sha512-38cufsx5k1ruUNrorXsiyTVBnFCXPFgr+MMkpMoFnh3T5G9drT3RkmE6Ss7oeaK6Glr/ihQNIPL6NzTJkGmXhA==", + "dependencies": { + "@d-fischer/shared-utils": "^3.6.1", + "klona": "^2.0.4", + "tslib": "^2.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + } + }, + "node_modules/@twurple/eventsub-ws": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/eventsub-ws/-/eventsub-ws-7.0.6.tgz", + "integrity": "sha512-n0JsJ7gTEadvd8saHbXHBO77nmvCBROjVIm3itIFELhLgtn3437wxJ+Ne+yuEKwln8WmZn0JWmVCEHoTWGQehw==", + "dependencies": { + "@d-fischer/connection": "^8.0.5", + "@d-fischer/logger": "^4.2.1", + "@d-fischer/shared-utils": "^3.6.1", + "@d-fischer/typed-event-emitter": "^3.3.0", + "@twurple/auth": "7.0.6", + "@twurple/common": "7.0.6", + "@twurple/eventsub-base": "7.0.6", + "tslib": "^2.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + }, + "peerDependencies": { + "@twurple/api": "7.0.6" + } + }, + "node_modules/@twurple/eventsub-ws/node_modules/@twurple/common": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/common/-/common-7.0.6.tgz", + "integrity": "sha512-38cufsx5k1ruUNrorXsiyTVBnFCXPFgr+MMkpMoFnh3T5G9drT3RkmE6Ss7oeaK6Glr/ihQNIPL6NzTJkGmXhA==", + "dependencies": { + "@d-fischer/shared-utils": "^3.6.1", + "klona": "^2.0.4", + "tslib": "^2.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + } + }, "node_modules/@twurple/pubsub": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/pubsub/-/pubsub-6.0.9.tgz", - "integrity": "sha512-ZHGuLdpV47s3fiy7DAl4x10zbm8ml6aG+W/V3Q/50z/XndKbxw3Khz7bW7CRBEGOb7Rqsnrs9qmah3lHcsJmSQ==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/pubsub/-/pubsub-7.0.6.tgz", + "integrity": "sha512-RM6t3pFpyHcF5c9RtPP3MC3IkhqYiiag8mHIDMVnhmBRfjTeANuDP/Rex6xzREx/tQlTYQ9vM8K1pbrKrFgPCg==", "dependencies": { - "@d-fischer/connection": "^8.0.2", + "@d-fischer/connection": "^8.0.5", "@d-fischer/logger": "^4.2.1", - "@d-fischer/shared-utils": "^3.4.0", + "@d-fischer/shared-utils": "^3.6.1", "@d-fischer/typed-event-emitter": "^3.3.0", - "@twurple/common": "6.0.9", + "@twurple/common": "7.0.6", "tslib": "^2.0.3" }, "funding": { "url": "https://github.com/sponsors/d-fischer" }, "peerDependencies": { - "@twurple/auth": "6.0.9" + "@twurple/auth": "7.0.6" } }, "node_modules/@twurple/pubsub/node_modules/@twurple/common": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/@twurple/common/-/common-6.0.9.tgz", - "integrity": "sha512-PKMXI5krHCaZT274vi4cBZn7t4Nq2zJc8illBr/inHwuuG6GYhFzRs5hBLdl5GL+F3hSyDpiD5MNLGLsfKPkWg==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@twurple/common/-/common-7.0.6.tgz", + "integrity": "sha512-38cufsx5k1ruUNrorXsiyTVBnFCXPFgr+MMkpMoFnh3T5G9drT3RkmE6Ss7oeaK6Glr/ihQNIPL6NzTJkGmXhA==", "dependencies": { - "@d-fischer/shared-utils": "^3.4.0", + "@d-fischer/shared-utils": "^3.6.1", "klona": "^2.0.4", "tslib": "^2.0.3" }, @@ -2741,9 +2866,9 @@ "integrity": "sha512-7axfYN8SW9pWg78NgenHasSproWQee5rzyPVLC9HpaQSDgNArsnKJD88EaMfi4Pl48AyciO3agYCFqpHS1gLpg==" }, "node_modules/@types/ws": { - "version": "8.5.4", - "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.4.tgz", - "integrity": "sha512-zdQDHKUgcX/zBc4GrwsE/7dVdAD8JR4EuiAXiiUhhfyIJXXb2+PrGshFyeXWQPMmmZ2XxgaqclgpIC7eTXc1mg==", + "version": "8.5.5", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.5.tgz", + "integrity": "sha512-lwhs8hktwxSjf9UaZ9tG5M03PGogvFaH8gUgLNbN9HKIg0dvv6q+gkSuJ8HN4/VbyxkuLzCjlN7GquQ0gUJfIg==", "dependencies": { "@types/node": "*" } @@ -4939,9 +5064,9 @@ } }, "node_modules/electron": { - "version": "27.1.2", - "resolved": "https://registry.npmjs.org/electron/-/electron-27.1.2.tgz", - "integrity": "sha512-Dy6BUuGLiIJv+zfsXwr78TV2TNppi24rXF4PIIS+OjDblEKdkI9r1iM8JUd3/x3sbGUy5mdLMSPhvmu//IhkgA==", + "version": "27.1.3", + "resolved": "https://registry.npmjs.org/electron/-/electron-27.1.3.tgz", + "integrity": "sha512-7eD8VMhhlL5J531OOawn00eMthUkX1e3qN5Nqd7eMK8bg5HxQBrn8bdPlvUEnCano9KhrVwaDnGeuzWoDOGpjQ==", "hasInstallScript": true, "dependencies": { "@electron/get": "^2.0.0", @@ -5574,9 +5699,9 @@ } }, "node_modules/electron/node_modules/@types/node": { - "version": "18.18.14", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", - "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "version": "18.19.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.0.tgz", + "integrity": "sha512-667KNhaD7U29mT5wf+TZUnrzPrlL2GNQ5N0BMjO2oNULhBxX0/FKCkm6JMu0Jh7Z+1LwUlR21ekd7KhIboNFNw==", "dependencies": { "undici-types": "~5.26.4" } @@ -8201,16 +8326,15 @@ } }, "node_modules/ircv3": { - "version": "0.31.6", - "resolved": "https://registry.npmjs.org/ircv3/-/ircv3-0.31.6.tgz", - "integrity": "sha512-dRrP2+JrhPjn7eMiUPo8+aySR2fMqflpGrxUpeN1Nau4BW4UmXqXKgkEy51LD+/uIVxwUCtrOGaPNrgcq/8Ctg==", + "version": "0.32.3", + "resolved": "https://registry.npmjs.org/ircv3/-/ircv3-0.32.3.tgz", + "integrity": "sha512-H0ejwbIPzJO73PPGJGrdEDrqRxxK0f+6/7kNZ7yY/ukTDZ8zy7w7mN4wMbmOFrnPYO78ZKnbeqmkBRgcVJ552Q==", "dependencies": { - "@d-fischer/connection": "^8.0.2", + "@d-fischer/connection": "^8.0.5", "@d-fischer/escape-string-regexp": "^5.0.0", "@d-fischer/logger": "^4.2.1", "@d-fischer/shared-utils": "^3.5.0", "@d-fischer/typed-event-emitter": "^3.3.0", - "@types/node": "^14.14.19", "klona": "^2.0.5", "tslib": "^2.4.1" }, @@ -8665,14 +8789,14 @@ "integrity": "sha512-nO6jcEfZWQXDhOiBtG2KvKyEptz7RVbpGP4vTD2hLBdmNQSsCiicO2Ioinv6UI4y9ukqnBpy+XZ9H6uLNgJTlw==" }, "node_modules/jimp": { - "version": "0.16.2", - "resolved": "https://registry.npmjs.org/jimp/-/jimp-0.16.2.tgz", - "integrity": "sha512-UpItBk81a92f8oEyoGYbO3YK4QcM0hoIyuGHmShoF9Ov63P5Qo7Q/X2xsAgnODmSuDJFOtrPtJd5GSWW4LKdOQ==", + "version": "0.16.13", + "resolved": "https://registry.npmjs.org/jimp/-/jimp-0.16.13.tgz", + "integrity": "sha512-Bxz8q7V4rnCky9A0ktTNGA9SkNFVWRHodddI/DaAWZJzF7sVUlFYKQ60y9JGqrKpi48ECA/TnfMzzc5C70VByA==", "dependencies": { "@babel/runtime": "^7.7.2", - "@jimp/custom": "^0.16.2", - "@jimp/plugins": "^0.16.2", - "@jimp/types": "^0.16.2", + "@jimp/custom": "^0.16.13", + "@jimp/plugins": "^0.16.13", + "@jimp/types": "^0.16.13", "regenerator-runtime": "^0.13.3" } }, @@ -9490,6 +9614,12 @@ "resolved": "https://registry.npmjs.org/node-abort-controller/-/node-abort-controller-2.0.0.tgz", "integrity": "sha512-L8RfEgjBTHAISTuagw51PprVAqNZoG6KSB6LQ6H1bskMVkFs5E71IyjauLBv3XbuomJlguWF/VnRHdJ1gqiAqA==" }, + "node_modules/node-addon-api": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-5.0.0.tgz", + "integrity": "sha512-CvkDw2OEnme7ybCykJpVcKH+uAOLV2qLqiyla128dN9TkEWfrYmxG6C2boDe5KcNQqZF3orkqzGgOMvZ/JNekA==", + "optional": true + }, "node_modules/node-cache": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/node-cache/-/node-cache-4.2.1.tgz", diff --git a/package.json b/package.json index 58b8882a6..baf00ebce 100644 --- a/package.json +++ b/package.json @@ -47,10 +47,11 @@ "@aws-sdk/client-polly": "^3.26.0", "@crowbartools/firebot-custom-scripts-types": "^5.53.2-6", "@nut-tree/nut-js": "^3.1.1", - "@twurple/api": "^6.0.9", - "@twurple/auth": "^6.0.9", - "@twurple/chat": "^6.0.9", - "@twurple/pubsub": "^6.0.9", + "@twurple/api": "^7.0.6", + "@twurple/auth": "^7.0.6", + "@twurple/chat": "^7.0.6", + "@twurple/eventsub-ws": "^7.0.6", + "@twurple/pubsub": "^7.0.6", "@zunderscore/elgato-light-control": "^1.1.2", "angular": "^1.8.0", "angular-animate": "^1.7.8", diff --git a/src/backend/chat/chat-helpers.js b/src/backend/chat/chat-helpers.js index 9dd933921..b9194ccde 100644 --- a/src/backend/chat/chat-helpers.js +++ b/src/backend/chat/chat-helpers.js @@ -9,6 +9,7 @@ const { FFZEmoteProvider } = require("./third-party/ffz"); const { SevenTVEmoteProvider } = require("./third-party/7tv"); const frontendCommunicator = require("../common/frontend-communicator"); const utils = require("../utility"); +const { parseChatMessage } = require("@twurple/chat"); /** * @typedef FirebotChatMessage @@ -206,20 +207,20 @@ function parseMessageParts(firebotChatMessage, parts) { } const { streamer, bot } = accountAccess.getAccounts(); return parts.flatMap(p => { - if (p.type === "text" && p.text != null) { + if (p.type === "text" && p.text.text != null) { if (firebotChatMessage.username !== streamer.displayName && (!bot.loggedIn || firebotChatMessage.username !== bot.displayName)) { if (!firebotChatMessage.whisper && !firebotChatMessage.tagged && streamer.loggedIn && - (p.text.includes(streamer.username) || p.text.includes(streamer.displayName))) { + (p.text.text.includes(streamer.username) || p.text.text.includes(streamer.displayName))) { firebotChatMessage.tagged = true; } } const subParts = []; - for (const word of p.text.split(" ")) { + for (const word of p.text.text.split(" ")) { // check for links if (URL_REGEX.test(word)) { subParts.push({ @@ -494,11 +495,10 @@ exports.buildFirebotChatMessage = async (msg, msgText, whisper = false, action = */ if (action && msg._params && msg._params.length > 1) { msg._params[1].value = msgText; - msg.parseParams(); } - const messageParts = parseMessageParts(firebotChatMessage, msg - .parseEmotes()); + const messageParts = parseMessageParts(firebotChatMessage, + parseChatMessage(msgText, msg.emoteOffsets)); firebotChatMessage.parts = messageParts; diff --git a/src/backend/chat/chat-listeners/twitch-chat-listeners.js b/src/backend/chat/chat-listeners/twitch-chat-listeners.js index cb127082f..bfe866a0b 100644 --- a/src/backend/chat/chat-listeners/twitch-chat-listeners.js +++ b/src/backend/chat/chat-listeners/twitch-chat-listeners.js @@ -28,7 +28,7 @@ const HIGHLIGHT_MESSAGE_REWARD_ID = "highlight-message"; exports.setupChatListeners = (streamerChatClient) => { streamerChatClient.onAnnouncement(async (_channel, _user, announcementInfo, msg) => { - const firebotChatMessage = await chatHelpers.buildFirebotChatMessage(msg, msg.message.value); + const firebotChatMessage = await chatHelpers.buildFirebotChatMessage(msg, msg.text); firebotChatMessage.isAnnouncement = true; firebotChatMessage.announcementColor = announcementInfo.color ?? "PRIMARY"; @@ -179,13 +179,4 @@ exports.setupChatListeners = (streamerChatClient) => { subInfo.plan ); }); - - streamerChatClient.onRaid((_channel, _username, raidInfo, msg) => { - twitchEventsHandler.raid.triggerRaid( - msg.userInfo.userName, - msg.userInfo.userId, - raidInfo.displayName, - raidInfo.viewerCount - ); - }); }; \ No newline at end of file diff --git a/src/backend/chat/twitch-chat.ts b/src/backend/chat/twitch-chat.ts index 4c96aae6e..29b839be9 100644 --- a/src/backend/chat/twitch-chat.ts +++ b/src/backend/chat/twitch-chat.ts @@ -15,7 +15,6 @@ import twitchEventsHandler from "../events/twitch-events"; import chatRolesManager from "../roles/chat-roles-manager"; import twitchApi from "../twitch-api/api"; import chatterPoll from "../twitch-api/chatter-poll"; -import followPoll from "../twitch-api/follow-poll"; interface UserModRequest { username: string; @@ -65,7 +64,6 @@ class TwitchChat extends EventEmitter { if (emitDisconnectEvent) { this.emit("disconnected"); } - followPoll.stopFollowPoll(); chatterPoll.stopChatterPoll(); activeUserHandler.clearAllActiveUsers(); @@ -137,7 +135,6 @@ class TwitchChat extends EventEmitter { twitchChatListeners.setupChatListeners(this._streamerChatClient); - followPoll.startFollowPoll(); chatterPoll.startChatterPoll(); const vips = await twitchApi.channels.getVips(); diff --git a/src/backend/common/connection-manager.js b/src/backend/common/connection-manager.js index fbd4a99c7..cd072820f 100644 --- a/src/backend/common/connection-manager.js +++ b/src/backend/common/connection-manager.js @@ -7,6 +7,7 @@ const { settings } = require("./settings-access"); const twitchApi = require("../twitch-api/api"); const twitchChat = require("../chat/twitch-chat"); const twitchPubSubClient = require("../twitch-api/pubsub/pubsub-client"); +const TwitchEventSubClient = require("../twitch-api/eventsub/eventsub-client"); const integrationManager = require("../integrations/IntegrationManager"); const accountAccess = require("../common/account-access"); @@ -101,9 +102,11 @@ class ConnectionManager extends EventEmitter { if (shouldConnect) { twitchChat.connect(); twitchPubSubClient.createClient(); + TwitchEventSubClient.createClient(); } else { twitchChat.disconnect(); twitchPubSubClient.disconnectPubSub(); + TwitchEventSubClient.disconnectEventSub(); } return true; } diff --git a/src/backend/common/user-access.js b/src/backend/common/user-access.js index c83251ee2..51130dd87 100644 --- a/src/backend/common/user-access.js +++ b/src/backend/common/user-access.js @@ -105,7 +105,6 @@ async function getUserDetails(userId) { const teamRoles = await teamRolesManager.getAllTeamRolesForViewer(twitchUser.name); const userFollowsStreamerResponse = await client.channels.getChannelFollowers( - streamerData.userId, streamerData.userId, userId ); diff --git a/src/backend/effects/builtin-effect-loader.js b/src/backend/effects/builtin-effect-loader.js index d44498e9f..671492293 100644 --- a/src/backend/effects/builtin-effect-loader.js +++ b/src/backend/effects/builtin-effect-loader.js @@ -9,7 +9,6 @@ exports.loadEffects = () => { 'add-quote', 'announcement', 'api', - 'approve-reject-channel-reward-redemption', 'block-unblock', 'celebration', 'chat-feed-alert', @@ -20,7 +19,6 @@ exports.loadEffects = () => { 'conditional-effects/conditional-effects', 'control-emulation', // No migration needed. 'cooldown-command', - 'create-stream-marker', 'currency', 'custom-script', 'custom-variable', @@ -41,7 +39,6 @@ exports.loadEffects = () => { 'pause-resume-effect-queue', 'play-sound', 'play-video', // No migration needed. - 'raid', 'random-effect', 'random-reddit-image', 'remove-user-metadata', @@ -64,11 +61,24 @@ exports.loadEffects = () => { 'toggle-event-set', 'toggle-event', 'toggle-timer', - 'twitch-shoutout', 'update-channel-reward', 'update-counter', 'update-role', - 'update-vip-role' + 'update-vip-role', + + 'twitch/raid', + 'twitch/shoutout', + 'twitch/create-stream-marker', + + 'twitch/approve-reject-channel-reward-redemption', + + 'twitch/create-poll', + 'twitch/end-poll', + + 'twitch/cancel-prediction', + 'twitch/create-prediction', + 'twitch/lock-prediction', + 'twitch/resolve-prediction' ].forEach(filename => { const definition = require(`./builtin/${filename}`); effectManager.registerEffect(definition); diff --git a/src/backend/effects/builtin/twitch-shoutout.ts b/src/backend/effects/builtin/twitch-shoutout.ts deleted file mode 100644 index 02ec8ff3d..000000000 --- a/src/backend/effects/builtin/twitch-shoutout.ts +++ /dev/null @@ -1,54 +0,0 @@ -import { EffectType } from "../../../types/effects"; -import { EffectCategory } from "../../../shared/effect-constants"; -import twitchApi from "../../twitch-api/api"; -import logger from "../../logwrapper"; - -const model: EffectType<{ - username: string; -}> = { - definition: { - id: "firebot:twitch-shoutout", - name: "Twitch Shoutout", - description: "Send a Twitch shoutout to another channel", - icon: "fad fa-bullhorn", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: [], - }, - optionsTemplate: ` - - - - - -
- Note: You must be live for this effect to work. Per Twitch limits, you may only send a shoutout every two minutes and to the same user once per hour. -
- - `, - optionsValidator: (effect) => { - const errors: string[] = []; - const username = effect.username?.trim(); - - if (!username?.length) { - errors.push("You must specify a channel to shoutout"); - } - - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - const targetUserId = (await twitchApi.users.getUserByName(effect.username)) - ?.id; - - if (targetUserId == null) { - logger.error( - `Unable to shoutout channel. Twitch user ${effect.username} does not exist.` - ); - return false; - } - - return await twitchApi.chat.sendShoutout(targetUserId); - }, -}; - -module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/approve-reject-channel-reward-redemption.ts b/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts similarity index 93% rename from src/backend/effects/builtin/approve-reject-channel-reward-redemption.ts rename to src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts index d67677fb7..b0ff33d8c 100644 --- a/src/backend/effects/builtin/approve-reject-channel-reward-redemption.ts +++ b/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts @@ -1,6 +1,6 @@ -import { EffectType } from "../../../types/effects"; -import { EffectCategory } from "../../../shared/effect-constants"; -import twitchApi from "../../twitch-api/api"; +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ rewardId: string; diff --git a/src/backend/effects/builtin/twitch/cancel-prediction.ts b/src/backend/effects/builtin/twitch/cancel-prediction.ts new file mode 100644 index 000000000..c1cb47590 --- /dev/null +++ b/src/backend/effects/builtin/twitch/cancel-prediction.ts @@ -0,0 +1,39 @@ +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{}> = { + definition: { + id: "twitch:cancel-prediction", + name: "Cancel Twitch Prediction", + description: "Cancels the currently active Twitch prediction and refunds all channel points wagered", + icon: "fad fa-ban", + categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, + dependencies: [] + }, + optionsTemplate: ` + +
+ Note: If there is no prediction currently running, this will take no action. +
+ + `, + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async () => { + const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); + + if (latestPrediction?.status !== "ACTIVE") { + logger.warn("There is no active Twitch prediction to cancel"); + return; + } + + logger.debug(`Canceling Twitch prediction "${latestPrediction.title}"`); + return await twitchApi.predictions.cancelPrediction(latestPrediction.id); + } +} + +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/create-poll.ts b/src/backend/effects/builtin/twitch/create-poll.ts new file mode 100644 index 000000000..f35cfdae9 --- /dev/null +++ b/src/backend/effects/builtin/twitch/create-poll.ts @@ -0,0 +1,85 @@ +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{ + title: string; + choices: string[]; + duration: number; + allowChannelPointVoting: boolean; + channelPointsPerVote: number; +}> = { + definition: { + id: "twitch:create-poll", + name: "Create Twitch Poll", + description: "Creates a Twitch poll", + icon: "fad fa-poll-h", + categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, + dependencies: [] + }, + optionsTemplate: ` + + + + + + + + + + + + + + + + + + +
+ Note: You may only have one poll running at a time. +
+ + `, + optionsValidator: (effect) => { + const errors: string[] = []; + + if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 25)) { + errors.push("You must enter a title no more than 25 characters long"); + } + + if (!(effect.duration >= 15 && effect.duration <= 1800)) { + errors.push("Duration must be between 15 and 1800 seconds"); + } + + if (!effect.choices?.length || !(effect.choices.length >= 2 && effect.choices.length <= 5)) { + errors.push("You must enter between 2 and 5 choices"); + } + + if (effect.allowChannelPointVoting && !(effect.channelPointsPerVote >= 1 && effect.channelPointsPerVote <= 1000000)) { + errors.push("Channel points per vote must be between 1 and 1,000,000"); + } + + return errors; + }, + optionsController: ($scope) => { + $scope.optionSettings = { + noDuplicates: true, + maxItems: 5 + } + }, + onTriggerEvent: async ({ effect }) => { + logger.debug(`Creating Twitch poll "${effect.title}"`) + return await twitchApi.polls.createPoll( + effect.title, + effect.choices, + effect.duration, + effect.allowChannelPointVoting ? effect.channelPointsPerVote : null + ); + } +} + +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/create-prediction.ts b/src/backend/effects/builtin/twitch/create-prediction.ts new file mode 100644 index 000000000..51c8af286 --- /dev/null +++ b/src/backend/effects/builtin/twitch/create-prediction.ts @@ -0,0 +1,73 @@ +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{ + title: string; + outcomes: string[]; + duration: number; +}> = { + definition: { + id: "twitch:create-prediction", + name: "Create Twitch Prediction", + description: "Creates a Twitch prediction", + icon: "fad fa-question-circle", + categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, + dependencies: [] + }, + optionsTemplate: ` + + + + + + + + + + + + + +
+ Note: You may only have one prediction running at a time. +
+ + `, + optionsValidator: (effect) => { + const errors: string[] = []; + + if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 45)) { + errors.push("You must enter a title no more than 45 characters long"); + } + + if (!(effect.duration >= 30 && effect.duration <= 1800)) { + errors.push("Duration must be between 30 and 1800 seconds"); + } + + if (!effect.outcomes?.length || !(effect.outcomes.length >= 2 && effect.outcomes.length <= 10)) { + errors.push("You must enter between 2 and 10 outcomes"); + } + + return errors; + }, + optionsController: ($scope) => { + $scope.optionSettings = { + noDuplicates: true, + maxItems: 10 + } + }, + onTriggerEvent: async ({ effect }) => { + logger.debug(`Creating Twitch prediction "${effect.title}"`) + return await twitchApi.predictions.createPrediction( + effect.title, + effect.outcomes, + effect.duration + ); + } +} + +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/create-stream-marker.ts b/src/backend/effects/builtin/twitch/create-stream-marker.ts similarity index 78% rename from src/backend/effects/builtin/create-stream-marker.ts rename to src/backend/effects/builtin/twitch/create-stream-marker.ts index 89ca36074..2958c42ad 100644 --- a/src/backend/effects/builtin/create-stream-marker.ts +++ b/src/backend/effects/builtin/twitch/create-stream-marker.ts @@ -1,6 +1,7 @@ -import { EffectType } from "../../../types/effects"; -import { EffectCategory } from "../../../shared/effect-constants"; -import twitchApi from "../../twitch-api/api"; +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ description: string; @@ -11,6 +12,7 @@ const model: EffectType<{ description: "Create a stream marker in your Twitch VOD", icon: "fad fa-map-pin", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/end-poll.ts b/src/backend/effects/builtin/twitch/end-poll.ts new file mode 100644 index 000000000..1cfe79420 --- /dev/null +++ b/src/backend/effects/builtin/twitch/end-poll.ts @@ -0,0 +1,45 @@ +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{ + archivePoll: boolean; +}> = { + definition: { + id: "twitch:end-poll", + name: "End Twitch Poll", + description: "Ends the currently active Twitch poll", + icon: "fad fa-stop-circle", + categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, + dependencies: [] + }, + optionsTemplate: ` + + + + + +
+ Note: If there is no poll currently running, this will take no action. +
+ + `, + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const latestPoll = await twitchApi.polls.getMostRecentPoll(); + + if (latestPoll?.status !== "ACTIVE") { + logger.warn("There is no active Twitch poll to end"); + return; + } + + logger.debug(`Ending Twitch poll "${latestPoll.title}"${effect.archivePoll ? " as archived" : ""}`); + return await twitchApi.polls.endPoll(latestPoll.id, effect.archivePoll); + } +} + +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/lock-prediction.ts b/src/backend/effects/builtin/twitch/lock-prediction.ts new file mode 100644 index 000000000..3b39374f5 --- /dev/null +++ b/src/backend/effects/builtin/twitch/lock-prediction.ts @@ -0,0 +1,39 @@ +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{}> = { + definition: { + id: "twitch:lock-prediction", + name: "Lock Twitch Prediction", + description: "Locks the currently active Twitch prediction so that no more predictions can be made", + icon: "fad fa-lock", + categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, + dependencies: [] + }, + optionsTemplate: ` + +
+ Note: If there is no prediction currently running, this will take no action. +
+ + `, + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async () => { + const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); + + if (latestPrediction?.status !== "ACTIVE") { + logger.warn("There is no active Twitch prediction to lock"); + return; + } + + logger.debug(`Locking Twitch prediction "${latestPrediction.title}"`); + return await twitchApi.predictions.lockPrediciton(latestPrediction.id); + } +} + +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/raid.ts b/src/backend/effects/builtin/twitch/raid.ts similarity index 87% rename from src/backend/effects/builtin/raid.ts rename to src/backend/effects/builtin/twitch/raid.ts index 2893a45bf..3bf234c04 100644 --- a/src/backend/effects/builtin/raid.ts +++ b/src/backend/effects/builtin/twitch/raid.ts @@ -1,7 +1,8 @@ -import { EffectType } from "../../../types/effects"; -import { EffectCategory } from "../../../shared/effect-constants"; -import twitchApi from "../../twitch-api/api"; -import logger from "../../logwrapper"; +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ action: "Raid Channel" | "Cancel Raid"; @@ -13,6 +14,7 @@ const model: EffectType<{ description: "Start or cancel a raid to another Twitch channel", icon: "fad fa-rocket-launch", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/resolve-prediction.ts b/src/backend/effects/builtin/twitch/resolve-prediction.ts new file mode 100644 index 000000000..d577b12f4 --- /dev/null +++ b/src/backend/effects/builtin/twitch/resolve-prediction.ts @@ -0,0 +1,55 @@ +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{ + outcome: number; +}> = { + definition: { + id: "twitch:resolve-prediction", + name: "Resolve Twitch Prediction", + description: "Resolves the currently active Twitch prediction by selecting an outcome and pays out channel points to the winners", + icon: "fad fa-trophy-alt", + categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], + hidden: !accountAccess.getAccounts().streamer.loggedIn, + dependencies: [] + }, + optionsTemplate: ` + + + + + +
+ Note: If there is no prediction currently running, this will take no action. +
+ + `, + optionsValidator: (effect) => { + const errors: string[] = []; + + if (!(effect.outcome >= 1 && effect.outcome <= 10)) { + errors.push("Outcome must be between 1 and 10.") + } + + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); + + if (latestPrediction?.status !== "ACTIVE" && latestPrediction?.status !== "LOCKED" ) { + logger.warn("There is no active Twitch prediction to resolve"); + return; + } + + const winningOutcome = latestPrediction.outcomes[effect.outcome - 1]; + + logger.debug(`Resolving Twitch prediction "${latestPrediction.title}" with outcome "${winningOutcome.title}"`); + return await twitchApi.predictions.resolvePrediction(latestPrediction.id, winningOutcome.id); + } +} + +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/shoutout.ts b/src/backend/effects/builtin/twitch/shoutout.ts new file mode 100644 index 000000000..957d9605a --- /dev/null +++ b/src/backend/effects/builtin/twitch/shoutout.ts @@ -0,0 +1,55 @@ +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import logger from "../../../logwrapper"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{ + username: string; +}> = { + definition: { + id: "firebot:twitch-shoutout", + name: "Twitch Shoutout", + description: "Send a Twitch shoutout to another channel", + icon: "fad fa-bullhorn", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + hidden: !accountAccess.getAccounts().streamer.loggedIn, + dependencies: [], + }, + optionsTemplate: ` + + + + + +
+ Note: You must be live for this effect to work. Per Twitch limits, you may only send a shoutout every two minutes and to the same user once per hour. +
+ + `, + optionsValidator: (effect) => { + const errors: string[] = []; + const username = effect.username?.trim(); + + if (!username?.length) { + errors.push("You must specify a channel to shoutout"); + } + + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const targetUserId = (await twitchApi.users.getUserByName(effect.username))?.id; + + if (targetUserId == null) { + logger.error( + `Unable to shoutout channel. Twitch user ${effect.username} does not exist.` + ); + return false; + } + + return await twitchApi.chat.sendShoutout(targetUserId); + }, +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/events/builtin/twitchEventSource.js b/src/backend/events/builtin/twitchEventSource.js index dbb954e4c..de3caf49d 100644 --- a/src/backend/events/builtin/twitchEventSource.js +++ b/src/backend/events/builtin/twitchEventSource.js @@ -362,7 +362,7 @@ module.exports = { username: "Firebot", rewardName: "Test Reward", rewardImage: "https://static-cdn.jtvnw.net/automatic-reward-images/highlight-1.png", - rewardCost: "200", + rewardCost: 200, messageText: "Test message" }, activityFeed: { @@ -423,6 +423,393 @@ module.exports = { return `**${eventData.moderator}** has set the chat mode to **${eventData.chatMode}**.`; } } + }, + { + id: "channel-poll-begin", + name: "Channel Poll Started", + description: "When a channel poll begins on your channel.", + cached: false, + queued: false, + manualMetadata: { + title: "Poll name" + }, + activityFeed: { + icon: "fad fa-poll-h", + getMessage: (eventData) => { + return `Channel poll **${eventData.title}** has begun.`; + } + } + }, + { + id: "channel-poll-progress", + name: "Channel Poll Progress", + description: "When a channel poll progresses on your channel.", + cached: false, + queued: false, + manualMetadata: { + title: "Poll name" + }, + activityFeed: { + icon: "fad fa-poll-h", + getMessage: (eventData) => { + return `Channel poll **${eventData.title}** has progressed.`; + } + } + }, + { + id: "channel-poll-end", + name: "Channel Poll Ended", + description: "When a channel poll ends on your channel.", + cached: false, + queued: false, + manualMetadata: { + title: "Poll name" + }, + activityFeed: { + icon: "fad fa-poll-h", + getMessage: (eventData) => { + return `Channel poll **${eventData.title}** has ended. Winning choice: **${eventData.winningChoice.title}**`; + } + } + }, + { + id: "channel-goal-begin", + name: "Channel Goal Started", + description: "When a channel goal begins on your channel.", + cached: false, + queued: false, + manualMetadata: { + description: "Goal name" + }, + activityFeed: { + icon: "fad fa-bullseye-arrow", + getMessage: (eventData) => { + let message; + if (eventData.description) { + message = `Channel ${eventData.type} goal **${eventData.description}** has begun (**${eventData.currentAmount}**/**${eventData.targetAmount}**).`; + } else { + message = `Channel ${eventData.type} goal has begun (**${eventData.currentAmount}**/**${eventData.targetAmount}**).`; + } + return message; + } + } + }, + { + id: "channel-goal-progress", + name: "Channel Goal Progress", + description: "When a channel goal progresses on your channel.", + cached: false, + queued: false, + manualMetadata: { + description: "Goal name" + }, + activityFeed: { + icon: "fad fa-bullseye-arrow", + getMessage: (eventData) => { + let message; + if (eventData.description) { + message = `Channel ${eventData.type} goal **${eventData.description}** has progressed (**${eventData.currentAmount}**/**${eventData.targetAmount}**).`; + } else { + message = `Channel ${eventData.type} goal has progressed (**${eventData.currentAmount}**/**${eventData.targetAmount}**).`; + } + return message; + } + } + }, + { + id: "channel-goal-end", + name: "Channel Goal Ended", + description: "When a channel goal ends on your channel.", + cached: false, + queued: false, + manualMetadata: { + description: "Goal name" + }, + activityFeed: { + icon: "fad fa-bullseye-arrow", + getMessage: (eventData) => { + let message; + if (eventData.description) { + message = `Channel ${eventData.type} goal **${eventData.description}** has ended. Goal **${eventData.isAchieved ? "was" : "was not"}** achieved. (**${eventData.currentAmount}**/**${eventData.targetAmount}**).`; + } else { + message = `Channel ${eventData.type} goal has ended. Goal **${eventData.isAchieved ? "was" : "was not"}** achieved. (**${eventData.currentAmount}**/**${eventData.targetAmount}**).`; + } + return message; + } + } + }, + { + id: "channel-prediction-begin", + name: "Channel Prediction Started", + description: "When a channel prediction begins on your channel.", + cached: false, + queued: false, + manualMetadata: { + title: "Title" + }, + activityFeed: { + icon: "fad fa-question-circle", + getMessage: (eventData) => { + return `Channel prediction **${eventData.title}** has begun.`; + } + } + }, + { + id: "channel-prediction-progress", + name: "Channel Prediction Progress", + description: "When a channel prediction progresses on your channel.", + cached: false, + queued: false, + manualMetadata: { + title: "Title" + }, + activityFeed: { + icon: "fad fa-question-circle", + getMessage: (eventData) => { + return `Channel prediction **${eventData.title}** has progressed.`; + } + } + }, + { + id: "channel-prediction-lock", + name: "Channel Prediction Locked", + description: "When a channel prediction is locked on your channel.", + cached: false, + queued: false, + manualMetadata: { + title: "Title" + }, + activityFeed: { + icon: "fad fa-question-circle", + getMessage: (eventData) => { + return `Channel prediction **${eventData.title}** has been locked.`; + } + } + }, + { + id: "channel-prediction-end", + name: "Channel Prediction Ended", + description: "When a channel prediction ends on your channel.", + cached: false, + queued: false, + manualMetadata: { + title: "Title" + }, + activityFeed: { + icon: "fad fa-question-circle", + getMessage: (eventData) => { + return `Channel prediction **${eventData.title}** has ended. Winning outcome: **${eventData.winningOutcome.title}**.`; + } + } + }, + { + id: "hype-train-start", + name: "Hype Train Started", + description: "When a hype train starts on your channel.", + cached: false, + queued: false, + manualMetadata: { + total: "150", + progress: "150", + goal: "500", + level: "1" + }, + activityFeed: { + icon: "fad fa-train", + getMessage: () => { + return `Hype train started!`; + } + } + }, + { + id: "hype-train-progress", + name: "Hype Train Progress", + description: "When a hype train progresses on your channel.", + cached: false, + queued: false, + manualMetadata: { + total: "150", + progress: "150", + goal: "500", + level: "1" + }, + activityFeed: { + icon: "fad fa-train", + getMessage: (eventData) => { + return `Level **${eventData.level}** hype train currently at **${Math.floor((eventData.progress / eventData.goal) * 100)}%**.`; + } + } + }, + { + id: "hype-train-end", + name: "Hype Train Ended", + description: "When a hype train ends on your channel.", + cached: false, + queued: false, + manualMetadata: { + total: "150", + level: "1" + }, + activityFeed: { + icon: "fad fa-train", + getMessage: (eventData) => { + return `Level **${eventData.level}** hype train ended.`; + } + } + }, + { + id: "stream-online", + name: "Stream Started", + description: "When your stream starts.", + cached: false, + queued: false, + manualMetadata: { }, + activityFeed: { + icon: "fad fa-play-circle", + getMessage: () => { + return `Stream started.`; + } + } + }, + { + id: "stream-offline", + name: "Stream Ended", + description: "When your stream ends.", + cached: false, + queued: false, + manualMetadata: { }, + activityFeed: { + icon: "fad fa-stop-circle", + getMessage: () => { + return `Stream ended.`; + } + } + }, + { + id: "charity-campaign-start", + name: "Charity Campaign Started", + description: "When you start a charity campaign in your channel.", + cached: false, + queued: false, + manualMetadata: { + charityName: "Great Cause, LLC", + charityDescription: "They do really great stuff", + charityWebsite: "https://somewebsite.org", + charityLogo: "https://somewebsite.org/logo.png", + currentTotalAmount: "10", + currentTotalCurrency: "USD", + targetTotalAmount: "1000", + targetTotalCurrency: "USD" + }, + activityFeed: { + icon: "fad fa-ribbon", + getMessage: (eventData) => { + return `Charity campaign benefitting **${eventData.charityName}** has started.`; + } + } + }, + { + id: "charity-donation", + name: "Charity Donation", + description: "When someone donates to your channel's charity campaign.", + cached: false, + queued: false, + manualMetadata: { + from: "Firebot", + charityName: "Great Cause, LLC", + charityDescription: "They do really great stuff", + charityWebsite: "https://somewebsite.org", + charityLogo: "https://somewebsite.org/logo.png", + donationAmount: "10", + donationCurrency: "USD" + }, + activityFeed: { + icon: "fad fa-hand-holding-heart", + getMessage: (eventData) => { + return `**${eventData.from}** made a charity donation of **${eventData.donationAmount} ${eventData.donationCurrency}**.`; + } + } + }, + { + id: "charity-campaign-progress", + name: "Charity Campaign Progress", + description: "When your channel's charity campaign progresses.", + cached: false, + queued: false, + manualMetadata: { + charityName: "Great Cause, LLC", + charityDescription: "They do really great stuff", + charityWebsite: "https://somewebsite.org", + charityLogo: "https://somewebsite.org/logo.png", + currentTotalAmount: "10", + currentTotalCurrency: "USD", + targetTotalAmount: "1000", + targetTotalCurrency: "USD" + }, + activityFeed: { + icon: "fad fa-ribbon", + getMessage: (eventData) => { + return `Charity campaign has progressed. Total so far: **${eventData.currentTotalAmount} ${eventData.currentTotalCurrency}**.`; + } + } + }, + { + id: "charity-campaign-end", + name: "Charity Campaign Ended", + description: "When your channel's charity campaign ends.", + cached: false, + queued: false, + manualMetadata: { + charityName: "Great Cause, LLC", + charityDescription: "They do really great stuff", + charityWebsite: "https://somewebsite.org", + charityLogo: "https://somewebsite.org/logo.png", + currentTotalAmount: "10", + currentTotalCurrency: "USD", + targetTotalAmount: "1000", + targetTotalCurrency: "USD" + }, + activityFeed: { + icon: "fad fa-ribbon", + getMessage: (eventData) => { + return `Charity campaign has ended. Goal reached: **${eventData.goalReached ? "Yes" : "No"}**. Total raised: **${eventData.currentTotalAmount} ${eventData.currentTotalCurrency}**.`; + } + } + }, + { + id: "shoutout-sent", + name: "Shoutout Sent", + description: "When you or a moderator sends a Twitch shoutout to another channel.", + cached: false, + queued: false, + manualMetadata: { + moderator: "Firebot", + username: "zunderscore", + viewerCount: 10 + }, + activityFeed: { + icon: "fad fa-bullhorn", + getMessage: (eventData) => { + return `**${eventData.moderator}** sent a shoutout to **${eventData.username}**`; + } + } + }, + { + id: "shoutout-received", + name: "Shoutout Received", + description: "When another channel sends you a Twitch shoutout.", + cached: false, + queued: false, + manualMetadata: { + username: "Firebot", + viewerCount: 10 + }, + activityFeed: { + icon: "fad fa-bullhorn", + getMessage: (eventData) => { + return `**${eventData.username}** shouted out your channel to ${eventData.viewerCount} viewers`; + } + } } ] -}; +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events.js b/src/backend/events/twitch-events.js index 5afb521ff..9ae61c886 100644 --- a/src/backend/events/twitch-events.js +++ b/src/backend/events/twitch-events.js @@ -1,13 +1,20 @@ "use strict"; exports.announcement = require('./twitch-events/announcement'); +exports.charity = require('./twitch-events/charity'); exports.chatMessage = require('./twitch-events/chat-message'); exports.chatModeChanged = require('./twitch-events/chat-mode-changed'); exports.cheer = require('./twitch-events/cheer'); exports.follow = require('./twitch-events/follow'); exports.giftSub = require('./twitch-events/gift-sub'); +exports.goal = require('./twitch-events/goal'); +exports.hypeTrain = require('./twitch-events/hype-train'); +exports.poll = require('./twitch-events/poll'); +exports.prediction = require('./twitch-events/prediction'); exports.raid = require('./twitch-events/raid'); exports.rewardRedemption = require('./twitch-events/reward-redemption'); +exports.shoutout = require('./twitch-events/shoutout'); +exports.stream = require('./twitch-events/stream'); exports.sub = require('./twitch-events/sub'); exports.viewerArrived = require('./twitch-events/viewer-arrived'); exports.viewerBanned = require('./twitch-events/viewer-banned'); diff --git a/src/backend/events/twitch-events/charity.ts b/src/backend/events/twitch-events/charity.ts new file mode 100644 index 000000000..94e0b34a2 --- /dev/null +++ b/src/backend/events/twitch-events/charity.ts @@ -0,0 +1,88 @@ +import eventManager from "../../events/EventManager"; + +export function triggerCharityCampaignStart( + charityName: string, + charityDescription: string, + charityLogo: string, + charityWebsite: string, + currentTotalAmount: number, + currentTotalCurrency: string, + targetTotalAmount: number, + targetTotalCurrency: string +) { + eventManager.triggerEvent("twitch", "charity-campaign-start", { + charityName, + charityDescription, + charityLogo, + charityWebsite, + currentTotalAmount, + currentTotalCurrency, + targetTotalAmount, + targetTotalCurrency + }); +}; + +export function triggerCharityDonation( + username: string, + charityName: string, + charityDescription: string, + charityLogo: string, + charityWebsite: string, + donationAmount: number, + donationCurrency: string +) { + eventManager.triggerEvent("twitch", "charity-donation", { + from: username, + charityName, + charityDescription, + charityLogo, + charityWebsite, + donationAmount, + donationCurrency + }); +}; + +export function triggerCharityCampaignProgress( + charityName: string, + charityDescription: string, + charityLogo: string, + charityWebsite: string, + currentTotalAmount: number, + currentTotalCurrency: string, + targetTotalAmount: number, + targetTotalCurrency: string +) { + eventManager.triggerEvent("twitch", "charity-campaign-progress", { + charityName, + charityDescription, + charityLogo, + charityWebsite, + currentTotalAmount, + currentTotalCurrency, + targetTotalAmount, + targetTotalCurrency + }); +}; + +export function triggerCharityCampaignEnd( + charityName: string, + charityDescription: string, + charityLogo: string, + charityWebsite: string, + currentTotalAmount: number, + currentTotalCurrency: string, + targetTotalAmount: number, + targetTotalCurrency: string +) { + eventManager.triggerEvent("twitch", "charity-campaign-end", { + charityName, + charityDescription, + charityLogo, + charityWebsite, + currentTotalAmount, + currentTotalCurrency, + targetTotalAmount, + targetTotalCurrency, + goalReached: currentTotalAmount >= targetTotalAmount + }); +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/gift-sub.ts b/src/backend/events/twitch-events/gift-sub.ts index 74cd357d9..37c639448 100644 --- a/src/backend/events/twitch-events/gift-sub.ts +++ b/src/backend/events/twitch-events/gift-sub.ts @@ -107,4 +107,4 @@ export function triggerSubGiftUpgrade( gifteeUsername: gifteeDisplayName, subPlan }); -}; +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/goal.ts b/src/backend/events/twitch-events/goal.ts new file mode 100644 index 000000000..e879dd688 --- /dev/null +++ b/src/backend/events/twitch-events/goal.ts @@ -0,0 +1,54 @@ +import eventManager from "../EventManager"; +import { EventSubChannelGoalType } from "@twurple/eventsub-base"; + +export function triggerChannelGoalBegin( + description: string, + type: EventSubChannelGoalType, + startDate: Date, + currentAmount: number, + targetAmount: number +) { + eventManager.triggerEvent("twitch", "channel-goal-begin", { + description, + type, + startDate, + currentAmount, + targetAmount + }); +}; + +export function triggerChannelGoalProgress( + description: string, + type: EventSubChannelGoalType, + startDate: Date, + currentAmount: number, + targetAmount: number +) { + eventManager.triggerEvent("twitch", "channel-goal-progress", { + description, + type, + startDate, + currentAmount, + targetAmount + }); +}; + +export function triggerChannelGoalEnd( + description: string, + type: EventSubChannelGoalType, + startDate: Date, + endDate: Date, + currentAmount: number, + targetAmount: number, + isAchieved: boolean +) { + eventManager.triggerEvent("twitch", "channel-goal-end", { + description, + type, + startDate, + endDate, + currentAmount, + targetAmount, + isAchieved + }); +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/hype-train.ts b/src/backend/events/twitch-events/hype-train.ts new file mode 100644 index 000000000..71c7300d8 --- /dev/null +++ b/src/backend/events/twitch-events/hype-train.ts @@ -0,0 +1,64 @@ +import eventManager from "../EventManager"; +import { EventSubChannelHypeTrainContribution } from "@twurple/eventsub-base" + +export function triggerHypeTrainStart( + total: number, + progress: number, + goal: number, + level: number, + startDate: Date, + expiryDate: Date, + lastContribution: EventSubChannelHypeTrainContribution, + topContributors: EventSubChannelHypeTrainContribution[] +) { + eventManager.triggerEvent("twitch", "hype-train-start", { + total, + progress, + goal, + level, + startDate, + expiryDate, + lastContribution, + topContributors + }); +}; + +export function triggerHypeTrainProgress( + total: number, + progress: number, + goal: number, + level: number, + startDate: Date, + expiryDate: Date, + lastContribution: EventSubChannelHypeTrainContribution, + topContributors: EventSubChannelHypeTrainContribution[] +) { + eventManager.triggerEvent("twitch", "hype-train-progress", { + total, + progress, + goal, + level, + startDate, + expiryDate, + lastContribution, + topContributors + }); +}; + +export function triggerHypeTrainEnd( + total: number, + level: number, + startDate: Date, + endDate: Date, + cooldownEndDate: Date, + topContributors: EventSubChannelHypeTrainContribution[] +) { + eventManager.triggerEvent("twitch", "hype-train-end", { + total, + level, + startDate, + endDate, + cooldownEndDate, + topContributors + }); +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/poll.ts b/src/backend/events/twitch-events/poll.ts new file mode 100644 index 000000000..d93f0957b --- /dev/null +++ b/src/backend/events/twitch-events/poll.ts @@ -0,0 +1,67 @@ +import eventManager from "../EventManager"; +import { + EventSubChannelPollBeginChoice, + EventSubChannelPollChoice, + EventSubChannelPollEndStatus +} from "@twurple/eventsub-base"; + +export function triggerChannelPollBegin( + title: string, + choices: EventSubChannelPollBeginChoice[], + startDate: Date, + endDate: Date, + isChannelPointsVotingEnabled: boolean, + channelPointsPerVote: number +) { + eventManager.triggerEvent("twitch", "channel-poll-begin", { + title, + choices, + startDate, + endDate, + isChannelPointsVotingEnabled, + channelPointsPerVote + }); +}; + +export function triggerChannelPollProgress( + title: string, + choices: EventSubChannelPollChoice[], + startDate: Date, + endDate: Date, + isChannelPointsVotingEnabled: boolean, + channelPointsPerVote: number +) { + eventManager.triggerEvent("twitch", "channel-poll-progress", { + title, + choices, + startDate, + endDate, + isChannelPointsVotingEnabled, + channelPointsPerVote + }); +}; + +export function triggerChannelPollEnd( + title: string, + choices: EventSubChannelPollChoice[], + startDate: Date, + endDate: Date, + isChannelPointsVotingEnabled: boolean, + channelPointsPerVote: number, + status: EventSubChannelPollEndStatus +) { + const winningChoice = choices.sort((c1: EventSubChannelPollChoice, c2:EventSubChannelPollChoice) => { + return c1.totalVotes < c2.totalVotes ? 1 : -1; + })[0]; + + eventManager.triggerEvent("twitch", "channel-poll-end", { + title, + choices, + winningChoice, + startDate, + endDate, + isChannelPointsVotingEnabled, + channelPointsPerVote, + status + }); +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/prediction.ts b/src/backend/events/twitch-events/prediction.ts new file mode 100644 index 000000000..bba05fa19 --- /dev/null +++ b/src/backend/events/twitch-events/prediction.ts @@ -0,0 +1,66 @@ +import eventManager from "../EventManager"; +import { + EventSubChannelPredictionBeginOutcome, + EventSubChannelPredictionOutcome, + EventSubChannelPredictionEndStatus +} from "@twurple/eventsub-base"; + +export function triggerChannelPredictionBegin( + title: string, + outcomes: EventSubChannelPredictionBeginOutcome[], + startDate: Date, + lockDate: Date +) { + eventManager.triggerEvent("twitch", "channel-prediction-begin", { + title, + outcomes, + startDate, + lockDate + }); +}; + +export function triggerChannelPredictionProgress( + title: string, + outcomes: EventSubChannelPredictionOutcome[], + startDate: Date, + lockDate: Date +) { + eventManager.triggerEvent("twitch", "channel-prediction-progress", { + title, + outcomes, + startDate, + lockDate + }); +}; + +export function triggerChannelPredictionLock( + title: string, + outcomes: EventSubChannelPredictionOutcome[], + startDate: Date, + lockDate: Date +) { + eventManager.triggerEvent("twitch", "channel-prediction-lock", { + title, + outcomes, + startDate, + lockDate + }); +}; + +export function triggerChannelPredictionEnd( + title: string, + outcomes: EventSubChannelPredictionOutcome[], + winningOutcome: EventSubChannelPredictionOutcome, + startDate: Date, + endDate: Date, + status: EventSubChannelPredictionEndStatus +) { + eventManager.triggerEvent("twitch", "channel-prediction-end", { + title, + outcomes, + winningOutcome, + startDate, + endDate, + status + }); +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/shoutout.ts b/src/backend/events/twitch-events/shoutout.ts new file mode 100644 index 000000000..8c305e2ab --- /dev/null +++ b/src/backend/events/twitch-events/shoutout.ts @@ -0,0 +1,23 @@ +import eventManager from "../../events/EventManager"; + +export function triggerShoutoutSent( + userDisplayName: string, + moderatorDisplayName: string, + viewerCount: number +) { + eventManager.triggerEvent("twitch", "shoutout-sent", { + username: userDisplayName, + moderator: moderatorDisplayName, + viewerCount + }); +}; + +export function triggerShoutoutReceived( + userDisplayName: string, + viewerCount: number +) { + eventManager.triggerEvent("twitch", "shoutout-received", { + username: userDisplayName, + viewerCount + }); +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/stream.ts b/src/backend/events/twitch-events/stream.ts new file mode 100644 index 000000000..7321892a8 --- /dev/null +++ b/src/backend/events/twitch-events/stream.ts @@ -0,0 +1,25 @@ +import eventManager from "../../events/EventManager"; + +export function triggerStreamOnline( + userId: string, + userLogin: string, + userDisplayName: string +) { + eventManager.triggerEvent("twitch", "stream-online", { + userId, + userLogin, + userDisplayName + }); +}; + +export function triggerStreamOffline( + userId: string, + userLogin: string, + userDisplayName: string +) { + eventManager.triggerEvent("twitch", "stream-offline", { + userId, + userLogin, + userDisplayName + }); +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/viewer-arrived.ts b/src/backend/events/twitch-events/viewer-arrived.ts index 01315fa50..be977ad3f 100644 --- a/src/backend/events/twitch-events/viewer-arrived.ts +++ b/src/backend/events/twitch-events/viewer-arrived.ts @@ -12,4 +12,4 @@ export function triggerViewerArrived( userId, messageText }); -} +}; \ No newline at end of file diff --git a/src/backend/events/twitch-events/viewer-timeout.ts b/src/backend/events/twitch-events/viewer-timeout.ts index 7acd30b86..42324189b 100644 --- a/src/backend/events/twitch-events/viewer-timeout.ts +++ b/src/backend/events/twitch-events/viewer-timeout.ts @@ -12,4 +12,4 @@ export function triggerTimeout( moderator, modReason }); -}; +}; \ No newline at end of file diff --git a/src/backend/twitch-api/api.ts b/src/backend/twitch-api/api.ts index 20981410a..d34181c2a 100644 --- a/src/backend/twitch-api/api.ts +++ b/src/backend/twitch-api/api.ts @@ -9,9 +9,13 @@ import { TwitchBitsApi } from "./resource/bits"; import { TwitchCategoriesApi } from "./resource/categories"; import { TwitchChannelRewardsApi } from "./resource/channel-rewards"; import { TwitchChannelsApi } from "./resource/channels"; +import { TwitchCharityApi } from "./resource/charity"; import { TwitchChatApi } from "./resource/chat"; import { TwitchModerationApi } from "./resource/moderation"; +import { TwitchPollsApi } from "./resource/polls"; +import { TwitchPredictionsApi } from "./resource/predictions"; import { TwitchStreamsApi } from "./resource/streams"; +import { TwitchSubscriptionsApi } from "./resource/subscriptions"; import { TwitchTeamsApi } from "./resource/teams"; import { TwitchUsersApi } from "./resource/users"; import { TwitchWhispersApi } from "./resource/whispers"; @@ -71,6 +75,10 @@ class TwitchApi { return new TwitchChannelsApi(this._streamerClient, this._botClient); } + get charity() { + return new TwitchCharityApi(this._streamerClient, this._botClient); + } + get chat() { return new TwitchChatApi(this._streamerClient, this._botClient); } @@ -79,10 +87,22 @@ class TwitchApi { return new TwitchModerationApi(this._streamerClient, this._botClient); } + get polls() { + return new TwitchPollsApi(this._streamerClient, this._botClient); + } + + get predictions() { + return new TwitchPredictionsApi(this._streamerClient, this._botClient); + } + get streams() { return new TwitchStreamsApi(this._streamerClient, this._botClient); } + get subscriptions() { + return new TwitchSubscriptionsApi(this._streamerClient, this._botClient); + } + get teams() { return new TwitchTeamsApi(this._streamerClient, this._botClient); } diff --git a/src/backend/twitch-api/eventsub/eventsub-client.ts b/src/backend/twitch-api/eventsub/eventsub-client.ts new file mode 100644 index 000000000..fed322242 --- /dev/null +++ b/src/backend/twitch-api/eventsub/eventsub-client.ts @@ -0,0 +1,417 @@ +import { EventSubSubscription } from "@twurple/eventsub-base"; +import { EventSubWsListener } from "@twurple/eventsub-ws"; + +import logger from "../../logwrapper"; +import accountAccess from "../../common/account-access"; +import frontendCommunicator from "../../common/frontend-communicator"; +import twitchEventsHandler from '../../events/twitch-events'; +import TwitchApi from "../api"; + +class TwitchEventSubClient { + private _eventSubListener: EventSubWsListener; + private _subscriptions: Array = []; + + async createClient(): Promise { + const streamer = accountAccess.getAccounts().streamer; + + await this.disconnectEventSub(); + + logger.info("Connecting to Twitch EventSub..."); + + try { + this._eventSubListener = new EventSubWsListener({ + apiClient: TwitchApi.streamerClient + }); + + this._eventSubListener.start(); + + // Stream online + const onlineSubscription = this._eventSubListener.onStreamOnline(streamer.userId, (event) => { + twitchEventsHandler.stream.triggerStreamOnline( + event.broadcasterId, + event.broadcasterName, + event.broadcasterDisplayName + ); + }); + this._subscriptions.push(onlineSubscription); + + // Stream offline + const offlineSubscription = this._eventSubListener.onStreamOffline(streamer.userId, (event) => { + twitchEventsHandler.stream.triggerStreamOffline( + event.broadcasterId, + event.broadcasterName, + event.broadcasterDisplayName + ); + }); + this._subscriptions.push(offlineSubscription); + + // Follows + const followSubscription = this._eventSubListener.onChannelFollow(streamer.userId, streamer.userId, (event) => { + twitchEventsHandler.follow.triggerFollow( + event.userId, + event.userName, + event.userDisplayName + ); + }); + this._subscriptions.push(followSubscription); + + // Cheers + const bitsSubscription = this._eventSubListener.onChannelCheer(streamer.userId, async (event) => { + const totalBits = (await TwitchApi.bits.getChannelBitsLeaderboard(1, "all", new Date(), event.userId))[0]?.amount ?? 0; + + twitchEventsHandler.cheer.triggerCheer( + event.userDisplayName ?? "An Anonymous Cheerer", + event.userId, + event.isAnonymous, + event.bits, + totalBits, + event.message ?? "" + ); + }); + this._subscriptions.push(bitsSubscription); + + // Channel custom reward + const customRewardRedemptionSubscription = this._eventSubListener.onChannelRedemptionAdd(streamer.userId, async (event) => { + const reward = await TwitchApi.channelRewards.getCustomChannelReward(event.rewardId); + let imageUrl = ""; + + if (reward && reward.defaultImage) { + const images = reward.defaultImage; + if (images.url4x) { + imageUrl = images.url4x; + } else if (images.url2x) { + imageUrl = images.url2x; + } else if (images.url1x) { + imageUrl = images.url1x; + } + } + + twitchEventsHandler.rewardRedemption.handleRewardRedemption( + event.id, + event.status, + !reward.shouldRedemptionsSkipRequestQueue, + event.input, + event.userId, + event.userName, + event.userDisplayName, + event.rewardId, + event.rewardTitle, + event.rewardPrompt, + event.rewardCost, + imageUrl + ); + }); + this._subscriptions.push(customRewardRedemptionSubscription); + + // Raid + const raidSubscription = this._eventSubListener.onChannelRaidTo(streamer.userId, (event) => { + twitchEventsHandler.raid.triggerRaid( + event.raidedBroadcasterName, + event.raidedBroadcasterId, + event.raidingBroadcasterDisplayName, + event.viewers + ); + }); + this._subscriptions.push(raidSubscription); + + // Shoutout sent to another channel + const shoutoutSentSubscription = this._eventSubListener.onChannelShoutoutCreate(streamer.userId, streamer.userId, (event) => { + twitchEventsHandler.shoutout.triggerShoutoutSent( + event.shoutedOutBroadcasterDisplayName, + event.moderatorDisplayName, + event.viewerCount + ) + }); + this._subscriptions.push(shoutoutSentSubscription); + + // Shoutout received from another channel + const shoutoutReceivedSubscription = this._eventSubListener.onChannelShoutoutReceive(streamer.userId, streamer.userId, (event) => { + twitchEventsHandler.shoutout.triggerShoutoutReceived( + event.shoutingOutBroadcasterDisplayName, + event.viewerCount + ) + }); + this._subscriptions.push(shoutoutReceivedSubscription); + + // Hype Train start + const hypeTrainBeginSubscription = this._eventSubListener.onChannelHypeTrainBegin(streamer.userId, (event) => { + twitchEventsHandler.hypeTrain.triggerHypeTrainStart( + event.total, + event.progress, + event.goal, + event.level, + event.startDate, + event.expiryDate, + event.lastContribution, + event.topContributors + ); + }); + this._subscriptions.push(hypeTrainBeginSubscription); + + // Hype Train progress + const hypeTrainProgressSubscription = this._eventSubListener.onChannelHypeTrainProgress(streamer.userId, (event) => { + twitchEventsHandler.hypeTrain.triggerHypeTrainProgress( + event.total, + event.progress, + event.goal, + event.level, + event.startDate, + event.expiryDate, + event.lastContribution, + event.topContributors + ); + }); + this._subscriptions.push(hypeTrainProgressSubscription); + + // Hype Train end + const hypeTrainEndSubscription = this._eventSubListener.onChannelHypeTrainEnd(streamer.userId, (event) => { + twitchEventsHandler.hypeTrain.triggerHypeTrainEnd( + event.total, + event.level, + event.startDate, + event.endDate, + event.cooldownEndDate, + event.topContributors + ); + }); + this._subscriptions.push(hypeTrainEndSubscription); + + // Channel goal begin + const channelGoalBeginSubscription = this._eventSubListener.onChannelGoalBegin(streamer.userId, (event) => { + twitchEventsHandler.goal.triggerChannelGoalBegin( + event.description, + event.type, + event.startDate, + event.currentAmount, + event.targetAmount + ); + }); + this._subscriptions.push(channelGoalBeginSubscription); + + // Channel goal progress + const channelGoalProgressSubscription = this._eventSubListener.onChannelGoalProgress(streamer.userId, (event) => { + twitchEventsHandler.goal.triggerChannelGoalProgress( + event.description, + event.type, + event.startDate, + event.currentAmount, + event.targetAmount + ); + }); + this._subscriptions.push(channelGoalProgressSubscription); + + // Channel goal end + const channelGoalEndSubscription = this._eventSubListener.onChannelGoalEnd(streamer.userId, (event) => { + twitchEventsHandler.goal.triggerChannelGoalEnd( + event.description, + event.type, + event.startDate, + event.endDate, + event.currentAmount, + event.targetAmount, + event.isAchieved + ); + }); + this._subscriptions.push(channelGoalEndSubscription); + + // Channel poll begin + const pollBeginSubscription = this._eventSubListener.onChannelPollBegin(streamer.userId, (event) => { + twitchEventsHandler.poll.triggerChannelPollBegin( + event.title, + event.choices, + event.startDate, + event.endDate, + event.isChannelPointsVotingEnabled, + event.channelPointsPerVote + ); + }); + this._subscriptions.push(pollBeginSubscription); + + // Channel poll progress + const pollProgressSubscription = this._eventSubListener.onChannelPollProgress(streamer.userId, (event) => { + twitchEventsHandler.poll.triggerChannelPollProgress( + event.title, + event.choices, + event.startDate, + event.endDate, + event.isChannelPointsVotingEnabled, + event.channelPointsPerVote + ); + }); + this._subscriptions.push(pollProgressSubscription); + + // Channel poll end + const pollEndSubscription = this._eventSubListener.onChannelPollEnd(streamer.userId, (event) => { + twitchEventsHandler.poll.triggerChannelPollEnd( + event.title, + event.choices, + event.startDate, + event.endDate, + event.isChannelPointsVotingEnabled, + event.channelPointsPerVote, + event.status + ); + }); + this._subscriptions.push(pollEndSubscription); + + // Channel prediction begin + const predictionBeginSubscription = this._eventSubListener.onChannelPredictionBegin(streamer.userId, (event) => { + twitchEventsHandler.prediction.triggerChannelPredictionBegin( + event.title, + event.outcomes, + event.startDate, + event.lockDate + ); + }); + this._subscriptions.push(predictionBeginSubscription); + + // Channel prediction progress + const predictionProgressSubscription = this._eventSubListener.onChannelPredictionProgress(streamer.userId, (event) => { + twitchEventsHandler.prediction.triggerChannelPredictionProgress( + event.title, + event.outcomes, + event.startDate, + event.lockDate + ); + }); + this._subscriptions.push(predictionProgressSubscription); + + // Channel prediction lock + const predictionLockSubscription = this._eventSubListener.onChannelPredictionLock(streamer.userId, (event) => { + twitchEventsHandler.prediction.triggerChannelPredictionLock( + event.title, + event.outcomes, + event.startDate, + event.lockDate + ); + }); + this._subscriptions.push(predictionLockSubscription); + + // Channel prediction end + const predictionEndSubscription = this._eventSubListener.onChannelPredictionEnd(streamer.userId, (event) => { + twitchEventsHandler.prediction.triggerChannelPredictionEnd( + event.title, + event.outcomes, + event.winningOutcome, + event.startDate, + event.endDate, + event.status + ); + }); + this._subscriptions.push(predictionEndSubscription); + + // Ban + const banSubscription = this._eventSubListener.onChannelBan(streamer.userId, (event) => { + if (event.endDate) { + const timeoutDuration = (event.endDate.getTime() - event.startDate.getTime()) / 1000; + twitchEventsHandler.viewerTimeout.triggerTimeout( + event.userDisplayName, + timeoutDuration, + event.moderatorName, + event.reason + ); + } else { + twitchEventsHandler.viewerBanned.triggerBanned( + event.userDisplayName, + event.moderatorName, + event.reason + ); + } + + frontendCommunicator.send("twitch:chat:user:delete-messages", event.userName); + }); + this._subscriptions.push(banSubscription); + + // Unban + const unbanSubscription = this._eventSubListener.onChannelUnban(streamer.userId, (event) => { + twitchEventsHandler.viewerBanned.triggerUnbanned( + event.userName, + event.moderatorName + ) + }); + this._subscriptions.push(unbanSubscription); + + // Charity Campaign Start + const charityCampaignStartSubscription = this._eventSubListener.onChannelCharityCampaignStart(streamer.userId, (event) => { + twitchEventsHandler.charity.triggerCharityCampaignStart( + event.charityName, + event.charityDescription, + event.charityLogo, + event.charityWebsite, + event.currentAmount.localizedValue, + event.currentAmount.currency, + event.targetAmount.localizedValue, + event.targetAmount.currency + ); + }); + this._subscriptions.push(charityCampaignStartSubscription); + + // Charity Donation + const charityDonationSubscription = this._eventSubListener.onChannelCharityDonation(streamer.userId, (event) => { + twitchEventsHandler.charity.triggerCharityDonation( + event.donorDisplayName, + event.charityName, + event.charityDescription, + event.charityLogo, + event.charityWebsite, + event.amount.localizedValue, + event.amount.currency + ); + }); + this._subscriptions.push(charityDonationSubscription); + + // Charity Campaign Progress + const charityCampaignProgressSubscription = this._eventSubListener.onChannelCharityCampaignProgress(streamer.userId, (event) => { + twitchEventsHandler.charity.triggerCharityCampaignProgress( + event.charityName, + event.charityDescription, + event.charityLogo, + event.charityWebsite, + event.currentAmount.localizedValue, + event.currentAmount.currency, + event.targetAmount.localizedValue, + event.targetAmount.currency + ); + }); + this._subscriptions.push(charityCampaignProgressSubscription); + + // Charity Campaign End + const charityCampaignEndSubscription = this._eventSubListener.onChannelCharityCampaignStop(streamer.userId, (event) => { + twitchEventsHandler.charity.triggerCharityCampaignEnd( + event.charityName, + event.charityDescription, + event.charityLogo, + event.charityWebsite, + event.currentAmount.localizedValue, + event.currentAmount.currency, + event.targetAmount.localizedValue, + event.targetAmount.currency + ); + }); + this._subscriptions.push(charityCampaignEndSubscription); + } catch (error) { + logger.error("Failed to connect to Twitch EventSub", error); + return; + } + + logger.info("Connected to the Twitch EventSub!"); + } + + async removeSubscriptions(): Promise { + this._subscriptions = []; + } + + async disconnectEventSub(): Promise { + await this.removeSubscriptions(); + try { + if (this._eventSubListener) { + this._eventSubListener.stop(); + logger.info("Disconnected from EventSub."); + } + } catch (error) { + logger.debug("Error disconnecting EventSub", error); + } + }; +} + +export = new TwitchEventSubClient(); \ No newline at end of file diff --git a/src/backend/twitch-api/follow-poll.js b/src/backend/twitch-api/follow-poll.js deleted file mode 100644 index ef36c6e5f..000000000 --- a/src/backend/twitch-api/follow-poll.js +++ /dev/null @@ -1,63 +0,0 @@ -"use strict"; - -const accountAccess = require("../common/account-access"); - -const twitchApi = require("./api"); - -const twitchEventsHandler = require("../events/twitch-events"); - -let followPollIntervalId; -let lastUserId; -let pollStartTime; - -function clearPollInterval() { - if (followPollIntervalId != null) { - clearTimeout(followPollIntervalId); - } -} - -exports.startFollowPoll = () => { - clearPollInterval(); - pollStartTime = Date.now(); - followPollIntervalId = setInterval(async () => { - const streamer = accountAccess.getAccounts().streamer; - const client = twitchApi.streamerClient; - - if (client == null || !streamer.loggedIn) { - return; - } - - const follows = (await client.channels.getChannelFollowers(streamer.userId, streamer.userId)).data; - - if (follows == null || follows.length < 1) { - return; - } - - if (lastUserId == null) { - lastUserId = follows[0].userId; - } else { - for (const follow of follows) { - - if (follow.followDate < pollStartTime) { - break; - } - - if (follow.userId !== lastUserId) { - twitchEventsHandler.follow.triggerFollow( - follow.userId, - follow.userName, - follow.userDisplayName - ); - } else { - break; - } - - } - lastUserId = follows[0].userId; - } - }, 10000); -}; - -exports.stopFollowPoll = () => { - clearPollInterval(); -}; \ No newline at end of file diff --git a/src/backend/twitch-api/pubsub/pubsub-client.js b/src/backend/twitch-api/pubsub/pubsub-client.js index b7a078e84..6b2073214 100644 --- a/src/backend/twitch-api/pubsub/pubsub-client.js +++ b/src/backend/twitch-api/pubsub/pubsub-client.js @@ -67,40 +67,6 @@ async function createClient() { try { const twitchEventsHandler = require('../../events/twitch-events'); - const redemptionListener = pubSubClient.onRedemption(streamer.userId, - (message) => { - logger.debug("Got reward redemption event!"); - - let imageUrl = ""; - if (message && message.rewardImage) { - const images = message.rewardImage; - if (images.url_4x) { - imageUrl = images.url_4x; - } else if (images.url_2x) { - imageUrl = images.url_2x; - } else if (images.url_1x) { - imageUrl = images.url_1x; - } - } - - twitchEventsHandler.rewardRedemption.handleRewardRedemption( - message.id, - message.status, - message.rewardIsQueued, - message.message ?? "", - message.userId, - message.userName, - message.userDisplayName, - message.rewardId, - message.rewardTitle, - message.rewardPrompt ?? "", - message.rewardCost, - imageUrl - ); - }); - - listeners.push(redemptionListener); - const whisperListener = pubSubClient.onWhisper(streamer.userId, (message) => { twitchEventsHandler.whisper.triggerWhisper( message.senderName, @@ -109,18 +75,6 @@ async function createClient() { }); listeners.push(whisperListener); - const bitsListener = pubSubClient.onBits(streamer.userId, (message) => { - twitchEventsHandler.cheer.triggerCheer( - message.userName ?? "An Anonymous Cheerer", - message.userId, - message.isAnonymous, - message.bits, - message.totalBits, - message.message ?? "" - ); - }); - listeners.push(bitsListener); - const bitsBadgeUnlockListener = pubSubClient.onBitsBadgeUnlock(streamer.userId, (message) => { twitchEventsHandler.cheer.triggerBitsBadgeUnlock( message.userName ?? "An Anonymous Cheerer", @@ -182,29 +136,6 @@ async function createClient() { case "clear": frontendCommunicator.send("twitch:chat:clear-feed", message.userName); break; - case "ban": - twitchEventsHandler.viewerBanned.triggerBanned( - message.args[0], - message.userName, - message.args[1] ?? "" - ); - frontendCommunicator.send("twitch:chat:user:delete-messages", message.args[0]); - break; - case "timeout": - twitchEventsHandler.viewerTimeout.triggerTimeout( - message.args[0], - message.args[1], - message.userName, - message.args[2] ?? "" - ); - frontendCommunicator.send("twitch:chat:user:delete-messages", message.args[0]); - break; - case "unban": - twitchEventsHandler.viewerBanned.triggerUnbanned( - message.args[0], - message.userName - ); - break; case "emoteonly": case "emoteonlyoff": case "subscribers": diff --git a/src/backend/twitch-api/resource/auth.ts b/src/backend/twitch-api/resource/auth.ts index 91eec3007..bbe108508 100644 --- a/src/backend/twitch-api/resource/auth.ts +++ b/src/backend/twitch-api/resource/auth.ts @@ -3,12 +3,12 @@ import accountAccess from "../../common/account-access"; import { ApiClient } from "@twurple/api"; export class TwitchAuthApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } async isTokenValid(type: "streamer" | "bot"): Promise { @@ -18,12 +18,12 @@ export class TwitchAuthApi { switch (type) { case "streamer": userId = accountAccess.getAccounts().streamer.userId; - apiClient = this.streamerClient; + apiClient = this._streamerClient; break; case "bot": userId = accountAccess.getAccounts().bot.userId; - apiClient = this.botClient; + apiClient = this._botClient; break; } diff --git a/src/backend/twitch-api/resource/bits.ts b/src/backend/twitch-api/resource/bits.ts index 1e00ce428..4a342a049 100644 --- a/src/backend/twitch-api/resource/bits.ts +++ b/src/backend/twitch-api/resource/bits.ts @@ -3,12 +3,12 @@ import accountAccess from "../../common/account-access"; import { ApiClient, HelixBitsLeaderboardEntry, HelixBitsLeaderboardPeriod, HelixBitsLeaderboardQuery } from "@twurple/api"; export class TwitchBitsApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } async getChannelBitsLeaderboard( @@ -27,7 +27,7 @@ export class TwitchBitsApi { startDate: startDate, contextUserId: userId }; - leaderboard.push(...(await this.streamerClient.bits.getLeaderboard(streamerId, params)).entries); + leaderboard.push(...(await this._streamerClient.bits.getLeaderboard(streamerId, params)).entries); } catch (error) { logger.error("Failed to get channel bits leaderboard", error.message); } diff --git a/src/backend/twitch-api/resource/categories.ts b/src/backend/twitch-api/resource/categories.ts index 67fcf184e..1a4be310f 100644 --- a/src/backend/twitch-api/resource/categories.ts +++ b/src/backend/twitch-api/resource/categories.ts @@ -16,12 +16,12 @@ export interface TwitchCategory { }; export class TwitchCategoriesApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } private mapTwitchCategory(category: HelixGame, size?: string): TwitchCategory { @@ -34,7 +34,7 @@ export class TwitchCategoriesApi { async getCategoryById(categoryId: string, size = "285x380"): Promise { try { - const category = await this.streamerClient.games.getGameById(categoryId); + const category = await this._streamerClient.games.getGameById(categoryId); if (category == null) { return null; } @@ -49,7 +49,7 @@ export class TwitchCategoriesApi { let categories: HelixGame[] = []; try { - const response = await this.streamerClient.search.searchCategories(categoryName); + const response = await this._streamerClient.search.searchCategories(categoryName); if (response && response.data) { categories = response.data; } diff --git a/src/backend/twitch-api/resource/channel-rewards.ts b/src/backend/twitch-api/resource/channel-rewards.ts index e7847b64d..dc1ad582f 100644 --- a/src/backend/twitch-api/resource/channel-rewards.ts +++ b/src/backend/twitch-api/resource/channel-rewards.ts @@ -41,12 +41,12 @@ export interface CustomReward { }; export class TwitchChannelRewardsApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } private mapCustomRewardToCreateRewardPayload(reward: CustomReward): HelixCreateCustomRewardData { @@ -154,7 +154,7 @@ export class TwitchChannelRewardsApi { async getCustomChannelRewards(onlyManageable: boolean = false): Promise { let rewards = []; try { - const response = await this.streamerClient.channelPoints.getCustomRewards( + const response = await this._streamerClient.channelPoints.getCustomRewards( accountAccess.getAccounts().streamer.userId, onlyManageable ); @@ -170,6 +170,27 @@ export class TwitchChannelRewardsApi { return rewards.map(r => this.mapCustomRewardResponse(r)); } + async getCustomChannelReward(rewardId: string): Promise { + let reward: HelixCustomReward; + + try { + const response = await this._streamerClient.channelPoints.getCustomRewardById( + accountAccess.getAccounts().streamer.userId, + rewardId + ); + if (response) { + reward = response; + } else { + return null; + } + } catch (err) { + logger.error("Failed to get Twitch custom channel reward", err.message); + return null; + } + + return this.mapCustomRewardResponse(reward); + }; + async getManageableCustomChannelRewards(): Promise { return await this.getCustomChannelRewards(true); } @@ -193,7 +214,7 @@ export class TwitchChannelRewardsApi { const data = this.mapCustomRewardToCreateRewardPayload(reward); try { - const response = await this.streamerClient.channelPoints.createCustomReward( + const response = await this._streamerClient.channelPoints.createCustomReward( accountAccess.getAccounts().streamer.userId, data ); @@ -207,7 +228,7 @@ export class TwitchChannelRewardsApi { async updateCustomChannelReward(reward: CustomReward): Promise { try { - await this.streamerClient.channelPoints.updateCustomReward( + await this._streamerClient.channelPoints.updateCustomReward( accountAccess.getAccounts().streamer.userId, reward.id, this.mapCustomRewardToUpdateRewardPayload(reward) @@ -221,7 +242,7 @@ export class TwitchChannelRewardsApi { async deleteCustomChannelReward(rewardId: string): Promise { try { - await this.streamerClient.channelPoints.deleteCustomReward(accountAccess.getAccounts().streamer.userId, rewardId); + await this._streamerClient.channelPoints.deleteCustomReward(accountAccess.getAccounts().streamer.userId, rewardId); return true; } catch (err) { logger.error("Failed to update twitch custom channel reward", err.message); @@ -231,7 +252,7 @@ export class TwitchChannelRewardsApi { async approveOrRejectChannelRewardRedemption(rewardId: string, redemptionId: string, approve: boolean = true): Promise { try { - const response = await this.streamerClient.channelPoints.updateRedemptionStatusByIds( + const response = await this._streamerClient.channelPoints.updateRedemptionStatusByIds( accountAccess.getAccounts().streamer.userId, rewardId, [redemptionId], diff --git a/src/backend/twitch-api/resource/channels.ts b/src/backend/twitch-api/resource/channels.ts index e4b69b5f7..6f917ef7f 100644 --- a/src/backend/twitch-api/resource/channels.ts +++ b/src/backend/twitch-api/resource/channels.ts @@ -1,14 +1,14 @@ -import accountAccess from "../../common/account-access"; import logger from '../../logwrapper'; +import accountAccess from "../../common/account-access"; import { ApiClient, CommercialLength, HelixChannel, HelixChannelUpdate, HelixUser } from "@twurple/api"; export class TwitchChannelsApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } /** @@ -23,7 +23,7 @@ export class TwitchChannelsApi { } try { - const response = await this.streamerClient.channels.getChannelInfoById(broadcasterId); + const response = await this._streamerClient.channels.getChannelInfoById(broadcasterId); return response; } catch (error) { logger.error("Failed to get twitch channel info", error.message); @@ -37,12 +37,12 @@ export class TwitchChannelsApi { * @param userId */ async getOnlineStatus(userId: string): Promise { - if (this.streamerClient == null) { + if (this._streamerClient == null) { return false; } try { - const stream = await this.streamerClient.streams.getStreamByUserId(userId); + const stream = await this._streamerClient.streams.getStreamByUserId(userId); if (stream != null) { return true; } @@ -59,7 +59,7 @@ export class TwitchChannelsApi { * @param data */ async updateChannelInformation(data: HelixChannelUpdate): Promise { - await this.streamerClient.channels.updateChannelInfo(accountAccess.getAccounts().streamer.userId, data); + await this._streamerClient.channels.updateChannelInfo(accountAccess.getAccounts().streamer.userId, data); } /** @@ -74,7 +74,7 @@ export class TwitchChannelsApi { let user: HelixUser; try { - user = await this.streamerClient.users.getUserByName(username); + user = await this._streamerClient.users.getUserByName(username); } catch (error) { logger.error(`Error getting user with username ${username}`, error.message); } @@ -97,7 +97,7 @@ export class TwitchChannelsApi { const isOnline = await this.getOnlineStatus(streamer.userId); if (isOnline && streamer.broadcasterType !== "") { - await this.streamerClient.channels.startChannelCommercial(streamer.userId, adLength as CommercialLength); + await this._streamerClient.channels.startChannelCommercial(streamer.userId, adLength as CommercialLength); } logger.debug(`A commercial was run. Length: ${adLength}. Twitch does not send confirmation, so we can't be sure it ran.`); @@ -118,7 +118,7 @@ export class TwitchChannelsApi { try { const streamerId = accountAccess.getAccounts().streamer.userId; - await this.streamerClient.raids.startRaid(streamerId, targetUserId); + await this._streamerClient.raids.startRaid(streamerId, targetUserId); return true; } catch (error) { @@ -135,7 +135,7 @@ export class TwitchChannelsApi { try { const streamerId = accountAccess.getAccounts().streamer.userId; - await this.streamerClient.raids.cancelRaid(streamerId); + await this._streamerClient.raids.cancelRaid(streamerId); return true; } catch (error) { @@ -153,11 +153,11 @@ export class TwitchChannelsApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - let result = await this.streamerClient.channels.getVips(streamerId); + let result = await this._streamerClient.channels.getVips(streamerId); vips.push(...result.data.map(c => c.displayName)); while (result.cursor) { - result = await this.streamerClient.channels.getVips(streamerId, { after: result.cursor }); + result = await this._streamerClient.channels.getVips(streamerId, { after: result.cursor }); vips.push(...result.data.map(c => c.displayName)); } } catch (error) { diff --git a/src/backend/twitch-api/resource/charity.ts b/src/backend/twitch-api/resource/charity.ts new file mode 100644 index 000000000..baf49f635 --- /dev/null +++ b/src/backend/twitch-api/resource/charity.ts @@ -0,0 +1,29 @@ +import accountAccess from "../../common/account-access"; +import logger from '../../logwrapper'; +import { ApiClient, CommercialLength, HelixChannel, HelixChannelUpdate, HelixUser } from "@twurple/api"; + +export class TwitchCharityApi { + private _streamerClient: ApiClient; + private _botClient: ApiClient; + + constructor(streamerClient: ApiClient, botClient: ApiClient) { + this._streamerClient = streamerClient; + this._botClient = botClient; + } + + async getCurrentCharityFundraiserTotal(): Promise { + const streamerId = accountAccess.getAccounts().streamer.userId; + + const totalRaised = (await this._streamerClient.charity.getCharityCampaign(streamerId))?.currentAmount?.localizedValue; + + return totalRaised; + } + + async getCurrentCharityFundraiserGoal(): Promise { + const streamerId = accountAccess.getAccounts().streamer.userId; + + const goal = (await this._streamerClient.charity.getCharityCampaign(streamerId))?.targetAmount?.localizedValue; + + return goal; + } +} \ No newline at end of file diff --git a/src/backend/twitch-api/resource/chat.ts b/src/backend/twitch-api/resource/chat.ts index 1c45ee171..a89b241a6 100644 --- a/src/backend/twitch-api/resource/chat.ts +++ b/src/backend/twitch-api/resource/chat.ts @@ -3,12 +3,12 @@ import accountAccess from "../../common/account-access"; import { ApiClient, HelixChatAnnouncementColor, HelixSendChatAnnouncementParams, HelixUpdateChatSettingsParams } from "@twurple/api"; export class TwitchChatApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } /** @@ -20,11 +20,11 @@ export class TwitchChatApi { try { const streamerUserId: string = accountAccess.getAccounts().streamer.userId; - let result = await this.streamerClient.chat.getChatters(streamerUserId, streamerUserId); + let result = await this._streamerClient.chat.getChatters(streamerUserId); chatters.push(...result.data.map(c => c.userDisplayName)); while (result.cursor) { - result = await this.streamerClient.chat.getChatters(streamerUserId, streamerUserId, { after: result.cursor }); + result = await this._streamerClient.chat.getChatters(streamerUserId, { after: result.cursor }); chatters.push(...result.data.map(c => c.userDisplayName)); } } catch (error) { @@ -52,7 +52,7 @@ export class TwitchChatApi { const streamerUserId: string = accountAccess.getAccounts().streamer.userId; const willSendAsBot: boolean = sendAsBot === true && accountAccess.getAccounts().bot?.userId != null - && this.botClient != null; + && this._botClient != null; const senderUserId: string = willSendAsBot === true ? accountAccess.getAccounts().bot.userId : streamerUserId; @@ -74,9 +74,11 @@ export class TwitchChatApi { }; if (willSendAsBot === true) { - await this.botClient.chat.sendAnnouncement(streamerUserId, senderUserId, announcement); + await this._botClient.asUser(senderUserId, async ctx => { + await ctx.chat.sendAnnouncement(streamerUserId, announcement); + }); } else { - await this.streamerClient.chat.sendAnnouncement(streamerUserId, senderUserId, announcement); + await this._streamerClient.chat.sendAnnouncement(streamerUserId, announcement); } } @@ -97,7 +99,7 @@ export class TwitchChatApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.chat.shoutoutUser(streamerId, targetUserId, streamerId); + await this._streamerClient.chat.shoutoutUser(streamerId, targetUserId); } catch (error) { logger.error("Error sending shoutout", error.message); return false; @@ -116,7 +118,7 @@ export class TwitchChatApi { const streamerUserId: string = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.moderation.deleteChatMessages(streamerUserId, streamerUserId, messageId); + await this._streamerClient.moderation.deleteChatMessages(streamerUserId, messageId); return true; } catch (error) { @@ -135,7 +137,7 @@ export class TwitchChatApi { const streamerUserId: string = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.moderation.deleteChatMessages(streamerUserId, streamerUserId); + await this._streamerClient.moderation.deleteChatMessages(streamerUserId, streamerUserId); return true; } catch (error) { @@ -159,7 +161,7 @@ export class TwitchChatApi { emoteOnlyModeEnabled: enable }; - await this.streamerClient.chat.updateSettings(streamerUserId, streamerUserId, chatSettings); + await this._streamerClient.chat.updateSettings(streamerUserId, chatSettings); return true; } catch (error) { @@ -185,7 +187,7 @@ export class TwitchChatApi { followerOnlyModeDelay: duration }; - await this.streamerClient.chat.updateSettings(streamerUserId, streamerUserId, chatSettings); + await this._streamerClient.chat.updateSettings(streamerUserId, chatSettings); return true; } catch (error) { @@ -209,7 +211,7 @@ export class TwitchChatApi { subscriberOnlyModeEnabled: enable }; - await this.streamerClient.chat.updateSettings(streamerUserId, streamerUserId, chatSettings); + await this._streamerClient.chat.updateSettings(streamerUserId, chatSettings); return true; } catch (error) { @@ -235,7 +237,7 @@ export class TwitchChatApi { slowModeDelay: enable === true ? duration : null }; - await this.streamerClient.chat.updateSettings(streamerUserId, streamerUserId, chatSettings); + await this._streamerClient.chat.updateSettings(streamerUserId, chatSettings); return true; } catch (error) { @@ -259,7 +261,7 @@ export class TwitchChatApi { uniqueChatModeEnabled: enable }; - await this.streamerClient.chat.updateSettings(streamerUserId, streamerUserId, chatSettings); + await this._streamerClient.chat.updateSettings(streamerUserId, chatSettings); return true; } catch (error) { diff --git a/src/backend/twitch-api/resource/moderation.ts b/src/backend/twitch-api/resource/moderation.ts index 5143e7372..8365fd23b 100644 --- a/src/backend/twitch-api/resource/moderation.ts +++ b/src/backend/twitch-api/resource/moderation.ts @@ -3,12 +3,12 @@ import accountAccess from "../../common/account-access"; import { ApiClient, HelixBanUserRequest, UserIdResolvable } from "@twurple/api"; export class TwitchModerationApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } /** @@ -33,7 +33,7 @@ export class TwitchModerationApi { reason: reason }; - const response = await this.streamerClient.moderation.banUser(streamerId, streamerId, timeoutRequest); + const response = await this._streamerClient.moderation.banUser(streamerId, timeoutRequest); return true; } catch (error) { @@ -60,7 +60,7 @@ export class TwitchModerationApi { reason: reason }; - await this.streamerClient.moderation.banUser(streamerId, streamerId, banRequest); + await this._streamerClient.moderation.banUser(streamerId, banRequest); return true; } catch (error) { @@ -80,7 +80,7 @@ export class TwitchModerationApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.moderation.unbanUser(streamerId, streamerId, userId); + await this._streamerClient.moderation.unbanUser(streamerId, userId); return true; } catch (error) { @@ -100,7 +100,7 @@ export class TwitchModerationApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.moderation.addModerator(streamerId, userId); + await this._streamerClient.moderation.addModerator(streamerId, userId); return true; } catch (error) { @@ -120,7 +120,7 @@ export class TwitchModerationApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.moderation.removeModerator(streamerId, userId); + await this._streamerClient.moderation.removeModerator(streamerId, userId); return true; } catch (error) { @@ -140,7 +140,7 @@ export class TwitchModerationApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.channels.addVip(streamerId, userId); + await this._streamerClient.channels.addVip(streamerId, userId); return true; } catch (error) { logger.error("Error adding VIP", error.message); @@ -159,7 +159,7 @@ export class TwitchModerationApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.channels.removeVip(streamerId, userId); + await this._streamerClient.channels.removeVip(streamerId, userId); return true; } catch (error) { logger.error("Error removing VIP", error.message); diff --git a/src/backend/twitch-api/resource/polls.ts b/src/backend/twitch-api/resource/polls.ts new file mode 100644 index 000000000..6785886db --- /dev/null +++ b/src/backend/twitch-api/resource/polls.ts @@ -0,0 +1,71 @@ +import logger from '../../logwrapper'; +import accountAccess from "../../common/account-access"; +import { ApiClient, HelixPoll } from "@twurple/api"; + +export class TwitchPollsApi { + private _streamerClient: ApiClient; + private _botClient: ApiClient; + + constructor(streamerClient: ApiClient, botClient: ApiClient) { + this._streamerClient = streamerClient; + this._botClient = botClient; + } + + /** + * Creates a Twitch poll + * + * @param title Title of the poll + * @param choices List of choices for the poll. Minimum of 2, maximum of 5. + * @param duration Duration in seconds to show poll. Minimum of 15, maximum of 1800 (30 minutes). + * @param channelPointsPerVote Number of channel points per additional vote. If null, channel point voting will be disabled. + */ + async createPoll(title: string, choices: string[], duration: number, channelPointsPerVote: number = null): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + this._streamerClient.polls.createPoll(streamerId, { + title: title, + choices: choices, + duration: duration, + channelPointsPerVote: channelPointsPerVote + }) + } catch (error) { + logger.error("Failed to create Twitch poll", error.message); + } + } + + /** + * End a Twitch poll. + * + * @param pollId The poll ID. + * @param showResult Whether to show the result, or archive and hide the result. + */ + async endPoll(pollId: string, showResult: boolean = true): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + await this._streamerClient.polls.endPoll(streamerId, pollId, showResult); + } catch (error) { + logger.error("Failed to end Twitch poll", error.message); + } + } + + /** + * Retrieve the most recent Twitch poll + * + * @returns A HelixPoll object with the most recent Twitch poll data + */ + async getMostRecentPoll(): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + const polls = await this._streamerClient.polls.getPolls(streamerId); + + return polls.data[0]; + + } catch (error) { + logger.error("Failed to get most recent Twitch poll", error.message); + return null; + } + } +}; \ No newline at end of file diff --git a/src/backend/twitch-api/resource/predictions.ts b/src/backend/twitch-api/resource/predictions.ts new file mode 100644 index 000000000..00211a8b7 --- /dev/null +++ b/src/backend/twitch-api/resource/predictions.ts @@ -0,0 +1,99 @@ +import logger from '../../logwrapper'; +import accountAccess from "../../common/account-access"; +import { ApiClient, HelixPrediction } from "@twurple/api"; + +export class TwitchPredictionsApi { + private _streamerClient: ApiClient; + private _botClient: ApiClient; + + constructor(streamerClient: ApiClient, botClient: ApiClient) { + this._streamerClient = streamerClient; + this._botClient = botClient; + } + + /** + * Creates a Twitch prediction + * + * @param title Title of the prediction + * @param outcomes List of outcomes for the prediction. Minimum of 2, maximum of 10. + * @param duration Duration in seconds to allow predictions. Minimum of 30, maximum of 1800 (30 minutes). + */ + async createPrediction(title: string, outcomes: string[], duration: number): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + this._streamerClient.predictions.createPrediction(streamerId, { + title: title, + outcomes: outcomes, + autoLockAfter: duration + }) + } catch (error) { + logger.error("Failed to create Twitch prediction", error.message); + } + } + + /** + * Locks a Twitch prediction so no more predictions can be made + * + * @param predictionId The prediction ID. + */ + async lockPrediciton(predictionId: string): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + await this._streamerClient.predictions.lockPrediction(streamerId, predictionId); + } catch (error) { + logger.error("Failed to lock Twitch prediction", error.message); + } + } + + /** + * Cancels a Twitch prediction and refunds all wagered channel points + * + * @param predictionId The prediction ID. + */ + async cancelPrediction(predictionId: string): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + await this._streamerClient.predictions.cancelPrediction(streamerId, predictionId); + } catch (error) { + logger.error("Failed to cancel Twitch prediction", error.message); + } + } + + /** + * Resolve a Twitch prediction. + * + * @param predictionId The prediction ID. + * @param outcomeId The winning outcome ID. + */ + async resolvePrediction(predictionId: string, outcomeId: string): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + await this._streamerClient.predictions.resolvePrediction(streamerId, predictionId, outcomeId); + } catch (error) { + logger.error("Failed to resolve Twitch prediction", error.message); + } + } + + /** + * Retrieve the most recent Twitch prediction + * + * @returns A HelixPrediction object with the most recent Twitch prediction data + */ + async getMostRecentPrediction(): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + + const predictions = await this._streamerClient.predictions.getPredictions(streamerId); + + return predictions.data[0]; + + } catch (error) { + logger.error("Failed to get most recent Twitch prediction", error.message); + return null; + } + } +}; \ No newline at end of file diff --git a/src/backend/twitch-api/resource/streams.ts b/src/backend/twitch-api/resource/streams.ts index 7c768b1e5..765a1841d 100644 --- a/src/backend/twitch-api/resource/streams.ts +++ b/src/backend/twitch-api/resource/streams.ts @@ -3,19 +3,19 @@ import accountAccess from "../../common/account-access"; import { ApiClient } from "@twurple/api"; export class TwitchStreamsApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } - async createStreamMarker(descriotion?: string): Promise { + async createStreamMarker(description?: string): Promise { try { const streamerId = accountAccess.getAccounts().streamer.userId; - await this.streamerClient.streams.createStreamMarker(streamerId, descriotion); + await this._streamerClient.streams.createStreamMarker(streamerId, description); } catch (error) { logger.error(`Failed to create stream marker`, error.message); } diff --git a/src/backend/twitch-api/resource/subscriptions.ts b/src/backend/twitch-api/resource/subscriptions.ts new file mode 100644 index 000000000..10c8869a1 --- /dev/null +++ b/src/backend/twitch-api/resource/subscriptions.ts @@ -0,0 +1,47 @@ +import logger from '../../logwrapper'; +import accountAccess from "../../common/account-access"; +import { ApiClient } from "@twurple/api"; + +export class TwitchSubscriptionsApi { + private _streamerClient: ApiClient; + private _botClient: ApiClient; + + constructor(streamerClient: ApiClient, botClient: ApiClient) { + this._streamerClient = streamerClient; + this._botClient = botClient; + } + + /** + * Retrieves the number of subscribers the streamer has + * + * @returns Number of subscribers the streamer has + */ + async getSubscriberCount(): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + const subscriberInfo = await this._streamerClient.subscriptions.getSubscriptions(streamerId); + + return subscriberInfo.total; + } catch (error) { + logger.error("Error getting channel subscriber count", error.message) + return 0; + } + } + + /** + * Retrieves the number of sub points the streamer has + * + * @returns Number of sub points the streamer has + */ + async getSubPointCount(): Promise { + try { + const streamerId = accountAccess.getAccounts().streamer.userId; + const subscriberInfo = await this._streamerClient.subscriptions.getSubscriptions(streamerId); + + return subscriberInfo.points; + } catch (error) { + logger.error("Error getting channel sub point count", error.message) + return 0; + } + } +} \ No newline at end of file diff --git a/src/backend/twitch-api/resource/teams.ts b/src/backend/twitch-api/resource/teams.ts index 0fa0f93d8..2b3d86c99 100644 --- a/src/backend/twitch-api/resource/teams.ts +++ b/src/backend/twitch-api/resource/teams.ts @@ -3,17 +3,17 @@ import accountAccess from "../../common/account-access"; import { ApiClient, HelixTeam } from "@twurple/api"; export class TwitchTeamsApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } async getTeams(broadcasterId: string): Promise { try { - const teams = await this.streamerClient.teams.getTeamsForBroadcaster(broadcasterId); + const teams = await this._streamerClient.teams.getTeamsForBroadcaster(broadcasterId); if (teams != null) { return teams; @@ -45,7 +45,7 @@ export class TwitchTeamsApi { async getMatchingTeamsByName(username: string): Promise { try { - const user = await this.streamerClient.users.getUserByName(username); + const user = await this._streamerClient.users.getUserByName(username); if (user == null) { return null; diff --git a/src/backend/twitch-api/resource/users.ts b/src/backend/twitch-api/resource/users.ts index 61cbba260..92360429a 100644 --- a/src/backend/twitch-api/resource/users.ts +++ b/src/backend/twitch-api/resource/users.ts @@ -3,24 +3,24 @@ import logger from "../../logwrapper"; import { ApiClient, HelixUser, UserIdResolvable } from "@twurple/api"; export class TwitchUsersApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } async getUserById(userId: string): Promise { - return await this.streamerClient.users.getUserById(userId); + return await this._streamerClient.users.getUserById(userId); } async getUserByName(username: string): Promise { - return await this.streamerClient.users.getUserByName(username); + return await this._streamerClient.users.getUserByName(username); } async getUsersByNames(usernames: string[]): Promise { - return await this.streamerClient.users.getUsersByNames(usernames); + return await this._streamerClient.users.getUsersByNames(usernames); } async getFollowDateForUser(username: string): Promise { @@ -28,7 +28,7 @@ export class TwitchUsersApi { const userId = (await this.getUserByName(username)).id; - const followData = await this.streamerClient.channels.getChannelFollowers(streamerData.userId, streamerData.userId, userId); + const followData = await this._streamerClient.channels.getChannelFollowers(streamerData.userId, userId); if (followData?.data[0] == null) { return null; @@ -55,7 +55,7 @@ export class TwitchUsersApi { } try { - const userFollowResponse = await this.streamerClient.channels.getChannelFollowers(channel.id, streamerData.userId, user.id); + const userFollowResponse = await this._streamerClient.channels.getChannelFollowers(channel.id, user.id); const userFollow = userFollowResponse?.data?.length === 1; return userFollow ?? false; @@ -73,7 +73,7 @@ export class TwitchUsersApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.users.createBlock(streamerId, userId, { + await this._streamerClient.users.createBlock(streamerId, userId, { reason }); } catch (error) { @@ -92,7 +92,7 @@ export class TwitchUsersApi { const streamerId = accountAccess.getAccounts().streamer.userId; try { - await this.streamerClient.users.deleteBlock(streamerId, userId); + await this._streamerClient.users.deleteBlock(streamerId, userId); } catch (error) { logger.error("Error unblocking user", error.message); return false; diff --git a/src/backend/twitch-api/resource/whispers.ts b/src/backend/twitch-api/resource/whispers.ts index 6a7b8e675..76c524a0a 100644 --- a/src/backend/twitch-api/resource/whispers.ts +++ b/src/backend/twitch-api/resource/whispers.ts @@ -3,12 +3,12 @@ import accountAccess from "../../common/account-access"; import { ApiClient, UserIdResolvable } from "@twurple/api"; export class TwitchWhispersApi { - streamerClient: ApiClient; - botClient: ApiClient; + private _streamerClient: ApiClient; + private _botClient: ApiClient; constructor(streamerClient: ApiClient, botClient: ApiClient) { - this.streamerClient = streamerClient; - this.botClient = botClient; + this._streamerClient = streamerClient; + this._botClient = botClient; } /** @@ -28,16 +28,16 @@ export class TwitchWhispersApi { ): Promise { const willSendAsBot: boolean = sendAsBot === true && accountAccess.getAccounts().bot?.userId != null - && this.botClient != null; + && this._botClient != null; const senderUserId: string = willSendAsBot === true ? accountAccess.getAccounts().bot.userId : accountAccess.getAccounts().streamer.userId; try { if (willSendAsBot === true) { - await this.botClient.whispers.sendWhisper(senderUserId, recipientUserId, message); + await this._botClient.whispers.sendWhisper(senderUserId, recipientUserId, message); } else { - await this.streamerClient.whispers.sendWhisper(senderUserId, recipientUserId, message); + await this._streamerClient.whispers.sendWhisper(senderUserId, recipientUserId, message); } return true; diff --git a/src/backend/variables/builtin-variable-loader.js b/src/backend/variables/builtin-variable-loader.js index 23009f586..e4dc2880e 100644 --- a/src/backend/variables/builtin-variable-loader.js +++ b/src/backend/variables/builtin-variable-loader.js @@ -41,6 +41,12 @@ exports.loadReplaceVariables = () => { 'bot', 'category-image-url', 'category', + 'charity-campaign-goal', + 'charity-campaign-total', + 'charity-description', + 'charity-logo', + 'charity-name', + 'charity-website', 'chat-message-animated-emote-urls', 'chat-message-emote-names', 'chat-message-emote-urls', @@ -98,6 +104,8 @@ exports.loadReplaceVariables = () => { 'gift-sub-type', 'has-role', 'has-roles', + 'hype-train-level', + 'hype-train-percent', 'loop-count', 'loop-item', 'math', @@ -115,6 +123,8 @@ exports.loadReplaceVariables = () => { 'object-walk-path-raw', 'object-walk-path', 'ordinal-indicator', + 'poll-winning-choice-name', + 'prediction-winning-outcome-name', 'preset-list-arg', 'previous-currency-amount', 'profile-page-bytebin-token', @@ -159,10 +169,8 @@ exports.loadReplaceVariables = () => { 'spoofed/or', 'stream-title', 'streamer', - 'sub-count', 'sub-message', 'sub-months', - 'sub-points', 'sub-streak', 'sub-type', 'sub-users', @@ -207,8 +215,12 @@ exports.loadReplaceVariables = () => { 'username', 'video-duration', 'view-time', + 'viewer-count', 'whisper-message', - 'word' + 'word', + + 'twitch/sub-count', + 'twitch/sub-points' ].forEach(filename => { const definition = require(`./builtin/${filename}`); replaceVariableManager.registerReplaceVariable(definition); diff --git a/src/backend/variables/builtin/charity-campaign-goal.ts b/src/backend/variables/builtin/charity-campaign-goal.ts new file mode 100644 index 000000000..95f3e5e42 --- /dev/null +++ b/src/backend/variables/builtin/charity-campaign-goal.ts @@ -0,0 +1,37 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; +import twitchApi from "../../twitch-api/api"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = [ + "twitch:charity-campaign-start", + "twitch:charity-campaign-progress", + "twitch:charity-campaign-end" +]; +triggers[EffectTrigger.COMMAND] = true; +triggers[EffectTrigger.PRESET_LIST] = true; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "charityCampaignGoal", + description: "The goal amount for the current charity campaign", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: async (trigger) => { + let charityCampaignGoal = 0; + if (trigger.metadata.eventData && trigger.metadata.eventData.targetTotalAmount) { + charityCampaignGoal = trigger.metadata.eventData.targetTotalAmount; + } else { + charityCampaignGoal = await twitchApi.charity.getCurrentCharityFundraiserGoal(); + } + + charityCampaignGoal = charityCampaignGoal ?? 0; + + return charityCampaignGoal; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/charity-campaign-total.ts b/src/backend/variables/builtin/charity-campaign-total.ts new file mode 100644 index 000000000..b79bdcde0 --- /dev/null +++ b/src/backend/variables/builtin/charity-campaign-total.ts @@ -0,0 +1,37 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; +import twitchApi from "../../twitch-api/api"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = [ + "twitch:charity-campaign-start", + "twitch:charity-campaign-progress", + "twitch:charity-campaign-end" +]; +triggers[EffectTrigger.COMMAND] = true; +triggers[EffectTrigger.PRESET_LIST] = true; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "charityCampaignTotal", + description: "The total amount raised so far during the current charity campaign", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: async (trigger) => { + let charityCampaignTotal = 0; + if (trigger.metadata.eventData && trigger.metadata.eventData.currentTotalAmount) { + charityCampaignTotal = trigger.metadata.eventData.currentTotalAmount; + } else { + charityCampaignTotal = await twitchApi.charity.getCurrentCharityFundraiserTotal(); + } + + charityCampaignTotal = charityCampaignTotal ?? 0; + + return charityCampaignTotal; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/charity-description.ts b/src/backend/variables/builtin/charity-description.ts new file mode 100644 index 000000000..97aaf2e48 --- /dev/null +++ b/src/backend/variables/builtin/charity-description.ts @@ -0,0 +1,28 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = [ + "twitch:charity-campaign-start", + "twitch:charity-donation", + "twitch:charity-campaign-progress", + "twitch:charity-campaign-end" +]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "charityDescription", + description: "A description of the charity", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger) => { + const charityDescription = (trigger.metadata.eventData && trigger.metadata.eventData.charityDescription) || ""; + + return charityDescription; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/charity-logo.ts b/src/backend/variables/builtin/charity-logo.ts new file mode 100644 index 000000000..c0f83159b --- /dev/null +++ b/src/backend/variables/builtin/charity-logo.ts @@ -0,0 +1,28 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = [ + "twitch:charity-campaign-start", + "twitch:charity-donation", + "twitch:charity-campaign-progress", + "twitch:charity-campaign-end" +]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "charityLogo", + description: "A URL to a PNG image of the charity's logo", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger) => { + const charityLogo = (trigger.metadata.eventData && trigger.metadata.eventData.charityLogo) || ""; + + return charityLogo; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/charity-name.ts b/src/backend/variables/builtin/charity-name.ts new file mode 100644 index 000000000..2df09c4d2 --- /dev/null +++ b/src/backend/variables/builtin/charity-name.ts @@ -0,0 +1,28 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = [ + "twitch:charity-campaign-start", + "twitch:charity-donation", + "twitch:charity-campaign-progress", + "twitch:charity-campaign-end" +]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "charityName", + description: "The name of the charity", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger) => { + const charityName = (trigger.metadata.eventData && trigger.metadata.eventData.charityName) || "Unknown Charity Name"; + + return charityName; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/charity-website.ts b/src/backend/variables/builtin/charity-website.ts new file mode 100644 index 000000000..8b6ca9e94 --- /dev/null +++ b/src/backend/variables/builtin/charity-website.ts @@ -0,0 +1,28 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = [ + "twitch:charity-campaign-start", + "twitch:charity-donation", + "twitch:charity-campaign-progress", + "twitch:charity-campaign-end" +]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "charityWebsite", + description: "The URL of the charity's website", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger) => { + const charityWebsite = (trigger.metadata.eventData && trigger.metadata.eventData.charityWebsite) || ""; + + return charityWebsite; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/donation-amount.js b/src/backend/variables/builtin/donation-amount.js index 50777891e..c8a460ac6 100644 --- a/src/backend/variables/builtin/donation-amount.js +++ b/src/backend/variables/builtin/donation-amount.js @@ -7,6 +7,7 @@ const { OutputDataType, VariableCategory } = require("../../../shared/variable-c const triggers = {}; triggers[EffectTrigger.EVENT] = [ + "twitch:charity-donation", "streamlabs:donation", "streamlabs:eldonation", "tipeeestream:donation", @@ -18,7 +19,7 @@ triggers[EffectTrigger.MANUAL] = true; const model = { definition: { handle: "donationAmount", - description: "The amount of a donation from StreamLabs/Tipeee/StreamElements/ExtraLife", + description: "The amount of a donation from Twitch/StreamLabs/Tipeee/StreamElements/ExtraLife", triggers: triggers, categories: [VariableCategory.COMMON, VariableCategory.NUMBERS, VariableCategory.TRIGGER], possibleDataOutput: [OutputDataType.NUMBER] diff --git a/src/backend/variables/builtin/donation-from.js b/src/backend/variables/builtin/donation-from.js index cc926b69b..9683c39db 100644 --- a/src/backend/variables/builtin/donation-from.js +++ b/src/backend/variables/builtin/donation-from.js @@ -7,6 +7,7 @@ const { OutputDataType, VariableCategory } = require("../../../shared/variable-c const triggers = {}; triggers[EffectTrigger.EVENT] = [ + "twitch:charity-donation", "streamlabs:donation", "streamlabs:eldonation", "tipeeestream:donation", @@ -18,7 +19,7 @@ triggers[EffectTrigger.MANUAL] = true; const model = { definition: { handle: "donationFrom", - description: "The name of who sent a StreamLabs/Tipeee/StreamElements/ExtraLife donation", + description: "The name of who sent a Twitch/StreamLabs/Tipeee/StreamElements/ExtraLife donation", triggers: triggers, categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], possibleDataOutput: [OutputDataType.TEXT] diff --git a/src/backend/variables/builtin/hype-train-level.ts b/src/backend/variables/builtin/hype-train-level.ts new file mode 100644 index 000000000..38117bab1 --- /dev/null +++ b/src/backend/variables/builtin/hype-train-level.ts @@ -0,0 +1,21 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = ["twitch:hype-train-start","twitch:hype-train-progress","twitch:hype-train-end"]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "hypeTrainLevel", + description: "The level of the current Twitch Hype Train.", + triggers: triggers, + categories: [VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: (trigger) => { + return trigger.metadata.eventData.level; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/hype-train-percent.ts b/src/backend/variables/builtin/hype-train-percent.ts new file mode 100644 index 000000000..832728ac7 --- /dev/null +++ b/src/backend/variables/builtin/hype-train-percent.ts @@ -0,0 +1,21 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = ["twitch:hype-train-start","twitch:hype-train-progress"]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "hypeTrainPercent", + description: "The percent completion of the current level of the Twitch Hype Train.", + triggers: triggers, + categories: [VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: (trigger) => { + return Math.floor((trigger.metadata.eventData.progress / trigger.metadata.eventData.goal) * 100); + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/moderator.js b/src/backend/variables/builtin/moderator.js index 6917e5288..57bccf56b 100644 --- a/src/backend/variables/builtin/moderator.js +++ b/src/backend/variables/builtin/moderator.js @@ -4,13 +4,13 @@ const { EffectTrigger } = require("../../../shared/effect-constants"); const { OutputDataType, VariableCategory } = require("../../../shared/variable-constants"); const triggers = {}; -triggers[EffectTrigger.EVENT] = ["twitch:banned", "twitch:unbanned", "twitch:timeout", "twitch:chat-mode-changed"]; +triggers[EffectTrigger.EVENT] = ["twitch:banned", "twitch:unbanned", "twitch:timeout", "twitch:chat-mode-changed", "twitch:shoutout-sent"]; triggers[EffectTrigger.MANUAL] = true; const model = { definition: { handle: "moderator", - description: "The name of the moderator that performed the action (ban, unban, timeout, or chat mode change).", + description: "The name of the moderator that performed the action (ban, unban, timeout, chat mode change, or shoutout).", triggers: triggers, categories: [VariableCategory.USER, VariableCategory.TRIGGER], possibleDataOutput: [OutputDataType.text] diff --git a/src/backend/variables/builtin/poll-winning-choice-name.ts b/src/backend/variables/builtin/poll-winning-choice-name.ts new file mode 100644 index 000000000..fd0659d5c --- /dev/null +++ b/src/backend/variables/builtin/poll-winning-choice-name.ts @@ -0,0 +1,22 @@ +import { EventSubChannelPollChoice } from "@twurple/eventsub-base"; +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = ["twitch:channel-poll-end"]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "pollWinningChoiceName", + description: "The name of the winning Twitch poll choice.", + triggers: triggers, + categories: [VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger) => { + return trigger.winningChoice.title; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/poll-winning-choice-votes.ts b/src/backend/variables/builtin/poll-winning-choice-votes.ts new file mode 100644 index 000000000..660ef502e --- /dev/null +++ b/src/backend/variables/builtin/poll-winning-choice-votes.ts @@ -0,0 +1,22 @@ +import { EventSubChannelPollChoice } from "@twurple/eventsub-base"; +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = ["twitch:channel-poll-end"]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "pollWinningChoiceVotes", + description: "The total number of votes the winning Twitch poll choice received.", + triggers: triggers, + categories: [VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: (trigger) => { + return trigger.winningChoice.totalVotes; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/prediction-winning-outcome-name.ts b/src/backend/variables/builtin/prediction-winning-outcome-name.ts new file mode 100644 index 000000000..e4c9afac4 --- /dev/null +++ b/src/backend/variables/builtin/prediction-winning-outcome-name.ts @@ -0,0 +1,21 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = ["twitch:channel-prediction-end"]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "preditionWinningOutcomeName", + description: "The name of the winning Twitch prediction outcome.", + triggers: triggers, + categories: [VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger) => { + return trigger.metadata.eventData.winningOutcome.title; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/sub-count.js b/src/backend/variables/builtin/sub-count.js deleted file mode 100644 index 1c2a0be1a..000000000 --- a/src/backend/variables/builtin/sub-count.js +++ /dev/null @@ -1,34 +0,0 @@ -// Migration: done - -'use strict'; - -const { OutputDataType, VariableCategory } = require("../../../shared/variable-constants"); - -const api = require("../../twitch-api/api"); -const accountAccess = require("../../common/account-access"); - -const model = { - definition: { - handle: "subCount", - description: "The number of subs you currently have.", - categories: [VariableCategory.NUMBERS], - possibleDataOutput: [OutputDataType.NUMBER] - }, - evaluator: async () => { - const { streamer } = accountAccess.getAccounts(); - let count = 0; - try { - const response = await api.streamerClient.subscriptions - .getSubscriptionsPaginated(streamer.channelId).getAll(); - if (response && response.length) { - count = response.length; - } - } catch { - // silently fail - } - - return count; - } -}; - -module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/sub-points.js b/src/backend/variables/builtin/sub-points.js deleted file mode 100644 index 04980ef44..000000000 --- a/src/backend/variables/builtin/sub-points.js +++ /dev/null @@ -1,49 +0,0 @@ -// Migration: done - -'use strict'; - -const { OutputDataType, VariableCategory } = require("../../../shared/variable-constants"); - -const api = require("../../twitch-api/api"); -const accountAccess = require("../../common/account-access"); -const logger = require("../../logwrapper"); - -const model = { - definition: { - handle: "subPoints", - description: "The number of sub points you currently have.", - categories: [VariableCategory.NUMBERS], - possibleDataOutput: [OutputDataType.NUMBER] - }, - evaluator: async () => { - const { streamer } = accountAccess.getAccounts(); - let points = 0; - try { - const response = await api.streamerClient.subscriptions - .getSubscriptionsPaginated(streamer.channelId).getAll(); - if (response && response.length) { - response.forEach(sub => { - switch (sub.tier) { - case "Prime": - case "1000": - points += 1; - break; - case "2000": - points += 2; - break; - case "3000": - points += 6; - break; - } - }); - } - } catch (err) { - logger.error("Error while fetching streamer subscriptions", err); - } - - // Streamer is included in the data, so we need to deduct 6 points for that. - return points - 6; - } -}; - -module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/twitch/sub-count.ts b/src/backend/variables/builtin/twitch/sub-count.ts new file mode 100644 index 000000000..c3d284878 --- /dev/null +++ b/src/backend/variables/builtin/twitch/sub-count.ts @@ -0,0 +1,17 @@ +import { ReplaceVariable } from "../../../../types/variables"; +import { OutputDataType, VariableCategory } from "../../../../shared/variable-constants"; +import twitchApi from "../../../twitch-api/api"; + +const model: ReplaceVariable = { + definition: { + handle: "subCount", + description: "The number of subs you currently have.", + categories: [VariableCategory.NUMBERS], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: async () => { + return await twitchApi.subscriptions.getSubscriberCount(); + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/twitch/sub-points.ts b/src/backend/variables/builtin/twitch/sub-points.ts new file mode 100644 index 000000000..280fccf12 --- /dev/null +++ b/src/backend/variables/builtin/twitch/sub-points.ts @@ -0,0 +1,17 @@ +import { ReplaceVariable } from "../../../../types/variables"; +import { OutputDataType, VariableCategory } from "../../../../shared/variable-constants"; +import twitchApi from "../../../twitch-api/api"; + +const model: ReplaceVariable = { + definition: { + handle: "subPoints", + description: "The number of sub points you currently have.", + categories: [VariableCategory.NUMBERS], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: async () => { + return await twitchApi.subscriptions.getSubPointCount(); + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/backend/variables/builtin/viewer-count.ts b/src/backend/variables/builtin/viewer-count.ts new file mode 100644 index 000000000..7b72ab2fd --- /dev/null +++ b/src/backend/variables/builtin/viewer-count.ts @@ -0,0 +1,21 @@ +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = ["twitch:shoutout-sent", "twitch:shoutout-received"]; +triggers[EffectTrigger.MANUAL] = true; + +const model = { + definition: { + handle: "viewerCount", + description: "The number of viewers that saw the event occur", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.NUMBER] + }, + evaluator: (trigger) => { + return trigger.metadata.eventData.viewerCount; + } +}; + +module.exports = model; \ No newline at end of file diff --git a/src/types/effects.d.ts b/src/types/effects.d.ts index 5d1353279..fea17a9d9 100644 --- a/src/types/effects.d.ts +++ b/src/types/effects.d.ts @@ -38,6 +38,7 @@ export type EffectType = { description: string; icon: string; categories: EffectCategory[]; + hidden?: boolean; triggers?: TriggerType[] | TriggersObject; dependencies?: Array<"chat">; outputs?: EffectOutput[]; From 61e85a2374773901cd5d2cc98df863044b463b6a Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sat, 16 Dec 2023 18:55:11 -0500 Subject: [PATCH 012/184] fix: Cancel Prediction detecting open prediction --- src/backend/effects/builtin/twitch/cancel-prediction.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/backend/effects/builtin/twitch/cancel-prediction.ts b/src/backend/effects/builtin/twitch/cancel-prediction.ts index c1cb47590..3ab8214f8 100644 --- a/src/backend/effects/builtin/twitch/cancel-prediction.ts +++ b/src/backend/effects/builtin/twitch/cancel-prediction.ts @@ -26,7 +26,7 @@ const model: EffectType<{}> = { onTriggerEvent: async () => { const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); - if (latestPrediction?.status !== "ACTIVE") { + if (latestPrediction?.status !== "ACTIVE" && latestPrediction?.status !== "LOCKED") { logger.warn("There is no active Twitch prediction to cancel"); return; } From 5c411760278c7c7337c4739e63fee8dbd453284d Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sat, 16 Dec 2023 21:54:52 -0500 Subject: [PATCH 013/184] chore: random int utility now uses Node crypto lib --- src/backend/utility.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/backend/utility.js b/src/backend/utility.js index 0d204b958..b0dd0046d 100644 --- a/src/backend/utility.js +++ b/src/backend/utility.js @@ -1,5 +1,6 @@ "use strict"; +const { randomInt } = require('node:crypto'); const moment = require("moment"); const replaceVariableManager = require("./variables/replace-variable-manager"); const accountAccess = require("./common/account-access"); @@ -9,7 +10,8 @@ const getRandomInt = (min, max) => { min = Math.ceil(min); max = Math.floor(max); - return Math.floor(Math.random() * (max - min + 1)) + min; + // randomInt is max exclusive, so we add 1 to make inclusive + return randomInt(min, max + 1); }; const escapeRegExp = (str) => { From d2e7ae60da8ea766e7061363be81acb55fbc7945 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sat, 16 Dec 2023 22:24:34 -0500 Subject: [PATCH 014/184] chore: refactor auth manager into TS --- .../auth/{auth-manager.js => auth-manager.ts} | 49 +++++++++---------- src/backend/auth/auth.d.ts | 4 +- 2 files changed, 27 insertions(+), 26 deletions(-) rename src/backend/auth/{auth-manager.js => auth-manager.ts} (80%) diff --git a/src/backend/auth/auth-manager.js b/src/backend/auth/auth-manager.ts similarity index 80% rename from src/backend/auth/auth-manager.js rename to src/backend/auth/auth-manager.ts index 60a715901..398ba4b0b 100644 --- a/src/backend/auth/auth-manager.js +++ b/src/backend/auth/auth-manager.ts @@ -1,30 +1,28 @@ -"use strict"; - -const EventEmitter = require("events"); -const logger = require("../logwrapper"); -const { settings } = require("../common/settings-access"); -const OAuthClient = require("client-oauth2"); -const frontendCommunicator = require("../common/frontend-communicator"); - -const HTTP_PORT = settings.getWebServerPort(); +import { EventEmitter } from "events"; +import ClientOAuth2 from "client-oauth2"; +import logger from "../logwrapper"; +import { AuthProvider, AuthProviderDefinition } from "./auth"; +import { settings } from "../common/settings-access"; +import frontendCommunicator from "../common/frontend-communicator"; class AuthManager extends EventEmitter { + private readonly _httpPort: string; + private _authProviders: AuthProvider[]; + constructor() { super(); - /** @type {import("./auth").AuthProvider[]} */ - this._authProviders = []; - this.REDIRECT_URI = 'http://localhost:' + HTTP_PORT + '/api/v1/auth/callback'; + this._authProviders = []; + this._httpPort = settings.getWebServerPort() } - /** @param {import("./auth").AuthProviderDefinition} provider */ - registerAuthProvider(provider) { + registerAuthProvider(provider: AuthProviderDefinition): void { if (provider == null) { return; } const redirectUrlHost = provider.redirectUriHost || "localhost"; - const redirectUri = `http://${redirectUrlHost}:${HTTP_PORT}/api/v1/auth/callback`; + const redirectUri = `http://${redirectUrlHost}:${this._httpPort}/api/v1/auth/callback`; const oauthClient = this.buildOAuthClientForProvider(provider, redirectUri); @@ -62,12 +60,11 @@ class AuthManager extends EventEmitter { logger.debug(`Registered Auth Provider ${provider.name}`); } - getAuthProvider(providerId) { + getAuthProvider(providerId: string): AuthProvider { return this._authProviders.find(p => p.id === providerId); } - /** @param {import("./auth").AuthProviderDefinition} provider */ - buildOAuthClientForProvider(provider, redirectUri) { + buildOAuthClientForProvider(provider: AuthProviderDefinition, redirectUri: string): ClientOAuth2 { let scopes; if (provider.scopes) { scopes = Array.isArray(provider.scopes) @@ -80,7 +77,7 @@ class AuthManager extends EventEmitter { const authUri = `${provider.auth.tokenHost}${provider.auth.authorizePath}`; const tokenUri = `${provider.auth.tokenHost}${provider.auth.tokenPath ?? ""}`; - return new OAuthClient({ + return new ClientOAuth2({ clientId: provider.client.id, clientSecret: provider.auth.type === "code" ? provider.client.secret : null, accessTokenUri: provider.auth.type === "token" ? null : tokenUri, @@ -91,14 +88,16 @@ class AuthManager extends EventEmitter { }); } - async refreshTokenIfExpired(providerId, tokenData) { + async refreshTokenIfExpired(providerId: string, tokenData: any): Promise { const provider = this.getAuthProvider(providerId); let accessToken = provider.oauthClient.createToken(tokenData); if (accessToken.expired()) { try { const params = { - scope: provider.details.scopes + scopes: Array.isArray(provider.details.scopes) + ? provider.details.scopes + : provider.details.scopes.split(" ") }; accessToken = await accessToken.refresh(params); @@ -110,7 +109,7 @@ class AuthManager extends EventEmitter { return accessToken.data; } - async revokeTokens(providerId, tokenData) { + async revokeTokens(providerId: string, tokenData: ClientOAuth2.Data): Promise { const provider = this.getAuthProvider(providerId); if (provider == null) { return; @@ -125,14 +124,14 @@ class AuthManager extends EventEmitter { } } - successfulAuth(providerId, tokenData) { + successfulAuth(providerId: string, tokenData: any): void { this.emit("auth-success", { providerId: providerId, tokenData: tokenData }); } } const manager = new AuthManager(); -frontendCommunicator.onAsync("begin-device-auth", async (providerId) => { +frontendCommunicator.onAsync("begin-device-auth", async (providerId: string): Promise => { const provider = manager.getAuthProvider(providerId); if (provider?.details?.auth?.type !== "device") { return; @@ -188,4 +187,4 @@ frontendCommunicator.onAsync("begin-device-auth", async (providerId) => { } }); -module.exports = manager; \ No newline at end of file +export = manager; \ No newline at end of file diff --git a/src/backend/auth/auth.d.ts b/src/backend/auth/auth.d.ts index 1c940e1cb..614dd862a 100644 --- a/src/backend/auth/auth.d.ts +++ b/src/backend/auth/auth.d.ts @@ -12,7 +12,8 @@ export interface AuthProviderDefinition { tokenHost: string; authorizePath: string; tokenPath?: string; - } + }; + redirectUriHost?: string; scopes?: string[] | string | undefined; } @@ -21,6 +22,7 @@ export interface AuthProvider { oauthClient: ClientOAuth2; authorizationUri: string; redirectUri: string; + tokenUri: string; details: AuthProviderDefinition; } From f04f33f1578084defa8c3304fdfaf4b2119f5a82 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 17 Dec 2023 10:16:57 -0500 Subject: [PATCH 015/184] chore: move FirebotChatMessage and FirebotEmote defs to TS --- src/backend/chat/chat-helpers.js | 55 +++---------------- src/backend/chat/commands/commandHandler.js | 2 +- .../moderation/chat-moderation-manager.js | 2 +- .../chat/moderation/raid-message-checker.js | 4 +- .../events/twitch-events/chat-message.ts | 2 +- .../games/builtin/trivia/trivia-command.js | 2 +- src/types/chat.d.ts | 39 +++++++++++++ 7 files changed, 52 insertions(+), 54 deletions(-) create mode 100644 src/types/chat.d.ts diff --git a/src/backend/chat/chat-helpers.js b/src/backend/chat/chat-helpers.js index b9194ccde..8858918d6 100644 --- a/src/backend/chat/chat-helpers.js +++ b/src/backend/chat/chat-helpers.js @@ -11,47 +11,6 @@ const frontendCommunicator = require("../common/frontend-communicator"); const utils = require("../utility"); const { parseChatMessage } = require("@twurple/chat"); -/** - * @typedef FirebotChatMessage - * @property {string} id - * @property {string} username - * @property {string} useridname - * @property {string} profilePicUrl - * @property {string} userId - * @property {string[]} roles - * @property {any[]} badges - * @property {string} customRewardId - * @property {string} color - * @property {string} rawText - * @property {import('@twurple/common').ParsedMessagePart[]} parts - * @property {boolean} whisper - * @property {boolean} action - * @property {boolean} isCheer - * @property {boolean} isAnnouncement - * @property {"PRIMARY" | "BLUE" | "GREEN" | "ORANGE" | "PURPLE"} announcementColor - * @property {boolean} tagged - * @property {boolean} isFounder - * @property {boolean} isBroadcaster - * @property {boolean} isBot - * @property {boolean} isMod - * @property {boolean} isSubscriber - * @property {boolean} isVip - * @property {boolean} isCheer - * @property {boolean} isHighlighted - * @property {boolean} isAutoModHeld - * @property {string} autoModStatus - * @property {string} autoModReason - * - */ - -/** - * @typedef FirebotEmote - * @property {string} url - * @property {string} animatedUrl - * @property {string} origin - * @property {string} code - */ - /**@type {import('@twurple/api').ChatBadgeSet[]} */ let badgeCache = null; exports.cacheBadges = async () => { @@ -198,7 +157,7 @@ exports.setUserProfilePicUrl = (userId, url, updateAccountAvatars = true) => { const URL_REGEX = utils.getUrlRegex(); /** - * @param {FirebotChatMessage} firebotChatMessage + * @param {import('../../types/chat').FirebotChatMessage} firebotChatMessage * @param {import("@twurple/common").ParsedMessagePart[]} parts */ function parseMessageParts(firebotChatMessage, parts) { @@ -351,7 +310,7 @@ const getMessageParts = (text) => { }; exports.buildFirebotChatMessageFromExtensionMessage = async (text = "", extensionName, extensionIconUrl, badges, color, id) => { - /**@type {FirebotChatMessage} */ + /**@type {import('../../types/chat').FirebotChatMessage} */ const firebotChatMessage = { id: id, username: extensionName, @@ -381,7 +340,7 @@ exports.buildFirebotChatMessageFromExtensionMessage = async (text = "", extensio /** * @arg {import("@twurple/pubsub").PubSubAutoModQueueMessage} msg - * @returns {Promise} + * @returns {Promise} */ exports.buildViewerFirebotChatMessageFromAutoModMessage = async (msg) => { const profilePicUrl = await getUserProfilePicUrl(msg.senderId); @@ -392,7 +351,7 @@ exports.buildViewerFirebotChatMessageFromAutoModMessage = async (msg) => { flagged: f.automod != null })); - /**@type {FirebotChatMessage} */ + /**@type {import('../../types/chat').FirebotChatMessage} */ const viewerFirebotChatMessage = { id: msg.messageId, username: msg.senderDisplayName, @@ -427,7 +386,7 @@ exports.buildStreamerFirebotChatMessageFromText = async (text = "") => { text = text.replace("/me", ""); } - /**@type {FirebotChatMessage} */ + /**@type {import('../../types/chat').FirebotChatMessage} */ const streamerFirebotChatMessage = { id: uuid(), username: streamer.displayName, @@ -458,11 +417,11 @@ exports.buildStreamerFirebotChatMessageFromText = async (text = "") => { /** * @arg {import("@twurple/chat").PrivateMessage} msg - * @returns {Promise} + * @returns {Promise} */ exports.buildFirebotChatMessage = async (msg, msgText, whisper = false, action = false) => { - /**@type {FirebotChatMessage} */ + /**@type {import('../../types/chat').FirebotChatMessage} */ const firebotChatMessage = { id: msg.tags.get("id"), username: msg.userInfo.displayName, diff --git a/src/backend/chat/commands/commandHandler.js b/src/backend/chat/commands/commandHandler.js index ffba199bb..948c966b7 100644 --- a/src/backend/chat/commands/commandHandler.js +++ b/src/backend/chat/commands/commandHandler.js @@ -372,7 +372,7 @@ function fireCommand( } /** - * @arg {import('../chat-helpers').FirebotChatMessage} firebotChatMessage + * @arg {import('../../../types/chat').FirebotChatMessage} firebotChatMessage */ async function handleChatMessage(firebotChatMessage) { diff --git a/src/backend/chat/moderation/chat-moderation-manager.js b/src/backend/chat/moderation/chat-moderation-manager.js index 5b7abca44..233658abe 100644 --- a/src/backend/chat/moderation/chat-moderation-manager.js +++ b/src/backend/chat/moderation/chat-moderation-manager.js @@ -159,7 +159,7 @@ const countEmojis = (str) => { /** * - * @param {import("../chat-helpers").FirebotChatMessage} chatMessage + * @param {import("../../../types/chat").FirebotChatMessage} chatMessage */ async function moderateMessage(chatMessage) { if (chatMessage == null) { diff --git a/src/backend/chat/moderation/raid-message-checker.js b/src/backend/chat/moderation/raid-message-checker.js index 1d1c86b48..27bb720d6 100644 --- a/src/backend/chat/moderation/raid-message-checker.js +++ b/src/backend/chat/moderation/raid-message-checker.js @@ -14,7 +14,7 @@ const settings = { /** * - * @param {import("../chat-helpers").FirebotChatMessage} message + * @param {import("../../../types/chat").FirebotChatMessage} message */ async function handleRaider(message) { const twitchApi = require("../../twitch-api/api"); @@ -30,7 +30,7 @@ async function handleRaider(message) { /** * - * @param {import("../chat-helpers").FirebotChatMessage} firebotChatMessage + * @param {import("../../../types/chat").FirebotChatMessage} firebotChatMessage */ async function sendMessageToCache(firebotChatMessage) { if (messageCache.length >= chatCacheLimit) { diff --git a/src/backend/events/twitch-events/chat-message.ts b/src/backend/events/twitch-events/chat-message.ts index c7a2bdf21..a436169c1 100644 --- a/src/backend/events/twitch-events/chat-message.ts +++ b/src/backend/events/twitch-events/chat-message.ts @@ -1,4 +1,4 @@ -import { FirebotChatMessage } from "../../chat/chat-helpers"; +import { FirebotChatMessage } from "../../../types/chat"; import eventManager from "../../events/EventManager"; export function triggerChatMessage(firebotChatMessage: FirebotChatMessage): void { diff --git a/src/backend/games/builtin/trivia/trivia-command.js b/src/backend/games/builtin/trivia/trivia-command.js index c23d4db56..ba57c55dc 100644 --- a/src/backend/games/builtin/trivia/trivia-command.js +++ b/src/backend/games/builtin/trivia/trivia-command.js @@ -31,7 +31,7 @@ function clearCurrentQuestion() { } twitchListeners.events.on("chat-message", async data => { - /**@type {import("../../../chat/chat-helpers").FirebotChatMessage} */ + /**@type {import("../../../../types/chat").FirebotChatMessage} */ const chatMessage = data; if (!currentQuestion) { return; diff --git a/src/types/chat.d.ts b/src/types/chat.d.ts new file mode 100644 index 000000000..fc7265139 --- /dev/null +++ b/src/types/chat.d.ts @@ -0,0 +1,39 @@ +import type { ParsedMessagePart } from "@twurple/chat"; + +export type FirebotChatMessage = { + id: string; + username: string; + useridname: string; + profilePicUrl: string; + userId: string; + roles: string[]; + badges: any[]; + customRewardId: string; + color: string; + rawText: string; + parts: ParsedMessagePart[]; + whisper: boolean; + action: boolean; + isCheer: boolean; + isAnnouncement: boolean; + announcementColor: "PRIMARY" | "BLUE" | "GREEN" | "ORANGE" | "PURPLE"; + tagged: boolean; + isFounder: boolean; + isBroadcaster: boolean; + isBot: boolean; + isMod: boolean; + isSubscriber: boolean; + isVip: boolean; + isCheer: boolean; + isHighlighted: boolean; + isAutoModHeld: boolean; + autoModStatus: string; + autoModReason: string; +}; + +export type FirebotEmote = { + url: string; + animatedUrl: string; + origin: string; + code: string; +}; \ No newline at end of file From e552f1d16fa128950091c6e68ba4fd879cab081f Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 17 Dec 2023 12:38:48 -0500 Subject: [PATCH 016/184] fix/chore: eval hidden effect prop, migrate more Twtich effects to TS --- src/backend/effects/builtin-effect-loader.js | 15 ++++++------ .../{ad-break.js => twitch/ad-break.ts} | 20 ++++++++-------- .../announcement.ts} | 24 ++++++++++++------- ...pprove-reject-channel-reward-redemption.ts | 2 ++ .../builtin/twitch/cancel-prediction.ts | 2 +- .../effects/builtin/twitch/create-poll.ts | 2 +- .../builtin/twitch/create-prediction.ts | 2 +- .../builtin/twitch/create-stream-marker.ts | 2 +- .../effects/builtin/twitch/end-poll.ts | 2 +- .../effects/builtin/twitch/lock-prediction.ts | 2 +- src/backend/effects/builtin/twitch/raid.ts | 2 +- .../builtin/twitch/resolve-prediction.ts | 2 +- .../builtin/{ => twitch}/set-chat-mode.ts | 10 ++++---- .../effects/builtin/twitch/shoutout.ts | 2 +- .../{stream-game.js => twitch/stream-game.ts} | 19 +++++++++------ .../stream-title.ts} | 16 +++++++------ src/backend/effects/effectManager.js | 12 +++++++++- src/types/effects.d.ts | 4 ++-- 18 files changed, 83 insertions(+), 57 deletions(-) rename src/backend/effects/builtin/{ad-break.js => twitch/ad-break.ts} (82%) rename src/backend/effects/builtin/{announcement.js => twitch/announcement.ts} (72%) rename src/backend/effects/builtin/{ => twitch}/set-chat-mode.ts (94%) rename src/backend/effects/builtin/{stream-game.js => twitch/stream-game.ts} (91%) rename src/backend/effects/builtin/{stream-title.js => twitch/stream-title.ts} (76%) diff --git a/src/backend/effects/builtin-effect-loader.js b/src/backend/effects/builtin-effect-loader.js index 671492293..f15e94d83 100644 --- a/src/backend/effects/builtin-effect-loader.js +++ b/src/backend/effects/builtin-effect-loader.js @@ -5,9 +5,7 @@ const effectManager = require("./effectManager"); exports.loadEffects = () => { [ 'active-user-lists', - 'ad-break', 'add-quote', - 'announcement', 'api', 'block-unblock', 'celebration', @@ -46,14 +44,11 @@ exports.loadEffects = () => { 'run-command', 'run-program', 'sequential-effect', - 'set-chat-mode', 'set-user-metadata', 'shoutout', 'show-image', // No migration needed. 'show-text', 'stop-effect-execution', - 'stream-game', - 'stream-title', 'take-screenshot', 'text-to-speech', 'toggle-command', @@ -66,11 +61,15 @@ exports.loadEffects = () => { 'update-role', 'update-vip-role', + 'twitch/ad-break', + 'twitch/announcement', + 'twitch/approve-reject-channel-reward-redemption', + 'twitch/create-stream-marker', 'twitch/raid', + 'twitch/set-chat-mode', 'twitch/shoutout', - 'twitch/create-stream-marker', - - 'twitch/approve-reject-channel-reward-redemption', + 'twitch/stream-title', + 'twitch/stream-game', 'twitch/create-poll', 'twitch/end-poll', diff --git a/src/backend/effects/builtin/ad-break.js b/src/backend/effects/builtin/twitch/ad-break.ts similarity index 82% rename from src/backend/effects/builtin/ad-break.js rename to src/backend/effects/builtin/twitch/ad-break.ts index 2e3c9818b..e0bd46bc9 100644 --- a/src/backend/effects/builtin/ad-break.js +++ b/src/backend/effects/builtin/twitch/ad-break.ts @@ -1,20 +1,20 @@ -"use strict"; +import { EffectType } from "../../../../types/effects"; +import { EffectCategory, EffectDependency } from '../../../../shared/effect-constants'; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; -const { EffectCategory, EffectDependency } = require('../../../shared/effect-constants'); -const accountAccess = require("../../common/account-access"); -const twitchApi = require("../../twitch-api/api"); - -const model = { +const model: EffectType<{ + adLength: number +}> = { definition: { id: "firebot:ad-break", name: "Ad Break", - description: "Trigger an ad-break", - hidden: !accountAccess.getAccounts().streamer.loggedIn, + description: "Trigger an ad break", + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, icon: "fad fa-ad", categories: [EffectCategory.COMMON, EffectCategory.MODERATION, EffectCategory.TWITCH], dependencies: [EffectDependency.CHAT] }, - globalSettings: {}, optionsTemplate: `
@@ -65,4 +65,4 @@ const model = { } }; -module.exports = model; +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/announcement.js b/src/backend/effects/builtin/twitch/announcement.ts similarity index 72% rename from src/backend/effects/builtin/announcement.js rename to src/backend/effects/builtin/twitch/announcement.ts index e8a19d59f..803ea7968 100644 --- a/src/backend/effects/builtin/announcement.js +++ b/src/backend/effects/builtin/twitch/announcement.ts @@ -1,14 +1,20 @@ -"use strict"; - -const { EffectCategory, EffectDependency } = require('../../../shared/effect-constants'); -const twitchApi = require("../../twitch-api/api"); - -const effect = { +import { EffectType } from "../../../../types/effects"; +import { EffectCategory, EffectDependency } from "../../../../shared/effect-constants"; +import { HelixChatAnnouncementColor } from "@twurple/api"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; + +const model: EffectType<{ + color: string, + message: string, + chatter?: string +}> = { definition: { id: "firebot:announcement", name: "Announce", description: "Send an announcement to your chat", icon: "fad fa-bullhorn", + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, categories: [EffectCategory.COMMON, EffectCategory.CHAT_BASED, EffectCategory.TWITCH], dependencies: [EffectDependency.CHAT] }, @@ -46,12 +52,12 @@ const effect = { }, onTriggerEvent: async ({ effect }) => { const { message, chatter } = effect; - const color = effect.color ?? "primary"; + const color = (effect.color.toLowerCase() ?? "primary") as HelixChatAnnouncementColor; - await twitchApi.chat.sendAnnouncement(message, color.toLowerCase(), chatter?.toLowerCase() === "bot"); + await twitchApi.chat.sendAnnouncement(message, color, chatter?.toLowerCase() === "bot"); return true; } }; -module.exports = effect; +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts b/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts index b0ff33d8c..663b265e7 100644 --- a/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts +++ b/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts @@ -1,5 +1,6 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; +import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ @@ -12,6 +13,7 @@ const model: EffectType<{ name: "Approve/Reject Channel Reward Redemption", description: "Approves or rejects a pending Twitch channel reward redemption", icon: "fad fa-check-circle", + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], dependencies: [] }, diff --git a/src/backend/effects/builtin/twitch/cancel-prediction.ts b/src/backend/effects/builtin/twitch/cancel-prediction.ts index 3ab8214f8..356f50d3c 100644 --- a/src/backend/effects/builtin/twitch/cancel-prediction.ts +++ b/src/backend/effects/builtin/twitch/cancel-prediction.ts @@ -11,7 +11,7 @@ const model: EffectType<{}> = { description: "Cancels the currently active Twitch prediction and refunds all channel points wagered", icon: "fad fa-ban", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/create-poll.ts b/src/backend/effects/builtin/twitch/create-poll.ts index f35cfdae9..976f3ec83 100644 --- a/src/backend/effects/builtin/twitch/create-poll.ts +++ b/src/backend/effects/builtin/twitch/create-poll.ts @@ -17,7 +17,7 @@ const model: EffectType<{ description: "Creates a Twitch poll", icon: "fad fa-poll-h", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/create-prediction.ts b/src/backend/effects/builtin/twitch/create-prediction.ts index 51c8af286..35cca9924 100644 --- a/src/backend/effects/builtin/twitch/create-prediction.ts +++ b/src/backend/effects/builtin/twitch/create-prediction.ts @@ -15,7 +15,7 @@ const model: EffectType<{ description: "Creates a Twitch prediction", icon: "fad fa-question-circle", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/create-stream-marker.ts b/src/backend/effects/builtin/twitch/create-stream-marker.ts index 2958c42ad..88dc18668 100644 --- a/src/backend/effects/builtin/twitch/create-stream-marker.ts +++ b/src/backend/effects/builtin/twitch/create-stream-marker.ts @@ -12,7 +12,7 @@ const model: EffectType<{ description: "Create a stream marker in your Twitch VOD", icon: "fad fa-map-pin", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/end-poll.ts b/src/backend/effects/builtin/twitch/end-poll.ts index 1cfe79420..066ae9d06 100644 --- a/src/backend/effects/builtin/twitch/end-poll.ts +++ b/src/backend/effects/builtin/twitch/end-poll.ts @@ -13,7 +13,7 @@ const model: EffectType<{ description: "Ends the currently active Twitch poll", icon: "fad fa-stop-circle", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/lock-prediction.ts b/src/backend/effects/builtin/twitch/lock-prediction.ts index 3b39374f5..6ab5096d9 100644 --- a/src/backend/effects/builtin/twitch/lock-prediction.ts +++ b/src/backend/effects/builtin/twitch/lock-prediction.ts @@ -11,7 +11,7 @@ const model: EffectType<{}> = { description: "Locks the currently active Twitch prediction so that no more predictions can be made", icon: "fad fa-lock", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/raid.ts b/src/backend/effects/builtin/twitch/raid.ts index 3bf234c04..49407c4b8 100644 --- a/src/backend/effects/builtin/twitch/raid.ts +++ b/src/backend/effects/builtin/twitch/raid.ts @@ -14,7 +14,7 @@ const model: EffectType<{ description: "Start or cancel a raid to another Twitch channel", icon: "fad fa-rocket-launch", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/twitch/resolve-prediction.ts b/src/backend/effects/builtin/twitch/resolve-prediction.ts index d577b12f4..d9dba6aec 100644 --- a/src/backend/effects/builtin/twitch/resolve-prediction.ts +++ b/src/backend/effects/builtin/twitch/resolve-prediction.ts @@ -13,7 +13,7 @@ const model: EffectType<{ description: "Resolves the currently active Twitch prediction by selecting an outcome and pays out channel points to the winners", icon: "fad fa-trophy-alt", categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [] }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/set-chat-mode.ts b/src/backend/effects/builtin/twitch/set-chat-mode.ts similarity index 94% rename from src/backend/effects/builtin/set-chat-mode.ts rename to src/backend/effects/builtin/twitch/set-chat-mode.ts index 4e4b10640..6c2073418 100644 --- a/src/backend/effects/builtin/set-chat-mode.ts +++ b/src/backend/effects/builtin/twitch/set-chat-mode.ts @@ -1,7 +1,8 @@ -import { EffectType } from "../../../types/effects"; -import { EffectCategory } from "../../../shared/effect-constants"; -import twitchApi from "../../twitch-api/api"; -import { TwitchCommandHelpers } from "../../chat/twitch-commands/twitch-command-helpers"; +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; +import { TwitchCommandHelpers } from "../../../chat/twitch-commands/twitch-command-helpers"; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ setFollowersOnly: boolean; @@ -23,6 +24,7 @@ const model: EffectType<{ name: "Set Chat Mode", description: "Sets the chat mode(s) for your Twitch channel", icon: "fad fa-comment-check", + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], dependencies: [] }, diff --git a/src/backend/effects/builtin/twitch/shoutout.ts b/src/backend/effects/builtin/twitch/shoutout.ts index 957d9605a..b52d4b400 100644 --- a/src/backend/effects/builtin/twitch/shoutout.ts +++ b/src/backend/effects/builtin/twitch/shoutout.ts @@ -13,7 +13,7 @@ const model: EffectType<{ description: "Send a Twitch shoutout to another channel", icon: "fad fa-bullhorn", categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - hidden: !accountAccess.getAccounts().streamer.loggedIn, + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, dependencies: [], }, optionsTemplate: ` diff --git a/src/backend/effects/builtin/stream-game.js b/src/backend/effects/builtin/twitch/stream-game.ts similarity index 91% rename from src/backend/effects/builtin/stream-game.js rename to src/backend/effects/builtin/twitch/stream-game.ts index 2c1bfe589..b133f1a94 100644 --- a/src/backend/effects/builtin/stream-game.js +++ b/src/backend/effects/builtin/twitch/stream-game.ts @@ -1,16 +1,21 @@ -"use strict"; +import { EffectType } from '../../../../types/effects'; +import { EffectCategory } from '../../../../shared/effect-constants'; +import logger from '../../../logwrapper'; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; +import eventsManager from "../../../events/EventManager"; -const { EffectCategory } = require('../../../shared/effect-constants'); -const logger = require('../../logwrapper'); -const twitchApi = require("../../twitch-api/api"); -const eventsManager = require("../../events/EventManager"); - -const model = { +const model: EffectType<{ + mode: "specific" | "custom", + gameId: string, + gameName: string +}> = { definition: { id: "firebot:streamgame", name: "Set Stream Category", description: "Set the stream category/game.", icon: "fad fa-gamepad", + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, categories: [EffectCategory.COMMON, EffectCategory.MODERATION, EffectCategory.TWITCH], dependencies: [] }, diff --git a/src/backend/effects/builtin/stream-title.js b/src/backend/effects/builtin/twitch/stream-title.ts similarity index 76% rename from src/backend/effects/builtin/stream-title.js rename to src/backend/effects/builtin/twitch/stream-title.ts index e3760263b..40d9d75d5 100644 --- a/src/backend/effects/builtin/stream-title.js +++ b/src/backend/effects/builtin/twitch/stream-title.ts @@ -1,15 +1,17 @@ -"use strict"; +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from '../../../../shared/effect-constants'; +import accountAccess from "../../../common/account-access"; +import twitchApi from "../../../twitch-api/api"; -const { EffectCategory } = require('../../../shared/effect-constants'); -const twitchApi = require("../../twitch-api/api"); -const accountAccess = require("../../common/account-access"); - -const model = { +const model: EffectType<{ + title: string +}> = { definition: { id: "firebot:streamtitle", name: "Set Stream Title", description: "Set the title of the stream.", icon: "fad fa-comment-dots", + hidden: () => !accountAccess.getAccounts().streamer.loggedIn, categories: [EffectCategory.COMMON, EffectCategory.MODERATION, EffectCategory.TWITCH], dependencies: [] }, @@ -35,4 +37,4 @@ const model = { } }; -module.exports = model; +module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/effectManager.js b/src/backend/effects/effectManager.js index 85a490a25..36fb1a0ad 100644 --- a/src/backend/effects/effectManager.js +++ b/src/backend/effects/effectManager.js @@ -56,8 +56,17 @@ class EffectManager extends EventEmitter { if (!e) { return {}; } + + // Create a copy of the def with an evaluated hidden prop + const definition = { + ...e.definition, + hidden: typeof e.definition.hidden === "function" + ? e.definition.hidden() + : e.definition.hidden + }; + return { - definition: e.definition, + definition: definition, optionsTemplate: e.optionsTemplate, optionsTemplateUrl: e.optionsTemplateUrl, optionsControllerRaw: e.optionsController @@ -116,6 +125,7 @@ frontendCommunicator.onAsync("getEffectDefinitions", async (triggerData) => { triggerMeta = triggerData.triggerMeta; const filteredEffectDefs = effects + .map(manager.mapEffectForFrontEnd) .map(e => e.definition) .filter(e => { if (triggerType != null) { diff --git a/src/types/effects.d.ts b/src/types/effects.d.ts index fea17a9d9..1c2f98167 100644 --- a/src/types/effects.d.ts +++ b/src/types/effects.d.ts @@ -38,7 +38,7 @@ export type EffectType = { description: string; icon: string; categories: EffectCategory[]; - hidden?: boolean; + hidden?: boolean | Func; triggers?: TriggerType[] | TriggersObject; dependencies?: Array<"chat">; outputs?: EffectOutput[]; @@ -46,7 +46,7 @@ export type EffectType = { optionsTemplate: string; optionsController?: ( $scope: EffectScope, - ...args: unknown[] + ...args: any[] ) => void; optionsValidator?: (effect: EffectModel) => string[]; onTriggerEvent: (event: { From d31dc3c88954c358e8b1e19457c9304c310ffa88 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 17 Dec 2023 16:06:15 -0500 Subject: [PATCH 017/184] chore: additional messaging on non-manageable channel rewards --- .../modals/channel-rewards/add-edit-channel-reward.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/gui/app/directives/modals/channel-rewards/add-edit-channel-reward.js b/src/gui/app/directives/modals/channel-rewards/add-edit-channel-reward.js index 963d43bc5..9e9491d22 100644 --- a/src/gui/app/directives/modals/channel-rewards/add-edit-channel-reward.js +++ b/src/gui/app/directives/modals/channel-rewards/add-edit-channel-reward.js @@ -20,7 +20,13 @@ />
-

This reward was created outside of Firebot so it's settings cannot be changed here. You can however still create effects for it. If you want to update settings for this Reward, you can do so on Twitch.

+

+ This reward was either created outside of Firebot, or by an older version of Firebot, so its settings cannot be changed here. You can however still create effects for it. If you want to update settings for this reward, you can do so on Twitch. +

+ +

If you would like to be able to edit this channel reward in Firebot or use the Update Channel Reward effect, you can Duplicate it from the Channel Rewards screen. This will preserve any effects and settings (except the image) you already have setup.

+

You can then delete the old reward from your Twitch dashboard. You will also need to update any existing Update Channel Reward effects to reference the newly created reward.

+
From f5b4ef5b689a98559801f76ce4ab3b740173f02d Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 17 Dec 2023 16:48:56 -0500 Subject: [PATCH 018/184] fix: prerelease semver parsing --- src/shared/compare-versions.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/shared/compare-versions.js b/src/shared/compare-versions.js index 655b319da..5916dcded 100644 --- a/src/shared/compare-versions.js +++ b/src/shared/compare-versions.js @@ -14,7 +14,7 @@ * - 1.0.0-beta2 * - 1.0.0-beta.3 */ -const semverRegex = /^v?(\d+)(?:[.](\d+))?(?:[.](\d+))?(?:-([a-z]*)[\W]?([\d]*))?$/i; +const semverRegex = /^v?(\d+)(?:[.](\d+))?(?:[.](\d+))?(?:-([a-zA-Z]+([\d]*)?)(?:[.](\d+))*)?$/i; const UpdateType = { NONE: "none", From eddb90bfc1d503e7daa19f9650e70653daf7b44f Mon Sep 17 00:00:00 2001 From: Erik Bigler Date: Sun, 17 Dec 2023 15:51:23 -0600 Subject: [PATCH 019/184] feat: improve effect dependencies and include display check --- src/backend/common/effect-runner.js | 29 +--- .../effects/builtin/twitch/ad-break.ts | 52 +++--- .../effects/builtin/twitch/announcement.ts | 87 +++++----- ...pprove-reject-channel-reward-redemption.ts | 71 ++++---- .../builtin/twitch/cancel-prediction.ts | 49 +++--- .../effects/builtin/twitch/create-poll.ts | 110 +++++++------ .../builtin/twitch/create-prediction.ts | 90 +++++----- .../builtin/twitch/create-stream-marker.ts | 42 +++-- .../effects/builtin/twitch/end-poll.ts | 50 +++--- .../effects/builtin/twitch/lock-prediction.ts | 46 +++--- src/backend/effects/builtin/twitch/raid.ts | 76 +++++---- .../builtin/twitch/resolve-prediction.ts | 70 ++++---- .../effects/builtin/twitch/set-chat-mode.ts | 127 ++++++++------- .../effects/builtin/twitch/shoutout.ts | 67 ++++---- .../effects/builtin/twitch/stream-game.ts | 154 ++++++++++-------- .../effects/builtin/twitch/stream-title.ts | 58 ++++--- src/backend/effects/effect-helpers.ts | 67 ++++++++ src/backend/effects/effectManager.d.ts | 1 + src/backend/effects/effectManager.js | 24 ++- .../integrations/IntegrationManager.js | 36 ++++ src/backend/utility.js | 1 + src/types/effects.d.ts | 115 ++++++------- 22 files changed, 820 insertions(+), 602 deletions(-) create mode 100644 src/backend/effects/effect-helpers.ts diff --git a/src/backend/common/effect-runner.js b/src/backend/common/effect-runner.js index d68a479f4..0e75493f9 100644 --- a/src/backend/common/effect-runner.js +++ b/src/backend/common/effect-runner.js @@ -2,7 +2,7 @@ const {ipcMain} = require('electron'); const logger = require('../logwrapper'); const effectManager = require("../effects/effectManager"); -const { EffectDependency, EffectTrigger } = require("../../shared/effect-constants"); +const { EffectTrigger } = require("../../shared/effect-constants"); const accountAccess = require('./account-access'); const replaceVariableManager = require("./../variables/replace-variable-manager"); const effectQueueManager = require("../effects/queues/effect-queue-manager"); @@ -46,9 +46,6 @@ const findAndReplaceVariables = async (data, trigger, effectOutputs) => { } }; -// Connection Dependency Checker -// This returns true if all dependency checks pass. -// NOTE: I don't know of a way to check for overlay status right now so this skips that check. function validateEffectCanRun(effectId, triggerType) { const effectDefinition = effectManager.getEffectById(effectId).definition; @@ -62,22 +59,13 @@ function validateEffectCanRun(effectId, triggerType) { } } - if (effectDefinition.dependencies) { - const twitchChat = require("../chat/twitch-chat"); - const validDeps = effectDefinition.dependencies.every(d => { - if (d === EffectDependency.CHAT) { - return twitchChat.chatIsConnected; - } - - if (d === EffectDependency.OVERLAY) { - return true; - } - - logger.info(`Unknown effect dependency: ${d}`); + // require here to avoid circular dependency issues :( + const { checkEffectDependencies } = require("../effects/effect-helpers"); + const depsMet = checkEffectDependencies(effectDefinition.dependencies, "execution", true); + if (!depsMet) { return false; - }); - return validDeps; + } } return true; @@ -109,12 +97,11 @@ async function runEffects(runEffectsContext) { logger.info(`${effect.type}(${effect.id}) is disabled, skipping...`); continue; } - // Check this effect for dependencies before running. - // If all dependencies are not fulfilled, we will skip this effect. + // Check this effect for dependencies before running. + // If any dependencies are not available, we will skip this effect. if (!validateEffectCanRun(effect.type, trigger.type)) { logger.info(`Skipping ${effect.type}(${effect.id}). Dependencies not met or trigger not supported.`); - continue; } diff --git a/src/backend/effects/builtin/twitch/ad-break.ts b/src/backend/effects/builtin/twitch/ad-break.ts index e0bd46bc9..e7e692adf 100644 --- a/src/backend/effects/builtin/twitch/ad-break.ts +++ b/src/backend/effects/builtin/twitch/ad-break.ts @@ -1,21 +1,25 @@ import { EffectType } from "../../../../types/effects"; -import { EffectCategory, EffectDependency } from '../../../../shared/effect-constants'; -import accountAccess from "../../../common/account-access"; +import { EffectCategory } from "../../../../shared/effect-constants"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - adLength: number + adLength: number; }> = { - definition: { - id: "firebot:ad-break", - name: "Ad Break", - description: "Trigger an ad break", - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - icon: "fad fa-ad", - categories: [EffectCategory.COMMON, EffectCategory.MODERATION, EffectCategory.TWITCH], - dependencies: [EffectDependency.CHAT] + definition: { + id: "firebot:ad-break", + name: "Ad Break", + description: "Trigger an ad break", + icon: "fad fa-ad", + categories: [ + EffectCategory.COMMON, + EffectCategory.MODERATION, + EffectCategory.TWITCH, + ], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: `
`, - optionsController: () => {}, - optionsValidator: () => { - return []; - }, - onTriggerEvent: async event => { - let adLength = event.effect.adLength; - - if (adLength == null) { - adLength = 30; - } + optionsController: () => {}, + optionsValidator: () => { + return []; + }, + onTriggerEvent: async (event) => { + let adLength = event.effect.adLength; - await twitchApi.channels.triggerAdBreak(adLength); - return true; + if (adLength == null) { + adLength = 30; } + + await twitchApi.channels.triggerAdBreak(adLength); + return true; + }, }; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/announcement.ts b/src/backend/effects/builtin/twitch/announcement.ts index 803ea7968..23b625320 100644 --- a/src/backend/effects/builtin/twitch/announcement.ts +++ b/src/backend/effects/builtin/twitch/announcement.ts @@ -1,24 +1,28 @@ import { EffectType } from "../../../../types/effects"; -import { EffectCategory, EffectDependency } from "../../../../shared/effect-constants"; +import { EffectCategory } from "../../../../shared/effect-constants"; import { HelixChatAnnouncementColor } from "@twurple/api"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - color: string, - message: string, - chatter?: string + color: string; + message: string; + chatter?: string; }> = { - definition: { - id: "firebot:announcement", - name: "Announce", - description: "Send an announcement to your chat", - icon: "fad fa-bullhorn", - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - categories: [EffectCategory.COMMON, EffectCategory.CHAT_BASED, EffectCategory.TWITCH], - dependencies: [EffectDependency.CHAT] + definition: { + id: "firebot:announcement", + name: "Announce", + description: "Send an announcement to your chat", + icon: "fad fa-bullhorn", + categories: [ + EffectCategory.COMMON, + EffectCategory.CHAT_BASED, + EffectCategory.TWITCH, + ], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` @@ -30,34 +34,39 @@ const model: EffectType<{ `, - optionsController: ($scope) => { - $scope.announcementColors = [ - "Primary", - "Blue", - "Green", - "Orange", - "Purple" - ]; + optionsController: ($scope) => { + $scope.announcementColors = [ + "Primary", + "Blue", + "Green", + "Orange", + "Purple", + ]; - if ($scope.effect.color == null) { - $scope.effect.color = "Primary"; - } - }, - optionsValidator: ({ message }) => { - const errors = []; - if (message?.length < 1) { - errors.push("Announcement message can't be blank."); - } - return errors; - }, - onTriggerEvent: async ({ effect }) => { - const { message, chatter } = effect; - const color = (effect.color.toLowerCase() ?? "primary") as HelixChatAnnouncementColor; + if ($scope.effect.color == null) { + $scope.effect.color = "Primary"; + } + }, + optionsValidator: ({ message }) => { + const errors = []; + if (message?.length < 1) { + errors.push("Announcement message can't be blank."); + } + return errors; + }, + onTriggerEvent: async ({ effect }) => { + const { message, chatter } = effect; + const color = (effect.color.toLowerCase() ?? + "primary") as HelixChatAnnouncementColor; - await twitchApi.chat.sendAnnouncement(message, color, chatter?.toLowerCase() === "bot"); + await twitchApi.chat.sendAnnouncement( + message, + color, + chatter?.toLowerCase() === "bot" + ); - return true; - } + return true; + }, }; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts b/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts index 663b265e7..303801862 100644 --- a/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts +++ b/src/backend/effects/builtin/twitch/approve-reject-channel-reward-redemption.ts @@ -1,23 +1,24 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - rewardId: string; - redemptionId: string; - approve: boolean; -}> = { - definition: { - id: "firebot:approve-reject-channel-reward-redemption", - name: "Approve/Reject Channel Reward Redemption", - description: "Approves or rejects a pending Twitch channel reward redemption", - icon: "fad fa-check-circle", - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - dependencies: [] + rewardId: string; + redemptionId: string; + approve: boolean; +}> = { + definition: { + id: "firebot:approve-reject-channel-reward-redemption", + name: "Approve/Reject Channel Reward Redemption", + description: + "Approves or rejects a pending Twitch channel reward redemption", + icon: "fad fa-check-circle", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` @@ -48,29 +49,27 @@ const model: EffectType<{
`, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if (!effect.rewardId?.length) { - errors.push("You must enter a reward ID"); - } else if (!effect.redemptionId?.length) { - errors.push("You must enter a redemption ID"); - } else if (effect.approve == null) { - errors.push("You must select an action"); - } - - return errors; - }, - optionsController: () => { - - }, - onTriggerEvent: async ({ effect }) => { - return await twitchApi.channelRewards.approveOrRejectChannelRewardRedemption( - effect.rewardId, - effect.redemptionId, - effect.approve - ); + if (!effect.rewardId?.length) { + errors.push("You must enter a reward ID"); + } else if (!effect.redemptionId?.length) { + errors.push("You must enter a redemption ID"); + } else if (effect.approve == null) { + errors.push("You must select an action"); } -} + + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + return await twitchApi.channelRewards.approveOrRejectChannelRewardRedemption( + effect.rewardId, + effect.redemptionId, + effect.approve + ); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/cancel-prediction.ts b/src/backend/effects/builtin/twitch/cancel-prediction.ts index 356f50d3c..907b6e3da 100644 --- a/src/backend/effects/builtin/twitch/cancel-prediction.ts +++ b/src/backend/effects/builtin/twitch/cancel-prediction.ts @@ -1,39 +1,44 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{}> = { - definition: { - id: "twitch:cancel-prediction", - name: "Cancel Twitch Prediction", - description: "Cancels the currently active Twitch prediction and refunds all channel points wagered", - icon: "fad fa-ban", - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [] + definition: { + id: "twitch:cancel-prediction", + name: "Cancel Twitch Prediction", + description: + "Cancels the currently active Twitch prediction and refunds all channel points wagered", + icon: "fad fa-ban", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: `
Note: If there is no prediction currently running, this will take no action.
`, - optionsValidator: () => [], - optionsController: () => {}, - onTriggerEvent: async () => { - const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async () => { + const latestPrediction = + await twitchApi.predictions.getMostRecentPrediction(); - if (latestPrediction?.status !== "ACTIVE" && latestPrediction?.status !== "LOCKED") { - logger.warn("There is no active Twitch prediction to cancel"); - return; - } - - logger.debug(`Canceling Twitch prediction "${latestPrediction.title}"`); - return await twitchApi.predictions.cancelPrediction(latestPrediction.id); + if ( + latestPrediction?.status !== "ACTIVE" && + latestPrediction?.status !== "LOCKED" + ) { + logger.warn("There is no active Twitch prediction to cancel"); + return; } -} + + logger.debug(`Canceling Twitch prediction "${latestPrediction.title}"`); + return await twitchApi.predictions.cancelPrediction(latestPrediction.id); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/create-poll.ts b/src/backend/effects/builtin/twitch/create-poll.ts index 976f3ec83..2c0b80f9a 100644 --- a/src/backend/effects/builtin/twitch/create-poll.ts +++ b/src/backend/effects/builtin/twitch/create-poll.ts @@ -1,26 +1,26 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - title: string; - choices: string[]; - duration: number; - allowChannelPointVoting: boolean; - channelPointsPerVote: number; + title: string; + choices: string[]; + duration: number; + allowChannelPointVoting: boolean; + channelPointsPerVote: number; }> = { - definition: { - id: "twitch:create-poll", - name: "Create Twitch Poll", - description: "Creates a Twitch poll", - icon: "fad fa-poll-h", - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [] + definition: { + id: "twitch:create-poll", + name: "Create Twitch Poll", + description: "Creates a Twitch poll", + icon: "fad fa-poll-h", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` @@ -44,42 +44,54 @@ const model: EffectType<{ `, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 25)) { - errors.push("You must enter a title no more than 25 characters long"); - } - - if (!(effect.duration >= 15 && effect.duration <= 1800)) { - errors.push("Duration must be between 15 and 1800 seconds"); - } - - if (!effect.choices?.length || !(effect.choices.length >= 2 && effect.choices.length <= 5)) { - errors.push("You must enter between 2 and 5 choices"); - } - - if (effect.allowChannelPointVoting && !(effect.channelPointsPerVote >= 1 && effect.channelPointsPerVote <= 1000000)) { - errors.push("Channel points per vote must be between 1 and 1,000,000"); - } + if ( + !effect.title?.length || + !(effect.title.length > 0 && effect.title.length <= 25) + ) { + errors.push("You must enter a title no more than 25 characters long"); + } - return errors; - }, - optionsController: ($scope) => { - $scope.optionSettings = { - noDuplicates: true, - maxItems: 5 - } - }, - onTriggerEvent: async ({ effect }) => { - logger.debug(`Creating Twitch poll "${effect.title}"`) - return await twitchApi.polls.createPoll( - effect.title, - effect.choices, - effect.duration, - effect.allowChannelPointVoting ? effect.channelPointsPerVote : null - ); + if (!(effect.duration >= 15 && effect.duration <= 1800)) { + errors.push("Duration must be between 15 and 1800 seconds"); + } + + if ( + !effect.choices?.length || + !(effect.choices.length >= 2 && effect.choices.length <= 5) + ) { + errors.push("You must enter between 2 and 5 choices"); + } + + if ( + effect.allowChannelPointVoting && + !( + effect.channelPointsPerVote >= 1 && + effect.channelPointsPerVote <= 1000000 + ) + ) { + errors.push("Channel points per vote must be between 1 and 1,000,000"); } -} + + return errors; + }, + optionsController: ($scope) => { + $scope.optionSettings = { + noDuplicates: true, + maxItems: 5, + }; + }, + onTriggerEvent: async ({ effect }) => { + logger.debug(`Creating Twitch poll "${effect.title}"`); + return await twitchApi.polls.createPoll( + effect.title, + effect.choices, + effect.duration, + effect.allowChannelPointVoting ? effect.channelPointsPerVote : null + ); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/create-prediction.ts b/src/backend/effects/builtin/twitch/create-prediction.ts index 35cca9924..21bc10cc0 100644 --- a/src/backend/effects/builtin/twitch/create-prediction.ts +++ b/src/backend/effects/builtin/twitch/create-prediction.ts @@ -1,24 +1,24 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - title: string; - outcomes: string[]; - duration: number; + title: string; + outcomes: string[]; + duration: number; }> = { - definition: { - id: "twitch:create-prediction", - name: "Create Twitch Prediction", - description: "Creates a Twitch prediction", - icon: "fad fa-question-circle", - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [] + definition: { + id: "twitch:create-prediction", + name: "Create Twitch Prediction", + description: "Creates a Twitch prediction", + icon: "fad fa-question-circle", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` @@ -37,37 +37,43 @@ const model: EffectType<{ `, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 45)) { - errors.push("You must enter a title no more than 45 characters long"); - } - - if (!(effect.duration >= 30 && effect.duration <= 1800)) { - errors.push("Duration must be between 30 and 1800 seconds"); - } - - if (!effect.outcomes?.length || !(effect.outcomes.length >= 2 && effect.outcomes.length <= 10)) { - errors.push("You must enter between 2 and 10 outcomes"); - } + if ( + !effect.title?.length || + !(effect.title.length > 0 && effect.title.length <= 45) + ) { + errors.push("You must enter a title no more than 45 characters long"); + } - return errors; - }, - optionsController: ($scope) => { - $scope.optionSettings = { - noDuplicates: true, - maxItems: 10 - } - }, - onTriggerEvent: async ({ effect }) => { - logger.debug(`Creating Twitch prediction "${effect.title}"`) - return await twitchApi.predictions.createPrediction( - effect.title, - effect.outcomes, - effect.duration - ); + if (!(effect.duration >= 30 && effect.duration <= 1800)) { + errors.push("Duration must be between 30 and 1800 seconds"); } -} + + if ( + !effect.outcomes?.length || + !(effect.outcomes.length >= 2 && effect.outcomes.length <= 10) + ) { + errors.push("You must enter between 2 and 10 outcomes"); + } + + return errors; + }, + optionsController: ($scope) => { + $scope.optionSettings = { + noDuplicates: true, + maxItems: 10, + }; + }, + onTriggerEvent: async ({ effect }) => { + logger.debug(`Creating Twitch prediction "${effect.title}"`); + return await twitchApi.predictions.createPrediction( + effect.title, + effect.outcomes, + effect.duration + ); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/create-stream-marker.ts b/src/backend/effects/builtin/twitch/create-stream-marker.ts index 88dc18668..f90757859 100644 --- a/src/backend/effects/builtin/twitch/create-stream-marker.ts +++ b/src/backend/effects/builtin/twitch/create-stream-marker.ts @@ -1,21 +1,21 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - description: string; -}> = { - definition: { - id: "firebot:create-stream-marker", - name: "Create Stream Marker", - description: "Create a stream marker in your Twitch VOD", - icon: "fad fa-map-pin", - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [] + description: string; +}> = { + definition: { + id: "firebot:create-stream-marker", + name: "Create Stream Marker", + description: "Create a stream marker in your Twitch VOD", + icon: "fad fa-map-pin", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` @@ -26,15 +26,13 @@ const model: EffectType<{ `, - optionsValidator: () => { - return [] as string[]; - }, - optionsController: () => { - - }, - onTriggerEvent: async ({ effect }) => { - await twitchApi.streams.createStreamMarker(effect.description); - } -} + optionsValidator: () => { + return [] as string[]; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + await twitchApi.streams.createStreamMarker(effect.description); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/end-poll.ts b/src/backend/effects/builtin/twitch/end-poll.ts index 066ae9d06..a1cc3c984 100644 --- a/src/backend/effects/builtin/twitch/end-poll.ts +++ b/src/backend/effects/builtin/twitch/end-poll.ts @@ -1,22 +1,22 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - archivePoll: boolean; + archivePoll: boolean; }> = { - definition: { - id: "twitch:end-poll", - name: "End Twitch Poll", - description: "Ends the currently active Twitch poll", - icon: "fad fa-stop-circle", - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [] + definition: { + id: "twitch:end-poll", + name: "End Twitch Poll", + description: "Ends the currently active Twitch poll", + icon: "fad fa-stop-circle", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` @@ -27,19 +27,23 @@ const model: EffectType<{ `, - optionsValidator: () => [], - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - const latestPoll = await twitchApi.polls.getMostRecentPoll(); + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const latestPoll = await twitchApi.polls.getMostRecentPoll(); - if (latestPoll?.status !== "ACTIVE") { - logger.warn("There is no active Twitch poll to end"); - return; - } - - logger.debug(`Ending Twitch poll "${latestPoll.title}"${effect.archivePoll ? " as archived" : ""}`); - return await twitchApi.polls.endPoll(latestPoll.id, effect.archivePoll); + if (latestPoll?.status !== "ACTIVE") { + logger.warn("There is no active Twitch poll to end"); + return; } -} + + logger.debug( + `Ending Twitch poll "${latestPoll.title}"${ + effect.archivePoll ? " as archived" : "" + }` + ); + return await twitchApi.polls.endPoll(latestPoll.id, effect.archivePoll); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/lock-prediction.ts b/src/backend/effects/builtin/twitch/lock-prediction.ts index 6ab5096d9..e6614d533 100644 --- a/src/backend/effects/builtin/twitch/lock-prediction.ts +++ b/src/backend/effects/builtin/twitch/lock-prediction.ts @@ -1,39 +1,41 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{}> = { - definition: { - id: "twitch:lock-prediction", - name: "Lock Twitch Prediction", - description: "Locks the currently active Twitch prediction so that no more predictions can be made", - icon: "fad fa-lock", - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [] + definition: { + id: "twitch:lock-prediction", + name: "Lock Twitch Prediction", + description: + "Locks the currently active Twitch prediction so that no more predictions can be made", + icon: "fad fa-lock", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: `
Note: If there is no prediction currently running, this will take no action.
`, - optionsValidator: () => [], - optionsController: () => {}, - onTriggerEvent: async () => { - const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async () => { + const latestPrediction = + await twitchApi.predictions.getMostRecentPrediction(); - if (latestPrediction?.status !== "ACTIVE") { - logger.warn("There is no active Twitch prediction to lock"); - return; - } - - logger.debug(`Locking Twitch prediction "${latestPrediction.title}"`); - return await twitchApi.predictions.lockPrediciton(latestPrediction.id); + if (latestPrediction?.status !== "ACTIVE") { + logger.warn("There is no active Twitch prediction to lock"); + return; } -} + + logger.debug(`Locking Twitch prediction "${latestPrediction.title}"`); + return await twitchApi.predictions.lockPrediciton(latestPrediction.id); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/raid.ts b/src/backend/effects/builtin/twitch/raid.ts index 49407c4b8..49f915adf 100644 --- a/src/backend/effects/builtin/twitch/raid.ts +++ b/src/backend/effects/builtin/twitch/raid.ts @@ -1,23 +1,23 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - action: "Raid Channel" | "Cancel Raid"; - username?: string; -}> = { - definition: { - id: "firebot:raid", - name: "Raid/Unraid Twitch Channel", - description: "Start or cancel a raid to another Twitch channel", - icon: "fad fa-rocket-launch", - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [] + action: "Raid Channel" | "Cancel Raid"; + username?: string; +}> = { + definition: { + id: "firebot:raid", + name: "Raid/Unraid Twitch Channel", + description: "Start or cancel a raid to another Twitch channel", + icon: "fad fa-rocket-launch", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: `
`, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if (!(effect.outcome >= 1 && effect.outcome <= 10)) { - errors.push("Outcome must be between 1 and 10.") - } + if (!(effect.outcome >= 1 && effect.outcome <= 10)) { + errors.push("Outcome must be between 1 and 10."); + } - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const latestPrediction = + await twitchApi.predictions.getMostRecentPrediction(); - if (latestPrediction?.status !== "ACTIVE" && latestPrediction?.status !== "LOCKED" ) { - logger.warn("There is no active Twitch prediction to resolve"); - return; - } + if ( + latestPrediction?.status !== "ACTIVE" && + latestPrediction?.status !== "LOCKED" + ) { + logger.warn("There is no active Twitch prediction to resolve"); + return; + } - const winningOutcome = latestPrediction.outcomes[effect.outcome - 1]; + const winningOutcome = latestPrediction.outcomes[effect.outcome - 1]; - logger.debug(`Resolving Twitch prediction "${latestPrediction.title}" with outcome "${winningOutcome.title}"`); - return await twitchApi.predictions.resolvePrediction(latestPrediction.id, winningOutcome.id); - } -} + logger.debug( + `Resolving Twitch prediction "${latestPrediction.title}" with outcome "${winningOutcome.title}"` + ); + return await twitchApi.predictions.resolvePrediction( + latestPrediction.id, + winningOutcome.id + ); + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/set-chat-mode.ts b/src/backend/effects/builtin/twitch/set-chat-mode.ts index 6c2073418..9cbd4ab63 100644 --- a/src/backend/effects/builtin/twitch/set-chat-mode.ts +++ b/src/backend/effects/builtin/twitch/set-chat-mode.ts @@ -1,34 +1,34 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import { TwitchCommandHelpers } from "../../../chat/twitch-commands/twitch-command-helpers"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - setFollowersOnly: boolean; - enableFollowersOnly?: boolean; - followersOnlyDuration?: string; - - setSubscribersOnly: boolean; - enableSubscribersOnly?: boolean; - - setEmoteOnly: boolean; - enableEmoteOnly?: boolean; - - setSlowMode: boolean; - enableSlowMode?: boolean; - slowModeDelay?: number; -}> = { - definition: { - id: "firebot:set-chat-mode", - name: "Set Chat Mode", - description: "Sets the chat mode(s) for your Twitch channel", - icon: "fad fa-comment-check", - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - categories: [ EffectCategory.COMMON, EffectCategory.TWITCH ], - dependencies: [] + setFollowersOnly: boolean; + enableFollowersOnly?: boolean; + followersOnlyDuration?: string; + + setSubscribersOnly: boolean; + enableSubscribersOnly?: boolean; + + setEmoteOnly: boolean; + enableEmoteOnly?: boolean; + + setSlowMode: boolean; + enableSlowMode?: boolean; + slowModeDelay?: number; +}> = { + definition: { + id: "firebot:set-chat-mode", + name: "Set Chat Mode", + description: "Sets the chat mode(s) for your Twitch channel", + icon: "fad fa-comment-check", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` `, - optionsValidator: (effect) => { - const errors: string[] = []; - - if (effect.setFollowersOnly === true && effect.enableFollowersOnly == null) { - errors.push("You must select a followers-only action"); - } else if (effect.setSubscribersOnly === true && effect.enableSubscribersOnly == null) { - errors.push("You must specify a subscribers-only action"); - } else if (effect.setEmoteOnly === true && effect.enableEmoteOnly == null) { - errors.push("You must specify an emote-only action"); - } else if (effect.setSlowMode === true && effect.enableSlowMode == null) { - errors.push("You must specify a slow mode action"); - } - - return errors; - }, - optionsController: () => { }, - onTriggerEvent: async ({ effect }) => { - if (effect.setFollowersOnly === true) { - const parsedDuration = TwitchCommandHelpers.getRawDurationInSeconds(effect.followersOnlyDuration, "minutes"); + optionsValidator: (effect) => { + const errors: string[] = []; + + if ( + effect.setFollowersOnly === true && + effect.enableFollowersOnly == null + ) { + errors.push("You must select a followers-only action"); + } else if ( + effect.setSubscribersOnly === true && + effect.enableSubscribersOnly == null + ) { + errors.push("You must specify a subscribers-only action"); + } else if (effect.setEmoteOnly === true && effect.enableEmoteOnly == null) { + errors.push("You must specify an emote-only action"); + } else if (effect.setSlowMode === true && effect.enableSlowMode == null) { + errors.push("You must specify a slow mode action"); + } - await twitchApi.chat.setFollowerOnlyMode(effect.enableFollowersOnly ?? false, Math.floor(parsedDuration / 60)); - } + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + if (effect.setFollowersOnly === true) { + const parsedDuration = TwitchCommandHelpers.getRawDurationInSeconds( + effect.followersOnlyDuration, + "minutes" + ); + + await twitchApi.chat.setFollowerOnlyMode( + effect.enableFollowersOnly ?? false, + Math.floor(parsedDuration / 60) + ); + } - if (effect.setSubscribersOnly === true) { - await twitchApi.chat.setSubscriberOnlyMode(effect.enableSubscribersOnly ?? false); - } + if (effect.setSubscribersOnly === true) { + await twitchApi.chat.setSubscriberOnlyMode( + effect.enableSubscribersOnly ?? false + ); + } - if (effect.setEmoteOnly === true) { - await twitchApi.chat.setEmoteOnlyMode(effect.enableEmoteOnly ?? false); - } + if (effect.setEmoteOnly === true) { + await twitchApi.chat.setEmoteOnlyMode(effect.enableEmoteOnly ?? false); + } - if (effect.setSlowMode === true) { - await twitchApi.chat.setSlowMode(effect.enableSlowMode ?? false, effect.slowModeDelay); - } + if (effect.setSlowMode === true) { + await twitchApi.chat.setSlowMode( + effect.enableSlowMode ?? false, + effect.slowModeDelay + ); } -} + }, +}; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/shoutout.ts b/src/backend/effects/builtin/twitch/shoutout.ts index b52d4b400..412a14060 100644 --- a/src/backend/effects/builtin/twitch/shoutout.ts +++ b/src/backend/effects/builtin/twitch/shoutout.ts @@ -1,22 +1,22 @@ import { EffectType } from "../../../../types/effects"; import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; -import accountAccess from "../../../common/account-access"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - username: string; + username: string; }> = { - definition: { - id: "firebot:twitch-shoutout", - name: "Twitch Shoutout", - description: "Send a Twitch shoutout to another channel", - icon: "fad fa-bullhorn", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - dependencies: [], + definition: { + id: "firebot:twitch-shoutout", + name: "Twitch Shoutout", + description: "Send a Twitch shoutout to another channel", + icon: "fad fa-bullhorn", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: ` @@ -27,29 +27,30 @@ const model: EffectType<{ `, - optionsValidator: (effect) => { - const errors: string[] = []; - const username = effect.username?.trim(); + optionsValidator: (effect) => { + const errors: string[] = []; + const username = effect.username?.trim(); - if (!username?.length) { - errors.push("You must specify a channel to shoutout"); - } - - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - const targetUserId = (await twitchApi.users.getUserByName(effect.username))?.id; - - if (targetUserId == null) { - logger.error( - `Unable to shoutout channel. Twitch user ${effect.username} does not exist.` - ); - return false; - } - - return await twitchApi.chat.sendShoutout(targetUserId); - }, + if (!username?.length) { + errors.push("You must specify a channel to shoutout"); + } + + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const targetUserId = (await twitchApi.users.getUserByName(effect.username)) + ?.id; + + if (targetUserId == null) { + logger.error( + `Unable to shoutout channel. Twitch user ${effect.username} does not exist.` + ); + return false; + } + + return await twitchApi.chat.sendShoutout(targetUserId); + }, }; module.exports = model; \ No newline at end of file diff --git a/src/backend/effects/builtin/twitch/stream-game.ts b/src/backend/effects/builtin/twitch/stream-game.ts index b133f1a94..5f2d85729 100644 --- a/src/backend/effects/builtin/twitch/stream-game.ts +++ b/src/backend/effects/builtin/twitch/stream-game.ts @@ -1,25 +1,29 @@ import { EffectType } from '../../../../types/effects'; import { EffectCategory } from '../../../../shared/effect-constants'; -import logger from '../../../logwrapper'; -import accountAccess from "../../../common/account-access"; +import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; import eventsManager from "../../../events/EventManager"; const model: EffectType<{ - mode: "specific" | "custom", - gameId: string, - gameName: string + mode: "specific" | "custom"; + gameId: string; + gameName: string; }> = { - definition: { - id: "firebot:streamgame", - name: "Set Stream Category", - description: "Set the stream category/game.", - icon: "fad fa-gamepad", - hidden: () => !accountAccess.getAccounts().streamer.loggedIn, - categories: [EffectCategory.COMMON, EffectCategory.MODERATION, EffectCategory.TWITCH], - dependencies: [] + definition: { + id: "firebot:streamgame", + name: "Set Stream Category", + description: "Set the stream category/game.", + icon: "fad fa-gamepad", + categories: [ + EffectCategory.COMMON, + EffectCategory.MODERATION, + EffectCategory.TWITCH, + ], + dependencies: { + twitch: true, }, - optionsTemplate: ` + }, + optionsTemplate: `
`, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if (!effect.rewardId?.length) { - errors.push("You must enter a reward ID"); - } else if (!effect.redemptionId?.length) { - errors.push("You must enter a redemption ID"); - } else if (effect.approve == null) { - errors.push("You must select an action"); - } + if (!effect.rewardId?.length) { + errors.push("You must enter a reward ID"); + } else if (!effect.redemptionId?.length) { + errors.push("You must enter a redemption ID"); + } else if (effect.approve == null) { + errors.push("You must select an action"); + } - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - return await twitchApi.channelRewards.approveOrRejectChannelRewardRedemption( - effect.rewardId, - effect.redemptionId, - effect.approve - ); - }, + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + return await twitchApi.channelRewards.approveOrRejectChannelRewardRedemption( + effect.rewardId, + effect.redemptionId, + effect.approve + ); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/cancel-prediction.ts b/src/backend/effects/builtin/twitch/cancel-prediction.ts index 907b6e3da..6a532cdd2 100644 --- a/src/backend/effects/builtin/twitch/cancel-prediction.ts +++ b/src/backend/effects/builtin/twitch/cancel-prediction.ts @@ -4,41 +4,36 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{}> = { - definition: { - id: "twitch:cancel-prediction", - name: "Cancel Twitch Prediction", - description: - "Cancels the currently active Twitch prediction and refunds all channel points wagered", - icon: "fad fa-ban", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "twitch:cancel-prediction", + name: "Cancel Twitch Prediction", + description: "Cancels the currently active Twitch prediction and refunds all channel points wagered", + icon: "fad fa-ban", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: `
Note: If there is no prediction currently running, this will take no action.
`, - optionsValidator: () => [], - optionsController: () => {}, - onTriggerEvent: async () => { - const latestPrediction = - await twitchApi.predictions.getMostRecentPrediction(); + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async () => { + const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); - if ( - latestPrediction?.status !== "ACTIVE" && - latestPrediction?.status !== "LOCKED" - ) { - logger.warn("There is no active Twitch prediction to cancel"); - return; - } + if (latestPrediction?.status !== "ACTIVE" && latestPrediction?.status !== "LOCKED") { + logger.warn("There is no active Twitch prediction to cancel"); + return; + } - logger.debug(`Canceling Twitch prediction "${latestPrediction.title}"`); - return await twitchApi.predictions.cancelPrediction(latestPrediction.id); - }, + logger.debug(`Canceling Twitch prediction "${latestPrediction.title}"`); + return await twitchApi.predictions.cancelPrediction(latestPrediction.id); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/create-poll.ts b/src/backend/effects/builtin/twitch/create-poll.ts index 2c0b80f9a..eca977805 100644 --- a/src/backend/effects/builtin/twitch/create-poll.ts +++ b/src/backend/effects/builtin/twitch/create-poll.ts @@ -4,23 +4,23 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - title: string; - choices: string[]; - duration: number; - allowChannelPointVoting: boolean; - channelPointsPerVote: number; + title: string; + choices: string[]; + duration: number; + allowChannelPointVoting: boolean; + channelPointsPerVote: number; }> = { - definition: { - id: "twitch:create-poll", - name: "Create Twitch Poll", - description: "Creates a Twitch poll", - icon: "fad fa-poll-h", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "twitch:create-poll", + name: "Create Twitch Poll", + description: "Creates a Twitch poll", + icon: "fad fa-poll-h", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: ` @@ -44,54 +44,45 @@ const model: EffectType<{ `, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if ( - !effect.title?.length || - !(effect.title.length > 0 && effect.title.length <= 25) - ) { - errors.push("You must enter a title no more than 25 characters long"); - } + if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 25)) { + errors.push("You must enter a title no more than 25 characters long"); + } - if (!(effect.duration >= 15 && effect.duration <= 1800)) { - errors.push("Duration must be between 15 and 1800 seconds"); - } + if (!(effect.duration >= 15 && effect.duration <= 1800)) { + errors.push("Duration must be between 15 and 1800 seconds"); + } - if ( - !effect.choices?.length || - !(effect.choices.length >= 2 && effect.choices.length <= 5) - ) { - errors.push("You must enter between 2 and 5 choices"); - } + if (!effect.choices?.length || !(effect.choices.length >= 2 && effect.choices.length <= 5)) { + errors.push("You must enter between 2 and 5 choices"); + } - if ( - effect.allowChannelPointVoting && - !( - effect.channelPointsPerVote >= 1 && - effect.channelPointsPerVote <= 1000000 - ) - ) { - errors.push("Channel points per vote must be between 1 and 1,000,000"); - } + if ( + effect.allowChannelPointVoting && + !(effect.channelPointsPerVote >= 1 && effect.channelPointsPerVote <= 1000000) + ) { + errors.push("Channel points per vote must be between 1 and 1,000,000"); + } - return errors; - }, - optionsController: ($scope) => { - $scope.optionSettings = { - noDuplicates: true, - maxItems: 5, - }; - }, - onTriggerEvent: async ({ effect }) => { - logger.debug(`Creating Twitch poll "${effect.title}"`); - return await twitchApi.polls.createPoll( - effect.title, - effect.choices, - effect.duration, - effect.allowChannelPointVoting ? effect.channelPointsPerVote : null - ); - }, + return errors; + }, + optionsController: ($scope) => { + $scope.optionSettings = { + noDuplicates: true, + maxItems: 5, + }; + }, + onTriggerEvent: async ({ effect }) => { + logger.debug(`Creating Twitch poll "${effect.title}"`); + return await twitchApi.polls.createPoll( + effect.title, + effect.choices, + effect.duration, + effect.allowChannelPointVoting ? effect.channelPointsPerVote : null + ); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/create-prediction.ts b/src/backend/effects/builtin/twitch/create-prediction.ts index 21bc10cc0..e33b26cfa 100644 --- a/src/backend/effects/builtin/twitch/create-prediction.ts +++ b/src/backend/effects/builtin/twitch/create-prediction.ts @@ -4,21 +4,21 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - title: string; - outcomes: string[]; - duration: number; + title: string; + outcomes: string[]; + duration: number; }> = { - definition: { - id: "twitch:create-prediction", - name: "Create Twitch Prediction", - description: "Creates a Twitch prediction", - icon: "fad fa-question-circle", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "twitch:create-prediction", + name: "Create Twitch Prediction", + description: "Creates a Twitch prediction", + icon: "fad fa-question-circle", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: ` @@ -37,43 +37,33 @@ const model: EffectType<{ `, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if ( - !effect.title?.length || - !(effect.title.length > 0 && effect.title.length <= 45) - ) { - errors.push("You must enter a title no more than 45 characters long"); - } + if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 45)) { + errors.push("You must enter a title no more than 45 characters long"); + } - if (!(effect.duration >= 30 && effect.duration <= 1800)) { - errors.push("Duration must be between 30 and 1800 seconds"); - } + if (!(effect.duration >= 30 && effect.duration <= 1800)) { + errors.push("Duration must be between 30 and 1800 seconds"); + } - if ( - !effect.outcomes?.length || - !(effect.outcomes.length >= 2 && effect.outcomes.length <= 10) - ) { - errors.push("You must enter between 2 and 10 outcomes"); - } + if (!effect.outcomes?.length || !(effect.outcomes.length >= 2 && effect.outcomes.length <= 10)) { + errors.push("You must enter between 2 and 10 outcomes"); + } - return errors; - }, - optionsController: ($scope) => { - $scope.optionSettings = { - noDuplicates: true, - maxItems: 10, - }; - }, - onTriggerEvent: async ({ effect }) => { - logger.debug(`Creating Twitch prediction "${effect.title}"`); - return await twitchApi.predictions.createPrediction( - effect.title, - effect.outcomes, - effect.duration - ); - }, + return errors; + }, + optionsController: ($scope) => { + $scope.optionSettings = { + noDuplicates: true, + maxItems: 10, + }; + }, + onTriggerEvent: async ({ effect }) => { + logger.debug(`Creating Twitch prediction "${effect.title}"`); + return await twitchApi.predictions.createPrediction(effect.title, effect.outcomes, effect.duration); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/create-stream-marker.ts b/src/backend/effects/builtin/twitch/create-stream-marker.ts index f90757859..c899d3e14 100644 --- a/src/backend/effects/builtin/twitch/create-stream-marker.ts +++ b/src/backend/effects/builtin/twitch/create-stream-marker.ts @@ -3,19 +3,19 @@ import { EffectCategory } from "../../../../shared/effect-constants"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - description: string; + description: string; }> = { - definition: { - id: "firebot:create-stream-marker", - name: "Create Stream Marker", - description: "Create a stream marker in your Twitch VOD", - icon: "fad fa-map-pin", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "firebot:create-stream-marker", + name: "Create Stream Marker", + description: "Create a stream marker in your Twitch VOD", + icon: "fad fa-map-pin", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: ` @@ -26,13 +26,13 @@ const model: EffectType<{ `, - optionsValidator: () => { - return [] as string[]; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - await twitchApi.streams.createStreamMarker(effect.description); - }, + optionsValidator: () => { + return [] as string[]; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + await twitchApi.streams.createStreamMarker(effect.description); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/end-poll.ts b/src/backend/effects/builtin/twitch/end-poll.ts index a1cc3c984..be3b475fb 100644 --- a/src/backend/effects/builtin/twitch/end-poll.ts +++ b/src/backend/effects/builtin/twitch/end-poll.ts @@ -4,19 +4,19 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - archivePoll: boolean; + archivePoll: boolean; }> = { - definition: { - id: "twitch:end-poll", - name: "End Twitch Poll", - description: "Ends the currently active Twitch poll", - icon: "fad fa-stop-circle", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "twitch:end-poll", + name: "End Twitch Poll", + description: "Ends the currently active Twitch poll", + icon: "fad fa-stop-circle", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: ` @@ -27,23 +27,19 @@ const model: EffectType<{ `, - optionsValidator: () => [], - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - const latestPoll = await twitchApi.polls.getMostRecentPoll(); + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const latestPoll = await twitchApi.polls.getMostRecentPoll(); - if (latestPoll?.status !== "ACTIVE") { - logger.warn("There is no active Twitch poll to end"); - return; - } + if (latestPoll?.status !== "ACTIVE") { + logger.warn("There is no active Twitch poll to end"); + return; + } - logger.debug( - `Ending Twitch poll "${latestPoll.title}"${ - effect.archivePoll ? " as archived" : "" - }` - ); - return await twitchApi.polls.endPoll(latestPoll.id, effect.archivePoll); - }, + logger.debug(`Ending Twitch poll "${latestPoll.title}"${effect.archivePoll ? " as archived" : ""}`); + return await twitchApi.polls.endPoll(latestPoll.id, effect.archivePoll); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/lock-prediction.ts b/src/backend/effects/builtin/twitch/lock-prediction.ts index e6614d533..40a01eecf 100644 --- a/src/backend/effects/builtin/twitch/lock-prediction.ts +++ b/src/backend/effects/builtin/twitch/lock-prediction.ts @@ -4,38 +4,36 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{}> = { - definition: { - id: "twitch:lock-prediction", - name: "Lock Twitch Prediction", - description: - "Locks the currently active Twitch prediction so that no more predictions can be made", - icon: "fad fa-lock", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "twitch:lock-prediction", + name: "Lock Twitch Prediction", + description: "Locks the currently active Twitch prediction so that no more predictions can be made", + icon: "fad fa-lock", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: `
Note: If there is no prediction currently running, this will take no action.
`, - optionsValidator: () => [], - optionsController: () => {}, - onTriggerEvent: async () => { - const latestPrediction = - await twitchApi.predictions.getMostRecentPrediction(); + optionsValidator: () => [], + optionsController: () => {}, + onTriggerEvent: async () => { + const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); - if (latestPrediction?.status !== "ACTIVE") { - logger.warn("There is no active Twitch prediction to lock"); - return; - } + if (latestPrediction?.status !== "ACTIVE") { + logger.warn("There is no active Twitch prediction to lock"); + return; + } - logger.debug(`Locking Twitch prediction "${latestPrediction.title}"`); - return await twitchApi.predictions.lockPrediciton(latestPrediction.id); - }, + logger.debug(`Locking Twitch prediction "${latestPrediction.title}"`); + return await twitchApi.predictions.lockPrediciton(latestPrediction.id); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/raid.ts b/src/backend/effects/builtin/twitch/raid.ts index 49f915adf..9c4d01b4d 100644 --- a/src/backend/effects/builtin/twitch/raid.ts +++ b/src/backend/effects/builtin/twitch/raid.ts @@ -4,20 +4,20 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - action: "Raid Channel" | "Cancel Raid"; - username?: string; + action: "Raid Channel" | "Cancel Raid"; + username?: string; }> = { - definition: { - id: "firebot:raid", - name: "Raid/Unraid Twitch Channel", - description: "Start or cancel a raid to another Twitch channel", - icon: "fad fa-rocket-launch", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "firebot:raid", + name: "Raid/Unraid Twitch Channel", + description: "Start or cancel a raid to another Twitch channel", + icon: "fad fa-rocket-launch", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: `
- + `, - optionsValidator: (effect) => { - const errors: string[] = []; - const username = effect.username?.trim(); + optionsValidator: (effect) => { + const errors: string[] = []; + const username = effect.username?.trim(); - if (effect.action == null) { - errors.push("You must select a raid action"); - } else if (effect.action === "Raid Channel" && !username?.length) { - errors.push("You must specify a channel to raid"); - } + if (effect.action == null) { + errors.push("You must select a raid action"); + } else if (effect.action === "Raid Channel" && !username?.length) { + errors.push("You must specify a channel to raid"); + } - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - if (effect.action === "Raid Channel") { - const targetUserId = ( - await twitchApi.users.getUserByName(effect.username) - )?.id; + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + if (effect.action === "Raid Channel") { + const targetUserId = (await twitchApi.users.getUserByName(effect.username))?.id; - if (targetUserId == null) { - logger.error( - `Unable to start raid. Twitch user ${effect.username} does not exist.` - ); - return false; - } + if (targetUserId == null) { + logger.error(`Unable to start raid. Twitch user ${effect.username} does not exist.`); + return false; + } - await twitchApi.channels.raidChannel(targetUserId); - } else { - await twitchApi.channels.cancelRaid(); - } - }, + await twitchApi.channels.raidChannel(targetUserId); + } else { + await twitchApi.channels.cancelRaid(); + } + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/resolve-prediction.ts b/src/backend/effects/builtin/twitch/resolve-prediction.ts index 4e2fefe6a..2a5e72b18 100644 --- a/src/backend/effects/builtin/twitch/resolve-prediction.ts +++ b/src/backend/effects/builtin/twitch/resolve-prediction.ts @@ -4,20 +4,20 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - outcome: number; + outcome: number; }> = { - definition: { - id: "twitch:resolve-prediction", - name: "Resolve Twitch Prediction", - description: - "Resolves the currently active Twitch prediction by selecting an outcome and pays out channel points to the winners", - icon: "fad fa-trophy-alt", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "twitch:resolve-prediction", + name: "Resolve Twitch Prediction", + description: + "Resolves the currently active Twitch prediction by selecting an outcome and pays out channel points to the winners", + icon: "fad fa-trophy-alt", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: ` @@ -28,38 +28,29 @@ const model: EffectType<{ `, - optionsValidator: (effect) => { - const errors: string[] = []; + optionsValidator: (effect) => { + const errors: string[] = []; - if (!(effect.outcome >= 1 && effect.outcome <= 10)) { - errors.push("Outcome must be between 1 and 10."); - } + if (!(effect.outcome >= 1 && effect.outcome <= 10)) { + errors.push("Outcome must be between 1 and 10."); + } - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - const latestPrediction = - await twitchApi.predictions.getMostRecentPrediction(); + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const latestPrediction = await twitchApi.predictions.getMostRecentPrediction(); - if ( - latestPrediction?.status !== "ACTIVE" && - latestPrediction?.status !== "LOCKED" - ) { - logger.warn("There is no active Twitch prediction to resolve"); - return; - } + if (latestPrediction?.status !== "ACTIVE" && latestPrediction?.status !== "LOCKED") { + logger.warn("There is no active Twitch prediction to resolve"); + return; + } - const winningOutcome = latestPrediction.outcomes[effect.outcome - 1]; + const winningOutcome = latestPrediction.outcomes[effect.outcome - 1]; - logger.debug( - `Resolving Twitch prediction "${latestPrediction.title}" with outcome "${winningOutcome.title}"` - ); - return await twitchApi.predictions.resolvePrediction( - latestPrediction.id, - winningOutcome.id - ); - }, + logger.debug(`Resolving Twitch prediction "${latestPrediction.title}" with outcome "${winningOutcome.title}"`); + return await twitchApi.predictions.resolvePrediction(latestPrediction.id, winningOutcome.id); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/set-chat-mode.ts b/src/backend/effects/builtin/twitch/set-chat-mode.ts index 9cbd4ab63..694d42d45 100644 --- a/src/backend/effects/builtin/twitch/set-chat-mode.ts +++ b/src/backend/effects/builtin/twitch/set-chat-mode.ts @@ -4,31 +4,31 @@ import { TwitchCommandHelpers } from "../../../chat/twitch-commands/twitch-comma import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - setFollowersOnly: boolean; - enableFollowersOnly?: boolean; - followersOnlyDuration?: string; + setFollowersOnly: boolean; + enableFollowersOnly?: boolean; + followersOnlyDuration?: string; - setSubscribersOnly: boolean; - enableSubscribersOnly?: boolean; + setSubscribersOnly: boolean; + enableSubscribersOnly?: boolean; - setEmoteOnly: boolean; - enableEmoteOnly?: boolean; + setEmoteOnly: boolean; + enableEmoteOnly?: boolean; - setSlowMode: boolean; - enableSlowMode?: boolean; - slowModeDelay?: number; + setSlowMode: boolean; + enableSlowMode?: boolean; + slowModeDelay?: number; }> = { - definition: { - id: "firebot:set-chat-mode", - name: "Set Chat Mode", - description: "Sets the chat mode(s) for your Twitch channel", - icon: "fad fa-comment-check", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "firebot:set-chat-mode", + name: "Set Chat Mode", + description: "Sets the chat mode(s) for your Twitch channel", + icon: "fad fa-comment-check", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: ` - + - + - + `, - optionsValidator: (effect) => { - const errors: string[] = []; - - if ( - effect.setFollowersOnly === true && - effect.enableFollowersOnly == null - ) { - errors.push("You must select a followers-only action"); - } else if ( - effect.setSubscribersOnly === true && - effect.enableSubscribersOnly == null - ) { - errors.push("You must specify a subscribers-only action"); - } else if (effect.setEmoteOnly === true && effect.enableEmoteOnly == null) { - errors.push("You must specify an emote-only action"); - } else if (effect.setSlowMode === true && effect.enableSlowMode == null) { - errors.push("You must specify a slow mode action"); - } - - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - if (effect.setFollowersOnly === true) { - const parsedDuration = TwitchCommandHelpers.getRawDurationInSeconds( - effect.followersOnlyDuration, - "minutes" - ); - - await twitchApi.chat.setFollowerOnlyMode( - effect.enableFollowersOnly ?? false, - Math.floor(parsedDuration / 60) - ); - } - - if (effect.setSubscribersOnly === true) { - await twitchApi.chat.setSubscriberOnlyMode( - effect.enableSubscribersOnly ?? false - ); - } - - if (effect.setEmoteOnly === true) { - await twitchApi.chat.setEmoteOnlyMode(effect.enableEmoteOnly ?? false); - } - - if (effect.setSlowMode === true) { - await twitchApi.chat.setSlowMode( - effect.enableSlowMode ?? false, - effect.slowModeDelay - ); - } - }, + optionsValidator: (effect) => { + const errors: string[] = []; + + if (effect.setFollowersOnly === true && effect.enableFollowersOnly == null) { + errors.push("You must select a followers-only action"); + } else if (effect.setSubscribersOnly === true && effect.enableSubscribersOnly == null) { + errors.push("You must specify a subscribers-only action"); + } else if (effect.setEmoteOnly === true && effect.enableEmoteOnly == null) { + errors.push("You must specify an emote-only action"); + } else if (effect.setSlowMode === true && effect.enableSlowMode == null) { + errors.push("You must specify a slow mode action"); + } + + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + if (effect.setFollowersOnly === true) { + const parsedDuration = TwitchCommandHelpers.getRawDurationInSeconds( + effect.followersOnlyDuration, + "minutes" + ); + + await twitchApi.chat.setFollowerOnlyMode( + effect.enableFollowersOnly ?? false, + Math.floor(parsedDuration / 60) + ); + } + + if (effect.setSubscribersOnly === true) { + await twitchApi.chat.setSubscriberOnlyMode(effect.enableSubscribersOnly ?? false); + } + + if (effect.setEmoteOnly === true) { + await twitchApi.chat.setEmoteOnlyMode(effect.enableEmoteOnly ?? false); + } + + if (effect.setSlowMode === true) { + await twitchApi.chat.setSlowMode(effect.enableSlowMode ?? false, effect.slowModeDelay); + } + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/shoutout.ts b/src/backend/effects/builtin/twitch/shoutout.ts index 412a14060..8c2c1e825 100644 --- a/src/backend/effects/builtin/twitch/shoutout.ts +++ b/src/backend/effects/builtin/twitch/shoutout.ts @@ -4,19 +4,19 @@ import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; const model: EffectType<{ - username: string; + username: string; }> = { - definition: { - id: "firebot:twitch-shoutout", - name: "Twitch Shoutout", - description: "Send a Twitch shoutout to another channel", - icon: "fad fa-bullhorn", - categories: [EffectCategory.COMMON, EffectCategory.TWITCH], - dependencies: { - twitch: true, + definition: { + id: "firebot:twitch-shoutout", + name: "Twitch Shoutout", + description: "Send a Twitch shoutout to another channel", + icon: "fad fa-bullhorn", + categories: [EffectCategory.COMMON, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: ` @@ -27,30 +27,27 @@ const model: EffectType<{ `, - optionsValidator: (effect) => { - const errors: string[] = []; - const username = effect.username?.trim(); + optionsValidator: (effect) => { + const errors: string[] = []; + const username = effect.username?.trim(); - if (!username?.length) { - errors.push("You must specify a channel to shoutout"); - } + if (!username?.length) { + errors.push("You must specify a channel to shoutout"); + } - return errors; - }, - optionsController: () => {}, - onTriggerEvent: async ({ effect }) => { - const targetUserId = (await twitchApi.users.getUserByName(effect.username)) - ?.id; + return errors; + }, + optionsController: () => {}, + onTriggerEvent: async ({ effect }) => { + const targetUserId = (await twitchApi.users.getUserByName(effect.username))?.id; - if (targetUserId == null) { - logger.error( - `Unable to shoutout channel. Twitch user ${effect.username} does not exist.` - ); - return false; - } + if (targetUserId == null) { + logger.error(`Unable to shoutout channel. Twitch user ${effect.username} does not exist.`); + return false; + } - return await twitchApi.chat.sendShoutout(targetUserId); - }, + return await twitchApi.chat.sendShoutout(targetUserId); + }, }; -module.exports = model; \ No newline at end of file +module.exports = model; diff --git a/src/backend/effects/builtin/twitch/stream-game.ts b/src/backend/effects/builtin/twitch/stream-game.ts index 5f2d85729..5dccc09e5 100644 --- a/src/backend/effects/builtin/twitch/stream-game.ts +++ b/src/backend/effects/builtin/twitch/stream-game.ts @@ -1,29 +1,25 @@ -import { EffectType } from '../../../../types/effects'; -import { EffectCategory } from '../../../../shared/effect-constants'; +import { EffectType } from "../../../../types/effects"; +import { EffectCategory } from "../../../../shared/effect-constants"; import logger from "../../../logwrapper"; import twitchApi from "../../../twitch-api/api"; import eventsManager from "../../../events/EventManager"; const model: EffectType<{ - mode: "specific" | "custom"; - gameId: string; - gameName: string; + mode: "specific" | "custom"; + gameId: string; + gameName: string; }> = { - definition: { - id: "firebot:streamgame", - name: "Set Stream Category", - description: "Set the stream category/game.", - icon: "fad fa-gamepad", - categories: [ - EffectCategory.COMMON, - EffectCategory.MODERATION, - EffectCategory.TWITCH, - ], - dependencies: { - twitch: true, + definition: { + id: "firebot:streamgame", + name: "Set Stream Category", + description: "Set the stream category/game.", + icon: "fad fa-gamepad", + categories: [EffectCategory.COMMON, EffectCategory.MODERATION, EffectCategory.TWITCH], + dependencies: { + twitch: true, + }, }, - }, - optionsTemplate: ` + optionsTemplate: `
-
+
@@ -250,7 +250,7 @@ ]; }; - const createEffectMenuOptions = () => { + ctrl.createEffectMenuOptions = (effect) => { ctrl.effectMenuOptions = [ { html: ` Edit Label`, @@ -268,7 +268,7 @@ } }, { - html: ` Toggle Enabled`, + html: ` ${effect.active ? "Disable Effect" : "Enable Effect"}`, click: function ($itemScope) { const $index = $itemScope.$index; ctrl.toggleEffectActiveState($index); @@ -340,10 +340,11 @@ ] } ]; + + return ctrl.effectMenuOptions; }; const rebuildEffectMenus = () => { - createEffectMenuOptions(); createAllEffectsMenuOptions(); }; @@ -524,7 +525,6 @@ ctrl.copyEffectAtIndex = function(index) { objectCopyHelper.copyEffects([ctrl.effectsData.list[index]]); - createEffectMenuOptions(); rebuildEffectMenus(); }; diff --git a/src/gui/app/directives/misc/sysCommandRow.js b/src/gui/app/directives/misc/sysCommandRow.js index 79d875e8c..c7ee31d8a 100644 --- a/src/gui/app/directives/misc/sysCommandRow.js +++ b/src/gui/app/directives/misc/sysCommandRow.js @@ -6,7 +6,7 @@ command: "<" }, template: ` -
+
{{$ctrl.command.name}}
{{$ctrl.command.trigger}}
@@ -65,7 +65,7 @@
- +
@@ -175,21 +175,25 @@ commandsService.saveSystemCommandOverride($ctrl.command); }; - $ctrl.sysCommandMenuOptions = [ - { - html: ` Edit`, - click: function () { - $ctrl.openEditSystemCommandModal(); - } - }, - { - html: ` Toggle Enabled`, - click: function () { - $ctrl.command.active = !$ctrl.command.active; - commandsService.saveSystemCommandOverride($ctrl.command); + $ctrl.sysCommandMenuOptions = () => { + const options = [ + { + html: ` Edit`, + click: function () { + $ctrl.openEditSystemCommandModal(); + } + }, + { + html: ` ${$ctrl.command.active ? "Disable Command" : "Enable Command"}`, + click: function () { + $ctrl.command.active = !$ctrl.command.active; + commandsService.saveSystemCommandOverride($ctrl.command); + } } - } - ]; + ]; + + return options; + }; } }); }()); From 0220155dfbbb0bba4630e02c31727032cf9dc59d Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 18 Dec 2023 14:26:51 -0500 Subject: [PATCH 030/184] feat(overlay): update page title on overlay for instance debug (#2185) --- src/resources/overlay/index.ejs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/resources/overlay/index.ejs b/src/resources/overlay/index.ejs index 834f17b79..39b9bcfaf 100644 --- a/src/resources/overlay/index.ejs +++ b/src/resources/overlay/index.ejs @@ -44,6 +44,13 @@ <% } %> \ No newline at end of file From 91a1c424e3c44e8851150169fc9c3751f0f20915 Mon Sep 17 00:00:00 2001 From: Erik Bigler Date: Sun, 24 Dec 2023 20:27:20 -0600 Subject: [PATCH 084/184] feat(ui): global ui refresh, standardized border radii, new button and input heights, animations, color tweaks, and more --- src/backend/effects/builtin/show-text.js | 4 +- src/gui/app/directives/controls/effectList.js | 4 +- .../directives/misc/replaceVariableMenu.js | 2 - .../modals/effects/add-new-effect-modal.js | 6 +- .../modals/misc/setupWizardModal.js | 5 +- .../modals/roles/addOrEditCustomRoleModal.js | 2 +- .../app/templates/live-events/_events.html | 12 +-- src/gui/scss/core/_bootstrap-overrides.scss | 82 +++++++++++++++---- src/gui/scss/core/_chat.scss | 6 +- src/gui/scss/core/_connection-panel.scss | 12 +-- src/gui/scss/core/_controls.scss | 55 +++++++------ src/gui/scss/core/_effects.scss | 16 ++-- src/gui/scss/core/_global.scss | 53 ++++++------ src/gui/scss/core/_live-events.scss | 6 +- src/gui/scss/core/_title-bar.scss | 2 +- src/gui/scss/core/thirdparty/_animate.scss | 31 ++++++- src/resources/overlay/index.ejs | 1 + 17 files changed, 188 insertions(+), 111 deletions(-) diff --git a/src/backend/effects/builtin/show-text.js b/src/backend/effects/builtin/show-text.js index 338a8edc7..7c266a70d 100644 --- a/src/backend/effects/builtin/show-text.js +++ b/src/backend/effects/builtin/show-text.js @@ -205,8 +205,8 @@ const showText = { ['misc', ['undo', 'redo', 'codeview']] ], fontSizes: ['8', '9', '10', '11', '12', '14', '18', '24', '36', '48', '64', '82', '88', '96', '110', '124', '136', '150', '200', '250', '300'], - fontNames: ['Arial', 'Arial Black', 'Comic Sans MS', 'Courier New', 'Helvetica', 'Impact', 'Tahoma', 'Times New Roman', 'Verdana', 'Open Sans', 'Roboto'], - fontNamesIgnoreCheck: ['Open Sans', 'Roboto'] + fontNames: ['Arial', 'Arial Black', 'Comic Sans MS', 'Courier New', 'Helvetica', 'Impact', 'Tahoma', 'Times New Roman', 'Verdana', 'Inter', 'Open Sans', 'Roboto'], + fontNamesIgnoreCheck: ['Inter', 'Open Sans', 'Roboto'] }; const installedFontNames = fontManager.getInstalledFonts().map(f => f.name); diff --git a/src/gui/app/directives/controls/effectList.js b/src/gui/app/directives/controls/effectList.js index e3ab618e6..51a5396b9 100644 --- a/src/gui/app/directives/controls/effectList.js +++ b/src/gui/app/directives/controls/effectList.js @@ -21,7 +21,7 @@
-

EFFECTS

+

Effects

@@ -173,7 +173,7 @@
- Add New Effect + Add New Effect
diff --git a/src/gui/app/directives/misc/replaceVariableMenu.js b/src/gui/app/directives/misc/replaceVariableMenu.js index bbdf59af6..6496afcbc 100644 --- a/src/gui/app/directives/misc/replaceVariableMenu.js +++ b/src/gui/app/directives/misc/replaceVariableMenu.js @@ -149,11 +149,9 @@
Categories
-
All
-
{{category}}
diff --git a/src/gui/app/directives/modals/effects/add-new-effect-modal.js b/src/gui/app/directives/modals/effects/add-new-effect-modal.js index 5e3ef9a65..5ea19df97 100644 --- a/src/gui/app/directives/modals/effects/add-new-effect-modal.js +++ b/src/gui/app/directives/modals/effects/add-new-effect-modal.js @@ -5,7 +5,7 @@ const { EffectCategory } = require("../../shared/effect-constants"); (function() { angular.module("firebotApp").component("addNewEffectModal", { template: ` -
+

Select New Effect

@@ -17,11 +17,9 @@ const { EffectCategory } = require("../../shared/effect-constants");
Categories
-
All
-
{{category}}
-
+
SELECTED EFFECT:
{{$ctrl.selectedEffectDef ? $ctrl.selectedEffectDef.name : "None"}}
diff --git a/src/gui/app/directives/modals/misc/setupWizardModal.js b/src/gui/app/directives/modals/misc/setupWizardModal.js index a51af3625..b3a961549 100644 --- a/src/gui/app/directives/modals/misc/setupWizardModal.js +++ b/src/gui/app/directives/modals/misc/setupWizardModal.js @@ -251,15 +251,16 @@
diff --git a/src/gui/app/directives/modals/roles/addOrEditCustomRoleModal.js b/src/gui/app/directives/modals/roles/addOrEditCustomRoleModal.js index d5f524cfc..29f4f62e4 100644 --- a/src/gui/app/directives/modals/roles/addOrEditCustomRoleModal.js +++ b/src/gui/app/directives/modals/roles/addOrEditCustomRoleModal.js @@ -30,7 +30,7 @@
-
+
No users with this role. diff --git a/src/gui/app/templates/live-events/_events.html b/src/gui/app/templates/live-events/_events.html index a5f6d0154..b1e6f24f9 100644 --- a/src/gui/app/templates/live-events/_events.html +++ b/src/gui/app/templates/live-events/_events.html @@ -10,10 +10,6 @@ ng-click="es.setSelectedTab('mainevents')" >
-
General Events
-
{{group.name}}
@@ -113,8 +105,8 @@ uib-tooltip="This event set is active" tooltip-append-to-body="true" > -
+ + + diff --git a/src/gui/app/services/utility.service.js b/src/gui/app/services/utility.service.js index 708ddce9b..df63ec0ad 100644 --- a/src/gui/app/services/utility.service.js +++ b/src/gui/app/services/utility.service.js @@ -679,7 +679,7 @@ } }, { - html: ` Copy`, + html: ` Copy`, click: function () { $scope.copy(); } @@ -714,7 +714,7 @@ ] }, { - html: ` Paste`, + html: ` Paste`, enabled: $scope.hasCopiedEffect(), click: function () { $scope.paste(); diff --git a/src/gui/app/templates/live-events/_events.html b/src/gui/app/templates/live-events/_events.html index b1e6f24f9..414b6e7a6 100644 --- a/src/gui/app/templates/live-events/_events.html +++ b/src/gui/app/templates/live-events/_events.html @@ -44,14 +44,14 @@ >
From 978997b3799806d7b2fb70bca3917013d964e49e Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sat, 30 Dec 2023 22:25:52 -0500 Subject: [PATCH 131/184] feat(commands): option to ignore whispers --- src/backend/chat/commands/commandHandler.js | 12 +++++-- .../addOrEditCustomCommandModal.html | 32 ++++++++++++++----- src/types/commands.d.ts | 3 +- 3 files changed, 35 insertions(+), 12 deletions(-) diff --git a/src/backend/chat/commands/commandHandler.js b/src/backend/chat/commands/commandHandler.js index d199427ab..7ea29f47c 100644 --- a/src/backend/chat/commands/commandHandler.js +++ b/src/backend/chat/commands/commandHandler.js @@ -408,15 +408,21 @@ async function handleChatMessage(firebotChatMessage) { const { streamer, bot } = accountAccess.getAccounts(); + // check if chat came from the streamer and if we should ignore it. + if (command.ignoreStreamer && firebotChatMessage.username === streamer.displayName) { + logger.debug("Message came from streamer and this command is set to ignore it"); + return false; + } + // check if chat came from the bot and if we should ignore it. if (command.ignoreBot && firebotChatMessage.username === bot.displayName) { logger.debug("Message came from bot and this command is set to ignore it"); return false; } - // check if chat came from the streamer and if we should ignore it. - if (command.ignoreStreamer && firebotChatMessage.username === streamer.displayName) { - logger.debug("Message came from streamer and this command is set to ignore it"); + // check if chat came via whisper and if we should ignore it. + if (command.ignoreWhispers && firebotChatMessage.whisper) { + logger.debug("Message came from whisper and this command is set to ignore it"); return false; } diff --git a/src/gui/app/directives/modals/commands/addOrEditCustomCommand/addOrEditCustomCommandModal.html b/src/gui/app/directives/modals/commands/addOrEditCustomCommand/addOrEditCustomCommandModal.html index 4ecc805d9..e364cc55c 100644 --- a/src/gui/app/directives/modals/commands/addOrEditCustomCommand/addOrEditCustomCommandModal.html +++ b/src/gui/app/directives/modals/commands/addOrEditCustomCommand/addOrEditCustomCommandModal.html @@ -176,19 +176,24 @@

Settings

+
+
+
+

Ignore

+
+
-
diff --git a/src/types/commands.d.ts b/src/types/commands.d.ts index 26a60a27d..f55b1e20f 100644 --- a/src/types/commands.d.ts +++ b/src/types/commands.d.ts @@ -64,8 +64,9 @@ export type CommandDefinition = { * If the command should be hidden from the `!commands` list. */ hidden?: boolean | undefined; - ignoreBot?: boolean | undefined; ignoreStreamer?: boolean | undefined; + ignoreBot?: boolean | undefined; + ignoreWhisper?: boolean | undefined; /** * If a chat message should be sent when the command is tried to be used but * the cooldown is not yet over. From b166d88af1d91fb3c0b4338d29b773932aee8ffe Mon Sep 17 00:00:00 2001 From: Dennis Rijsdijk Date: Sun, 31 Dec 2023 15:12:56 +0100 Subject: [PATCH 132/184] fix(effects): move clipping variable fields and remove variables from search in OBS source mute (#2313) --- src/backend/effects/builtin/add-quote.js | 4 ++-- src/backend/effects/builtin/delay.js | 2 +- src/backend/effects/builtin/dice.js | 1 + src/backend/effects/builtin/log-message.js | 2 +- src/backend/effects/builtin/twitch/create-poll.ts | 2 +- src/backend/effects/builtin/twitch/create-prediction.ts | 2 +- src/backend/effects/builtin/twitch/create-stream-marker.ts | 2 +- .../builtin/obs/effects/toggle-obs-source-muted.ts | 2 +- 8 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/backend/effects/builtin/add-quote.js b/src/backend/effects/builtin/add-quote.js index 080df83c1..9fa9c6c4b 100644 --- a/src/backend/effects/builtin/add-quote.js +++ b/src/backend/effects/builtin/add-quote.js @@ -15,10 +15,10 @@ const addQuoteEffect = { dependencies: [] }, globalSettings: {}, - optionsTemplate: ` + optionsTemplate: `

This is the name of the person who is creating the quote entry.

- + diff --git a/src/backend/effects/builtin/delay.js b/src/backend/effects/builtin/delay.js index dd259fef2..8d95902b0 100644 --- a/src/backend/effects/builtin/delay.js +++ b/src/backend/effects/builtin/delay.js @@ -16,7 +16,7 @@ const model = {
Seconds - +
`, diff --git a/src/backend/effects/builtin/dice.js b/src/backend/effects/builtin/dice.js index c4a16cef0..463481698 100644 --- a/src/backend/effects/builtin/dice.js +++ b/src/backend/effects/builtin/dice.js @@ -18,6 +18,7 @@ const model = { input-title="Dice" model="effect.dice" placeholder-text="2d20 or 2d10+1d12 or 1d10+3" + menu-position="under" /> diff --git a/src/backend/effects/builtin/log-message.js b/src/backend/effects/builtin/log-message.js index 25dc68f2f..95c353a63 100644 --- a/src/backend/effects/builtin/log-message.js +++ b/src/backend/effects/builtin/log-message.js @@ -16,7 +16,7 @@ const addFirebotLogMessage = { optionsTemplate: `

Enter the message you would like to write to the Firebot log file.

- + diff --git a/src/backend/effects/builtin/twitch/create-poll.ts b/src/backend/effects/builtin/twitch/create-poll.ts index 99ca69007..674529a22 100644 --- a/src/backend/effects/builtin/twitch/create-poll.ts +++ b/src/backend/effects/builtin/twitch/create-poll.ts @@ -22,7 +22,7 @@ const model: EffectType<{ }, optionsTemplate: ` - + diff --git a/src/backend/effects/builtin/twitch/create-prediction.ts b/src/backend/effects/builtin/twitch/create-prediction.ts index 2911bf0eb..45812f38f 100644 --- a/src/backend/effects/builtin/twitch/create-prediction.ts +++ b/src/backend/effects/builtin/twitch/create-prediction.ts @@ -20,7 +20,7 @@ const model: EffectType<{ }, optionsTemplate: ` - + diff --git a/src/backend/effects/builtin/twitch/create-stream-marker.ts b/src/backend/effects/builtin/twitch/create-stream-marker.ts index d89a6570b..73d2546d6 100644 --- a/src/backend/effects/builtin/twitch/create-stream-marker.ts +++ b/src/backend/effects/builtin/twitch/create-stream-marker.ts @@ -17,7 +17,7 @@ const model: EffectType<{ }, optionsTemplate: ` - + diff --git a/src/backend/integrations/builtin/obs/effects/toggle-obs-source-muted.ts b/src/backend/integrations/builtin/obs/effects/toggle-obs-source-muted.ts index 3b28d08b5..3da2998d2 100644 --- a/src/backend/integrations/builtin/obs/effects/toggle-obs-source-muted.ts +++ b/src/backend/integrations/builtin/obs/effects/toggle-obs-source-muted.ts @@ -26,7 +26,7 @@ export const ToggleSourceMutedEffectType: EffectType = }, optionsTemplate: ` - +
From f79b79fbc84f01b1a2f5ead63e58da64444381dd Mon Sep 17 00:00:00 2001 From: Perry Date: Sun, 31 Dec 2023 15:19:32 +0100 Subject: [PATCH 133/184] Fix: Webhooks (#2314) Changed the RegEx to allow for Canary/PTB Discord and Guilded WebHooks --- .../modals/integrations/addOrEditDiscordWebhookModal.js | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js b/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js index 84ecd52bb..d681b5d21 100644 --- a/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js +++ b/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js @@ -88,9 +88,12 @@ } function validateWebhookUrl() { - const webhookRegex = /^https:\/\/discord(?:app)?\.com\/api\/webhooks\/[^/\s]+\/[^/\s]+$/i; + // const webhookRegex = /^https:\/\/discord(?:app)?\.com\/api\/webhooks\/[^/\s]+\/[^/\s]+$/i; // Old Discord Regex + const discordWebhookRegex = /^https:\/\/(?:ptb\.|canary\.)?discord(?:app)?\.com\/api\/webhooks\/[^/\s]+\/[^/\s]+$/i; + const guildedWebhookRegex = /^https:\/\/media\.guilded?\.gg\/webhooks\/[^/\s]+\/[^/\s]+$/i; const webhookUrl = $ctrl.channel.webhookUrl; - return webhookUrl != null && webhookUrl.length > 0 && webhookRegex.test(webhookUrl); + // return webhookUrl != null && webhookUrl.length > 0 && webhookRegex.test(webhookUrl); // Old Return + return webhookUrl != null && webhookUrl.length > 0 && (discordWebhookRegex.test(webhookUrl) || guildedWebhookRegex.test(webhookUrl)); } $ctrl.save = function() { From afa3012cc8af26f38d082b70ac18f0f6ec22c18d Mon Sep 17 00:00:00 2001 From: Perry Date: Sun, 31 Dec 2023 15:24:11 +0100 Subject: [PATCH 134/184] Removed commented out lines --- .../modals/integrations/addOrEditDiscordWebhookModal.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js b/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js index d681b5d21..350218c37 100644 --- a/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js +++ b/src/gui/app/directives/modals/integrations/addOrEditDiscordWebhookModal.js @@ -88,11 +88,9 @@ } function validateWebhookUrl() { - // const webhookRegex = /^https:\/\/discord(?:app)?\.com\/api\/webhooks\/[^/\s]+\/[^/\s]+$/i; // Old Discord Regex const discordWebhookRegex = /^https:\/\/(?:ptb\.|canary\.)?discord(?:app)?\.com\/api\/webhooks\/[^/\s]+\/[^/\s]+$/i; const guildedWebhookRegex = /^https:\/\/media\.guilded?\.gg\/webhooks\/[^/\s]+\/[^/\s]+$/i; const webhookUrl = $ctrl.channel.webhookUrl; - // return webhookUrl != null && webhookUrl.length > 0 && webhookRegex.test(webhookUrl); // Old Return return webhookUrl != null && webhookUrl.length > 0 && (discordWebhookRegex.test(webhookUrl) || guildedWebhookRegex.test(webhookUrl)); } From 5921d1c4e5828778fd4a0c6dffceb82e545b1bb8 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 12:04:50 -0500 Subject: [PATCH 135/184] feat(obs): add OBS Current Program Scene Changed event (#2209) --- src/backend/integrations/builtin/obs/constants.ts | 1 + .../builtin/obs/events/obs-event-source.ts | 9 +++++++++ src/backend/integrations/builtin/obs/obs-remote.ts | 11 +++++++++++ 3 files changed, 21 insertions(+) diff --git a/src/backend/integrations/builtin/obs/constants.ts b/src/backend/integrations/builtin/obs/constants.ts index 3892e7856..c385a0ec4 100644 --- a/src/backend/integrations/builtin/obs/constants.ts +++ b/src/backend/integrations/builtin/obs/constants.ts @@ -7,6 +7,7 @@ export const OBS_RECORDING_STOPPED_EVENT_ID = "recording-stopped"; export const OBS_SCENE_ITEM_ENABLE_STATE_CHANGED_EVENT_ID = "scene-item-enable-state-changed"; export const OBS_SCENE_TRANSITION_STARTED_EVENT_ID = "scene-transition-started"; export const OBS_SCENE_TRANSITION_ENDED_EVENT_ID = "scene-transition-ended"; +export const OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID = "current-program-scene-changed"; export const OBS_CURRENT_SCENE_TRANSITION_CHANGED_EVENT_ID = "current-scene-transition-changed"; export const OBS_CURRENT_SCENE_TRANSITION_DURATION_CHANGED_EVENT_ID = "current-scene-transition-duration-changed"; export const OBS_REPLAY_BUFFER_SAVED_EVENT_ID = "replay-buffer-saved"; diff --git a/src/backend/integrations/builtin/obs/events/obs-event-source.ts b/src/backend/integrations/builtin/obs/events/obs-event-source.ts index e31184dab..ef40de455 100644 --- a/src/backend/integrations/builtin/obs/events/obs-event-source.ts +++ b/src/backend/integrations/builtin/obs/events/obs-event-source.ts @@ -1,6 +1,7 @@ import { EventSource } from "../../../../../types/events"; import { OBS_CURRENT_PROFILE_CHANGED_EVENT_ID, + OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_DURATION_CHANGED_EVENT_ID, OBS_EVENT_SOURCE_ID, @@ -74,6 +75,14 @@ export const OBSEventSource: EventSource = { transitionName: "Test Transition" } }, + { + id: OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID, + name: "OBS Current Program Scene Changed", + description: "When the current program scene has changed in OBS", + manualMetadata: { + sceneName: "New Scene" + } + }, { id: OBS_CURRENT_SCENE_TRANSITION_CHANGED_EVENT_ID, name: "OBS Current Scene Transition Changed", diff --git a/src/backend/integrations/builtin/obs/obs-remote.ts b/src/backend/integrations/builtin/obs/obs-remote.ts index e0c7e0481..32c4e591c 100644 --- a/src/backend/integrations/builtin/obs/obs-remote.ts +++ b/src/backend/integrations/builtin/obs/obs-remote.ts @@ -2,6 +2,7 @@ import { ScriptModules } from "@crowbartools/firebot-custom-scripts-types"; import OBSWebSocket from "obs-websocket-js"; import { OBS_CURRENT_PROFILE_CHANGED_EVENT_ID, + OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_DURATION_CHANGED_EVENT_ID, OBS_EVENT_SOURCE_ID, @@ -107,6 +108,16 @@ function setupRemoteListeners() { ); }); + obs.on("CurrentProgramSceneChanged", ({ sceneName }) => { + eventManager?.triggerEvent( + OBS_EVENT_SOURCE_ID, + OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID, + { + sceneName + } + ); + }); + obs.on("CurrentSceneTransitionChanged", ({ transitionName }) => { eventManager?.triggerEvent( OBS_EVENT_SOURCE_ID, From b6bd0fda56f3565ff51ee5f3ad31f0d4905c216c Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 12:17:21 -0500 Subject: [PATCH 136/184] feat(obs): add OBS Current Scene Collection Changed event (#2209) --- src/backend/integrations/builtin/obs/constants.ts | 1 + .../builtin/obs/events/obs-event-source.ts | 9 +++++++++ .../integrations/builtin/obs/obs-integration.ts | 2 +- src/backend/integrations/builtin/obs/obs-remote.ts | 11 +++++++++++ ...tion-name-variable.ts => scene-collection-name.ts} | 4 ++-- 5 files changed, 24 insertions(+), 3 deletions(-) rename src/backend/integrations/builtin/obs/variables/{scene-collection-name-variable.ts => scene-collection-name.ts} (56%) diff --git a/src/backend/integrations/builtin/obs/constants.ts b/src/backend/integrations/builtin/obs/constants.ts index c385a0ec4..44496ecd1 100644 --- a/src/backend/integrations/builtin/obs/constants.ts +++ b/src/backend/integrations/builtin/obs/constants.ts @@ -11,5 +11,6 @@ export const OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID = "current-program-scene export const OBS_CURRENT_SCENE_TRANSITION_CHANGED_EVENT_ID = "current-scene-transition-changed"; export const OBS_CURRENT_SCENE_TRANSITION_DURATION_CHANGED_EVENT_ID = "current-scene-transition-duration-changed"; export const OBS_REPLAY_BUFFER_SAVED_EVENT_ID = "replay-buffer-saved"; +export const OBS_CURRENT_SCENE_COLLECTION_CHANGED_EVENT_ID = "current-scene-collection-changed"; export const OBS_CURRENT_PROFILE_CHANGED_EVENT_ID = "current-profile-changed"; export const OBS_VENDOR_EVENT_EVENT_ID = "vendor-event"; diff --git a/src/backend/integrations/builtin/obs/events/obs-event-source.ts b/src/backend/integrations/builtin/obs/events/obs-event-source.ts index ef40de455..b8ec2654d 100644 --- a/src/backend/integrations/builtin/obs/events/obs-event-source.ts +++ b/src/backend/integrations/builtin/obs/events/obs-event-source.ts @@ -2,6 +2,7 @@ import { EventSource } from "../../../../../types/events"; import { OBS_CURRENT_PROFILE_CHANGED_EVENT_ID, OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID, + OBS_CURRENT_SCENE_COLLECTION_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_DURATION_CHANGED_EVENT_ID, OBS_EVENT_SOURCE_ID, @@ -105,6 +106,14 @@ export const OBSEventSource: EventSource = { description: "When OBS saves the replay buffer", manualMetadata: {} }, + { + id: OBS_CURRENT_SCENE_COLLECTION_CHANGED_EVENT_ID, + name: "OBS Current Scene Collection Changed", + description: "When the current scene collection is changed in OBS", + manualMetadata: { + sceneCollectionName: "New Scene Collection" + } + }, { id: OBS_CURRENT_PROFILE_CHANGED_EVENT_ID, name: "OBS Current Profile Changed", diff --git a/src/backend/integrations/builtin/obs/obs-integration.ts b/src/backend/integrations/builtin/obs/obs-integration.ts index e10122911..48e976480 100644 --- a/src/backend/integrations/builtin/obs/obs-integration.ts +++ b/src/backend/integrations/builtin/obs/obs-integration.ts @@ -29,7 +29,7 @@ import { TakeOBSSourceScreenshotEffectType } from "./effects/take-obs-source-scr import { OBSEventSource } from "./events/obs-event-source"; import { SceneNameEventFilter } from "./filters/scene-name-filter"; import { SceneNameVariable } from "./variables/scene-name-variable"; -import { SceneCollectionNameVariable } from "./variables/scene-collection-name-variable"; +import { SceneCollectionNameVariable } from "./variables/scene-collection-name"; import { IsStreamingVariable } from "./variables/is-streaming"; import { IsRecordingVariable } from "./variables/is-recording"; import { ColorValueVariable } from "./variables/obs-color-value"; diff --git a/src/backend/integrations/builtin/obs/obs-remote.ts b/src/backend/integrations/builtin/obs/obs-remote.ts index 32c4e591c..0474bf127 100644 --- a/src/backend/integrations/builtin/obs/obs-remote.ts +++ b/src/backend/integrations/builtin/obs/obs-remote.ts @@ -3,6 +3,7 @@ import OBSWebSocket from "obs-websocket-js"; import { OBS_CURRENT_PROFILE_CHANGED_EVENT_ID, OBS_CURRENT_PROGRAM_SCENE_CHANGED_EVENT_ID, + OBS_CURRENT_SCENE_COLLECTION_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_CHANGED_EVENT_ID, OBS_CURRENT_SCENE_TRANSITION_DURATION_CHANGED_EVENT_ID, OBS_EVENT_SOURCE_ID, @@ -148,6 +149,16 @@ function setupRemoteListeners() { ); }); + obs.on("CurrentSceneCollectionChanged", ({ sceneCollectionName }) => { + eventManager?.triggerEvent( + OBS_EVENT_SOURCE_ID, + OBS_CURRENT_SCENE_COLLECTION_CHANGED_EVENT_ID, + { + sceneCollectionName + } + ); + }); + obs.on("CurrentProfileChanged", ({ profileName }) => { eventManager?.triggerEvent( OBS_EVENT_SOURCE_ID, diff --git a/src/backend/integrations/builtin/obs/variables/scene-collection-name-variable.ts b/src/backend/integrations/builtin/obs/variables/scene-collection-name.ts similarity index 56% rename from src/backend/integrations/builtin/obs/variables/scene-collection-name-variable.ts rename to src/backend/integrations/builtin/obs/variables/scene-collection-name.ts index 581c0b1af..8e6b1de29 100644 --- a/src/backend/integrations/builtin/obs/variables/scene-collection-name-variable.ts +++ b/src/backend/integrations/builtin/obs/variables/scene-collection-name.ts @@ -5,11 +5,11 @@ export const SceneCollectionNameVariable: ReplaceVariable = { definition: { handle: "obsSceneCollectionName", description: - "The name of the current OBS Scene Collection. If OBS isn't running, it returns 'Unknown'.", + "The name of the OBS scene collection that triggered the event, or the name of the current OBS scene collection if there is no event. If OBS isn't running, it returns 'Unknown'.", possibleDataOutput: ["text"] }, evaluator: async () => { - const currentSceneCollectionName = await getCurrentSceneCollectionName(); + const currentSceneCollectionName = trigger.metadata?.eventData?.sceneCollectionName ?? await getCurrentSceneCollectionName(); return currentSceneCollectionName ?? "Unknown"; } }; From 4539e519dc759a846028b0e642af837f39a0a59b Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 12:23:48 -0500 Subject: [PATCH 137/184] fix(obs): trigger param didn't save the first time --- .../integrations/builtin/obs/variables/scene-collection-name.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/backend/integrations/builtin/obs/variables/scene-collection-name.ts b/src/backend/integrations/builtin/obs/variables/scene-collection-name.ts index 8e6b1de29..0d740f2ed 100644 --- a/src/backend/integrations/builtin/obs/variables/scene-collection-name.ts +++ b/src/backend/integrations/builtin/obs/variables/scene-collection-name.ts @@ -8,7 +8,7 @@ export const SceneCollectionNameVariable: ReplaceVariable = { "The name of the OBS scene collection that triggered the event, or the name of the current OBS scene collection if there is no event. If OBS isn't running, it returns 'Unknown'.", possibleDataOutput: ["text"] }, - evaluator: async () => { + evaluator: async (trigger) => { const currentSceneCollectionName = trigger.metadata?.eventData?.sceneCollectionName ?? await getCurrentSceneCollectionName(); return currentSceneCollectionName ?? "Unknown"; } From e7fd2f969aa8e8bdf45b1f541aa2cdad516b86c4 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 13:35:40 -0500 Subject: [PATCH 138/184] fix(ui): move menu icons to gui folder --- .../electron/window-management.js | 52 +++++++++--------- .../images/icons/discord.png | Bin .../images/icons/mdi/LICENSE | 0 .../icons/mdi/account-heart-outline.png | Bin .../images/icons/mdi/auto-fix.png | Bin .../images/icons/mdi/backup-restore.png | Bin .../images/icons/mdi/bug-outline.png | Bin .../images/icons/mdi/content-copy.png | Bin .../images/icons/mdi/content-cut.png | Bin .../images/icons/mdi/content-paste.png | Bin .../images/icons/mdi/exit-run.png | Bin .../icons/mdi/folder-account-outline.png | Bin .../icons/mdi/folder-refresh-outline.png | Bin .../images/icons/mdi/folder-text-outline.png | Bin .../images/icons/mdi/forum-outline.png | Bin .../images/icons/mdi/hand-heart-outline.png | Bin .../images/icons/mdi/import.png | Bin .../images/icons/mdi/information-outline.png | Bin .../images/icons/mdi/redo.png | Bin .../images/icons/mdi/select-all.png | Bin .../images/icons/mdi/shopping-outline.png | Bin .../images/icons/mdi/source-branch.png | Bin .../images/icons/mdi/star-circle-outline.png | Bin .../images/icons/mdi/text-search.png | Bin .../images/icons/mdi/tools.png | Bin .../images/icons/mdi/twitter.png | Bin .../images/icons/mdi/undo.png | Bin .../images/icons/mdi/window-close.png | Bin .../images/icons/mdi/window-minimize.png | Bin 29 files changed, 26 insertions(+), 26 deletions(-) rename src/{resources => gui}/images/icons/discord.png (100%) rename src/{resources => gui}/images/icons/mdi/LICENSE (100%) rename src/{resources => gui}/images/icons/mdi/account-heart-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/auto-fix.png (100%) rename src/{resources => gui}/images/icons/mdi/backup-restore.png (100%) rename src/{resources => gui}/images/icons/mdi/bug-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/content-copy.png (100%) rename src/{resources => gui}/images/icons/mdi/content-cut.png (100%) rename src/{resources => gui}/images/icons/mdi/content-paste.png (100%) rename src/{resources => gui}/images/icons/mdi/exit-run.png (100%) rename src/{resources => gui}/images/icons/mdi/folder-account-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/folder-refresh-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/folder-text-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/forum-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/hand-heart-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/import.png (100%) rename src/{resources => gui}/images/icons/mdi/information-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/redo.png (100%) rename src/{resources => gui}/images/icons/mdi/select-all.png (100%) rename src/{resources => gui}/images/icons/mdi/shopping-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/source-branch.png (100%) rename src/{resources => gui}/images/icons/mdi/star-circle-outline.png (100%) rename src/{resources => gui}/images/icons/mdi/text-search.png (100%) rename src/{resources => gui}/images/icons/mdi/tools.png (100%) rename src/{resources => gui}/images/icons/mdi/twitter.png (100%) rename src/{resources => gui}/images/icons/mdi/undo.png (100%) rename src/{resources => gui}/images/icons/mdi/window-close.png (100%) rename src/{resources => gui}/images/icons/mdi/window-minimize.png (100%) diff --git a/src/backend/app-management/electron/window-management.js b/src/backend/app-management/electron/window-management.js index 4c092b4d9..8f909bc8c 100644 --- a/src/backend/app-management/electron/window-management.js +++ b/src/backend/app-management/electron/window-management.js @@ -179,7 +179,7 @@ function createMainWindow() { component: "importSetupModal" }); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/import.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/import.png") }, { type: 'separator' @@ -193,7 +193,7 @@ function createMainWindow() { ); shell.openPath(rootFolder); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/folder-account-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/folder-account-outline.png") }, { label: 'Open Logs Folder', @@ -204,7 +204,7 @@ function createMainWindow() { ); shell.openPath(rootFolder); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/folder-text-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/folder-text-outline.png") }, { label: 'Open Backups Folder', @@ -215,14 +215,14 @@ function createMainWindow() { ); shell.openPath(backupFolder); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/folder-refresh-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/folder-refresh-outline.png") }, { type: 'separator' }, { role: 'quit', - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/exit-run.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/exit-run.png") } ] }, @@ -231,27 +231,27 @@ function createMainWindow() { submenu: [ { role: 'cut', - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/content-cut.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/content-cut.png") }, { role: 'copy', - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/content-copy.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/content-copy.png") }, { role: 'paste', - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/content-paste.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/content-paste.png") }, { role: "undo", - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/undo.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/undo.png") }, { role: "redo", - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/redo.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/redo.png") }, { role: "selectAll", - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/select-all.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/select-all.png") } ] }, @@ -260,11 +260,11 @@ function createMainWindow() { submenu: [ { role: 'minimize', - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/window-minimize.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/window-minimize.png") }, { role: 'close', - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/window-close.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/window-close.png") } ] }, @@ -279,7 +279,7 @@ function createMainWindow() { component: "setupWizardModal" }); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/auto-fix.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/auto-fix.png") }, { label: 'Restore from backup...', @@ -287,7 +287,7 @@ function createMainWindow() { click: async () => { frontendCommunicator.send("restore-backup"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/backup-restore.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/backup-restore.png") }, { label: 'Custom Variable Inspector', @@ -296,14 +296,14 @@ function createMainWindow() { // eslint-disable-next-line no-use-before-define createVariableInspectorWindow(); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/text-search.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/text-search.png") }, { type: 'separator' }, { role: 'toggledevtools', - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/tools.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/tools.png") } ] }, @@ -315,14 +315,14 @@ function createMainWindow() { click: () => { shell.openExternal("https://discord.gg/tTmMbrG"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/discord.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/discord.png") }, { label: 'Follow @FirebotApp on Twitter', click: () => { shell.openExternal("https://twitter.com/FirebotApp"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/twitter.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/twitter.png") }, { type: 'separator' @@ -332,21 +332,21 @@ function createMainWindow() { click: () => { shell.openExternal("https://github.com/crowbartools/Firebot"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/source-branch.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/source-branch.png") }, { label: 'Report a Bug', click: () => { shell.openExternal("https://github.com/crowbartools/Firebot/issues/new?assignees=&labels=Bug&template=bug_report.yml&title=%5BBug%5D+"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/bug-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/bug-outline.png") }, { label: 'Request a Feature', click: () => { shell.openExternal("https://github.com/crowbartools/Firebot/issues/new?assignees=&labels=Enhancement&template=feature_request.md&title=%5BFeature+Request%5D+"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/star-circle-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/star-circle-outline.png") }, { type: 'separator' @@ -356,21 +356,21 @@ function createMainWindow() { click: () => { shell.openExternal("https://crowbar-tools.myspreadshop.com"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/shopping-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/shopping-outline.png") }, { label: 'Donate', click: () => { shell.openExternal("https://opencollective.com/crowbartools"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/hand-heart-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/hand-heart-outline.png") }, { label: 'Submit a Testimonial', click: () => { shell.openExternal("https://firebot.app/testimonial-submission"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/account-heart-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/account-heart-outline.png") }, { type: 'separator' @@ -380,7 +380,7 @@ function createMainWindow() { click: () => { frontendCommunicator.send("open-about-modal"); }, - icon: path.resolve(__dirname, "../../../resources/images/icons/mdi/information-outline.png") + icon: path.resolve(__dirname, "../../../gui/images/icons/mdi/information-outline.png") } ] } diff --git a/src/resources/images/icons/discord.png b/src/gui/images/icons/discord.png similarity index 100% rename from src/resources/images/icons/discord.png rename to src/gui/images/icons/discord.png diff --git a/src/resources/images/icons/mdi/LICENSE b/src/gui/images/icons/mdi/LICENSE similarity index 100% rename from src/resources/images/icons/mdi/LICENSE rename to src/gui/images/icons/mdi/LICENSE diff --git a/src/resources/images/icons/mdi/account-heart-outline.png b/src/gui/images/icons/mdi/account-heart-outline.png similarity index 100% rename from src/resources/images/icons/mdi/account-heart-outline.png rename to src/gui/images/icons/mdi/account-heart-outline.png diff --git a/src/resources/images/icons/mdi/auto-fix.png b/src/gui/images/icons/mdi/auto-fix.png similarity index 100% rename from src/resources/images/icons/mdi/auto-fix.png rename to src/gui/images/icons/mdi/auto-fix.png diff --git a/src/resources/images/icons/mdi/backup-restore.png b/src/gui/images/icons/mdi/backup-restore.png similarity index 100% rename from src/resources/images/icons/mdi/backup-restore.png rename to src/gui/images/icons/mdi/backup-restore.png diff --git a/src/resources/images/icons/mdi/bug-outline.png b/src/gui/images/icons/mdi/bug-outline.png similarity index 100% rename from src/resources/images/icons/mdi/bug-outline.png rename to src/gui/images/icons/mdi/bug-outline.png diff --git a/src/resources/images/icons/mdi/content-copy.png b/src/gui/images/icons/mdi/content-copy.png similarity index 100% rename from src/resources/images/icons/mdi/content-copy.png rename to src/gui/images/icons/mdi/content-copy.png diff --git a/src/resources/images/icons/mdi/content-cut.png b/src/gui/images/icons/mdi/content-cut.png similarity index 100% rename from src/resources/images/icons/mdi/content-cut.png rename to src/gui/images/icons/mdi/content-cut.png diff --git a/src/resources/images/icons/mdi/content-paste.png b/src/gui/images/icons/mdi/content-paste.png similarity index 100% rename from src/resources/images/icons/mdi/content-paste.png rename to src/gui/images/icons/mdi/content-paste.png diff --git a/src/resources/images/icons/mdi/exit-run.png b/src/gui/images/icons/mdi/exit-run.png similarity index 100% rename from src/resources/images/icons/mdi/exit-run.png rename to src/gui/images/icons/mdi/exit-run.png diff --git a/src/resources/images/icons/mdi/folder-account-outline.png b/src/gui/images/icons/mdi/folder-account-outline.png similarity index 100% rename from src/resources/images/icons/mdi/folder-account-outline.png rename to src/gui/images/icons/mdi/folder-account-outline.png diff --git a/src/resources/images/icons/mdi/folder-refresh-outline.png b/src/gui/images/icons/mdi/folder-refresh-outline.png similarity index 100% rename from src/resources/images/icons/mdi/folder-refresh-outline.png rename to src/gui/images/icons/mdi/folder-refresh-outline.png diff --git a/src/resources/images/icons/mdi/folder-text-outline.png b/src/gui/images/icons/mdi/folder-text-outline.png similarity index 100% rename from src/resources/images/icons/mdi/folder-text-outline.png rename to src/gui/images/icons/mdi/folder-text-outline.png diff --git a/src/resources/images/icons/mdi/forum-outline.png b/src/gui/images/icons/mdi/forum-outline.png similarity index 100% rename from src/resources/images/icons/mdi/forum-outline.png rename to src/gui/images/icons/mdi/forum-outline.png diff --git a/src/resources/images/icons/mdi/hand-heart-outline.png b/src/gui/images/icons/mdi/hand-heart-outline.png similarity index 100% rename from src/resources/images/icons/mdi/hand-heart-outline.png rename to src/gui/images/icons/mdi/hand-heart-outline.png diff --git a/src/resources/images/icons/mdi/import.png b/src/gui/images/icons/mdi/import.png similarity index 100% rename from src/resources/images/icons/mdi/import.png rename to src/gui/images/icons/mdi/import.png diff --git a/src/resources/images/icons/mdi/information-outline.png b/src/gui/images/icons/mdi/information-outline.png similarity index 100% rename from src/resources/images/icons/mdi/information-outline.png rename to src/gui/images/icons/mdi/information-outline.png diff --git a/src/resources/images/icons/mdi/redo.png b/src/gui/images/icons/mdi/redo.png similarity index 100% rename from src/resources/images/icons/mdi/redo.png rename to src/gui/images/icons/mdi/redo.png diff --git a/src/resources/images/icons/mdi/select-all.png b/src/gui/images/icons/mdi/select-all.png similarity index 100% rename from src/resources/images/icons/mdi/select-all.png rename to src/gui/images/icons/mdi/select-all.png diff --git a/src/resources/images/icons/mdi/shopping-outline.png b/src/gui/images/icons/mdi/shopping-outline.png similarity index 100% rename from src/resources/images/icons/mdi/shopping-outline.png rename to src/gui/images/icons/mdi/shopping-outline.png diff --git a/src/resources/images/icons/mdi/source-branch.png b/src/gui/images/icons/mdi/source-branch.png similarity index 100% rename from src/resources/images/icons/mdi/source-branch.png rename to src/gui/images/icons/mdi/source-branch.png diff --git a/src/resources/images/icons/mdi/star-circle-outline.png b/src/gui/images/icons/mdi/star-circle-outline.png similarity index 100% rename from src/resources/images/icons/mdi/star-circle-outline.png rename to src/gui/images/icons/mdi/star-circle-outline.png diff --git a/src/resources/images/icons/mdi/text-search.png b/src/gui/images/icons/mdi/text-search.png similarity index 100% rename from src/resources/images/icons/mdi/text-search.png rename to src/gui/images/icons/mdi/text-search.png diff --git a/src/resources/images/icons/mdi/tools.png b/src/gui/images/icons/mdi/tools.png similarity index 100% rename from src/resources/images/icons/mdi/tools.png rename to src/gui/images/icons/mdi/tools.png diff --git a/src/resources/images/icons/mdi/twitter.png b/src/gui/images/icons/mdi/twitter.png similarity index 100% rename from src/resources/images/icons/mdi/twitter.png rename to src/gui/images/icons/mdi/twitter.png diff --git a/src/resources/images/icons/mdi/undo.png b/src/gui/images/icons/mdi/undo.png similarity index 100% rename from src/resources/images/icons/mdi/undo.png rename to src/gui/images/icons/mdi/undo.png diff --git a/src/resources/images/icons/mdi/window-close.png b/src/gui/images/icons/mdi/window-close.png similarity index 100% rename from src/resources/images/icons/mdi/window-close.png rename to src/gui/images/icons/mdi/window-close.png diff --git a/src/resources/images/icons/mdi/window-minimize.png b/src/gui/images/icons/mdi/window-minimize.png similarity index 100% rename from src/resources/images/icons/mdi/window-minimize.png rename to src/gui/images/icons/mdi/window-minimize.png From 9a7059845087c202552d262c6d31177794ccdde3 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 13:59:06 -0500 Subject: [PATCH 139/184] fix(effects): move some poll/prediction validation to effect run, after var eval --- .../effects/builtin/twitch/create-poll.ts | 16 ++++++++++++++-- .../effects/builtin/twitch/create-prediction.ts | 16 ++++++++++++++-- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/src/backend/effects/builtin/twitch/create-poll.ts b/src/backend/effects/builtin/twitch/create-poll.ts index 674529a22..3726a673a 100644 --- a/src/backend/effects/builtin/twitch/create-poll.ts +++ b/src/backend/effects/builtin/twitch/create-poll.ts @@ -47,8 +47,8 @@ const model: EffectType<{ optionsValidator: (effect) => { const errors: string[] = []; - if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 25)) { - errors.push("You must enter a title no more than 25 characters long"); + if (!effect.title?.length || effect.title.length === 0) { + errors.push("You must enter a title"); } if (!(effect.duration >= 15 && effect.duration <= 1800)) { @@ -77,6 +77,18 @@ const model: EffectType<{ }; }, onTriggerEvent: async ({ effect }) => { + if (!effect.title.length || effect.title.length < 1 || effect.title.length > 60) { + logger.error(`Unable to create poll. Poll title "${effect.title}" must be between 1 and 60 characters.`); + return false; + } + + effect.choices.forEach(c => { + if (!c.length || c.length < 1 || c.length > 25) { + logger.error(`Unable to create poll. Poll choice "${c}" must be between 1 and 25 characters.`); + return false; + } + }); + logger.debug(`Creating Twitch poll "${effect.title}"`); return await twitchApi.polls.createPoll( effect.title, diff --git a/src/backend/effects/builtin/twitch/create-prediction.ts b/src/backend/effects/builtin/twitch/create-prediction.ts index 45812f38f..c2f3bdd6a 100644 --- a/src/backend/effects/builtin/twitch/create-prediction.ts +++ b/src/backend/effects/builtin/twitch/create-prediction.ts @@ -40,8 +40,8 @@ const model: EffectType<{ optionsValidator: (effect) => { const errors: string[] = []; - if (!effect.title?.length || !(effect.title.length > 0 && effect.title.length <= 45)) { - errors.push("You must enter a title no more than 45 characters long"); + if (!effect.title?.length || effect.title.length === 0) { + errors.push("You must enter a title"); } if (!(effect.duration >= 30 && effect.duration <= 1800)) { @@ -63,6 +63,18 @@ const model: EffectType<{ }; }, onTriggerEvent: async ({ effect }) => { + if (!effect.title.length || effect.title.length < 1 || effect.title.length > 45) { + logger.error(`Unable to create prediction. Prediction title "${effect.title}" must be between 1 and 45 characters.`); + return false; + } + + effect.outcomes.forEach(o => { + if (!o.length || o.length < 1 || o.length > 25) { + logger.error(`Unable to create prediction. Prediction outcome "${o}" must be between 1 and 25 characters.`); + return false; + } + }); + logger.debug(`Creating Twitch prediction "${effect.title}"`); return await twitchApi.predictions.createPrediction(effect.title, effect.outcomes, effect.duration); } From 5d6130b3783a15c4da9cf179ef5b8fd20a847c3c Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 15:25:56 -0500 Subject: [PATCH 140/184] fix(moderation): adding new banned regex no longer breaks UI (#2146) --- src/gui/app/services/chat-moderation.service.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/gui/app/services/chat-moderation.service.js b/src/gui/app/services/chat-moderation.service.js index 628315e4f..dc65118f3 100644 --- a/src/gui/app/services/chat-moderation.service.js +++ b/src/gui/app/services/chat-moderation.service.js @@ -108,7 +108,7 @@ createdAt: moment().valueOf() }; - service.chatModerationData.bannedRegularExpressions = service.chatModerationData.bannedRegularExpressions.push(mapped); + service.chatModerationData.bannedRegularExpressions.push(mapped); backendCommunicator.fireEvent("addBannedRegularExpression", mapped); }; From fecb7c5ae9fd7abdd04d2cd33222e18b3743425b Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 16:11:42 -0500 Subject: [PATCH 141/184] feat(events): add Overlay Connected event, overlayInstance var (#1957) --- .../events/builtin/firebot-event-source.js | 15 +++++++++++++ .../variables/builtin-variable-loader.js | 1 + .../variables/builtin/overlay-instance.ts | 22 +++++++++++++++++++ src/resources/overlay/js/main.js | 6 +++++ src/server/http-server-manager.js | 10 ++++++++- 5 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 src/backend/variables/builtin/overlay-instance.ts diff --git a/src/backend/events/builtin/firebot-event-source.js b/src/backend/events/builtin/firebot-event-source.js index 7bff7b715..9d00c77f1 100644 --- a/src/backend/events/builtin/firebot-event-source.js +++ b/src/backend/events/builtin/firebot-event-source.js @@ -20,6 +20,21 @@ const firebotEventSource = { } } }, + { + id: "overlay-connected", + name: "Overlay Connected", + description: "When a Firebot overlay is connected.", + cached: false, + manualMetadata: { + instanceName: "Default" + }, + activityFeed: { + icon: "fad fa-tv-alt", + getMessage: (eventData) => { + return `**${eventData.instanceName}** overlay connected`; + } + } + }, { id: "view-time-update", name: "View Time Update", diff --git a/src/backend/variables/builtin-variable-loader.js b/src/backend/variables/builtin-variable-loader.js index 43655e4f9..87c018a80 100644 --- a/src/backend/variables/builtin-variable-loader.js +++ b/src/backend/variables/builtin-variable-loader.js @@ -129,6 +129,7 @@ exports.loadReplaceVariables = () => { 'object-walk-path-raw', 'object-walk-path', 'ordinal-indicator', + 'overlay-instance', 'poll-winning-choice-name', 'prediction-winning-outcome-name', 'preset-list-arg', diff --git a/src/backend/variables/builtin/overlay-instance.ts b/src/backend/variables/builtin/overlay-instance.ts new file mode 100644 index 000000000..408cc0807 --- /dev/null +++ b/src/backend/variables/builtin/overlay-instance.ts @@ -0,0 +1,22 @@ +import { ReplaceVariable } from "../../../types/variables"; +import { EffectTrigger } from "../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../shared/variable-constants"; + +const triggers = {}; +triggers[EffectTrigger.EVENT] = ["firebot:overlay-connected"]; +triggers[EffectTrigger.MANUAL] = true; + +const model: ReplaceVariable = { + definition: { + handle: "overlayInstance", + description: "The name of the overlay instance that triggered the event.", + triggers: triggers, + categories: [VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger) => { + return trigger.metadata?.eventData?.instanceName ?? "Default"; + } +}; + +export = model; \ No newline at end of file diff --git a/src/resources/overlay/js/main.js b/src/resources/overlay/js/main.js index 5424afad1..d36a46a94 100644 --- a/src/resources/overlay/js/main.js +++ b/src/resources/overlay/js/main.js @@ -18,6 +18,12 @@ function overlaySocketConnect(){ ws.onopen = function(){ notification('close'); console.log(`Connection is opened on port ${overlayPort}...`); + + const olInstance = params.get("instance"); + + sendWebsocketEvent("overlay-connected", { + instanceName: olInstance == null || olInstance === "" ? "Default" : olInstance + }); }; // When we get a message from the Firebot GUI... diff --git a/src/server/http-server-manager.js b/src/server/http-server-manager.js index 9c5fb5469..85a1d6a3a 100644 --- a/src/server/http-server-manager.js +++ b/src/server/http-server-manager.js @@ -11,6 +11,7 @@ const path = require('path'); const logger = require("../backend/logwrapper"); const { settings } = require("../backend/common/settings-access"); const effectManager = require("../backend/effects/effectManager"); +const eventManager = require("../backend/events/EventManager"); const resourceTokenManager = require("../backend/resourceTokenManager"); const electron = require('electron'); @@ -180,7 +181,14 @@ class HttpServerManager extends EventEmitter { ws.on('message', (message) => { try { const event = JSON.parse(message); - this.emit("overlay-event", event); + + if (event.name === "overlay-connected") { + eventManager.triggerEvent("firebot", "overlay-connected", { + instanceName: event.data.instanceName + }); + } else { + this.emit("overlay-event", event); + } } catch (error) { logger.error("Error parsing overlay event", error); } From e39928ee8dee8daade1c338a54a6e41c45b27e30 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 17:15:46 -0500 Subject: [PATCH 142/184] fix(effects): effect outputs now bubble down into nested effect lists (#2273) --- src/backend/common/effect-runner.js | 6 ++--- src/backend/effects/builtin/effect-group.js | 8 +++--- src/backend/effects/builtin/loop-effects.js | 27 ++++++++++++++++----- 3 files changed, 29 insertions(+), 12 deletions(-) diff --git a/src/backend/common/effect-runner.js b/src/backend/common/effect-runner.js index 9add1c7d5..5b247d58c 100644 --- a/src/backend/common/effect-runner.js +++ b/src/backend/common/effect-runner.js @@ -74,7 +74,7 @@ function validateEffectCanRun(effectId, triggerType) { } -async function triggerEffect(effect, trigger) { +async function triggerEffect(effect, trigger, outputs) { // For each effect, send it off to the appropriate handler. logger.debug(`Running ${effect.type}(${effect.id}) effect...`); @@ -87,7 +87,7 @@ async function triggerEffect(effect, trigger) { } }; - return effectDef.onTriggerEvent({ effect, trigger, sendDataToOverlay }); + return effectDef.onTriggerEvent({ effect, trigger, sendDataToOverlay, outputs }); } async function runEffects(runEffectsContext) { @@ -115,7 +115,7 @@ async function runEffects(runEffectsContext) { })); try { - const response = await triggerEffect(effect, trigger); + const response = await triggerEffect(effect, trigger, runEffectsContext.outputs); if (!response) { continue; } diff --git a/src/backend/effects/builtin/effect-group.js b/src/backend/effects/builtin/effect-group.js index 4c37b3557..5a9482039 100644 --- a/src/backend/effects/builtin/effect-group.js +++ b/src/backend/effects/builtin/effect-group.js @@ -133,7 +133,7 @@ const effectGroup = { onTriggerEvent: event => { return new Promise(resolve => { - const { effect, trigger } = event; + const { effect, trigger, outputs } = event; let processEffectsRequest = {}; @@ -153,7 +153,8 @@ const effectGroup = { processEffectsRequest = { trigger: newTrigger, - effects: presetList.effects + effects: presetList.effects, + outputs: outputs }; } else { const effectList = effect.effectList; @@ -164,7 +165,8 @@ const effectGroup = { processEffectsRequest = { trigger: trigger, - effects: effectList + effects: effectList, + outputs: outputs }; } diff --git a/src/backend/effects/builtin/loop-effects.js b/src/backend/effects/builtin/loop-effects.js index 93aef593e..4cff95552 100644 --- a/src/backend/effects/builtin/loop-effects.js +++ b/src/backend/effects/builtin/loop-effects.js @@ -97,9 +97,11 @@ const model = { onTriggerEvent: event => { return new Promise(async resolve => { - const { effect, trigger } = event; + const { effect, trigger, outputs } = event; const effectList = effect.effectList; + let lastOutputs = outputs ?? {}; + if (!effectList || !effectList.list) { return resolve(true); } @@ -108,7 +110,7 @@ const model = { return resolve(true); } - const runEffects = async (loopCount = 0, loopItem = null) => { + const runEffects = async (loopCount = 0, loopItem = null, outputs = null) => { const trigger = event.trigger; trigger.metadata.loopCount = loopCount; trigger.metadata.loopItem = loopItem; @@ -118,7 +120,8 @@ const model = { id: effectList.id, list: effectList.list, queue: effectList.queue - } + }, + outputs: outputs }; try { @@ -140,7 +143,11 @@ const model = { } for (let i = 0; i < loopCount; i++) { - const result = await runEffects(i); + const result = await runEffects(i, null, lastOutputs); + lastOutputs = { + ...lastOutputs, + ...result.outputs + }; if (result != null && result.success === true) { if (result.stopEffectExecution) { return resolve({ @@ -178,7 +185,11 @@ const model = { const conditionsPass = await conditionManager.runConditions(effect.conditionData, trigger); if (conditionsPass) { - const result = await runEffects(currentLoopCount); + const result = await runEffects(currentLoopCount, null, lastOutputs); + lastOutputs = { + ...lastOutputs, + ...result.outputs + }; if (result != null && result.success === true) { if (result.stopEffectExecution) { return resolve({ @@ -214,7 +225,11 @@ const model = { let currentLoopCount = 0; for (const item of arrayToIterate) { - const result = await runEffects(currentLoopCount, item); + const result = await runEffects(currentLoopCount, item, lastOutputs); + lastOutputs = { + ...lastOutputs, + ...result.outputs + }; if (result != null && result.success === true) { if (result.stopEffectExecution) { return resolve({ From 7061f805b64b86ce1ada5013b184d55fa92887c4 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 17:32:41 -0500 Subject: [PATCH 143/184] fix(effects): add effect outputs to random/sequential effect --- src/backend/effects/builtin/random-effect.js | 4 +++- src/backend/effects/builtin/sequential-effect.js | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/backend/effects/builtin/random-effect.js b/src/backend/effects/builtin/random-effect.js index 4b9a2a3b4..630d6f307 100644 --- a/src/backend/effects/builtin/random-effect.js +++ b/src/backend/effects/builtin/random-effect.js @@ -78,6 +78,7 @@ const randomEffect = { const effect = event.effect; const effectList = effect.effectList; + const outputs = effect.outputs; if (!effectList || !effectList.list) { return resolve(true); @@ -162,7 +163,8 @@ const randomEffect = { id: effectList.id, list: [chosenEffect], queue: effectList.queue - } + }, + outputs: outputs }; effectRunner.processEffects(processEffectsRequest) diff --git a/src/backend/effects/builtin/sequential-effect.js b/src/backend/effects/builtin/sequential-effect.js index 531f6cad5..9e5535d49 100644 --- a/src/backend/effects/builtin/sequential-effect.js +++ b/src/backend/effects/builtin/sequential-effect.js @@ -62,6 +62,7 @@ const model = { const effect = event.effect; const effectList = effect.effectList; + const outputs = effect.outputs; if (!effectList || !effectList.list) { return resolve(true); @@ -122,7 +123,8 @@ const model = { id: effectList.id, list: [chosenEffect], queue: effectList.queue - } + }, + outputs: outputs }; effectRunner.processEffects(processEffectsRequest) From bda3aafffb30b9b444afac1558cb29a9ad92ebd5 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 18:32:47 -0500 Subject: [PATCH 144/184] fi(effects): bubble down outputs to conditional effects, HTTP request error effects --- .../builtin/conditional-effects/conditional-effects.js | 5 +++-- src/backend/effects/builtin/http-request.js | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/backend/effects/builtin/conditional-effects/conditional-effects.js b/src/backend/effects/builtin/conditional-effects/conditional-effects.js index db965001a..01fe9e49f 100644 --- a/src/backend/effects/builtin/conditional-effects/conditional-effects.js +++ b/src/backend/effects/builtin/conditional-effects/conditional-effects.js @@ -118,7 +118,7 @@ const model = { onTriggerEvent: event => { return new Promise(async (resolve) => { // What should this do when triggered. - const { effect, trigger } = event; + const { effect, trigger, outputs } = event; let effectsToRun = null; if (effect.ifs != null) { @@ -142,7 +142,8 @@ const model = { if (effectsToRun != null) { const processEffectsRequest = { trigger: event.trigger, - effects: effectsToRun + effects: effectsToRun, + outputs: outputs }; effectRunner.processEffects(processEffectsRequest) diff --git a/src/backend/effects/builtin/http-request.js b/src/backend/effects/builtin/http-request.js index e3d6ce2cc..c61303dd8 100644 --- a/src/backend/effects/builtin/http-request.js +++ b/src/backend/effects/builtin/http-request.js @@ -223,7 +223,7 @@ const effect = { const customVariableManager = require("../../common/custom-variable-manager"); const effectRunner = require("../../common/effect-runner"); - const { effect, trigger } = event; + const { effect, trigger, outputs } = event; let headers = effect.headers.reduce((acc, next) => { acc[next.key] = next.value; @@ -281,7 +281,8 @@ const effect = { if (effect.options.runEffectsOnError) { const processEffectsRequest = { trigger, - effects: effect.errorEffects + effects: effect.errorEffects, + outputs: outputs }; const effectResult = await effectRunner.processEffects(processEffectsRequest); From fa0b7af8cfaf7cef2e190cc6ef7ce6fbd3b0c084 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Sun, 31 Dec 2023 21:03:05 -0500 Subject: [PATCH 145/184] 5.60.0-beta2 --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 26b40b4f8..9bb9f28a5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "firebotv5", - "version": "5.60.0-beta1", + "version": "5.60.0-beta2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "firebotv5", - "version": "5.60.0-beta1", + "version": "5.60.0-beta2", "license": "GPL-3.0", "dependencies": { "@aws-sdk/client-polly": "^3.26.0", diff --git a/package.json b/package.json index dc5686917..fe3e1e389 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "firebotv5", - "version": "5.60.0-beta1", + "version": "5.60.0-beta2", "description": "Powerful all-in-one bot for Twitch streamers.", "main": "build/main.js", "scripts": { From 33c6a18bdff47ed6503c2819d86f551aef742144 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 1 Jan 2024 09:42:32 -0500 Subject: [PATCH 146/184] fix(chat): fix chat reply message part offsets --- src/backend/chat/chat-helpers.ts | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/src/backend/chat/chat-helpers.ts b/src/backend/chat/chat-helpers.ts index 74c82ac0a..2f88e81df 100644 --- a/src/backend/chat/chat-helpers.ts +++ b/src/backend/chat/chat-helpers.ts @@ -331,16 +331,6 @@ class FirebotChatHelpers { roles: [] }; - if (firebotChatMessage.isReply) { - const replyUsername = msg.tags.get("reply-parent-user-login"); - if (firebotChatMessage.replyParentMessageText.startsWith(`@${replyUsername}`)) { - firebotChatMessage.replyParentMessageText = firebotChatMessage.replyParentMessageText.substring(replyUsername.length + 1); - } - if (msgText.startsWith('@')) { - msgText = msgText.split(" ").slice(1).join(" "); - } - } - const profilePicUrl = await this.getUserProfilePicUrl(firebotChatMessage.userId); firebotChatMessage.profilePicUrl = profilePicUrl; @@ -363,6 +353,22 @@ class FirebotChatHelpers { firebotChatMessage.parts = messageParts; + if (firebotChatMessage.isReply) { + const replyUsername = msg.tags.get("reply-parent-user-login"); + if (firebotChatMessage.replyParentMessageText.startsWith(`@${replyUsername}`)) { + firebotChatMessage.replyParentMessageText = firebotChatMessage.replyParentMessageText.substring(replyUsername.length + 1); + } + + const firstPart = firebotChatMessage.parts[0] ?? {} as Partial; + if (firstPart.type === "text" && firstPart.text.startsWith('@')) { + firstPart.text = firstPart.text.split(" ").slice(1).join(" "); + + if (firstPart.text.trim() === "") { + firebotChatMessage.parts.splice(0, 1); + } + } + } + if (this._badgeCache != null) { firebotChatMessage.badges = this._getChatBadges(msg.userInfo.badges); } From fc7fca0bea50e7236256645f604b98b794c3fd47 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 1 Jan 2024 12:33:59 -0500 Subject: [PATCH 147/184] feat(chat): cheermotes in Dashboard, cheermote vars in chat message events --- src/backend/chat/chat-helpers.ts | 66 ++++++++++++++++--- src/backend/twitch-api/resource/bits.ts | 12 +++- .../variables/builtin-variable-loader.js | 5 ++ .../builtin/twitch/cheermote-amounts.ts | 48 ++++++++++++++ .../builtin/twitch/cheermote-animated-urls.ts | 48 ++++++++++++++ .../builtin/twitch/cheermote-colors.ts | 48 ++++++++++++++ .../builtin/twitch/cheermote-names.ts | 48 ++++++++++++++ .../builtin/twitch/cheermote-urls.ts | 48 ++++++++++++++ .../chat/feed items/chat-message.js | 11 ++++ src/types/chat.d.ts | 10 +++ src/types/triggers.d.ts | 9 ++- 11 files changed, 341 insertions(+), 12 deletions(-) create mode 100644 src/backend/variables/builtin/twitch/cheermote-amounts.ts create mode 100644 src/backend/variables/builtin/twitch/cheermote-animated-urls.ts create mode 100644 src/backend/variables/builtin/twitch/cheermote-colors.ts create mode 100644 src/backend/variables/builtin/twitch/cheermote-names.ts create mode 100644 src/backend/variables/builtin/twitch/cheermote-urls.ts diff --git a/src/backend/chat/chat-helpers.ts b/src/backend/chat/chat-helpers.ts index 2f88e81df..e287f955c 100644 --- a/src/backend/chat/chat-helpers.ts +++ b/src/backend/chat/chat-helpers.ts @@ -1,14 +1,14 @@ -import { HelixChatBadgeSet, HelixEmote } from "@twurple/api"; -import { ChatMessage, ParsedMessagePart, parseChatMessage } from "@twurple/chat"; +import { HelixChatBadgeSet, HelixCheermoteList, HelixEmote } from "@twurple/api"; +import { ChatMessage, ParsedMessageCheerPart, ParsedMessagePart, findCheermotePositions, parseChatMessage } from "@twurple/chat"; import { PubSubAutoModQueueMessage } from "@twurple/pubsub"; import { ThirdPartyEmote, ThirdPartyEmoteProvider } from "./third-party/third-party-emote-provider"; import { BTTVEmoteProvider } from "./third-party/bttv"; import { FFZEmoteProvider } from "./third-party/ffz"; import { SevenTVEmoteProvider } from "./third-party/7tv"; -import { FirebotChatMessage, FirebotParsedMessagePart } from "../../types/chat"; +import { FirebotChatMessage, FirebotCheermoteInstance, FirebotParsedMessagePart } from "../../types/chat"; import logger from "../logwrapper"; import accountAccess, { FirebotAccount } from "../common/account-access"; -import twitchClient from "../twitch-api/api"; +import twitchApi from "../twitch-api/api"; import frontendCommunicator from "../common/frontend-communicator"; import utils from "../utility"; @@ -28,13 +28,15 @@ class FirebotChatHelpers { new SevenTVEmoteProvider() ]; + private _twitchCheermotes: HelixCheermoteList; + private _profilePicUrlCache: Record = {}; private readonly URL_REGEX = utils.getUrlRegex(); async cacheBadges(): Promise { const streamer = accountAccess.getAccounts().streamer; - const client = twitchClient.streamerClient; + const client = twitchApi.streamerClient; if (streamer.loggedIn && client) { try { const channelBadges = await client.chat.getChannelBadges(streamer.userId); @@ -51,7 +53,7 @@ class FirebotChatHelpers { } async cacheTwitchEmotes(): Promise { - const client = twitchClient.streamerClient; + const client = twitchApi.streamerClient; const streamer = accountAccess.getAccounts().streamer; if (client == null || !streamer.loggedIn) { @@ -83,10 +85,48 @@ class FirebotChatHelpers { } } + async cacheCheermotes() { + this._twitchCheermotes = await twitchApi.bits.getChannelCheermotes(); + } + + parseCheermote(part: ParsedMessageCheerPart | FirebotParsedMessagePart): FirebotCheermoteInstance { + const displayInfo = this._twitchCheermotes.getCheermoteDisplayInfo(part.name, part.amount, { + background: "light", + state: "animated", + scale: "4" + }); + + const staticDisplayInfo = this._twitchCheermotes.getCheermoteDisplayInfo(part.name, part.amount, { + background: "light", + state: "static", + scale: "4" + }); + + return { + name: part.name, + amount: part.amount, + url: staticDisplayInfo.url, + animatedUrl: displayInfo.url, + color: displayInfo.color + }; + } + + async getCheermoteData(message: string): Promise { + const cheermotes: FirebotCheermoteInstance[] = []; + if (!(message?.length > 0)) { + return cheermotes; + } + + const parsedCheermotes = findCheermotePositions(message, this._twitchCheermotes.getPossibleNames()); + + return parsedCheermotes.map(this.parseCheermote); + } + async handleChatConnect(): Promise { await this.cacheBadges(); await this.cacheTwitchEmotes(); await this.cacheThirdPartyEmotes(); + await this.cacheCheermotes(); frontendCommunicator.send("all-emotes", [ ...Object.values(this._twitchEmotes || {}) @@ -116,9 +156,9 @@ class FirebotChatHelpers { } const streamer = accountAccess.getAccounts().streamer; - const client = twitchClient.streamerClient; + const client = twitchApi.streamerClient; if (streamer.loggedIn && client) { - const user = await twitchClient.users.getUserById(userId); + const user = await twitchApi.users.getUserById(userId); if (user) { this._profilePicUrlCache[userId] = user.profilePictureUrl; return user.profilePictureUrl; @@ -213,6 +253,14 @@ class FirebotChatHelpers { part.animatedUrl = emote ? emote.getAnimatedImageUrl("1.0") : null; } + if (part.type === "cheer") { + const parsedCheermote = this.parseCheermote(part); + + part.animatedUrl = parsedCheermote.animatedUrl; + part.url = parsedCheermote.url; + part.color = parsedCheermote.color; + } + return part; }); } @@ -349,7 +397,7 @@ class FirebotChatHelpers { } const messageParts = this._parseMessageParts(firebotChatMessage, - parseChatMessage(msgText, msg.emoteOffsets)); + parseChatMessage(msgText, msg.emoteOffsets, this._twitchCheermotes?.getPossibleNames())); firebotChatMessage.parts = messageParts; diff --git a/src/backend/twitch-api/resource/bits.ts b/src/backend/twitch-api/resource/bits.ts index 37923b467..ebe8fe3df 100644 --- a/src/backend/twitch-api/resource/bits.ts +++ b/src/backend/twitch-api/resource/bits.ts @@ -1,6 +1,6 @@ import logger from "../../logwrapper"; import accountAccess from "../../common/account-access"; -import { ApiClient, HelixBitsLeaderboardEntry, HelixBitsLeaderboardPeriod, HelixBitsLeaderboardQuery } from "@twurple/api"; +import { ApiClient, HelixBitsLeaderboardEntry, HelixBitsLeaderboardPeriod, HelixBitsLeaderboardQuery, HelixCheermoteList } from "@twurple/api"; export class TwitchBitsApi { private _streamerClient: ApiClient; @@ -46,4 +46,14 @@ export class TwitchBitsApi { return l.userName; }); } + + async getChannelCheermotes(): Promise { + try { + const streamerId: string = accountAccess.getAccounts().streamer.userId; + return await this._streamerClient.bits.getCheermotes(streamerId); + } catch (error) { + logger.error(`Error getting channel cheermotes: ${error.message}`); + return null; + } + } } \ No newline at end of file diff --git a/src/backend/variables/builtin-variable-loader.js b/src/backend/variables/builtin-variable-loader.js index 87c018a80..cdcb06714 100644 --- a/src/backend/variables/builtin-variable-loader.js +++ b/src/backend/variables/builtin-variable-loader.js @@ -231,6 +231,11 @@ exports.loadReplaceVariables = () => { 'twitch/channel-goal-description', 'twitch/channel-goal-target-amount', 'twitch/channel-goal-type', + 'twitch/cheermote-amounts', + 'twitch/cheermote-animated-urls', + 'twitch/cheermote-colors', + 'twitch/cheermote-names', + 'twitch/cheermote-urls', 'twitch/hype-train-level', 'twitch/hype-train-percent', 'twitch/sub-count', diff --git a/src/backend/variables/builtin/twitch/cheermote-amounts.ts b/src/backend/variables/builtin/twitch/cheermote-amounts.ts new file mode 100644 index 000000000..2226e6917 --- /dev/null +++ b/src/backend/variables/builtin/twitch/cheermote-amounts.ts @@ -0,0 +1,48 @@ +import { ReplaceVariable } from "../../../../types/variables"; +import { EffectTrigger } from "../../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../../shared/variable-constants"; +import { FirebotParsedMessagePart } from "../../../../types/chat"; + +const triggers = {}; +triggers[EffectTrigger.MANUAL] = true; +triggers[EffectTrigger.COMMAND] = true; +triggers[EffectTrigger.EVENT] = [ + "twitch:chat-message", + "twitch:first-time-chat", + "firebot:highlight-message", + "twitch:viewer-arrived" +]; + +const model: ReplaceVariable = { + definition: { + handle: "cheermoteAmounts", + examples: [ + { + usage: "cheermoteAmounts[1]", + description: "Get the amount cheered using a specific instance of a cheermote." + } + ], + description: "Outputs the amounts cheered for each instance of a chat message's cheermotes from the associated command or event.", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger, target: number = null) => { + let messageParts: FirebotParsedMessagePart[] = []; + if (trigger.type === EffectTrigger.COMMAND) { + messageParts = trigger.metadata.chatMessage.parts; + } else if (trigger.type === EffectTrigger.EVENT) { + messageParts = trigger.metadata.eventData.chatMessage.parts; + } + + const cheermoteAmounts = messageParts.filter(p => p.type === "cheer").map(e => e.amount); + + if (target != null) { + return cheermoteAmounts[target]; + } + + return cheermoteAmounts; + } +}; + +module.exports = model; diff --git a/src/backend/variables/builtin/twitch/cheermote-animated-urls.ts b/src/backend/variables/builtin/twitch/cheermote-animated-urls.ts new file mode 100644 index 000000000..abcba0939 --- /dev/null +++ b/src/backend/variables/builtin/twitch/cheermote-animated-urls.ts @@ -0,0 +1,48 @@ +import { ReplaceVariable } from "../../../../types/variables"; +import { EffectTrigger } from "../../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../../shared/variable-constants"; +import { FirebotParsedMessagePart } from "../../../../types/chat"; + +const triggers = {}; +triggers[EffectTrigger.MANUAL] = true; +triggers[EffectTrigger.COMMAND] = true; +triggers[EffectTrigger.EVENT] = [ + "twitch:chat-message", + "twitch:first-time-chat", + "firebot:highlight-message", + "twitch:viewer-arrived" +]; + +const model: ReplaceVariable = { + definition: { + handle: "cheermoteAnimatedUrls", + examples: [ + { + usage: "cheermoteAnimatedUrls[1]", + description: "Get the animated URL of a specific instance of a cheermote." + } + ], + description: "Outputs the animated URLs of a chat message's cheermotes from the associated command or event.", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger, target: number = null) => { + let messageParts: FirebotParsedMessagePart[] = []; + if (trigger.type === EffectTrigger.COMMAND) { + messageParts = trigger.metadata.chatMessage.parts; + } else if (trigger.type === EffectTrigger.EVENT) { + messageParts = trigger.metadata.eventData.chatMessage.parts; + } + + const cheermoteAnimatedUrls = messageParts.filter(p => p.type === "cheer").map(e => e.animatedUrl); + + if (target != null) { + return cheermoteAnimatedUrls[target]; + } + + return cheermoteAnimatedUrls; + } +}; + +module.exports = model; diff --git a/src/backend/variables/builtin/twitch/cheermote-colors.ts b/src/backend/variables/builtin/twitch/cheermote-colors.ts new file mode 100644 index 000000000..743f47f51 --- /dev/null +++ b/src/backend/variables/builtin/twitch/cheermote-colors.ts @@ -0,0 +1,48 @@ +import { ReplaceVariable } from "../../../../types/variables"; +import { EffectTrigger } from "../../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../../shared/variable-constants"; +import { FirebotParsedMessagePart } from "../../../../types/chat"; + +const triggers = {}; +triggers[EffectTrigger.MANUAL] = true; +triggers[EffectTrigger.COMMAND] = true; +triggers[EffectTrigger.EVENT] = [ + "twitch:chat-message", + "twitch:first-time-chat", + "firebot:highlight-message", + "twitch:viewer-arrived" +]; + +const model: ReplaceVariable = { + definition: { + handle: "cheermoteColors", + examples: [ + { + usage: "cheermoteColors[1]", + description: "Get the text color (in #RRGGBB format) of a specific instance of a cheermote." + } + ], + description: "Outputs the text colors (in #RRGGBB format) of a chat message's cheermotes from the associated command or event.", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger, target: number = null) => { + let messageParts: FirebotParsedMessagePart[] = []; + if (trigger.type === EffectTrigger.COMMAND) { + messageParts = trigger.metadata.chatMessage.parts; + } else if (trigger.type === EffectTrigger.EVENT) { + messageParts = trigger.metadata.eventData.chatMessage.parts; + } + + const cheermoteColors = messageParts.filter(p => p.type === "cheer").map(e => e.color); + + if (target != null) { + return cheermoteColors[target]; + } + + return cheermoteColors; + } +}; + +module.exports = model; diff --git a/src/backend/variables/builtin/twitch/cheermote-names.ts b/src/backend/variables/builtin/twitch/cheermote-names.ts new file mode 100644 index 000000000..a4f02a37f --- /dev/null +++ b/src/backend/variables/builtin/twitch/cheermote-names.ts @@ -0,0 +1,48 @@ +import { ReplaceVariable } from "../../../../types/variables"; +import { EffectTrigger } from "../../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../../shared/variable-constants"; +import { FirebotParsedMessagePart } from "../../../../types/chat"; + +const triggers = {}; +triggers[EffectTrigger.MANUAL] = true; +triggers[EffectTrigger.COMMAND] = true; +triggers[EffectTrigger.EVENT] = [ + "twitch:chat-message", + "twitch:first-time-chat", + "firebot:highlight-message", + "twitch:viewer-arrived" +]; + +const model: ReplaceVariable = { + definition: { + handle: "cheermoteNames", + examples: [ + { + usage: "cheermoteNames[1]", + description: "Get the name of a specific instance of a cheermote." + } + ], + description: "Outputs the names of a chat message's cheermotes from the associated command or event.", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger, target: number = null) => { + let messageParts: FirebotParsedMessagePart[] = []; + if (trigger.type === EffectTrigger.COMMAND) { + messageParts = trigger.metadata.chatMessage.parts; + } else if (trigger.type === EffectTrigger.EVENT) { + messageParts = trigger.metadata.eventData.chatMessage.parts; + } + + const cheermoteNames = messageParts.filter(p => p.type === "cheer").map(e => e.name); + + if (target != null) { + return cheermoteNames[target]; + } + + return cheermoteNames; + } +}; + +module.exports = model; diff --git a/src/backend/variables/builtin/twitch/cheermote-urls.ts b/src/backend/variables/builtin/twitch/cheermote-urls.ts new file mode 100644 index 000000000..dfefef317 --- /dev/null +++ b/src/backend/variables/builtin/twitch/cheermote-urls.ts @@ -0,0 +1,48 @@ +import { ReplaceVariable } from "../../../../types/variables"; +import { EffectTrigger } from "../../../../shared/effect-constants"; +import { OutputDataType, VariableCategory } from "../../../../shared/variable-constants"; +import { FirebotParsedMessagePart } from "../../../../types/chat"; + +const triggers = {}; +triggers[EffectTrigger.MANUAL] = true; +triggers[EffectTrigger.COMMAND] = true; +triggers[EffectTrigger.EVENT] = [ + "twitch:chat-message", + "twitch:first-time-chat", + "firebot:highlight-message", + "twitch:viewer-arrived" +]; + +const model: ReplaceVariable = { + definition: { + handle: "cheermoteUrls", + examples: [ + { + usage: "cheermoteUrls[1]", + description: "Get the URL of a specific instance of a cheermote." + } + ], + description: "Outputs the URLs of a chat message's cheermotes from the associated command or event.", + triggers: triggers, + categories: [VariableCategory.COMMON, VariableCategory.TRIGGER], + possibleDataOutput: [OutputDataType.TEXT] + }, + evaluator: (trigger, target: number = null) => { + let messageParts: FirebotParsedMessagePart[] = []; + if (trigger.type === EffectTrigger.COMMAND) { + messageParts = trigger.metadata.chatMessage.parts; + } else if (trigger.type === EffectTrigger.EVENT) { + messageParts = trigger.metadata.eventData.chatMessage.parts; + } + + const cheermoteUrls = messageParts.filter(p => p.type === "cheer").map(e => e.url); + + if (target != null) { + return cheermoteUrls[target]; + } + + return cheermoteUrls; + } +}; + +module.exports = model; diff --git a/src/gui/app/directives/chat/feed items/chat-message.js b/src/gui/app/directives/chat/feed items/chat-message.js index aaff3e7cc..418fcbf08 100644 --- a/src/gui/app/directives/chat/feed items/chat-message.js +++ b/src/gui/app/directives/chat/feed items/chat-message.js @@ -135,6 +135,17 @@ {{part.text}} + + + + + {{part.amount}} + ; + eventData?: { + chatMessage?: FirebotChatMessage; + [x: string]: unknown + }; counter?: { id: string; name: string; From 628f22d98e0b0940b75101cc493dc73da5a67cbf Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 1 Jan 2024 15:12:28 -0500 Subject: [PATCH 148/184] fix(dashboard): fix quick action sorting (#2318) --- src/backend/common/settings-access.js | 8 ++++++++ src/backend/quick-actions/quick-action-manager.js | 11 ++++++++++- .../directives/chat/quick-actions/quick-actions.js | 6 +++++- .../modals/chat/quick-action-settings-modal.js | 6 +++++- 4 files changed, 28 insertions(+), 3 deletions(-) diff --git a/src/backend/common/settings-access.js b/src/backend/common/settings-access.js index 1eec8760d..a27502ccb 100644 --- a/src/backend/common/settings-access.js +++ b/src/backend/common/settings-access.js @@ -293,4 +293,12 @@ settings.setOpenStreamPreviewOnLaunch = (enabled) => { pushDataToFile("/settings/openStreamPreviewOnLaunch", enabled === true); }; +settings.getQuickActionSettings = () => { + return getDataFromFile("/settings/quickActions"); +}; + +settings.setQuickActionSettings = (quickActions) => { + pushDataToFile("/settings/quickActions", quickActions); +}; + exports.settings = settings; diff --git a/src/backend/quick-actions/quick-action-manager.js b/src/backend/quick-actions/quick-action-manager.js index eca48ca74..37ac7b5a3 100644 --- a/src/backend/quick-actions/quick-action-manager.js +++ b/src/backend/quick-actions/quick-action-manager.js @@ -6,6 +6,7 @@ const effectRunner = require("../common/effect-runner"); const presetEffectListManager = require("../effects/preset-lists/preset-effect-list-manager"); const { EffectTrigger } = require("../../shared/effect-constants"); const accountAccess = require("../common/account-access"); +const { settings } = require("../common/settings-access"); /** @typedef {import("../../shared/types").QuickActionDefinition} QuickActionDefinition */ @@ -48,6 +49,14 @@ class QuickActionManager extends JsonDbManager { ]; } + deleteQuickAction(customQuickActionId) { + if (super.deleteItem(customQuickActionId)) { + const quickActionSettings = settings.getQuickActionSettings(); + delete quickActionSettings[customQuickActionId]; + settings.setQuickActionSettings(quickActionSettings); + } + } + /** * @returns {QuickActionDefinition[]} */ @@ -116,7 +125,7 @@ frontendCommunicator.onAsync("saveAllCustomQuickActions", async (/** @type {QuickActionDefinition[]} */ allCustomQuickActions) => await quickActionManager.saveAllItems(allCustomQuickActions)); frontendCommunicator.on("deleteCustomQuickAction", - (/** @type {string} */ customQuickActionId) => quickActionManager.deleteItem(customQuickActionId)); + (/** @type {string} */ customQuickActionId) => quickActionManager.deleteQuickAction(customQuickActionId)); frontendCommunicator.on("triggerQuickAction", quickActionId => { quickActionManager.triggerQuickAction(quickActionId); diff --git a/src/gui/app/directives/chat/quick-actions/quick-actions.js b/src/gui/app/directives/chat/quick-actions/quick-actions.js index 77aae5f83..f5a00eee8 100644 --- a/src/gui/app/directives/chat/quick-actions/quick-actions.js +++ b/src/gui/app/directives/chat/quick-actions/quick-actions.js @@ -5,7 +5,7 @@ .component("quickActions", { template: `
-
+
-
+
{{action.name}} @@ -49,6 +49,10 @@ $ctrl.settings = $ctrl.resolve.settings; }; + $ctrl.sortQuickActions = (qa) => { + return $ctrl.settings[qa.id].position; + }; + $ctrl.sortableOptions = { handle: ".dragHandle", stop: () => { From 0b0e371e584b0fa74cbf7c12d1ac750f1052277a Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 1 Jan 2024 16:04:03 -0500 Subject: [PATCH 149/184] fix(roles): use chat message data to update VIP roles (#2142) --- .../chat/chat-listeners/twitch-chat-listeners.js | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/backend/chat/chat-listeners/twitch-chat-listeners.js b/src/backend/chat/chat-listeners/twitch-chat-listeners.js index 9bcbac694..0f9c8247e 100644 --- a/src/backend/chat/chat-listeners/twitch-chat-listeners.js +++ b/src/backend/chat/chat-listeners/twitch-chat-listeners.js @@ -6,6 +6,7 @@ const chatHelpers = require("../chat-helpers"); const activeUserHandler = require("./active-user-handler"); const accountAccess = require("../../common/account-access"); const chatModerationManager = require("../moderation/chat-moderation-manager"); +const chatRolesManager = require("../../roles/chat-roles-manager"); const twitchEventsHandler = require("../../events/twitch-events"); const raidMessageChecker = require(".././moderation/raid-message-checker"); const logger = require("../../logwrapper"); @@ -52,6 +53,12 @@ exports.setupChatListeners = (streamerChatClient, botChatClient) => { await chatModerationManager.moderateMessage(firebotChatMessage); + if (firebotChatMessage.isVip === true) { + chatRolesManager.addVipToVipList(firebotChatMessage.username); + } else { + chatRolesManager.removeVipFromVipList(firebotChatMessage.username); + } + // send to the frontend if (firebotChatMessage.isHighlighted) { firebotChatMessage.customRewardId = HIGHLIGHT_MESSAGE_REWARD_ID; @@ -117,6 +124,13 @@ exports.setupChatListeners = (streamerChatClient, botChatClient) => { streamerChatClient.onAction(async (_channel, _user, messageText, msg) => { const firebotChatMessage = await chatHelpers.buildFirebotChatMessage(msg, messageText, false, true); + + if (firebotChatMessage.isVip === true) { + chatRolesManager.addVipToVipList(firebotChatMessage.username); + } else { + chatRolesManager.removeVipFromVipList(firebotChatMessage.username); + } + frontendCommunicator.send("twitch:chat:message", firebotChatMessage); twitchEventsHandler.chatMessage.triggerChatMessage(firebotChatMessage); From 88dee66f6f2910f0af2f7d37d05738bcc8def975 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 1 Jan 2024 21:21:31 -0500 Subject: [PATCH 150/184] chore(chat): clarify Highlight/Spotlight Message event/action --- src/backend/events/builtin/firebot-event-source.js | 4 ++-- src/gui/app/directives/chat/feed items/chat-message.js | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/backend/events/builtin/firebot-event-source.js b/src/backend/events/builtin/firebot-event-source.js index 9d00c77f1..f87f62f43 100644 --- a/src/backend/events/builtin/firebot-event-source.js +++ b/src/backend/events/builtin/firebot-event-source.js @@ -87,8 +87,8 @@ const firebotEventSource = { }, { id: "highlight-message", - name: "Chat Message Highlight", - description: "When you select to highlight a message on your overlay.", + name: "Chat Message Spotlight", + description: "When you choose to spotlight a message, like by displaying on an overlay.", cached: false, manualMetadata: { username: "Firebot", diff --git a/src/gui/app/directives/chat/feed items/chat-message.js b/src/gui/app/directives/chat/feed items/chat-message.js index 418fcbf08..e1cb2c443 100644 --- a/src/gui/app/directives/chat/feed items/chat-message.js +++ b/src/gui/app/directives/chat/feed items/chat-message.js @@ -312,8 +312,8 @@ }); actions.push({ - name: "Highlight Message", - icon: "fa-eye" + name: "Spotlight Message", + icon: "fa-lightbulb-on" }); actions.push({ @@ -449,10 +449,10 @@ threadOrReplyMessageId: $ctrl.message.id }); break; - case "quote this message": + case "quote message": updateChatField(`!quote add @${userName} ${rawText}`); break; - case "highlight this message": + case "spotlight message": chatMessagesService.highlightMessage(userName, rawText); break; case "shoutout": From 0c88d151cabffff2aeb95bd191d6b6a5fc70f020 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 1 Jan 2024 22:09:32 -0500 Subject: [PATCH 151/184] fix(chat): bold tagged messages in compact mode --- src/gui/scss/core/_chat.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/gui/scss/core/_chat.scss b/src/gui/scss/core/_chat.scss index 99314995a..4d53f2a59 100644 --- a/src/gui/scss/core/_chat.scss +++ b/src/gui/scss/core/_chat.scss @@ -201,7 +201,7 @@ &.isTagged { .chatContent { - font-weight: 700; + font-weight: 700 !important; } } &.isCompact { From cfadb2949bbdbd5fa7bbb359de2864cc502e3612 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Mon, 1 Jan 2024 22:30:24 -0500 Subject: [PATCH 152/184] fix(chat): link regex parsing --- src/backend/chat/chat-helpers.ts | 2 +- src/backend/utility.js | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/backend/chat/chat-helpers.ts b/src/backend/chat/chat-helpers.ts index e287f955c..483c502a0 100644 --- a/src/backend/chat/chat-helpers.ts +++ b/src/backend/chat/chat-helpers.ts @@ -32,7 +32,7 @@ class FirebotChatHelpers { private _profilePicUrlCache: Record = {}; - private readonly URL_REGEX = utils.getUrlRegex(); + private readonly URL_REGEX = utils.getNonGlobalUrlRegex(); async cacheBadges(): Promise { const streamer = accountAccess.getAccounts().streamer; diff --git a/src/backend/utility.js b/src/backend/utility.js index 8ee254910..2ac473074 100644 --- a/src/backend/utility.js +++ b/src/backend/utility.js @@ -22,6 +22,10 @@ const getUrlRegex = () => { return /\b(?:https?:(?:\/\/)?)?(?:[a-z\d](?:[a-z\d-]{0,253}[a-z\d])?\.)+[a-z][a-z\d-]{0,60}[a-z\d](?:$|[\\/]|\w?)+/gi; }; +const getNonGlobalUrlRegex = () => { + return /\b(?:https?:(?:\/\/)?)?(?:[a-z\d](?:[a-z\d-]{0,253}[a-z\d])?\.)+[a-z][a-z\d-]{0,60}[a-z\d](?:$|[\\/]|\w?)+/i; +}; + /** * Translates seconds into human readable format of seconds, minutes, hours, days, and years * @@ -227,6 +231,7 @@ const wait = (ms) => { exports.getRandomInt = getRandomInt; exports.escapeRegExp = escapeRegExp; exports.getUrlRegex = getUrlRegex; +exports.getNonGlobalUrlRegex = getNonGlobalUrlRegex; exports.secondsForHumans = secondsForHumans; exports.formattedSeconds = formattedSeconds; exports.getTriggerIdFromTriggerData = getTriggerIdFromTriggerData; From 19bfa410382d71c45383d3e22f97c689ee5ce146 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Tue, 2 Jan 2024 09:00:35 -0500 Subject: [PATCH 153/184] fix(chat): add UserContextApiClient for bot, fix bot announce/whisper --- src/backend/twitch-api/api.ts | 9 +++++++-- src/backend/twitch-api/resource/chat.ts | 3 --- .../twitch-api/user-context-api-client.ts | 20 +++++++++++++++++++ 3 files changed, 27 insertions(+), 5 deletions(-) create mode 100644 src/backend/twitch-api/user-context-api-client.ts diff --git a/src/backend/twitch-api/api.ts b/src/backend/twitch-api/api.ts index 0608c8713..a333ecaad 100644 --- a/src/backend/twitch-api/api.ts +++ b/src/backend/twitch-api/api.ts @@ -4,6 +4,8 @@ import { AuthProvider } from "@twurple/auth"; import logger from "../logwrapper"; import accountAccess from "../common/account-access"; +import { UserContextApiClient } from "./user-context-api-client"; + import { TwitchAuthApi } from "./resource/auth"; import { TwitchBitsApi } from "./resource/bits"; import { TwitchCategoriesApi } from "./resource/categories"; @@ -23,7 +25,7 @@ import { TwitchWhispersApi } from "./resource/whispers"; class TwitchApi { private _streamerClient: ApiClient; - private _botClient: ApiClient; + private _botClient: UserContextApiClient; setupApiClients(streamerProvider: AuthProvider, botProvider: AuthProvider): void { if (!streamerProvider && !botProvider) { @@ -35,7 +37,10 @@ class TwitchApi { } if (accountAccess.getAccounts().bot.loggedIn) { - this._botClient = new ApiClient({ authProvider: botProvider }); + this._botClient = new UserContextApiClient( + { authProvider: botProvider }, + accountAccess.getAccounts().bot.userId + ); } logger.info("Finished setting up Twitch API client"); diff --git a/src/backend/twitch-api/resource/chat.ts b/src/backend/twitch-api/resource/chat.ts index f792c54c9..2f67bc4ff 100644 --- a/src/backend/twitch-api/resource/chat.ts +++ b/src/backend/twitch-api/resource/chat.ts @@ -53,9 +53,6 @@ export class TwitchChatApi { const willSendAsBot: boolean = sendAsBot === true && accountAccess.getAccounts().bot?.userId != null && this._botClient != null; - const senderUserId: string = willSendAsBot === true ? - accountAccess.getAccounts().bot.userId : - streamerUserId; if (message?.length < 1) { return; diff --git a/src/backend/twitch-api/user-context-api-client.ts b/src/backend/twitch-api/user-context-api-client.ts new file mode 100644 index 000000000..85c65d0b0 --- /dev/null +++ b/src/backend/twitch-api/user-context-api-client.ts @@ -0,0 +1,20 @@ +import { ApiClient, ApiConfig } from "@twurple/api"; + +/** + * A Twurple API client that always acts in the context of the specified user. + * + * Functionally equivalent to Twurple's internal `UserContextApiClient` class + * used in the callback for `ApiClient.asUser` + */ +export class UserContextApiClient extends ApiClient { + constructor( + config: ApiConfig, + private readonly _userId: string + ) { + super(config); + } + + _getUserIdFromRequestContext(): string { + return this._userId; + } +} \ No newline at end of file From 169e3d98484b61b28ede5648b1a0a61ea091c61e Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Tue, 2 Jan 2024 09:15:28 -0500 Subject: [PATCH 154/184] fix(chat): when Dashboard delete chat message fails, show toast notification --- src/backend/chat/twitch-chat.ts | 2 +- src/backend/twitch-api/resource/chat.ts | 2 +- src/gui/app/services/chat-messages.service.js | 12 ++++++++---- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/src/backend/chat/twitch-chat.ts b/src/backend/chat/twitch-chat.ts index 0be63ae1e..54f0e9abd 100644 --- a/src/backend/chat/twitch-chat.ts +++ b/src/backend/chat/twitch-chat.ts @@ -305,7 +305,7 @@ frontendCommunicator.onAsync("send-chat-message", async (sendData: ChatMessageRe }); frontendCommunicator.onAsync("delete-message", async (messageId: string) => { - await twitchApi.chat.deleteChatMessage(messageId); + return await twitchApi.chat.deleteChatMessage(messageId); }); frontendCommunicator.onAsync("update-user-mod-status", async (data: UserModRequest) => { diff --git a/src/backend/twitch-api/resource/chat.ts b/src/backend/twitch-api/resource/chat.ts index 2f67bc4ff..7f39f8b14 100644 --- a/src/backend/twitch-api/resource/chat.ts +++ b/src/backend/twitch-api/resource/chat.ts @@ -117,7 +117,7 @@ export class TwitchChatApi { return true; } catch (error) { - logger.error("Error clearing chat", error.message); + logger.error("Error deleting chat message", error.message); } return false; diff --git a/src/gui/app/services/chat-messages.service.js b/src/gui/app/services/chat-messages.service.js index 8f32c0d41..c5efb3441 100644 --- a/src/gui/app/services/chat-messages.service.js +++ b/src/gui/app/services/chat-messages.service.js @@ -7,7 +7,7 @@ angular .module('firebotApp') .factory('chatMessagesService', function (logger, listenerService, settingsService, - soundService, backendCommunicator, pronounsService, accountAccess) { + soundService, backendCommunicator, pronounsService, accountAccess, ngToast) { const service = {}; // Chat Message Queue @@ -255,9 +255,13 @@ } } - service.deleteMessage = messageId => { - markMessageAsDeleted(messageId); - backendCommunicator.send("delete-message", messageId); + service.deleteMessage = async (messageId) => { + const result = await backendCommunicator.fireEventAsync("delete-message", messageId); + if (result === true) { + markMessageAsDeleted(messageId); + } else { + ngToast.create("Unable to delete chat message. Check log for more details."); + } }; backendCommunicator.on("twitch:chat:message:deleted", markMessageAsDeleted); From f3a503241909da411161de462f495dddeb671b66 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Tue, 2 Jan 2024 12:05:35 -0500 Subject: [PATCH 155/184] 5.60.0-beta3 --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9bb9f28a5..61e865cde 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "firebotv5", - "version": "5.60.0-beta2", + "version": "5.60.0-beta3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "firebotv5", - "version": "5.60.0-beta2", + "version": "5.60.0-beta3", "license": "GPL-3.0", "dependencies": { "@aws-sdk/client-polly": "^3.26.0", diff --git a/package.json b/package.json index fe3e1e389..1b2481a17 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "firebotv5", - "version": "5.60.0-beta2", + "version": "5.60.0-beta3", "description": "Powerful all-in-one bot for Twitch streamers.", "main": "build/main.js", "scripts": { From e942b498dc26cd22953a54474901a4480b5bee79 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Tue, 2 Jan 2024 23:40:53 -0500 Subject: [PATCH 156/184] fix(vars): load pollWinningChoiceVotes --- src/backend/variables/builtin-variable-loader.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/backend/variables/builtin-variable-loader.js b/src/backend/variables/builtin-variable-loader.js index cdcb06714..81c1e4b0b 100644 --- a/src/backend/variables/builtin-variable-loader.js +++ b/src/backend/variables/builtin-variable-loader.js @@ -131,6 +131,7 @@ exports.loadReplaceVariables = () => { 'ordinal-indicator', 'overlay-instance', 'poll-winning-choice-name', + 'poll-winning-choice-votes', 'prediction-winning-outcome-name', 'preset-list-arg', 'previous-currency-amount', From f99fb5f1411ec58874e1ea2b16d9886cce8d3ae6 Mon Sep 17 00:00:00 2001 From: CKY- Date: Wed, 3 Jan 2024 07:52:45 -0700 Subject: [PATCH 157/184] typo fixes --- src/backend/common/account-access.js | 2 +- src/backend/common/handlers/apiProcessor.js | 2 +- .../conditions/condition-manager.js | 4 ++-- src/backend/effects/builtin/file-writer.js | 4 ++-- src/backend/import/v4/areas/v4-fonts-importer.js | 2 +- .../import/v4/areas/v4-hotkeys-importer.js | 2 +- .../import/v4/areas/v4-scripts-importer.js | 2 +- src/backend/import/v4/v4-effect-mapper.js | 2 +- .../builtin/aws/text-to-speech-polly-effect.js | 2 +- .../builtin/streamelements/streamelements.js | 2 +- .../restrictions/builtin/chat-messages.js | 2 +- .../restrictions/builtin/custom-variable.js | 2 +- src/backend/restrictions/builtin/follow-check.js | 2 +- src/backend/restrictions/builtin/time-range.js | 2 +- src/backend/restrictions/builtin/view-time.js | 2 +- src/backend/restrictions/builtin/viewer-count.js | 2 +- src/backend/timers/timer-manager.ts | 2 +- src/backend/twitch-api/resource/auth.ts | 2 +- src/backend/variables/builtin/concat.js | 2 +- .../variables/builtin/gift-receivers-raw.js | 2 +- src/backend/variables/builtin/math.js | 16 ++++++++-------- .../variables/builtin/object-walk-path-raw.js | 2 +- .../variables/builtin/object-walk-path.js | 2 +- src/backend/variables/builtin/top-currency.js | 2 +- src/backend/variables/builtin/top-metadata.js | 2 +- .../variables/builtin/top-view-time-raw.js | 2 +- src/backend/variables/builtin/top-view-time.js | 2 +- src/gui/app/controllers/counters.controller.js | 2 +- src/gui/app/controllers/updates.controller.js | 2 +- src/gui/app/directives/effectOptions.js | 2 +- .../modals/backups/restoreBackupModal.js | 2 +- .../editSystemCommand/editSystemCommandModal.js | 2 +- .../modals/misc/editUrlAllowlistModal.js | 2 +- .../modals/misc/fontManagementModal.js | 2 +- .../directives/modals/misc/setupWizardModal.js | 4 ++-- .../modals/misc/txtFileWordImportModal.js | 4 ++-- .../directives/restrictions/restrictionItem.js | 2 +- .../restrictions/restrictionOptions.js | 2 +- 38 files changed, 49 insertions(+), 49 deletions(-) diff --git a/src/backend/common/account-access.js b/src/backend/common/account-access.js index ec3d80830..09ba45373 100644 --- a/src/backend/common/account-access.js +++ b/src/backend/common/account-access.js @@ -173,7 +173,7 @@ function updateAccount(accountType, account, emitUpdate = true) { const otherAccount = accountType === "streamer" ? cache.bot : cache.streamer; if (otherAccount != null && otherAccount.loggedIn) { if (otherAccount.userId === account.userId) { - renderWindow.webContents.send("error", "You cannot sign into the same user for both Streamer and Bot accounts. The bot account should be a seperate Twitch user. If you don't have a seperate user, simply don't use the Bot account feature as it's not required."); + renderWindow.webContents.send("error", "You cannot sign into the same user for both Streamer and Bot accounts. The bot account should be a separate Twitch user. If you don't have a separate user, simply don't use the Bot account feature as it's not required."); return; } } diff --git a/src/backend/common/handlers/apiProcessor.js b/src/backend/common/handlers/apiProcessor.js index 70cc8c62f..2bc92c252 100644 --- a/src/backend/common/handlers/apiProcessor.js +++ b/src/backend/common/handlers/apiProcessor.js @@ -69,7 +69,7 @@ async function randomDogFact() { logger.debug(err.message); renderWindow.webContents.send( "error", - "Couldnt conenct to the dog fact api. It may be down." + "Couldnt connect to the dog fact api. It may be down." ); return "[Error getting API response]"; }); diff --git a/src/backend/effects/builtin/conditional-effects/conditions/condition-manager.js b/src/backend/effects/builtin/conditional-effects/conditions/condition-manager.js index 8f59d9b04..20c518777 100644 --- a/src/backend/effects/builtin/conditional-effects/conditions/condition-manager.js +++ b/src/backend/effects/builtin/conditional-effects/conditions/condition-manager.js @@ -55,7 +55,7 @@ class ConditionManager extends EventEmitter { try { condition.leftSideValue = await util.populateStringWithTriggerData(condition.leftSideValue, triggerData); } catch (err) { - logger.warn("Unable to process leftSideValue replace varaibles for condition", err); + logger.warn("Unable to process leftSideValue replace variables for condition", err); } } @@ -63,7 +63,7 @@ class ConditionManager extends EventEmitter { try { condition.rightSideValue = await util.populateStringWithTriggerData(condition.rightSideValue, triggerData); } catch (err) { - logger.warn("Unable to process rightSideValue replace varaibles for condition", err); + logger.warn("Unable to process rightSideValue replace variables for condition", err); } } diff --git a/src/backend/effects/builtin/file-writer.js b/src/backend/effects/builtin/file-writer.js index 9a05c5f76..b5c82a5f2 100644 --- a/src/backend/effects/builtin/file-writer.js +++ b/src/backend/effects/builtin/file-writer.js @@ -68,7 +68,7 @@ const fileWriter = {
-

-
- Description - - -
- + +
diff --git a/src/gui/app/directives/modals/commands/editSystemCommand/editSystemCommandModal.html b/src/gui/app/directives/modals/commands/editSystemCommand/editSystemCommandModal.html index 88a4e3c5f..7a29e6c44 100644 --- a/src/gui/app/directives/modals/commands/editSystemCommand/editSystemCommandModal.html +++ b/src/gui/app/directives/modals/commands/editSystemCommand/editSystemCommandModal.html @@ -52,6 +52,27 @@

+ + + + + Date: Wed, 3 Jan 2024 17:44:45 -0600 Subject: [PATCH 162/184] feat(commands): Make create stream marker sys command chat messages editable #2321 --- src/backend/chat/commands/builtin/marker.js | 37 ++++++++++++++++++--- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/src/backend/chat/commands/builtin/marker.js b/src/backend/chat/commands/builtin/marker.js index e27b86c03..108e347db 100644 --- a/src/backend/chat/commands/builtin/marker.js +++ b/src/backend/chat/commands/builtin/marker.js @@ -33,11 +33,35 @@ const model = { ] } ] + }, + options: { + successTemplate: { + type: "string", + title: "Output Template", + description: "The chat message to send when the marker is created.", + tip: "Variables: {timestamp}", + default: `Marker created at {timestamp}.`, + useTextArea: true + }, + unableTemplate: { + type: "string", + title: "Unable Output Template", + description: "The chat message to send a marker is unable to be created.", + default: "Unable to create a stream marker.", + useTextArea: true + }, + errorTemplate: { + type: "string", + title: "Error Output Template", + description: "The chat message to send when there was an error creating a marker.", + default: "Failed to create a stream marker.", + useTextArea: true + } } }, - onTriggerEvent: async event => { + onTriggerEvent: async ({ userCommand, commandOptions }) => { - const { args } = event.userCommand; + const { args } = userCommand; const streamer = accountAccess.getAccounts().streamer; @@ -46,13 +70,16 @@ const model = { .createStreamMarker(streamer.userId, args.join(" ")); if (marker == null) { - await chat.sendChatMessage(`Unable to create a stream marker.`); + await chat.sendChatMessage(commandOptions.unableTemplate); return; } - await chat.sendChatMessage(`Marker created at ${utils.formattedSeconds(marker.positionInSeconds, true)}`); + await chat.sendChatMessage( + commandOptions.successTemplate + .replace("{timestamp}", utils.formattedSeconds(marker.positionInSeconds, true)) + ); } catch (error) { logger.error(error); - await chat.sendChatMessage(`Failed to create a stream marker.`); + await chat.sendChatMessage(commandOptions.errorTemplate); } } }; From cc78ed27ee202bf6f9b16efed3bf36d45dfcd659 Mon Sep 17 00:00:00 2001 From: Zack Williamson Date: Thu, 4 Jan 2024 00:01:51 -0500 Subject: [PATCH 163/184] fix: don't dont --- src/backend/common/account-access.js | 2 +- src/backend/common/effect-runner.js | 2 +- src/backend/common/profile-manager.js | 2 +- src/backend/currency/currencyManager.js | 2 +- src/backend/database/currencyDatabase.js | 2 +- src/backend/effects/builtin/random-effect.js | 4 ++-- src/backend/effects/builtin/sequential-effect.js | 2 +- src/backend/effects/builtin/show-text.js | 2 +- src/backend/events/events-router.js | 2 +- src/backend/import/v4/v4-effect-mapper.js | 4 ++-- src/gui/app/app-main.js | 6 +++--- src/gui/app/controllers/settings.controller.js | 2 +- src/gui/app/directives/misc/keyCapture.js | 2 +- src/gui/app/directives/modals/viewers/editColumnsModal.js | 2 +- src/gui/app/index.js | 2 +- src/gui/app/services/utility.service.js | 2 +- 16 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/backend/common/account-access.js b/src/backend/common/account-access.js index 09ba45373..5afc1bc83 100644 --- a/src/backend/common/account-access.js +++ b/src/backend/common/account-access.js @@ -169,7 +169,7 @@ function updateAccount(accountType, account, emitUpdate = true) { botTokenIssue = false; } - // dont let streamer and bot be the same + // don't let streamer and bot be the same const otherAccount = accountType === "streamer" ? cache.bot : cache.streamer; if (otherAccount != null && otherAccount.loggedIn) { if (otherAccount.userId === account.userId) { diff --git a/src/backend/common/effect-runner.js b/src/backend/common/effect-runner.js index 5b247d58c..ca3af85e4 100644 --- a/src/backend/common/effect-runner.js +++ b/src/backend/common/effect-runner.js @@ -17,7 +17,7 @@ const findAndReplaceVariables = async (data, trigger, effectOutputs) => { for (const key of keys) { - // skip nested effect lists and conditions so we dont replace variables too early + // skip nested effect lists and conditions so we don't replace variables too early if (SKIP_VARIABLE_PROPERTIES.includes(key)) { continue; } diff --git a/src/backend/common/profile-manager.js b/src/backend/common/profile-manager.js index fd2761094..8841788cf 100644 --- a/src/backend/common/profile-manager.js +++ b/src/backend/common/profile-manager.js @@ -87,7 +87,7 @@ function getLoggedInProfile() { return loggedInUser; } } catch (err) { - // We dont have a value in our global settings. So, lets try some other things. + // We don't have a value in our global settings. So, lets try some other things. try { const globalSettingsDb = dataAccess.getJsonDbInUserData("./global-settings"), activeProfiles = globalSettingsDb.getData("./activeProfiles"); diff --git a/src/backend/currency/currencyManager.js b/src/backend/currency/currencyManager.js index 1c3049bf3..6c47ab292 100644 --- a/src/backend/currency/currencyManager.js +++ b/src/backend/currency/currencyManager.js @@ -340,7 +340,7 @@ function createCurrencyCommandDefinition(currency) { return false; } - // Dont allow person to give themselves currency. + // Don't allow person to give themselves currency. if (event.userCommand.commandSender.toLowerCase() === username.toLowerCase()) { await twitchChat.sendChatMessage( `${event.userCommand.commandSender}, you can't give yourself currency.`); diff --git a/src/backend/database/currencyDatabase.js b/src/backend/database/currencyDatabase.js index aa340330f..478aeca51 100644 --- a/src/backend/database/currencyDatabase.js +++ b/src/backend/database/currencyDatabase.js @@ -56,7 +56,7 @@ function adjustCurrency(user, currencyId, value, adjustType = "adjust") { return resolve(); } - // Dont do anything if value is not a number or is 0. + // Don't do anything if value is not a number or is 0. if (isNaN(value)) { return resolve(); } diff --git a/src/backend/effects/builtin/random-effect.js b/src/backend/effects/builtin/random-effect.js index 630d6f307..f7134f719 100644 --- a/src/backend/effects/builtin/random-effect.js +++ b/src/backend/effects/builtin/random-effect.js @@ -105,7 +105,7 @@ const randomEffect = { // try to find queue in cache let cacheEntry = randomQueuesCache[effect.id]; if (!cacheEntry) { - // we dont have a preexisting queue in the cache, create a new one + // we don't have a preexisting queue in the cache, create a new one cacheEntry = { queue: util.shuffleArray(newEffectIds), currentEffectIds: newEffectIds @@ -143,7 +143,7 @@ const randomEffect = { chosenEffect = effectList.list.find(e => e.id === chosenEffectId); } else { - // we dont care about repeats, just get an effect via random index + // we don't care about repeats, just get an effect via random index const randomIndex = util.getRandomInt(0, enabledEffectList.length - 1); chosenEffect = enabledEffectList[randomIndex]; diff --git a/src/backend/effects/builtin/sequential-effect.js b/src/backend/effects/builtin/sequential-effect.js index 9e5535d49..a06cb427c 100644 --- a/src/backend/effects/builtin/sequential-effect.js +++ b/src/backend/effects/builtin/sequential-effect.js @@ -84,7 +84,7 @@ const model = { // try to find queue in cache let cacheEntry = sequentialQueuesCache[effect.id]; if (!cacheEntry) { - // we dont have a preexisting queue in the cache, create a new one + // we don't have a preexisting queue in the cache, create a new one cacheEntry = { queue: newEffectIds, currentEffectIds: newEffectIds diff --git a/src/backend/effects/builtin/show-text.js b/src/backend/effects/builtin/show-text.js index 7c266a70d..667c4236a 100644 --- a/src/backend/effects/builtin/show-text.js +++ b/src/backend/effects/builtin/show-text.js @@ -70,7 +70,7 @@ const showText = { ng-model="effect.height">
-