vars chore/fix: Hide Deprecated Variables and Update Variable Data Typings

src/backend/variables/builtin/array/array-filter.ts

@@ -93,7 +93,7 @@ const model : ReplaceVariable = {
             },
             {
                 usage: 'arrayFilter[rawArray, value, key, true]',
-                description: 'Filter out any item in the array that has a key property twitch equals "value"'
+                description: 'Filter out any item in the array that has a key property which equals "value"'
             }
         ],
         categories: [VariableCategory.ADVANCED],

src/backend/variables/builtin/array/raw-array-filter.ts

@@ -19,12 +19,13 @@ const model : ReplaceVariable = {
             },
             {
                 usage: 'rawArrayFilter[rawArray, value, key, true]',
-                description: 'Filter out any item in the array that has a key property twitch equals "value"'
+                description: 'Filter out any item in the array that has a key property which equals "value"'
             }
         ],
 
         categories: [VariableCategory.ADVANCED],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.TEXT],
+        hidden: true
     },
     evaluator: arrayFilter.evaluator
 };

src/backend/variables/builtin/currency/top-currency-raw.ts

@@ -7,9 +7,9 @@ import currencyManager from "../../../currency/currency-manager";
 const model : ReplaceVariable = {
     definition: {
         handle: "rawTopCurrency",
-        description: "Returns a raw array containing those with the most of the specified currency. Items in the array contain 'place', 'username' and 'amount' properties",
+        description: "Returns a raw array containing those with the most of the specified currency. Items in the array contain `place`, `username` and `amount` properties.",
         usage: "rawTopCurrency[currencyName]",
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY]
     },
 
     // eslint-disable-next-line @typescript-eslint/no-inferrable-types

src/backend/variables/builtin/metadata/arg-array-raw.ts

@@ -13,7 +13,8 @@ const model : ReplaceVariable = {
         description: "(Deprecated: use $argArray) Returns the raw array of command arguments",
         triggers: triggers,
         categories: [VariableCategory.ADVANCED],
-        possibleDataOutput: [OutputDataType.ARRAY]
+        possibleDataOutput: [OutputDataType.ARRAY],
+        hidden: true
     },
     evaluator: (trigger: Trigger) : string[] => {
         return trigger.metadata.userCommand ? trigger.metadata.userCommand.args : [];

src/backend/variables/builtin/metadata/top-metadata-raw.ts

@@ -6,9 +6,9 @@ import viewerMetadataManager from "../../../viewers/viewer-metadata-manager";
 const model : ReplaceVariable = {
     definition: {
         handle: "rawTopMetadata",
-        description: "Returns a raw array of users with the most of a given metadata key. Items contain 'username', 'place' and 'amount' properties",
+        description: "Returns a raw array of users with the most of a given metadata key. Items contain `username`, `place` and `amount` properties.",
         usage: "rawTopMetadata[metadataKey]",
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY, OutputDataType.TEXT]
     },
 
     // eslint-disable-next-line @typescript-eslint/no-inferrable-types

src/backend/variables/builtin/misc/quote-as-raw-object.ts

@@ -25,7 +25,8 @@ const model : ReplaceVariable = {
             }
         ],
         categories: [VariableCategory.TEXT],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.TEXT],
+        hidden: true
     },
     evaluator: async (_, quoteId: number, property) => {
         const quoteCommand = commandManager.getSystemCommandById("firebot:quotesmanagement");

src/backend/variables/builtin/misc/top-view-time-raw.ts

@@ -6,9 +6,9 @@ import viewerOnlineStatusManager from "../../../viewers/viewer-online-status-man
 const model : ReplaceVariable = {
     definition: {
         handle: "rawTopViewTime",
-        description: "Returns a raw array containing users with the most view time(in hours). Items contain 'username', 'place' and 'minutes' properties",
+        description: "Returns a raw array containing users with the most view time (in hours). Items contain `username`, 'place` and `minutes` properties.",
         usage: "rawTopViewTime[count]",
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY]
     },
 
     // eslint-disable-next-line @typescript-eslint/no-inferrable-types

src/backend/variables/builtin/twitch/cheer/bits-leaderboard-raw.ts

@@ -6,7 +6,7 @@ import bitsLeaderboard from './bits-leaderboard';
 const model : ReplaceVariable = {
     definition: {
         handle: "rawBitsLeaderboard",
-        description: "(Deprecated: use $bitsLoaderboard) Returns a raw array of the all-time bits leaderboard of the streamer's channel, up to the specified count. Each item in the array has a `username` and `amount` property",
+        description: "(Deprecated: use $bitsLeaderboard) Returns a raw array of the all-time bits leaderboard of the streamer's channel, up to the specified count. Each item in the array has a `username` and `amount` property",
         usage: "rawBitsLeaderboard[count]",
         examples: [
             {
@@ -19,7 +19,8 @@ const model : ReplaceVariable = {
             }
         ],
         categories: [VariableCategory.COMMON, VariableCategory.ADVANCED],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY],
+        hidden: true
     },
     evaluator: bitsLeaderboard.evaluator,
     argsCheck: bitsLeaderboard.argsCheck

src/backend/variables/builtin/twitch/cheer/bits-leaderboard.ts

@@ -23,7 +23,7 @@ const model : ReplaceVariable = {
             }
         ],
         categories: [VariableCategory.COMMON, VariableCategory.ADVANCED],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY]
     },
     argsCheck: (
         count: null | number = 1,

src/backend/variables/builtin/twitch/cheer/bits-top-cheerers-raw.ts

@@ -22,7 +22,8 @@ const model : ReplaceVariable = {
             }
         ],
         categories: [VariableCategory.COMMON, VariableCategory.USER],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY],
