New options

README.md

@@ -5,11 +5,10 @@
 
 **WARNING:** this relies on undocumented features of Rumble. If Rumble changes their site, this may break.
 
-Add support for capturing the paid Rumble Rants for [Rumble.com](https://rumble.com/) livestreams.
+Add support for capturing the paid Rumble Rants for [Rumble.com](https://rumble.com/), gifted subscriptions, and raids for livestreams.
 Rants are shown past their normal expiration date in the chat.
 
-Rants can be shown as a sidebar on the stream page or in a separate window. After a stream ends, cached data can be
-viewed by loading the stream page again.
+Rants can be shown as a sidebar on the stream page or in a separate window. After a stream ends, cached data can be viewed by loading the stream page again.
 
 Additionally, all cached data can be viewed and managed from the Cached Rants page.
 
@@ -124,6 +123,24 @@ Options:
 - Unchecked: display as sidebar (Default)
 - Checked: open as popup
 
+**Include Gifts**
+
+Include gifted subscriptions in the sidebar
+
+Options:
+
+- Unchecked: gifted subscriptions are not captured
+- Checked: gifted subscriptions are captured (Default)
+
+**Include Raids**
+
+Include incoming raids in the sidebar
+
+Options:
+
+- Unchecked: incoming raids are not captured
+- Checked: incoming raids are captured (Default)
+
 ### Page Links
 
 Click "View Cached Rants" to open the Cached Rants page

eslint.config.js

@@ -64,6 +64,7 @@ module.exports = [
             ...jsdoc.configs.recommended.rules,
             "prettier/prettier": "error",
             "sonarjs/todo-tag": "warn",
+            "sonarjs/cognitive-complexity": "off",
             "import/no-extraneous-dependencies": ["error", { devDependencies: true }],
             "no-underscore-dangle": "off",
             "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],

package.json

@@ -1,6 +1,6 @@
 {
     "name": "rantstats-extension",
-    "version": "1.5.0",
+    "version": "1.5.1",
     "packageManager": "yarn@4.6.0",
     "description": "Add support for capturing paid Rumble Rants for Rumble.com livestreams.",
     "main": "output/pages/content/content.js",

src/components/open-chat/open-chat.ts

@@ -82,9 +82,10 @@ const addCacheButtonToNode = (parentClassName: string, onclick: () => void): boo
 }
 
 /**
- *
- * @param parentClassName
- * @param onclick
+ * Add button to open cached data below video player
+ * @param parentClassName class name of section to add button to
+ * @param onclick function to handle button click
+ * @returns true if button added
  */
 const addCacheButtonToActions = (parentClassName: string, onclick: () => void): boolean => {
     // get related videos list

src/components/rants/rant.ts

@@ -1,4 +1,12 @@
-import { cacheMessage, getAllCachedMessageIds, getBadge, getBadges, getUser, updateCachedMessage } from "../../cache"
+import {
+    cacheMessage,
+    getAllCachedMessageIds,
+    getBadge,
+    getBadges,
+    getOptions,
+    getUser,
+    updateCachedMessage,
+} from "../../cache"
 import { CacheBadge, GiftPurchaseNotification, Notification } from "../../types/cache"
 import { CONSTS } from "../../types/consts"
 import { SortOrder } from "../../types/option-types"
@@ -396,16 +404,17 @@ const renderRant = async (
 }
 
 /**
- *
- * @param messageId
- * @param time
- * @param text
- * @param raidNotification
- * @param username
- * @param userImage
- * @param badges
- * @param read
- * @param cachePage
+ * Render a raid notification
+ * @param messageId id of the message
+ * @param time Time message was posted
+ * @param text text of the notification
+ * @param raidNotification raid notification information
+ * @param username Username for user
+ * @param userImage Optional path to profile image
+ * @param badges badges for user
+ * @param read true: message should be marked read
+ * @param cachePage true: data being displayed on cache page
+ * @returns A void promise
  */
 const renderRaidNotification = async (
     messageId: string,
@@ -673,19 +682,20 @@ const renderGiftNotification = async (
 const GIFTED_REGEX = /Was gifted a membership by (?<giver_name>.+?) /
 
 /**
- *
- * @param text
+ * Checks if the text indicates the user received a gift
+ * @param text the notification text
+ * @returns true if text matches gift receiver text
  */
 export const isGiftReceiver = (text: string): boolean => {
     return GIFTED_REGEX.exec(text) !== null
 }
 
 /**
- *
- * @param messageId
- * @param time
- * @param text
- * @param username
+ * Render a notification
+ * @param messageId id of the message
+ * @param time Time message was posted
+ * @param text text of the notification
+ * @param username Username for user
  */
 export const addGiftReceiver = (messageId: string, time: string, text: string, username: string): void => {
     if (text === undefined || text === "") {
@@ -813,32 +823,36 @@ export const renderMessage = async (
 
     const messageIdNotification = `${messageId}-notification`
 
+    const options = await getOptions()
+
     if (isGiftReceiver(text)) {
         addGiftReceiver(messageId, time, text, realUsername)
     } else if (raid_notification) {
-        await renderRaidNotification(
-            messageId,
-            time,
-            text,
-            raid_notification,
-            realUsername,
-            realUserImage,
-            badges,
-            read,
-            cachePage,
-        )
+        if (options?.includeRaids)
+            await renderRaidNotification(
+                messageId,
+                time,
+                text,
+                raid_notification,
+                realUsername,
+                realUserImage,
+                badges,
+                read,
+                cachePage,
+            )
     } else if (rant && text !== "") {
         // subscription may not have a message text so don't render
         await renderRant(messageId, time, text, rant, realUsername, realUserImage, badges, read, cachePage)
     } else if (giftPurchaseNotification) {
-        await renderGiftNotification(
-            messageIdNotification,
-            time,
-            giftPurchaseNotification,
-            realUsername,
-            realUserImage,
-            cachePage,
-        )
+        if (options?.includeRaids)
+            await renderGiftNotification(
+                messageIdNotification,
+                time,
+                giftPurchaseNotification,
+                realUsername,
+                realUserImage,
+                cachePage,
+            )
     } else if (notification) {
         await renderNotification(messageIdNotification, time, notification, realUsername, realUserImage, cachePage)
     }

src/manifest.json

@@ -1,7 +1,7 @@
 {
     "manifest_version": 3,
     "name": "RantStats Extension for Rumble.com",
-    "version": "1.5.0",
+    "version": "1.5.1",
     "description": "Add support for capturing paid Rumble Rants for Rumble.com livestreams.",
     "icons": {
         "16": "images/icon-16.png",

src/pages/options/options.html

@@ -1,5 +1,5 @@
 <!doctype html>
-<html class="rantstats">
+<html class="rantstats" lang="en">
     <head>
         <title>Options | RantStats Extension for Rumble.com</title>
 
@@ -79,11 +79,7 @@ <h1>RantStats Extension Options</h1>
 
             <div class="option">
                 <div class="option-info">
-                    <label
-                        class="name"
-                        for="open-location"
-                        title="Opens the Rant Stats data in a popup instead of sidebar"
-                    >
+                    <label class="name" for="open-location" title="Open Rant Stats in a popup instead of sidebar">
                         Open as Popup</label
                     >
                     <p class="description">Open Rant Stats in a popup instead of sidebar</p>
@@ -93,6 +89,32 @@ <h1>RantStats Extension Options</h1>
                     <input type="checkbox" id="open-location" />
                 </div>
             </div>
+
+            <div class="option">
+                <div class="option-info">
+                    <label class="name" for="include-gifts" title="Include gifted subscriptions in the sidebar">
+                        Include Gifts</label
+                    >
+                    <p class="description">Include gifted subscriptions in the sidebar</p>
+                </div>
+
+                <div class="selector">
+                    <input type="checkbox" id="include-gifts" />
+                </div>
+            </div>
+
+            <div class="option">
+                <div class="option-info">
+                    <label class="name" for="include-raids" title="Include incoming raids in the sidebar">
+                        Include Raids</label
+                    >
+                    <p class="description">Include incoming raids in the sidebar</p>
+                </div>
+
+                <div class="selector">
+                    <input type="checkbox" id="include-raids" />
+                </div>
+            </div>
         </div>
 
         <footer>

src/pages/options/options.ts

@@ -13,6 +13,8 @@ const themeSelect = document.getElementById("theme") as HTMLSelectElement
 const openLocationCheckbox = document.getElementById("open-location") as HTMLInputElement
 const bytesUseSpan = document.getElementById(CONSTS.BYTES_USE_ID) as HTMLSpanElement
 const alternateColorsCheckbox = document.getElementById("alternate-colors") as HTMLInputElement
+const includeGiftsCheckbox = document.getElementById("include-gifts") as HTMLInputElement
+const includeRaidsCheckbox = document.getElementById("include-raids") as HTMLInputElement
 
 // temporary options before saving
 let tempOptions: Options = null
@@ -60,6 +62,8 @@ const setOptions = (options: Options): void => {
     themeSelect.value = options.theme.toString()
     openLocationCheckbox.checked = options.asPopup
     alternateColorsCheckbox.checked = options.alternateColors
+    includeGiftsCheckbox.checked = options.includeGifts
+    includeRaidsCheckbox.checked = options.includeRaids
 
     tempOptions = options
 
@@ -77,6 +81,8 @@ const getCurrentOptions = (): Options => {
         theme: themeSelect.value,
         asPopup: openLocationCheckbox.checked,
         alternateColors: alternateColorsCheckbox.checked,
+        includeGifts: includeGiftsCheckbox.checked,
+        includeRaids: includeRaidsCheckbox.checked,
     }
 }
 
@@ -200,6 +206,8 @@ themeSelect.addEventListener("change", optionChanged)
 openLocationCheckbox.addEventListener("change", optionChanged)
 bytesUseSpan.addEventListener("change", optionChanged)
 alternateColorsCheckbox.addEventListener("change", optionChanged)
+includeGiftsCheckbox.addEventListener("change", optionChanged)
+includeRaidsCheckbox.addEventListener("change", optionChanged)
 document.getElementById("clear").addEventListener("click", clearOptions)
 document.getElementById("open-rants").addEventListener("click", triggerOpenRantsPage)
 document.getElementById("open-about").addEventListener("click", triggerOpenAboutPage)

src/types/option-types.ts

@@ -68,6 +68,14 @@ export type Options = {
      * Alternate colors of messages in chat
      */
     alternateColors: boolean
+    /**
+     * Include gifted subscriptions
+     */
+    includeGifts: boolean
+    /**
+     * Include raid notifications
+     */
+    includeRaids: boolean
 }
 
 /**
@@ -79,4 +87,6 @@ export const defaultOptions: Options = {
     theme: Theme.Rumble.toString(),
     asPopup: false,
     alternateColors: false,
+    includeGifts: true,
+    includeRaids: true,
 }