feat: websocket events

src/backend/chat/commands/command-manager.ts

@@ -9,6 +9,9 @@ import profileManager from "../../common/profile-manager";
 import frontendCommunicator from "../../common/frontend-communicator";
 import accountAccess from "../../common/account-access";
 
+import webSocketServerManager from "../../../server/websocket-server-manager";
+import { WebSocketEventType } from "../../../types/websocket";
+
 interface SystemCommandOverrides {
     [overrideId: string]: SystemCommandDefinition
 }
@@ -71,6 +74,8 @@ class CommandManager extends EventEmitter {
 
         this._registeredSysCommands.push(command);
 
+        webSocketServerManager.triggerEvent("command:system:created", command);
+
         logger.debug(`Registered Sys Command ${command.definition.id}`);
 
         this.emit("systemCommandRegistered", command);
@@ -82,7 +87,10 @@ class CommandManager extends EventEmitter {
      * @param id The ID of the system command to unregister
      */
     unregisterSystemCommand(id: string): void {
+        const command = this._registeredSysCommands.find(c => c.definition.id === id);
         this._registeredSysCommands = this._registeredSysCommands.filter(c => c.definition.id !== id);
+
+        webSocketServerManager.triggerEvent("command:system:deleted", command);
         this.emit("systemCommandUnRegistered", id);
         logger.debug(`Unregistered Sys Command ${id}`);
     }
@@ -242,14 +250,15 @@ class CommandManager extends EventEmitter {
         const override = this._commandCache.systemCommandOverrides[id];
         if (override != null) {
             override.trigger = newTrigger;
-            this.saveSystemCommandOverride(override);
+            this.saveSystemCommandOverride(override, false);
         }
 
         const defaultCmd = this._registeredSysCommands.find(
             c => c.definition.id === id
         );
         if (defaultCmd != null) {
             defaultCmd.definition.trigger = newTrigger;
+            webSocketServerManager.triggerEvent("command:system:updated", defaultCmd);
         }
 
         frontendCommunicator.send("system-commands-updated");
@@ -260,7 +269,7 @@ class CommandManager extends EventEmitter {
      *
      * @param command The `SystemCommandDefinition` with the system command override data
      */
-    saveSystemCommandOverride(command: SystemCommandDefinition): void {
+    saveSystemCommandOverride(command: SystemCommandDefinition, emitWebsocket = true): void {
         this._commandCache.systemCommandOverrides[command.id] = command;
 
         const commandDb = this.getCommandsDb();
@@ -270,6 +279,10 @@ class CommandManager extends EventEmitter {
 
         try {
             commandDb.push(`/systemCommandOverrides/${id}`, command);
+
+            if (emitWebsocket) {
+                webSocketServerManager.triggerEvent("command:system:updated", command);
+            }
         } catch (err) { }
 
         frontendCommunicator.send("system-command-override-saved", command);
@@ -289,6 +302,8 @@ class CommandManager extends EventEmitter {
         id = id.replace("/", "");
         try {
             commandDb.delete(`/systemCommandOverrides/${id}`);
+            const command = this.getSystemCommandById(id);
+            webSocketServerManager.triggerEvent("command:system:updated", command);
         } catch (err) {} //eslint-disable-line no-empty
 
         frontendCommunicator.send("system-commands-updated");
@@ -304,7 +319,9 @@ class CommandManager extends EventEmitter {
      * @param user The user who is creating/editing the custom command
      */
     saveCustomCommand(command: CommandDefinition, user?: string): void {
+        let eventType: WebSocketEventType = "command:custom:updated";
         if (command.id == null || command.id === "") {
+            eventType = "command:custom:created";
             // generate id for new command
             const uuidv1 = require("uuid/v1");
             command.id = uuidv1();
@@ -330,6 +347,7 @@ class CommandManager extends EventEmitter {
 
         try {
             commandDb.push(`/customCommands/${command.id}`, command);
+            webSocketServerManager.triggerEvent(eventType, command);
         } catch (err) {}
 
         const existingCommandIndex = this._commandCache.customCommands.findIndex(c => c.id === command.id);
@@ -392,7 +410,9 @@ class CommandManager extends EventEmitter {
         }
 
         try {
+            const command = this.getCustomCommandById(id);
             commandDb.delete(`/customCommands/${id}`);
+            webSocketServerManager.triggerEvent("command:custom:deleted", command);
         } catch (err) {
             logger.warn("error when deleting command", err.message);
         }

src/backend/common/custom-variable-manager.js

@@ -7,6 +7,8 @@ const { ipcMain } = require("electron");
 
 const NodeCache = require("node-cache");
 
+const webSocketServerManager = require("../../server/websocket-server-manager");
+
 const cache = new NodeCache({ stdTTL: 0, checkperiod: 1 });
 exports._cache = cache;
 
@@ -20,7 +22,11 @@ const onCustomVariableExpire = (key, value) => {
     windowManagement.sendVariableExpireToInspector(key, value);
 };
 
-const onCustomVariableDelete = (key) => {
+const onCustomVariableDelete = (key, value) => {
+    webSocketServerManager.triggerEvent("custom-variable:deleted", {
+        name: key,
+        value: value
+    });
     windowManagement.sendVariableDeleteToInspector(key);
 };
 
@@ -85,6 +91,8 @@ exports.addCustomVariable = (name, data, ttl = 0, propertyPath = null) => {
         //silently fail
     }
 
+    const eventType = !cache.keys().includes(name) ? "custom-variable:created" : "custom-variable:updated";
+
     const dataRaw = data != null ? data.toString().toLowerCase() : "null";
     const dataIsNull = dataRaw === "null" || dataRaw === "undefined";
 
@@ -97,6 +105,10 @@ exports.addCustomVariable = (name, data, ttl = 0, propertyPath = null) => {
             dataToSet = currentData;
         }
         cache.set(name, dataToSet, ttl === "" ? 0 : ttl);
+        webSocketServerManager.triggerEvent(eventType, {
+            name: name,
+            value: dataToSet
+        });
     } else {
         const currentData = cache.get(name);
         if (!currentData) {
@@ -132,6 +144,10 @@ exports.addCustomVariable = (name, data, ttl = 0, propertyPath = null) => {
                 }
             }
             cache.set(name, currentData, ttl === "" ? 0 : ttl);
+            webSocketServerManager.triggerEvent(eventType, {
+                name: name,
+                value: currentData
+            });
         } catch (error) {
             logger.debug(`error setting data to custom variable ${name} using property path ${propertyPath}`);
         }

src/backend/counters/counter-manager.ts

@@ -11,6 +11,7 @@ import profileManager from "../common/profile-manager";
 import { TriggerType } from "../common/EffectType";
 import { Counter } from "../../types/counters";
 import { EffectList } from "../../types/effects";
+import webSocketServerManager from "../../server/websocket-server-manager";
 
 class CounterManager extends JsonDbManager<Counter> {
     constructor() {
@@ -61,14 +62,21 @@ class CounterManager extends JsonDbManager<Counter> {
     override saveItem(counter: Counter): Counter {
         this.updateCounterTxtFile(counter.name, counter.value);
 
-        return super.saveItem(counter);
+        const eventType = counter.id == null || this.getItem(counter.id) == null ? "counter:created" : "counter:updated";
+
+        const finalCounter = super.saveItem(counter);
+
+        webSocketServerManager.triggerEvent(eventType, finalCounter);
+
+        return finalCounter;
     }
 
     override deleteItem(counterId: string): boolean {
         const counter = this.getItem(counterId);
 
         const result = super.deleteItem(counterId);
         if (result === true) {
+            webSocketServerManager.triggerEvent("counter:deleted", counter);
             this.deleteCounterTxtFile(counter.name);
         }
 

src/backend/effects/effectManager.d.ts

@@ -1,8 +1,11 @@
-import { EffectType } from "../../types/effects";
+import { EffectType, OverlayExtension } from "../../types/effects";
+import { EventEmitter } from "node:events";
 
-declare class EffectManager {
+
+declare class EffectManager extends EventEmitter {
     registerEffect: <EffectModel>(effectType: EffectType<EffectModel>) => void;
     getEffectById: (effectId: string) => EffectType<unknown> | undefined;
+    getEffectOverlayExtensions: () => OverlayExtension[];
 }
 
 declare const _EffectManager: EffectManager;

src/backend/effects/preset-lists/preset-effect-list-manager.js

@@ -2,6 +2,7 @@
 
 const frontendCommunicator = require("../../common/frontend-communicator");
 const JsonDbManager = require("../../database/json-db-manager");
+const webSocketServerManager = require("../../../server/websocket-server-manager");
 
 /**
  * @typedef PresetEffectList
@@ -24,6 +25,24 @@ class PresetEffectListManager extends JsonDbManager {
         super("Preset Effect List", "/effects/preset-effect-lists");
     }
 
+    saveItem(presetList) {
+        const eventType = presetList.id == null || super.getItem(presetList.id) == null ? "preset-effect-list:created" : "preset-effect-list:updated";
+
+        const finalPresetList = super.saveItem(presetList);
+
+        webSocketServerManager.triggerEvent(eventType, finalPresetList);
+
+        return finalPresetList;
+    }
+
+    deleteItem(presetListId) {
+        const presetList = super.getItem(presetListId);
+
+        if (super.deleteItem(presetListId)) {
+            webSocketServerManager.triggerEvent("preset-effect-list:deleted", presetList);
+        }
+    }
+
     /**
      * @returns {void}
      */

src/backend/effects/queues/effect-queue-manager.js

@@ -4,6 +4,8 @@ const frontendCommunicator = require("../../common/frontend-communicator");
 const JsonDbManager = require("../../database/json-db-manager");
 const effectQueueRunner = require("./effect-queue-runner");
 
+const webSocketServerManager = require("../../../server/websocket-server-manager");
+
 /**
  * @typedef EffectQueue
  * @prop {string} id - the id of the effect queue
@@ -53,18 +55,30 @@ class EffectQueueManager extends JsonDbManager {
      * @returns {EffectQueue | null}
      * */
     saveItem(effectQueue) {
+        const existingQueue = super.getItem(effectQueue.id);
+        const outputQueue = structuredClone(effectQueue);
+        const eventType = existingQueue == null ? "effect-queue:created" : "effect-queue:updated";
         delete effectQueue.length;
         delete effectQueue.queue;
         const savedEffectQueue = super.saveItem(effectQueue);
 
         if (savedEffectQueue) {
             effectQueueRunner.updateQueueConfig(savedEffectQueue);
+            webSocketServerManager.triggerEvent(eventType, outputQueue);
             return savedEffectQueue;
         }
 
         return null;
     }
 
+    deleteItem(queueId) {
+        const queue = super.getItem(queueId);
+
+        if (super.deleteItem(queueId)) {
+            webSocketServerManager.triggerEvent("effect-queue:deleted", queue);
+        }
+    }
+
     /**
      * @override
      * @param allItems - array of all effect queues

src/backend/effects/queues/effect-queue-runner.js

@@ -4,6 +4,8 @@ const effectRunner = require("../../common/effect-runner");
 const eventManager = require("../../events/EventManager");
 const frontendCommunicator = require("../../common/frontend-communicator");
 
+const webSocketServerManager = require("../../../server/websocket-server-manager");
+
 /**
  * Queue Entry
  * @typedef {Object} QueueEntry
@@ -31,14 +33,18 @@ class EffectQueue {
     }
 
     sendQueueLengthUpdate(lengthOverride = null) {
-        frontendCommunicator.send("updateQueueLength", {
+        const queue = {
             id: this.id,
             length: lengthOverride ?? this._queue.length
-        });
+        };
+
+        frontendCommunicator.send("updateQueueLength", queue);
+
+        webSocketServerManager.triggerEvent("effect-queue:length-updated", queue);
     }
 
     runQueue() {
-        return new Promise(resolve => {
+        return new Promise((resolve) => {
             if (this._queue.length === 0 || this.canceled || this._paused === true) {
                 return resolve();
             }
@@ -55,15 +61,15 @@ class EffectQueue {
 
             if (this.mode === "interval") {
                 effectRunner.runEffects(runEffectsContext)
-                    .catch(err => {
+                    .catch((err) => {
                         logger.warn(`Error while processing effects for queue ${this.id}`, err);
                     });
                 setTimeout(() => {
                     resolve(this.runQueue());
                 }, this.interval * 1000);
             } else if (this.mode === "auto") {
                 effectRunner.runEffects(runEffectsContext)
-                    .catch(err => {
+                    .catch((err) => {
                         logger.warn(`Error while processing effects for queue ${this.id}`, err);
                     })
                     .finally(() => {
@@ -73,7 +79,7 @@ class EffectQueue {
                     });
             } else if (this.mode === "custom") {
                 effectRunner.runEffects(runEffectsContext)
-                    .catch(err => {
+                    .catch((err) => {
                         logger.warn(`Error while processing effects for queue ${this.id}`, err);
                     });
                 setTimeout(() => {

src/backend/roles/custom-roles-manager.ts

@@ -10,6 +10,8 @@ import twitchApi from "../twitch-api/api";
 import twitchRoleManager from "../../shared/twitch-roles";
 import { BasicViewer } from "../../types/viewers";
 
+import webSocketServerManager from "../../server/websocket-server-manager";
+
 interface LegacyCustomRole {
     id: string;
     name: string;
@@ -214,13 +216,17 @@ class CustomRolesManager {
             return;
         }
 
+        const eventType = this._customRoles[role.id] == null ? "custom-role:created" : "custom-role:updated";
+
         this._customRoles[role.id] = role;
 
         try {
             const rolesDb = this.getCustomRolesDb();
 
             rolesDb.push(`/${role.id}`, role);
 
+            webSocketServerManager.triggerEvent(eventType, role);
+
             logger.debug(`Saved role ${role.id} to file.`);
         } catch (error) {
             logger.warn("There was an error saving a role.", error);
@@ -315,13 +321,17 @@ class CustomRolesManager {
             return;
         }
 
+        const role = this._customRoles[roleId];
+
         delete this._customRoles[roleId];
 
         try {
             const rolesDb = this.getCustomRolesDb();
 
             rolesDb.delete(`/${roleId}`);
 
+            webSocketServerManager.triggerEvent("custom-role:deleted", role);
+
             logger.debug(`Deleted role: ${roleId}`);
         } catch (error) {
             logger.warn("There was an error deleting a role.", error);