feat (effect): add activity feed effect

package.json

@@ -25,6 +25,7 @@
         "@types/fs-extra": "^11.0.4",
         "@types/luxon": "^3.1.0",
         "@types/node": "^18.18.2",
+        "@types/uuid": "^10.0.0",
         "@typescript-eslint/eslint-plugin": "^5.62.0",
         "@typescript-eslint/parser": "^5.62.0",
         "electron": "^28.2.3",

src/backend/effects/builtin-effect-loader.js

@@ -5,6 +5,7 @@ const effectManager = require("./effectManager");
 exports.loadEffects = () => {
     [
         'active-user-lists',
+        'activity-feed-alert',
         'add-quote',
         'api',
         'block-unblock',

src/backend/effects/builtin/activity-feed-alert.ts

@@ -0,0 +1,76 @@
+import { EffectType } from "../../../types/effects";
+import { EffectCategory } from "../../../shared/effect-constants";
+import { handleTriggeredEvent } from "../../events/activity-feed-manager";
+
+const effect: EffectType<{
+    message: string;
+    icon: string;
+}> = {
+    definition: {
+        id: "firebot:activity-feed-alert",
+        name: "Activity Feed Alert",
+        description: "Display an alert in Firebot's activity feed",
+        icon: "fad fa-comment-exclamation",
+        categories: [EffectCategory.FUN],
+        dependencies: []
+    },
+    optionsTemplate: `
+    <eos-container>
+        <p>Use this effect to send yourself alerts in Firebot's activity feed.</p>
+    </eos-container>
+    <eos-container header="Message" pad-top="true">
+        <firebot-input 
+            model="effect.message" 
+            placeholder-text="Enter message"
+            use-text-area="true"
+            rows="4"
+            cols="40"
+        />
+    </eos-container> 
+    <eos-container header="Icon" pad-top="true">
+        <input 
+			maxlength="2" 
+			type="text" 
+			class="form-control" 
+			ng-model="effect.icon" 
+			icon-picker required
+		/>
+    </eos-container> 
+    `,
+    optionsController: () => { },
+    optionsValidator: (effect) => {
+        const errors = [];
+        if (effect.message == null || effect.message === "") {
+            errors.push("Alert message can't be blank.");
+        }
+        return errors;
+    },
+    onTriggerEvent: async ({ effect }) => {
+        handleTriggeredEvent(
+            {
+                id: "firebot",
+                name: "Firebot"
+            },
+            {
+                id: "activity-feed-alert",
+                name: "Activity Feed Alert",
+                activityFeed: {
+                    icon: effect.icon || "fad fa-comment-exclamation",
+                    getMessage: () => {
+                        return effect.message;
+                    }
+                }
+            },
+            {
+                username: "firebot"
+            },
+            {
+                forceAllow: true,
+                canRetrigger: false
+            });
+
+        return true;
+    }
+};
+
+module.exports = effect;

src/backend/events/activity-feed-manager.js

@@ -12,7 +12,7 @@ const timeFormat = isUSLocale ? "h:mm" : "H:mm";
 
 const previousActivity = [];
 
-function handleTriggeredEvent(source, event, metadata) {
+export function handleTriggeredEvent(source, event, metadata, eventSettings = { forceAllow: false, canRetrigger: true }) {
     if (source == null || event == null || metadata == null) {
         return;
     }
@@ -44,7 +44,8 @@ function handleTriggeredEvent(source, event, metadata) {
         },
         event: {
             id: event.id,
-            name: event.name
+            name: event.name,
+            ...eventSettings
         },
         message: event.activityFeed.getMessage(metadata),
         icon: event.activityFeed.icon,

src/gui/app/services/activity-feed.service.js

@@ -24,7 +24,7 @@
                 }
 
                 const allowedEvents = settingsService.getAllowedActivityEvents();
-                if (!allowedEvents.includes(`${activity.source.id}:${activity.event.id}`)) {
+                if (!activity.event.forceAllow && !allowedEvents.includes(`${activity.source.id}:${activity.event.id}`)) {
                     return;
                 }
 
@@ -42,13 +42,13 @@
             };
 
             service.markAllAcknowledged = () => {
-                service.allActivities.forEach(a => {
+                service.allActivities.forEach((a) => {
                     a.acknowledged = true;
                 });
             };
 
             service.markAllNotAcknowledged = () => {
-                service.allActivities.forEach(a => {
+                service.allActivities.forEach((a) => {
                     a.acknowledged = false;
                 });
             };

src/gui/app/templates/chat/_chat-messages.html

@@ -270,6 +270,7 @@ <h4><i class="fas" ng-class="currentThreadMessages().length < 2 ? 'fa-reply' : '
           style="font-size: 15px; display: flex; align-items: center"
         >
           <i
+            ng-if="activity.event.canRetrigger !== false"
             class="clickable far fa-redo mr-4"
             ng-click="afs.retriggerEvent(activity.id)"
             uib-tooltip="Retrigger event"