feat: variable examples and description changes (#2908)

Co-authored-by: Erik Bigler <erikbigler@gmail.com>

src/backend/integrations/builtin/extralife/variables/extralife-donations.ts

@@ -33,7 +33,7 @@ const ExtraLifeDonations: ReplaceVariable = {
                 description: "Returns top 3 donations for current signed in extra life account in JSON format."
             }
         ],
-        categories: [VariableCategory.COMMON, VariableCategory.TRIGGER],
+        categories: [VariableCategory.COMMON, VariableCategory.INTEGRATION],
         possibleDataOutput: [OutputDataType.TEXT]
     },
     evaluator: (_, sortName: string, numResults: number, participantID: number, returnJson: boolean) => {

src/backend/integrations/builtin/extralife/variables/extralife-incentives.ts

@@ -29,7 +29,7 @@ const ExtraLifeIncentives: ReplaceVariable = {
                 description: "Returns ten incentives for current logged in extra life account in JSON format."
             }
         ],
-        categories: [VariableCategory.COMMON, VariableCategory.TRIGGER],
+        categories: [VariableCategory.COMMON, VariableCategory.INTEGRATION],
         possibleDataOutput: [OutputDataType.TEXT]
     },
     evaluator: async (_, rewardDesc: string, numResults: number, participantID: number, returnJson: boolean) => {

src/backend/integrations/builtin/extralife/variables/extralife-info.ts

@@ -57,7 +57,7 @@ const ExtraLifeInfo: ReplaceVariable = {
                 description: "Get all profile data for the current logged in extra life account in JSON format."
             }
         ],
-        categories: [VariableCategory.COMMON, VariableCategory.TRIGGER],
+        categories: [VariableCategory.COMMON, VariableCategory.INTEGRATION],
         possibleDataOutput: [OutputDataType.TEXT]
     },
     evaluator: (_, infoPath: string, participantID: number, returnJson: boolean) => {

src/backend/integrations/builtin/extralife/variables/extralife-milestones.ts

@@ -29,7 +29,7 @@ const ExtraLifeMilestones: ReplaceVariable = {
                 description: "Returns three milestones in JSON format."
             }
         ],