+        hidden: true
     },
     argsCheck: topBitsCheerers.argsCheck,
     evaluator: topBitsCheerers.evaluator

src/backend/variables/builtin/twitch/cheer/bits-top-cheerers.ts

@@ -24,7 +24,7 @@ const model : ReplaceVariable = {
             }
         ],
         categories: [VariableCategory.COMMON, VariableCategory.USER],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY]
     },
     argsCheck: (count: null | number = 1, period: null | string = "all", startDate = null) => {
         if (count == null && period == null && startDate == null) {

src/backend/variables/builtin/twitch/subs/gift-receivers-raw.ts

@@ -12,7 +12,7 @@ const model : ReplaceVariable = {
         description: "Returns a raw array containing the recipients' usernames and months subbed",
         triggers: triggers,
         categories: [VariableCategory.COMMON, VariableCategory.USER, VariableCategory.TRIGGER],
-        possibleDataOutput: [OutputDataType.ALL]
+        possibleDataOutput: [OutputDataType.ARRAY, OutputDataType.TEXT]
     },
     evaluator: (trigger) => {
         if (trigger == null || trigger.metadata == null || trigger.metadata.eventData == null || trigger.metadata.eventData.giftReceivers == null) {

src/backend/variables/builtin/twitch/subs/sub-users.ts

@@ -8,15 +8,15 @@ const logger = require("../../../../logwrapper");
 const model : ReplaceVariable = {
     definition: {
         handle: "subNames",
-        description: "Returns an array of subscriptions you currently have. Items contain 'username', 'tier' and 'isGift' properties",
+        description: "Returns an array of subscribers you currently have. Items contain `username`, `tier` and `isGift` properties.",
         usage: "subNames",
         examples: [
             {
                 usage: "subNames",
-                description: 'Returns: [{username: "firebottle", displayname: "FireBottle", tier: 2000, isGift:false}, {username: "ebiggz", displayname: "EBiggz", tier: 1000, isGift:true}] To be used with array or custom variables'
+                description: 'Returns: [{username: "firebottle", displayname: "FireBottle", tier: 2000, isGift:false}, {username: "ebiggz", displayname: "EBiggz", tier: 1000, isGift:true}] To be used with array or custom variables.'
             }
         ],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY]
     },
     evaluator: async () => {
         const { streamer } = accountAccess.getAccounts();

src/backend/variables/builtin/user/roles/custom-role-users-raw.ts

@@ -9,7 +9,8 @@ const model : ReplaceVariable = {
         usage: "rawCustomRoleUsers[role]",
         description: "(Deprecated: use $customRoleUsers) Returns an array of all the users in the specified custom role.",
         categories: [VariableCategory.USER],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY],
+        hidden: true
     },
     evaluator: customRoleUsers.evaluator
 };

src/backend/variables/builtin/user/roles/random-custom-role-user-raw.ts

@@ -8,7 +8,7 @@ const model : ReplaceVariable = {
     definition: {
         handle: "rawRandomCustomRoleUser",
         usage: "rawRandomCustomRoleUser[role]",
-        description: "Returns a random user that has the specified custom role as an object containing `id`, `username`, and `displayName` fields.",
+        description: "Returns a random user that has the specified custom role as an object containing `id`, `username`, and `displayName` properties.",
         categories: [VariableCategory.USER],
         possibleDataOutput: [OutputDataType.OBJECT]
     },

src/backend/variables/builtin/user/roles/user-roles-raw.ts

@@ -40,7 +40,8 @@ const model : ReplaceVariable = {
             }
         ],
         categories: [VariableCategory.COMMON, VariableCategory.USER],
-        possibleDataOutput: [OutputDataType.ALL]
+        possibleDataOutput: [OutputDataType.ARRAY],
+        hidden: true
     },
     evaluator: userRoles.evaluator
 };

src/backend/variables/builtin/user/roles/user-roles.ts

@@ -40,7 +40,7 @@ const model : ReplaceVariable = {
             }
         ],
         categories: [VariableCategory.COMMON, VariableCategory.USER],
-        possibleDataOutput: [OutputDataType.ALL]
+        possibleDataOutput: [OutputDataType.ARRAY]
     },
     evaluator: async (trigger, username: null | string, roleType) : Promise<unknown[]> => {
         if (username == null && roleType == null) {

src/backend/variables/builtin/user/user-id-name.ts

@@ -18,7 +18,8 @@ const model : ReplaceVariable = {
         handle: "useridname",
         description: "(Deprecated: Use $user or $username) The associated underlying user identifying name for the given trigger.",
         triggers: triggers,
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.TEXT],
+        hidden: true
     },
     evaluator: user.evaluator
 };

src/backend/variables/builtin/user/username-array-raw.ts

@@ -8,7 +8,8 @@ const model : ReplaceVariable = {
         handle: "rawUsernameArray",
         description: "(Deprecated: use $usernameArray) Returns a raw array of all usernames saved in the user db",
         categories: [VariableCategory.ADVANCED],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY],
+        hidden: true
     },
     evaluator: usernameArray.evaluator
 };

src/backend/variables/builtin/user/username-array.ts

@@ -8,7 +8,7 @@ const model : ReplaceVariable = {
         handle: "usernameArray",
         description: "Returns an array of all usernames saved in the user db",
         categories: [VariableCategory.ADVANCED],
-        possibleDataOutput: [OutputDataType.TEXT]
+        possibleDataOutput: [OutputDataType.ARRAY]
     },
     evaluator: async () => {
         const usernames = await viewerDatabase.getAllUsernames();