@lumiastream/lumia-types 2.1.17 → 2.2.0-beta.2

package/dist/activity.types.d.ts

@@ -118,189 +118,390 @@ export declare enum LumiaExternalActivityCommandTypes {
     CHATBOT_MESSAGE = "chatbot-messsage",
     TTS = "tts"
 }
+/**
+ * Comprehensive enum of all Lumia alert types.
+ * Used to identify specific events in AlertEvent.alert field.
+ */
 export declare enum LumiaAlertValues {
+    /** Lumia Stream donation received */
     LUMIASTREAM_DONATION = "lumiastream-donation",
+    /** Lumia application opened */
     LUMIASTREAM_LUMIA_OPENED = "lumiastream-lumiaOpened",
+    /** Lumia application closed */
     LUMIASTREAM_LUMIA_CLOSED = "lumiastream-lumiaClosed",
+    /** Stream mode activated */
     LUMIASTREAM_STREAMMODE_ON = "lumiastream-streammodeOn",
+    /** Stream mode deactivated */
     LUMIASTREAM_STREAMMODE_OFF = "lumiastream-streammodeOff",
+    /** Raffle started */
     LUMIASTREAM_RAFFLE_START = "lumiastream-raffleStart",
+    /** Raffle stopped */
     LUMIASTREAM_RAFFLE_STOP = "lumiastream-raffleStop",
+    /** Raffle winner selected */
     LUMIASTREAM_RAFFLE_WINNER = "lumiastream-raffleWinner",
+    /** Spin wheel winner selected */
     LUMIASTREAM_SPINWHEEL_WINNER = "lumiastream-spinwheelWinner",
+    /** Poll started */
     LUMIASTREAM_POLL_STARTED = "lumiastream-pollStarted",
+    /** Poll progress update */
     LUMIASTREAM_POLL_PROGRESSED = "lumiastream-pollProgressed",
+    /** Poll ended */
     LUMIASTREAM_POLL_ENDED = "lumiastream-pollEnded",
+    /** Viewer queue started */
     LUMIASTREAM_VIEWERQUEUE_STARTED = "lumiastream-viewerqueueStarted",
+    /** Viewer queue ended */
     LUMIASTREAM_VIEWERQUEUE_ENDED = "lumiastream-viewerqueueEnded",
+    /** Roulette winner selected */
     LUMIASTREAM_ROULETTE_WINNER = "lumiastream-rouletteWinner",
+    /** Slots winner */
     LUMIASTREAM_SLOTS_WINNER = "lumiastream-slotsWinner",
+    /** Twitch extension interaction */
     TWITCH_EXTENSION = "twitch-extension",
+    /** Twitch channel points redemption */
     TWITCH_POINTS = "twitch-points",
+    /** Twitch stream went live */
     TWITCH_STREAM_LIVE = "twitch-streamLive",
+    /** Twitch stream went offline */
     TWITCH_STREAM_OFFLINE = "twitch-streamOffline",
+    /** First chat message in stream */
     TWITCH_FIRST_CHATTER = "twitch-firstChatter",
+    /** User entered the stream */
     TWITCH_ENTRANCE = "twitch-entrance",
+    /** New follower */
     TWITCH_FOLLOWER = "twitch-follower",
+    /** Total Session followers count */
+    TWITCH_SESSION_FOLLOWERS = "twitch-sessionFollowers",
+    /** New subscription */
     TWITCH_SUBSCRIBER = "twitch-subscriber",
+    /** Total Session subs count */
+    TWITCH_SESSION_SUBS = "twitch-sessionSubs",
+    /** Gift subscription given */
     TWITCH_GIFT_SUBSCRIPTION = "twitch-giftSubscription",
+    /** Total Session gifts count */
+    TWITCH_SESSION_GIFTS = "twitch-sessionGifts",
+    /** Incoming raid */
     TWITCH_RAID = "twitch-raid",
+    /** Outgoing raid */
     TWITCH_RAID_OUT = "twitch-raidOut",
+    /** Bits cheered */
     TWITCH_BITS = "twitch-bits",
+    /** Total Session bits count */
+    TWITCH_SESSION_BITS = "twitch-sessionBits",
+    /** Channel points redemption */
     TWITCH_REDEMPTION = "twitch-redemption",
+    /** Hype train started */
     TWITCH_HYPETRAIN_STARTED = "twitch-hypetrainStarted",
+    /** Hype train progress */
     TWITCH_HYPETRAIN_PROGRESSED = "twitch-hypetrainProgressed",
+    /** Hype train level increased */
     TWITCH_HYPETRAIN_LEVEL_PROGRESSED = "twitch-hypetrainLevelProgressed",
+    /** Hype train ended */
     TWITCH_HYPETRAIN_ENDED = "twitch-hypetrainEnded",
+    /** Poll started */
     TWITCH_POLL_STARTED = "twitch-pollStarted",
+    /** Poll progress update */
     TWITCH_POLL_PROGRESSED = "twitch-pollProgressed",
+    /** Poll ended */
     TWITCH_POLL_ENDED = "twitch-pollEnded",
+    /** Prediction started */
     TWITCH_PREDICTION_STARTED = "twitch-predictionStarted",
+    /** Prediction progress update */
     TWITCH_PREDICTION_PROGRESSED = "twitch-predictionProgressed",
+    /** Prediction locked */
     TWITCH_PREDICTION_LOCKED = "twitch-predictionLocked",
+    /** Prediction ended */
     TWITCH_PREDICTION_ENDED = "twitch-predictionEnded",
+    /** Goal started */
     TWITCH_GOAL_STARTED = "twitch-goalStarted",
+    /** Goal progress update */
     TWITCH_GOAL_PROGRESSED = "twitch-goalProgressed",
+    /** Goal completed */
     TWITCH_GOAL_ENDED = "twitch-goalEnded",
+    /** Charity donation */
     TWITCH_CHARITY_DONATION = "twitch-charityDonation",
+    /** Charity campaign started */
     TWITCH_CHARITY_CAMPAIGN_STARTED = "twitch-charityCampaignStarted",
+    /** Charity campaign progress */
     TWITCH_CHARITY_CAMPAIGN_PROGRESSED = "twitch-charityCampaignProgressed",
+    /** Charity campaign stopped */
     TWITCH_CHARITY_CAMPAIGN_STOPPED = "twitch-charityCampaignStopped",
+    /** Stream category changed */
     TWITCH_CATEGORY = "twitch-categoryChanged",
+    /** Clip created */
     TWITCH_CLIP = "twitch-clip",
+    /** User joined channel */
     TWITCH_CHANNEL_JOIN = "twitch-channelJoin",
+    /** User left channel */
     TWITCH_CHANNEL_LEAVE = "twitch-channelLeave",
+    /** User banned */
     TWITCH_BANNED = "twitch-banned",
+    /** User timed out */
     TWITCH_TIMEOUT = "twitch-timeout",
+    /** User timeout expired */
     TWITCH_TIMEOUT_OVER = "twitch-timeoutOver",
+    /** Shoutout received */
     TWITCH_SHOUTOUT_RECEIVE = "twitch-shoutoutReceive",
+    /** Ad break started */
     TWITCH_AD_STARTED = "twitch-adStarted",
+    /** Ad break ended */
     TWITCH_AD_STOPPED = "twitch-adStopped",
+    /** Power-ups used */
     TWITCH_POWERUPS = "twitch-powerups",
+    /** Power-up points earned */
     TWITCH_POWERUPS_POINTS = "twitch-powerups-points",
+    /** YouTube stream went live */
     YOUTUBE_STREAM_LIVE = "youtube-streamLive",
+    /** YouTube stream went offline */
     YOUTUBE_STREAM_OFFLINE = "youtube-streamOffline",
+    /** First YouTube chat message */
     YOUTUBE_FIRST_CHATTER = "youtube-firstChatter",
+    /** YouTube user entrance */
     YOUTUBE_ENTRANCE = "youtube-entrance",
+    /** YouTube channel membership */
     YOUTUBE_MEMBER = "youtube-member",
+    /** YouTube new subscriber */
     YOUTUBE_SUBSCRIBER = "youtube-subscriber",
+    /** YouTube Super Chat */
     YOUTUBE_SUPERCHAT = "youtube-superchat",
+    /** YouTube Super Sticker */
     YOUTUBE_SUPERSTICKER = "youtube-supersticker",
+    /** YouTube total likes */
     YOUTUBE_LIKE = "youtube-like",
+    /** YouTube total views */
     YOUTUBE_VIEWERS = "youtube-viewers",
+    /** Facebook stream went live */
     FACEBOOK_STREAM_LIVE = "facebook-streamLive",
+    /** Facebook stream went offline */
     FACEBOOK_STREAM_OFFLINE = "facebook-streamOffline",
+    /** First Facebook chat message */
     FACEBOOK_FIRST_CHATTER = "facebook-firstChatter",
+    /** Facebook user entrance */
     FACEBOOK_ENTRANCE = "facebook-entrance",
+    /** Facebook new follower */
     FACEBOOK_FOLLOWER = "facebook-follower",
+    /** Facebook reaction */
     FACEBOOK_REACTION = "facebook-reaction",
+    /** Facebook stars received */
     FACEBOOK_STAR = "facebook-star",
+    /** Facebook support */
     FACEBOOK_SUPPORT = "facebook-support",
+    /** Facebook gift subscription */
     FACEBOOK_GIFT_SUBSCRIPTION = "facebook-subscriptionGift",
+    /** Facebook share */
     FACEBOOK_SHARE = "facebook-share",
+    /** Facebook fan */
     FACEBOOK_FAN = "facebook-fan",
+    /** Trovo stream went live */
     TROVO_STREAM_LIVE = "trovo-streamLive",
+    /** Trovo stream went offline */
     TROVO_STREAM_OFFLINE = "trovo-streamOffline",
+    /** First Trovo chat message */
     TROVO_FIRST_CHATTER = "trovo-firstChatter",
+    /** Trovo user entrance */
     TROVO_ENTRANCE = "trovo-entrance",
+    /** Trovo channel join */
     TROVO_CHANNEL_JOIN = "trovo-channelJoin",
-    TROVO_SUBSCRIBER = "trovo-subscriber",// potential for Trovo, needs testing in POC
-    TROVO_FOLLOWER = "trovo-follower",// potential for Trovo, needs testing in POC
-    TROVO_SPELL = "trovo-spell",// potential for Trovo, needs testing in POC
+    /** Trovo subscriber (potential, needs testing) */
+    TROVO_SUBSCRIBER = "trovo-subscriber",
+    /** Trovo follower (potential, needs testing) */
+    TROVO_FOLLOWER = "trovo-follower",
+    /** Trovo spell cast (potential, needs testing) */
+    TROVO_SPELL = "trovo-spell",
+    /** Trovo gift subscription */
     TROVO_GIFT_SUBSCRIPTION = "trovo-giftSubscription",
+    /** Trovo raid */
     TROVO_RAID = "trovo-raid",
+    /** First TikTok chat message */
     TIKTOK_FIRST_CHATTER = "tiktok-firstChatter",
+    /** TikTok user entrance */
     TIKTOK_ENTRANCE = "tiktok-entrance",
+    /** TikTok new follower */
     TIKTOK_FOLLOWER = "tiktok-follower",
+    /** TikTok like received */
     TIKTOK_LIKE = "tiktok-like",
+    /** TikTok total likes */
     TIKTOK_TOTAL_LIKES = "tiktok-totalLikes",
+    /** TikTok gift received */
     TIKTOK_GIFT = "tiktok-gift",
+    /** TikTok new subscriber */
     TIKTOK_SUBSCRIBER = "tiktok-subscriber",
+    /** TikTok share */
     TIKTOK_SHARE = "tiktok-share",
+    /** TikTok stream ended */
     TIKTOK_STREAM_END = "tiktok-streamEnd",
+    /** New TikTok video posted */
     TIKTOK_NEW_VIDEO = "tiktok-newVideo",
+    /** Kick points earned */
     KICK_POINTS = "kick-points",
+    /** First Kick chat message */
     KICK_FIRST_CHATTER = "kick-firstChatter",
+    /** Kick user entrance */
     KICK_ENTRANCE = "kick-entrance",
+    /** Kick new follower */
     KICK_FOLLOWER = "kick-follower",
+    /** Total Session followers count */
+    KICK_SESSION_FOLLOWERS = "kick-sessionFollowers",
+    /** Kick new subscriber */
     KICK_SUBSCRIBER = "kick-subscriber",
+    /** Total Session subs count */
+    KICK_SESSION_SUBS = "kick-sessionSubs",
+    /** Kick gift subscription */
     KICK_GIFT_SUBSCRIPTION = "kick-subscriptionGift",
+    /** Total Session gifts count */
+    KICK_SESSION_GIFTS = "kick-sessionGifts",
+    /** Kick host */
     KICK_HOST = "kick-host",
+    /** Kick user banned */
     KICK_BANNED = "kick-banned",
+    /** Kick user unbanned */
     KICK_UNBANNED = "kick-unbanned",
+    /** First Discord message */
     DISCORD_FIRST_CHATTER = "discord-firstChatter",
+    /** Discord user entrance */
     DISCORD_ENTRANCE = "discord-entrance",
+    /** Streamlabs donation */
     STREAMLABS_DONATION = "streamlabs-donation",
+    /** Streamlabs charity donation */
     STREAMLABS_CHARITY = "streamlabs-charity",
+    /** Streamlabs merchandise purchase */
     STREAMLABS_MERCH = "streamlabs-merch",
+    /** Streamlabs redemption */
     STREAMLABS_REDEMPTION = "streamlabs-redemption",
+    /** Streamlabs Prime gift */
     STREAMLABS_PRIMEGIFT = "streamlabs-primegift",
+    /** StreamElements donation */
     STREAMELEMENTS_DONATION = "streamelements-donation",
+    /** Extra Life donation */
     EXTRALIFE_DONATION = "extralife-donation",
+    /** DonorDrive donation */
     DONORDRIVE_DONATION = "donordrive-donation",
+    /** Tiltify campaign donation */
     TILTIFY_DONATION = "tiltify-campaignDonation",
+    /** TipeeeStream donation */
     TIPEEESTREAM_DONATION = "tipeeestream-donation",
+    /** TreatStream treat */
     TREATSTREAM_TREAT = "treatstream-treat",
+    /** Patreon pledge */
     PATREON_PLEDGE = "patreon-campaignPledge",
+    /** Ko-fi donation */
+    KOFI_DONATION = "kofi-donation",
+    /** Ko-fi subscription */
+    KOFI_SUBSCRIPTION = "kofi-subscription",
+    /** Ko-fi commission */
+    KOFI_COMMISSION = "kofi-commission",
+    /** Ko-fi shop order */
+    KOFI_SHOPORDER = "kofi-shopOrder",
+    /** Fourthwall shop order */
+    FOURTHWALL_SHOPORDER = "fourthwall-shopOrder",
+    /** Fourthwall donation */
+    FOURTHWALL_DONATION = "fourthwall-donation",
+    /** Fourthwall subscription */
+    FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
+    /** Fourthwall gift purchase */
+    FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
+    /** Fourthwall giveaway started */
+    FOURTHWALL_GIVEAWAY_STARTED = "fourthwall-giveawayStarted",
+    /** Fourthwall giveaway ended */
+    FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
+    /** Fourthwall thank you sent */
+    FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
+    /** OBS profile switched */
     OBS_SWITCH_PROFILE = "obs-switchProfile",
+    /** OBS scene switched */
     OBS_SWITCH_SCENE = "obs-switchScene",
+    /** OBS scene item visibility changed */
     OBS_SCENE_ITEM_VISIBILITY = "obs-sceneItemVisibility",
+    /** OBS scene item hidden */
     OBS_SCENE_ITEM_HIDDEN = "obs-sceneItemHidden",
-    OBS_SWITCH_TRANSITION = "obs-switchTransition",
+    /** OBS transition switched */
+    OBS_SWITCH_TRANSITION = "obs-switch-transition",
+    /** OBS transition started */
     OBS_TRANSITION_BEGIN = "obs-transitionBegin",
+    /** OBS transition ended */
     OBS_TRANSITION_END = "obs-transitionEnd",
+    /** OBS stream starting */
     OBS_STREAM_STARTING = "obs-streamStarting",
+    /** OBS stream stopping */
     OBS_STREAM_STOPPING = "obs-streamStopping",
+    /** OBS recording starting */
     OBS_RECORDING_STARTING = "obs-recordingStarting",
+    /** OBS recording stopping */
     OBS_RECORDING_STOPPING = "obs-recordingStopping",
+    /** OBS replay buffer saved */
     OBS_REPLAY_BUFFER_SAVED = "obs-replayBufferSaved",
+    /** OBS vertical backtrack saved */
     OBS_VERTICAL_BACKTRACK_SAVED = "obs-verticalBacktrackSaved",
+    /** OBS vendor-specific event */
     OBS_VENDOR_EVENT = "obs-vendorEvent",
+    /** SLOBS scene collection switched */
     SLOBS_SWITCH_SCENE_COLLECTION = "slobs-switchSceneCollection",
+    /** SLOBS scene switched */
     SLOBS_SWITCH_SCENE = "slobs-switchScene",
+    /** SLOBS scene item visibility changed */
     SLOBS_SCENE_ITEM_VISIBILITY = "slobs-sceneItemVisibility",
+    /** SLOBS scene item hidden */
     SLOBS_SCENE_ITEM_HIDDEN = "slobs-sceneItemHidden",
+    /** Spotify song changed */
     SPOTIFY_SWITCH_SONG = "spotify-switchSong",
+    /** Spotify song started playing */
     SPOTIFY_SONG_PLAYED = "spotify-songPlayed",
+    /** Spotify song paused */
     SPOTIFY_SONG_PAUSED = "spotify-songPaused",
+    /** YouTube Music song changed */
     YOUTUBEMUSIC_SWITCH_SONG = "youtubemusic-switchSong",
+    /** YouTube Music song started playing */
     YOUTUBEMUSIC_SONG_PLAYED = "youtubemusic-songPlayed",
+    /** YouTube Music song paused */
     YOUTUBEMUSIC_SONG_PAUSED = "youtubemusic-songPaused",
+    /** Now Playing song changed */
     NOWPLAYING_SWITCH_SONG = "nowplaying-switchSong",
+    /** Now Playing song started */
     NOWPLAYING_SONG_PLAYED = "nowplaying-songPlayed",
+    /** Now Playing song paused */
     NOWPLAYING_SONG_PAUSED = "nowplaying-songPaused",
+    /** VLC song changed */
     VLC_SWITCH_SONG = "vlc-switchSong",
+    /** VLC song started playing */
     VLC_SONG_PLAYED = "vlc-songPlayed",
+    /** VLC song paused */
     VLC_SONG_PAUSED = "vlc-songPaused",
+    /** Heart rate update from Pulse */
     PULSE_HEARTRATE = "pulse-heartrate",
+    /** Calories burned update from Pulse */
     PULSE_CALORIES = "pulse-calories",
+    /** New Twitter/X follower */
     TWITTER_FOLLOWER = "twitter-follower",
+    /** Twitter/X like received */
     TWITTER_LIKE = "twitter-like",
+    /** Twitter/X retweet */
     TWITTER_RETWEET = "twitter-retweet",
+    /** WooCommerce order received */
     WOOCOMMERCE_ORDER = "woocommerce-order",
-    KOFI_DONATION = "kofi-donation",
-    KOFI_SUBSCRIPTION = "kofi-subscription",
-    KOFI_COMMISSION = "kofi-commission",
-    KOFI_SHOPORDER = "kofi-shopOrder",
+    /** Streamer.bot action executed */
     STREAMERBOT_ACTION = "streamerbot-action",
-    FOURTHWALL_SHOPORDER = "fourthwall-shopOrder",
-    FOURTHWALL_DONATION = "fourthwall-donation",
-    FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
-    FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
-    FOURTHWALL_GIVEAWAY_STARTED = "fourthwall-giveawayStarted",
-    FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
-    FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
+    /** Crowd Control effect triggered */
     CROWDCONTROL_EFFECT = "crowdcontrol-effect",
+    /** VTube Studio hotkey triggered */
     VTUBESTUDIO_HOTKEY_TRIGGERED = "vtubestudio-hotkeyTriggered",
+    /** VTube Studio model loaded */
     VTUBESTUDIO_MODEL_LOADED = "vtubestudio-modelLoaded",
+    /** VTube Studio animation started */
     VTUBESTUDIO_ANIMATION_START = "vtubestudio-animationStart",
+    /** VTube Studio animation ended */
     VTUBESTUDIO_ANIMATION_END = "vtubestudio-animationEnd",
+    /** VTube Studio item added */
     VTUBESTUDIO_ITEM_ADDED = "vtubestudio-itemAdded",
+    /** VTube Studio item removed */
     VTUBESTUDIO_ITEM_REMOVED = "vtubestudio-itemRemoved",
+    /** VTube Studio background changed */
     VTUBESTUDIO_BACKGROUND_CHANGED = "vtubestudio-backgroundChanged",
+    /** Meld stream starting */
     MELD_STREAM_STARTING = "meld-streamStarting",
+    /** Meld stream stopping */
     MELD_STREAM_STOPPING = "meld-streamStopping",
+    /** Meld recording starting */
     MELD_RECORDING_STARTING = "meld-recordingStarting",
+    /** Meld recording stopping */
     MELD_RECORDING_STOPPING = "meld-recordingStopping"
 }
 export declare const LumiaAlertFriendlyValues: {
@@ -327,11 +528,15 @@ export declare const LumiaAlertFriendlyValues: {
     "twitch-firstChatter": string;
     "twitch-entrance": string;
     "twitch-follower": string;
+    "twitch-sessionFollowers": string;
     "twitch-subscriber": string;
+    "twitch-sessionSubs": string;
     "twitch-giftSubscription": string;
+    "twitch-sessionGifts": string;
     "twitch-raid": string;
     "twitch-raidOut": string;
     "twitch-bits": string;
+    "twitch-sessionBits": string;
     "twitch-redemption": string;
     "twitch-hypetrainStarted": string;
     "twitch-hypetrainProgressed": string;
@@ -403,8 +608,11 @@ export declare const LumiaAlertFriendlyValues: {
     "kick-points": string;
     "kick-firstChatter": string;
     "kick-follower": string;
+    "kick-sessionFollowers": string;
     "kick-subscriber": string;
+    "kick-sessionSubs": string;
     "kick-subscriptionGift": string;
+    "kick-sessionGifts": string;
     "kick-host": string;
     "kick-banned": string;
     "kick-unbanned": string;
@@ -427,7 +635,7 @@ export declare const LumiaAlertFriendlyValues: {
     "obs-switchScene": string;
     "obs-sceneItemVisibility": string;
     "obs-sceneItemHidden": string;
-    "obs-switchTransition": string;
+    "obs-switch-transition": string;
     "obs-transitionBegin": string;
     "obs-transitionEnd": string;
     "obs-streamStarting": string;