-        categories: [VariableCategory.COMMON, VariableCategory.TRIGGER],
+        categories: [VariableCategory.COMMON, VariableCategory.INTEGRATION],
         possibleDataOutput: [OutputDataType.TEXT]
     },
     evaluator: async (_, milestoneGoal: string, numResults: number, participantID: number, returnJson: boolean) => {

src/backend/integrations/builtin/obs/variables/group-item-id.ts

@@ -1,6 +1,7 @@
 import { TriggerType } from "../../../../common/EffectType";
 import { ReplaceVariable } from "../../../../../types/variables";
 import { OBS_EVENT_SOURCE_ID, OBS_SCENE_ITEM_ENABLE_STATE_CHANGED_EVENT_ID } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -14,6 +15,7 @@ export const GroupItemIdVariable: ReplaceVariable = {
         description:
             "The group-unique numeric ID of the item in OBS that triggered the event, or -1 when the item is not grouped.",
         possibleDataOutput: ["number"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS],
         triggers: triggers
     },
     evaluator: async (trigger) => {

src/backend/integrations/builtin/obs/variables/group-name.ts

@@ -1,6 +1,7 @@
 import { TriggerType } from "../../../../common/EffectType";
 import { ReplaceVariable } from "../../../../../types/variables";
 import { OBS_EVENT_SOURCE_ID, OBS_SCENE_ITEM_ENABLE_STATE_CHANGED_EVENT_ID } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -14,6 +15,7 @@ export const GroupNameVariable: ReplaceVariable = {
         description:
             "The name of the OBS group containing the item that triggered the event, or 'Unknown' if the element isn't grouped.",
         possibleDataOutput: ["text"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS],
         triggers: triggers
     },
     evaluator: async (trigger) => {

src/backend/integrations/builtin/obs/variables/input-active.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_ACTIVE_STATE_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,7 +16,8 @@ export const InputActiveVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputActive",
         description: "Returns `true` if the OBS input is active or `false` if it is not.",
-        possibleDataOutput: ["bool"]
+        possibleDataOutput: ["bool"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputActive = trigger.metadata?.eventData?.inputActive;

src/backend/integrations/builtin/obs/variables/input-audio-balance.ts

@@ -4,7 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_AUDIO_BALANCE_CHANGED_EVENT_ID
 } from "../constants";
-
+import { VariableCategory } from "../../../../../shared/variable-constants";
 const triggers = {};
 triggers[TriggerType.EVENT] = [
     `${OBS_EVENT_SOURCE_ID}:${OBS_INPUT_AUDIO_BALANCE_CHANGED_EVENT_ID}`
@@ -15,7 +15,8 @@ export const InputAudioBalanceVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputAudioBalance",
         description: "Returns the audio balance value of the OBS input.",
-        possibleDataOutput: ["number"]
+        possibleDataOutput: ["number"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputAudioBalance = trigger.metadata?.eventData?.inputAudioBalance;

src/backend/integrations/builtin/obs/variables/input-audio-monitor-type.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_AUDIO_MONITOR_TYPE_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,7 +16,8 @@ export const InputAudioMonitorTypeVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputMonitorType",
         description: "Returns the audio monitor type of the OBS input. Values are `None`, `Monitor Only`, or `Monitor and Output`.",
-        possibleDataOutput: ["text"]
+        possibleDataOutput: ["text"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const monitorType = trigger.metadata?.eventData?.monitorType;

src/backend/integrations/builtin/obs/variables/input-audio-sync-offset.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_AUDIO_BALANCE_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,7 +16,8 @@ export const InputAudioSyncOffsetVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputAudioSyncOffset",
         description: "Returns the audio sync offset (in milliseconds) of the OBS input.",
-        possibleDataOutput: ["number"]
+        possibleDataOutput: ["number"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputAudioSyncOffset = trigger.metadata?.eventData?.inputAudioSyncOffset;

src/backend/integrations/builtin/obs/variables/input-audio-tracks.ts

@@ -4,7 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_AUDIO_TRACKS_CHANGED_EVENT_ID
 } from "../constants";
-
+import { VariableCategory } from "../../../../../shared/variable-constants";
 const triggers = {};
 triggers[TriggerType.EVENT] = [
     `${OBS_EVENT_SOURCE_ID}:${OBS_INPUT_AUDIO_TRACKS_CHANGED_EVENT_ID}`
@@ -15,7 +15,8 @@ export const InputAudioTracksVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputAudioTracks",
         description: "Returns the raw OBS audio tracks object of the OBS input.",
-        possibleDataOutput: ["object"]
+        possibleDataOutput: ["object"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputAudioTracks = trigger.metadata?.eventData?.inputAudioTracks;

src/backend/integrations/builtin/obs/variables/input-kind.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_CREATED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,7 +16,8 @@ export const InputKindVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputKind",
         description: "Returns the OBS internal name of the kind of OBS input.",
-        possibleDataOutput: ["text"]
+        possibleDataOutput: ["text"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputKind = trigger.metadata?.eventData?.inputKind;

src/backend/integrations/builtin/obs/variables/input-muted.ts

@@ -4,7 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_MUTE_STATE_CHANGED_EVENT_ID
 } from "../constants";
-
+import { VariableCategory } from "../../../../../shared/variable-constants";
 const triggers = {};
 triggers[TriggerType.EVENT] = [
     `${OBS_EVENT_SOURCE_ID}:${OBS_INPUT_MUTE_STATE_CHANGED_EVENT_ID}`
@@ -15,7 +15,8 @@ export const InputMutedVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputMuted",
         description: "Returns `true` if the OBS input is muted or `false` if it is not.",
-        possibleDataOutput: ["bool"]
+        possibleDataOutput: ["bool"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputMuted = trigger.metadata?.eventData?.inputMuted;

src/backend/integrations/builtin/obs/variables/input-name.ts

@@ -15,6 +15,7 @@ import {
     OBS_INPUT_AUDIO_MONITOR_TYPE_CHANGED_EVENT_ID,
     OBS_INPUT_AUDIO_TRACKS_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -37,7 +38,8 @@ export const InputNameVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputName",
         description: "Returns the name of the OBS input.",
-        possibleDataOutput: ["text"]
+        possibleDataOutput: ["text"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputName = trigger.metadata?.eventData?.inputName;

src/backend/integrations/builtin/obs/variables/input-settings.ts

@@ -5,6 +5,7 @@ import {
     OBS_INPUT_CREATED_EVENT_ID,
     OBS_INPUT_SETTINGS_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -17,7 +18,8 @@ export const InputSettingsVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputSettings",
         description: "Returns the raw OBS settings object of the OBS input.",
-        possibleDataOutput: ["object"]
+        possibleDataOutput: ["object"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputSettings = trigger.metadata?.eventData?.inputSettings;

src/backend/integrations/builtin/obs/variables/input-showing.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_SHOW_STATE_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,7 +16,8 @@ export const InputShowingVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputShowing",
         description: "Returns `true` if the OBS input is currently showing or `false` if it is not.",
-        possibleDataOutput: ["bool"]
+        possibleDataOutput: ["bool"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputShowing = trigger.metadata?.eventData?.inputShowing;

src/backend/integrations/builtin/obs/variables/input-uuid.ts

@@ -15,6 +15,7 @@ import {
     OBS_INPUT_AUDIO_MONITOR_TYPE_CHANGED_EVENT_ID,
     OBS_INPUT_AUDIO_TRACKS_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -37,7 +38,8 @@ export const InputUuidVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputUuid",
         description: "Returns the UUID of the OBS input.",
-        possibleDataOutput: ["text"]
+        possibleDataOutput: ["text"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputUuid = trigger.metadata?.eventData?.inputUuid;

src/backend/integrations/builtin/obs/variables/input-volume-db.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_VOLUME_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,7 +16,8 @@ export const InputVolumeDbVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputVolumeDb",
         description: "Returns the volume level in dB of the OBS input.",
-        possibleDataOutput: ["number"]
+        possibleDataOutput: ["number"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputVolumeDb = trigger.metadata?.eventData?.inputVolumeDb;

src/backend/integrations/builtin/obs/variables/input-volume-multiplier.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_VOLUME_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,7 +16,8 @@ export const InputVolumeMultiplierVariable: ReplaceVariable = {
     definition: {
         handle: "obsInputVolumeMultiplier",
         description: "Returns the volume level multiplier of the OBS input.",
-        possibleDataOutput: ["number"]
+        possibleDataOutput: ["number"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async (trigger) => {
         const inputVolumeMultiplier = trigger.metadata?.eventData?.inputVolumeMultiplier;

src/backend/integrations/builtin/obs/variables/is-connected.ts

@@ -1,11 +1,13 @@
 import { ReplaceVariable } from "../../../../../types/variables";
 import { isConnected } from "../obs-remote";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 export const IsConnectedVariable: ReplaceVariable = {
     definition: {
         handle: "obsIsConnected",
         description: "Returns 'true' if OBS is currently connected or 'false' if it is not.",
-        possibleDataOutput: ["bool"]
+        possibleDataOutput: ["bool"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async () => {
         return isConnected() ?? false;

src/backend/integrations/builtin/obs/variables/is-recording.ts

@@ -1,12 +1,14 @@
 import { ReplaceVariable } from "../../../../../types/variables";
 import { isRecording } from "../obs-remote";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 export const IsRecordingVariable: ReplaceVariable = {
     definition: {
         handle: "obsIsRecording",
         description:
       "Returns 'true' if OBS is currently recording or 'false' if it is not.",
-        possibleDataOutput: ["bool"]
+        possibleDataOutput: ["bool"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async () => {
         const recordState = await isRecording();

src/backend/integrations/builtin/obs/variables/is-streaming.ts

@@ -1,12 +1,14 @@
 import { ReplaceVariable } from "../../../../../types/variables";
 import { isStreaming } from "../obs-remote";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 export const IsStreamingVariable: ReplaceVariable = {
     definition: {
         handle: "obsIsStreaming",
         description:
       "Returns 'true' if OBS is currently streaming or 'false' if it is not.",
-        possibleDataOutput: ["bool"]
+        possibleDataOutput: ["bool"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS]
     },
     evaluator: async () => {
         const streamState = await isStreaming();

src/backend/integrations/builtin/obs/variables/obs-color-value.ts

@@ -6,7 +6,7 @@ export const ColorValueVariable: ReplaceVariable = {
     definition: {
         handle: "obsColorValue",
         description: "Returns an OBS color value based on either a hex color code (e.g. #0066FF) or an HTML color name.",
-        categories: [VariableCategory.ADVANCED],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS],
         possibleDataOutput: ["number"]
     },
     evaluator: (_, ...args: string[]) => {

src/backend/integrations/builtin/obs/variables/old-input-name.ts

@@ -4,6 +4,7 @@ import {
     OBS_EVENT_SOURCE_ID,
     OBS_INPUT_NAME_CHANGED_EVENT_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -15,6 +16,7 @@ export const OldInputNameVariable: ReplaceVariable = {
     definition: {
         handle: "obsOldInputName",
         description: "Returns the previous name of the OBS input.",
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS],
         possibleDataOutput: ["text"]
     },
     evaluator: async (trigger) => {

src/backend/integrations/builtin/obs/variables/profile-name.ts

@@ -4,6 +4,7 @@ import {
     OBS_CURRENT_PROFILE_CHANGED_EVENT_ID,
     OBS_EVENT_SOURCE_ID
 } from "../constants";
+import { VariableCategory } from "../../../../../shared/variable-constants";
 
 const triggers = {};
 triggers[TriggerType.EVENT] = [
@@ -16,6 +17,7 @@ export const ProfileNameVariable: ReplaceVariable = {
         description:
       "The name of the OBS profile that triggered the event.",
         possibleDataOutput: ["text"],
+        categories: [VariableCategory.ADVANCED, VariableCategory.INTEGRATION, VariableCategory.OBS],
         triggers: triggers
     },
     evaluator: async (trigger) => {