@lumiastream/lumia-types 3.3.5 → 3.3.7-alpha.1

package/dist/songrequest.types.d.ts

@@ -0,0 +1,157 @@
+import { LumiaStreamingSites } from './activity.types';
+/** Lifecycle of a single song request. */
+export declare enum SongRequestStatus {
+    /** Awaiting moderator approval (only used when `config.approvalRequired`). */
+    PENDING = "pending",
+    /** Approved, waiting in the queue. */
+    QUEUED = "queued",
+    /** Currently playing. */
+    PLAYING = "playing",
+    /** Finished playing naturally. */
+    COMPLETED = "completed",
+    /** Rejected by streamer / mod before playing. */
+    DENIED = "denied",
+    /** Ended early (skip button or skip command). */
+    SKIPPED = "skipped"
+}
+/** Where a request entered the system. Used for analytics + permission checks. */
+export declare enum SongRequestSource {
+    /** Triggered by the `!sr` system chatbot command. */
+    CHAT_COMMAND = "chat",
+    /** Triggered by the ADD_SONG_REQUEST Lumia action (decks, automations, …). */
+    LUMIA_ACTION = "action",
+    /** Streamer added directly from the dashboard. */
+    STREAMER = "streamer",
+    /** Mod added directly from the modtool window. */
+    MOD = "mod"
+}
+/** Format of the user's submission, before resolution. */
+export declare enum SongRequestProvider {
+    /** YouTube watch URL or short URL. */
+    YOUTUBE = "youtube",
+    /** Spotify track URL — may be routed to Spotify queue or converted to YouTube. */
+    SPOTIFY = "spotify",
+    /** YouTube Music URL (less common; usually treated like YouTube). */
+    YOUTUBE_MUSIC = "youtubeMusic",
+    /** Free-text query that needs a search before it can play. */
+    TEXT = "text"
+}
+/** Where the resolved song actually plays once approved. */
+export declare enum SongRequestPlaybackTarget {
+    /** Hidden YT iframe inside the songrequest overlay module (default). */
+    OVERLAY = "overlay",
+    /** Streamer's Spotify Premium player via Spotify Web API queue. */
+    SPOTIFY = "spotify",
+    /** Streamer's YouTube Music player via YT Music queue. */
+    YOUTUBE_MUSIC = "youtubeMusic"
+}
+/** A single request item — one row in the queue / pending tray / history. */
+export interface SongRequestItem {
+    id: string;
+    status: SongRequestStatus;
+    source: SongRequestSource;
+    provider: SongRequestProvider;
+    /** Raw user input — the URL or text query they submitted. */
+    query: string;
+    resolvedUrl?: string;
+    /** YouTube video ID (resolved for both YOUTUBE and TEXT providers). */
+    videoId?: string;
+    /** Spotify track ID, when applicable. */
+    spotifyTrackId?: string;
+    title?: string;
+    artist?: string;
+    thumbnailUrl?: string;
+    durationSeconds?: number;
+    requesterUsername: string;
+    requesterPlatform?: LumiaStreamingSites;
+    requesterAvatar?: string;
+    approvedBy?: string;
+    approvedAt?: number;
+    deniedBy?: string;
+    deniedReason?: string;
+    /** Chosen at queue-entry time based on connected services + config. */
+    playbackTarget?: SongRequestPlaybackTarget;
+    createdAt: number;
+    startedAt?: number;
+    endedAt?: number;
+    tipAmount?: number;
+    tipCurrency?: string;
+}
+/**
+ * User-configurable settings for the song-request system. Lives in user
+ * settings (not in runtime state). Role gating for the `!sr` command piggybacks
+ * on the system command's own `userLevels` field — we deliberately do NOT
+ * duplicate it here.
+ */
+export interface SongRequestConfig {
+    enabled: boolean;
+    /** Trigger word for the system chatbot command. Default: `!sr`. */
+    triggerCommand: string;
+    cooldownPerUserSeconds: number;
+    cooldownGlobalSeconds: number;
+    maxRequestsPerUserInSession: number;
+    /** When true, requests land in `pending` until a mod / streamer approves. */
+    approvalRequired: boolean;
+    maxQueueSize: number;
+    maxSongDurationSeconds: number;
+    allowYouTubeUrls: boolean;
+    allowSpotifyUrls: boolean;
+    allowFreeTextSearch: boolean;
+    /** Required for free-text → YouTube Data API v3 search. */
+    youtubeApiKey?: string;
+    /**
+     * Where approved songs play. `'auto'` = use the streamer's connected music
+     * service (Spotify Premium > YT Music) when available, otherwise the overlay
+     * iframe. The other values force a single target regardless of connections.
+     */
+    preferredPlaybackTarget: 'auto' | SongRequestPlaybackTarget;
+    announceInChat: boolean;
+    chatTemplateAdded: string;
+    chatTemplateNowPlaying: string;
+    chatTemplateDenied: string;
+    /** Used for dedup / cooldown / queue-full / disallowed-source rejections. */
+    chatTemplateRejected: string;
+}
+/** Runtime queue state. Lives in the LumiaStream Redux slice; the dashboard
+ *  widgets and the overlay module consume slices of this shape. */
+export interface SongRequestState {
+    /** Awaiting moderator approval (empty when `approvalRequired: false`). */
+    pending: SongRequestItem[];
+    /** Approved, waiting to play. Index 0 plays next. */
+    queue: SongRequestItem[];
+    /** Currently playing item, if any. */
+    nowPlaying: SongRequestItem | null;
+    /** Recently completed / skipped / denied items, newest first. Capped. */
+    history: SongRequestItem[];
+}
+/** Fired whenever the active queue or now-playing changes. */
+export interface SongRequestQueueUpdatePayload {
+    queue: SongRequestItem[];
+    nowPlaying: SongRequestItem | null;
+}
+/** Fired whenever the pending tray changes (drives the moderation widget). */
+export interface SongRequestPendingUpdatePayload {
+    pending: SongRequestItem[];
+}
+/** Lighter-weight ping when only nowPlaying changed (e.g., natural advance). */
+export interface SongRequestNowPlayingPayload {
+    nowPlaying: SongRequestItem | null;
+}
+export interface SongRequestAddParams {
+    /** Raw input — URL or free text. The parser resolves it. */
+    query: string;
+    requesterUsername?: string;
+    requesterPlatform?: LumiaStreamingSites;
+    /** Defaults to `LUMIA_ACTION` when omitted (matches the action call site). */
+    source?: SongRequestSource;
+    /**
+     * Streamer / mod additions can skip the pending state. Chat-command
+     * additions ignore this flag — chat is always subject to `approvalRequired`.
+     */
+    forceApprove?: boolean;
+}
+export interface SongRequestModerationParams {
+    id: string;
+    /** Optional reason for deny actions (surfaced in chat / mod log). */
+    reason?: string;
+}

package/dist/songrequest.types.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SongRequestPlaybackTarget = exports.SongRequestProvider = exports.SongRequestSource = exports.SongRequestStatus = void 0;
+// ---------------------------------------------------------------------------
+// Song Request — shared types for the native LumiaStream song-request system.
+//
+// Used by:
+//   - LumiaStream renderer (queue manager, system chatbot command, Lumia
+//     action handler, dashboard page + widgets)
+//   - Overlay-UI `songrequest` module (now-playing card + queue list + skip/
+//     pause UI; consumes SongRequestQueueUpdatePayload via SSE)
+//   - Lumia-UI `se-import` (`mapMediaShare` translates SE's
+//     `se-widget-media-share` widget into a Lumia `songrequest` module)
+//
+// Architecture summary (so this file's shape is legible standalone):
+//   1. Viewers submit via `!sr <youtube-url|spotify-url|free text>` chat
+//      command. Streamer / mods can also add via the dashboard UI or via the
+//      ADD_SONG_REQUEST Lumia action.
+//   2. Submission lands in `pending` for moderator approval (default) or
+//      jumps directly to `queue` when `forceApprove: true` (streamer / mod
+//      additions) or when `config.approvalRequired: false`.
+//   3. Approved items get a `playbackTarget` chosen at queue time:
+//        - `OVERLAY` (default): hidden YT iframe inside the songrequest
+//          overlay module
+//        - `SPOTIFY`: routed to streamer's Spotify Premium queue via
+//          spotify.manager.SearchAndAddToQueue (already implemented)
+//        - `YOUTUBE_MUSIC`: routed to streamer's YT Music queue (handler
+//          to be added in Phase E)
+//   4. Items move queue → nowPlaying → history (capped) as they play out.
+// ---------------------------------------------------------------------------
+/** Lifecycle of a single song request. */
+var SongRequestStatus;
+(function (SongRequestStatus) {
+    /** Awaiting moderator approval (only used when `config.approvalRequired`). */
+    SongRequestStatus["PENDING"] = "pending";
+    /** Approved, waiting in the queue. */
+    SongRequestStatus["QUEUED"] = "queued";
+    /** Currently playing. */
+    SongRequestStatus["PLAYING"] = "playing";
+    /** Finished playing naturally. */
+    SongRequestStatus["COMPLETED"] = "completed";
+    /** Rejected by streamer / mod before playing. */
+    SongRequestStatus["DENIED"] = "denied";
+    /** Ended early (skip button or skip command). */
+    SongRequestStatus["SKIPPED"] = "skipped";
+})(SongRequestStatus || (exports.SongRequestStatus = SongRequestStatus = {}));
+/** Where a request entered the system. Used for analytics + permission checks. */
+var SongRequestSource;
+(function (SongRequestSource) {
+    /** Triggered by the `!sr` system chatbot command. */
+    SongRequestSource["CHAT_COMMAND"] = "chat";
+    /** Triggered by the ADD_SONG_REQUEST Lumia action (decks, automations, …). */
+    SongRequestSource["LUMIA_ACTION"] = "action";
+    /** Streamer added directly from the dashboard. */
+    SongRequestSource["STREAMER"] = "streamer";
+    /** Mod added directly from the modtool window. */
+    SongRequestSource["MOD"] = "mod";
+})(SongRequestSource || (exports.SongRequestSource = SongRequestSource = {}));
+/** Format of the user's submission, before resolution. */
+var SongRequestProvider;
+(function (SongRequestProvider) {
+    /** YouTube watch URL or short URL. */
+    SongRequestProvider["YOUTUBE"] = "youtube";
+    /** Spotify track URL — may be routed to Spotify queue or converted to YouTube. */
+    SongRequestProvider["SPOTIFY"] = "spotify";
+    /** YouTube Music URL (less common; usually treated like YouTube). */
+    SongRequestProvider["YOUTUBE_MUSIC"] = "youtubeMusic";
+    /** Free-text query that needs a search before it can play. */
+    SongRequestProvider["TEXT"] = "text";
+})(SongRequestProvider || (exports.SongRequestProvider = SongRequestProvider = {}));
+/** Where the resolved song actually plays once approved. */
+var SongRequestPlaybackTarget;
+(function (SongRequestPlaybackTarget) {
+    /** Hidden YT iframe inside the songrequest overlay module (default). */
+    SongRequestPlaybackTarget["OVERLAY"] = "overlay";
+    /** Streamer's Spotify Premium player via Spotify Web API queue. */
+    SongRequestPlaybackTarget["SPOTIFY"] = "spotify";
+    /** Streamer's YouTube Music player via YT Music queue. */
+    SongRequestPlaybackTarget["YOUTUBE_MUSIC"] = "youtubeMusic";
+})(SongRequestPlaybackTarget || (exports.SongRequestPlaybackTarget = SongRequestPlaybackTarget = {}));

package/dist/variables.types.d.ts

@@ -158,6 +158,30 @@ export declare enum SystemVariables {
     SESSION_DONATOR_LIST_WITH_AMOUNT = "session_donator_list_with_amount",
     /** Raw donation total ignoring currency. Use as {{total_raw_donation_amount}}. */
     TOTAL_RAW_DONATION_AMOUNT = "total_raw_donation_amount",
+    /** Donation sum for the current calendar week. Use as {{week_donation_amount}}. */
+    WEEK_DONATION_AMOUNT = "week_donation_amount",
+    /** Donation sum for the current calendar month. Use as {{month_donation_amount}}. */
+    MONTH_DONATION_AMOUNT = "month_donation_amount",
+    /** Donation event count for the current calendar week. Use as {{week_donation_count}}. */
+    WEEK_DONATION_COUNT = "week_donation_count",
+    /** Donation event count for the current calendar month. Use as {{month_donation_count}}. */
+    MONTH_DONATION_COUNT = "month_donation_count",
+    /** Top donator for the current calendar week. Use as {{week_top_donator}}. */
+    WEEK_TOP_DONATOR = "week_top_donator",
+    /** Amount for WEEK_TOP_DONATOR. Use as {{week_top_donator_amount}}. */
+    WEEK_TOP_DONATOR_AMOUNT = "week_top_donator_amount",
+    /** Top donators this week (top 10, comma-separated usernames). Use as {{week_top_donator_list}}. */
+    WEEK_TOP_DONATOR_LIST = "week_top_donator_list",
+    /** Amounts for WEEK_TOP_DONATOR_LIST (parallel comma-separated). Use as {{week_top_donator_list_amount}}. */
+    WEEK_TOP_DONATOR_LIST_AMOUNT = "week_top_donator_list_amount",
+    /** Top donator for the current calendar month. Use as {{month_top_donator}}. */
+    MONTH_TOP_DONATOR = "month_top_donator",
+    /** Amount for MONTH_TOP_DONATOR. Use as {{month_top_donator_amount}}. */
+    MONTH_TOP_DONATOR_AMOUNT = "month_top_donator_amount",
+    /** Top donators this month. Use as {{month_top_donator_list}}. */
+    MONTH_TOP_DONATOR_LIST = "month_top_donator_list",
+    /** Amounts for MONTH_TOP_DONATOR_LIST. Use as {{month_top_donator_list_amount}}. */
+    MONTH_TOP_DONATOR_LIST_AMOUNT = "month_top_donator_list_amount",
     /** Raffle title. Use as {{raffle_title}}. */
     RAFFLE_TITLE = "raffle_title",
     /** Raffle description. Use as {{raffle_description}}. */
@@ -246,14 +270,32 @@ export declare enum SystemVariables {
     TWITCH_CURRENT_FOLLOWERS = "twitch_current_followers",
     /** Session followers count. Use as {{twitch_session_follower_count}}. */
     TWITCH_SESSION_FOLLOWER_COUNT = "twitch_session_follower_count",
+    /** Followers for the current calendar week. Use as {{twitch_week_follower_count}}. */
+    TWITCH_WEEK_FOLLOWER_COUNT = "twitch_week_follower_count",
+    /** Followers for the current calendar month. Use as {{twitch_month_follower_count}}. */
+    TWITCH_MONTH_FOLLOWER_COUNT = "twitch_month_follower_count",
     /** Current subscribers (comma-separated). Use as {{twitch_current_subscribers}}. */
     TWITCH_CURRENT_SUBSCRIBERS = "twitch_current_subscribers",
     /** Lifetime total subs. Use as {{twitch_total_subscriber_count}}. */
     TWITCH_TOTAL_SUBSCRIBER_COUNT = "twitch_total_subscriber_count",
     /** Session subs count. Use as {{twitch_session_subscribers_count}}. */
     TWITCH_SESSION_SUBSCRIBERS_COUNT = "twitch_session_subscribers_count",
+    /** Session NEW subscribers (excluding resubs / gifts). Use as {{twitch_session_new_subscribers_count}}. */
+    TWITCH_SESSION_NEW_SUBSCRIBERS_COUNT = "twitch_session_new_subscribers_count",
+    /** Session resubscribers (excluding new / gifts). Use as {{twitch_session_resub_subscribers_count}}. */
+    TWITCH_SESSION_RESUB_SUBSCRIBERS_COUNT = "twitch_session_resub_subscribers_count",
+    /** Session gifted subscribers. Use as {{twitch_session_gifted_subscribers_count}}. */
+    TWITCH_SESSION_GIFTED_SUBSCRIBERS_COUNT = "twitch_session_gifted_subscribers_count",
+    /** Subscribers for the current calendar week. Use as {{twitch_week_subscriber_count}}. */
+    TWITCH_WEEK_SUBSCRIBER_COUNT = "twitch_week_subscriber_count",
+    /** Subscribers for the current calendar month. Use as {{twitch_month_subscriber_count}}. */
+    TWITCH_MONTH_SUBSCRIBER_COUNT = "twitch_month_subscriber_count",
     /** Session gifts count. Use as {{twitch_session_gifts_count}}. */
     TWITCH_SESSION_GIFTS_COUNT = "twitch_session_gifts_count",
+    /** All-time top gifter. Use as {{twitch_alltime_top_gifter}}. */
+    TWITCH_ALLTIME_TOP_GIFTER = "twitch_alltime_top_gifter",
+    /** Lifetime gift count for TWITCH_ALLTIME_TOP_GIFTER. Use as {{twitch_alltime_top_gifter_amount}}. */
+    TWITCH_ALLTIME_TOP_GIFTER_AMOUNT = "twitch_alltime_top_gifter_amount",
     /** Lifetime gift members count. Use as {{twitch_total_gift_subscription_count}}. */
     TWITCH_TOTAL_GIFT_SUBSCRIPTION_COUNT = "twitch_total_gift_subscription_count",
     /** Current moderators (comma-separated). Use as {{twitch_current_mods}}. */
@@ -292,6 +334,10 @@ export declare enum SystemVariables {
     TWITCH_TOTAL_BITS_COUNT = "twitch_total_bits_count",
     /** Session bits count. Use as {{twitch_session_bits_count}}. */
     TWITCH_SESSION_BITS_COUNT = "twitch_session_bits_count",
+    /** Bits for the current calendar week. Use as {{twitch_week_bits_count}}. */
+    TWITCH_WEEK_BITS_COUNT = "twitch_week_bits_count",
+    /** Bits for the current calendar month. Use as {{twitch_month_bits_count}}. */
+    TWITCH_MONTH_BITS_COUNT = "twitch_month_bits_count",
     /** Last bit sender. Use as {{twitch_last_bit}}. */
     TWITCH_LAST_BIT = "twitch_last_bit",
     /** Last bit amount. Use as {{twitch_last_bit_amount}}. */
@@ -300,6 +346,64 @@ export declare enum SystemVariables {
     TWITCH_SESSION_BITS = "twitch_session_bits",
     /** Session bits with amounts list. Use as {{twitch_session_bits_with_amount}}. */
     TWITCH_SESSION_BITS_WITH_AMOUNT = "twitch_session_bits_with_amount",
+    /** Top single cheer this session. Use as {{twitch_session_top_cheer}}. */
+    TWITCH_SESSION_TOP_CHEER = "twitch_session_top_cheer",
+    /** Amount for TWITCH_SESSION_TOP_CHEER. Use as {{twitch_session_top_cheer_amount}}. */
+    TWITCH_SESSION_TOP_CHEER_AMOUNT = "twitch_session_top_cheer_amount",
+    /** Top cheerer this session (by total bits). Use as {{twitch_session_top_cheerer}}. */
+    TWITCH_SESSION_TOP_CHEERER = "twitch_session_top_cheerer",
+    /** Total bits for TWITCH_SESSION_TOP_CHEERER. Use as {{twitch_session_top_cheerer_amount}}. */
+    TWITCH_SESSION_TOP_CHEERER_AMOUNT = "twitch_session_top_cheerer_amount",
+    /** Top cheerer for the current calendar week. Use as {{twitch_week_top_cheerer}}. */
+    TWITCH_WEEK_TOP_CHEERER = "twitch_week_top_cheerer",
+    /** Total bits for TWITCH_WEEK_TOP_CHEERER. Use as {{twitch_week_top_cheerer_amount}}. */
+    TWITCH_WEEK_TOP_CHEERER_AMOUNT = "twitch_week_top_cheerer_amount",
+    /** Top cheerer for the current calendar month. Use as {{twitch_month_top_cheerer}}. */
+    TWITCH_MONTH_TOP_CHEERER = "twitch_month_top_cheerer",
+    /** Total bits for TWITCH_MONTH_TOP_CHEERER. Use as {{twitch_month_top_cheerer_amount}}. */
+    TWITCH_MONTH_TOP_CHEERER_AMOUNT = "twitch_month_top_cheerer_amount",
+    /** Whether a hype train is currently active (true/false). Use as {{twitch_hypetrain_active}}. */
+    TWITCH_HYPETRAIN_ACTIVE = "twitch_hypetrain_active",
+    /** Current hype train level. Use as {{twitch_hypetrain_level}}. */
+    TWITCH_HYPETRAIN_LEVEL = "twitch_hypetrain_level",
+    /** Current hype train progress toward the next level. Use as {{twitch_hypetrain_progress}}. */
+    TWITCH_HYPETRAIN_PROGRESS = "twitch_hypetrain_progress",
+    /** Target value to reach the next hype train level. Use as {{twitch_hypetrain_level_goal}}. */
+    TWITCH_HYPETRAIN_LEVEL_GOAL = "twitch_hypetrain_level_goal",
+    /** Total contributions this hype train (running sum). Use as {{twitch_hypetrain_total}}. */
+    TWITCH_HYPETRAIN_TOTAL = "twitch_hypetrain_total",
+    /** Top contributor for the current hype train. Use as {{twitch_hypetrain_top_contributor}}. */
+    TWITCH_HYPETRAIN_TOP_CONTRIBUTOR = "twitch_hypetrain_top_contributor",
+    /** Amount contributed by TWITCH_HYPETRAIN_TOP_CONTRIBUTOR. Use as {{twitch_hypetrain_top_contributor_amount}}. */
+    TWITCH_HYPETRAIN_TOP_CONTRIBUTOR_AMOUNT = "twitch_hypetrain_top_contributor_amount",
+    /** All-time top cheerer (by total bits). Use as {{twitch_alltime_top_cheerer}}. */
+    TWITCH_ALLTIME_TOP_CHEERER = "twitch_alltime_top_cheerer",
+    /** Total bits for TWITCH_ALLTIME_TOP_CHEERER. Use as {{twitch_alltime_top_cheerer_amount}}. */
+    TWITCH_ALLTIME_TOP_CHEERER_AMOUNT = "twitch_alltime_top_cheerer_amount",
+    /** Top cheerers list (top 10, comma-separated usernames, sorted by total bits). Use as {{top_cheerer_list}}. */
+    TOP_CHEERER_LIST = "top_cheerer_list",
+    /** Total bits for TOP_CHEERER_LIST (parallel comma-separated). Use as {{top_cheerer_list_amount}}. */
+    TOP_CHEERER_LIST_AMOUNT = "top_cheerer_list_amount",
+    /** Top cheerers this week (top 10, comma-separated usernames). Use as {{week_top_cheerer_list}}. */
+    WEEK_TOP_CHEERER_LIST = "week_top_cheerer_list",
+    /** Total bits for WEEK_TOP_CHEERER_LIST (parallel comma-separated). Use as {{week_top_cheerer_list_amount}}. */
+    WEEK_TOP_CHEERER_LIST_AMOUNT = "week_top_cheerer_list_amount",
+    /** Top cheerers this month. Use as {{month_top_cheerer_list}}. */
+    MONTH_TOP_CHEERER_LIST = "month_top_cheerer_list",
+    /** Total bits for MONTH_TOP_CHEERER_LIST. Use as {{month_top_cheerer_list_amount}}. */
+    MONTH_TOP_CHEERER_LIST_AMOUNT = "month_top_cheerer_list_amount",
+    /** Top gifters list (top 10, comma-separated usernames, sorted by lifetime gifted subs). Use as {{top_gifter_list}}. */
+    TOP_GIFTER_LIST = "top_gifter_list",
+    /** Total gifts for TOP_GIFTER_LIST (parallel comma-separated). Use as {{top_gifter_list_amount}}. */
+    TOP_GIFTER_LIST_AMOUNT = "top_gifter_list_amount",
+    /** Top gifters this week. Use as {{week_top_gifter_list}}. */
+    WEEK_TOP_GIFTER_LIST = "week_top_gifter_list",
+    /** Total gifts for WEEK_TOP_GIFTER_LIST. Use as {{week_top_gifter_list_amount}}. */
+    WEEK_TOP_GIFTER_LIST_AMOUNT = "week_top_gifter_list_amount",
+    /** Top gifters this month. Use as {{month_top_gifter_list}}. */
+    MONTH_TOP_GIFTER_LIST = "month_top_gifter_list",
+    /** Total gifts for MONTH_TOP_GIFTER_LIST. Use as {{month_top_gifter_list_amount}}. */
+    MONTH_TOP_GIFTER_LIST_AMOUNT = "month_top_gifter_list_amount",
     /** Last clip ID. Use as {{twitch_last_clip_id}}. */
     TWITCH_LAST_CLIP_ID = "twitch_last_clip_id",
     /** Last clip URL. Use as {{twitch_last_clip_url}}. */
@@ -322,6 +426,10 @@ export declare enum SystemVariables {
     TWITCH_CURRENT_POLL_ID = "twitch_current_poll_id",
     /** Current prediction ID. Use as {{twitch_current_prediction_id}}. */
     TWITCH_CURRENT_PREDICTION_ID = "twitch_current_prediction_id",
+    /** Channel id. Use as {{youtube_channel_id}}. */
+    YOUTUBE_CHANNEL_ID = "youtube_channel_id",
+    /** Channel username (custom URL slug, falls back to channel title). Use as {{youtube_username}}. */
+    YOUTUBE_USERNAME = "youtube_username",
     /** Current viewer count. Use as {{youtube_current_viewer_count}}. */
     YOUTUBE_CURRENT_VIEWER_COUNT = "youtube_current_viewer_count",
     /** Total viewer count (stream). Use as {{youtube_total_viewer_count}}. */
@@ -346,6 +454,10 @@ export declare enum SystemVariables {
     YOUTUBE_LAST_CHATTER = "youtube_last_chatter",
     /** Session subscriber count. Use as {{youtube_session_subscriber_count}}. */
     YOUTUBE_SESSION_SUBSCRIBER_COUNT = "youtube_session_subscriber_count",
+    /** Subscribers for the current calendar week. Use as {{youtube_week_subscriber_count}}. */
+    YOUTUBE_WEEK_SUBSCRIBER_COUNT = "youtube_week_subscriber_count",
+    /** Subscribers for the current calendar month. Use as {{youtube_month_subscriber_count}}. */
+    YOUTUBE_MONTH_SUBSCRIBER_COUNT = "youtube_month_subscriber_count",
     /** Lifetime subscriber count. Use as {{youtube_total_subscriber_count}}. */
     YOUTUBE_TOTAL_SUBSCRIBER_COUNT = "youtube_total_subscriber_count",
     /** Session SuperChat count. Use as {{youtube_session_superchat_count}}. */
@@ -364,6 +476,10 @@ export declare enum SystemVariables {
     YOUTUBE_TOTAL_MEMBER_COUNT = "youtube_total_member_count",
     /** Session member count. Use as {{youtube_session_member_count}}. */
     YOUTUBE_SESSION_MEMBER_COUNT = "youtube_session_member_count",
+    /** Members for the current calendar week. Use as {{youtube_week_member_count}}. */
+    YOUTUBE_WEEK_MEMBER_COUNT = "youtube_week_member_count",
+    /** Members for the current calendar month. Use as {{youtube_month_member_count}}. */
+    YOUTUBE_MONTH_MEMBER_COUNT = "youtube_month_member_count",
     /** Last member. Use as {{youtube_last_member}}. */
     YOUTUBE_LAST_MEMBER = "youtube_last_member",
     /** Session members (list). Use as {{youtube_session_members}}. */
@@ -392,6 +508,10 @@ export declare enum SystemVariables {
     YOUTUBE_TOTAL_VIDEO_COUNT = "youtube_total_video_count",
     /** Total channel views. Use as {{youtube_total_view_count}}. */
     YOUTUBE_TOTAL_VIEW_COUNT = "youtube_total_view_count",
+    /** Page / user id. Use as {{facebook_user_id}}. */
+    FACEBOOK_USER_ID = "facebook_user_id",
+    /** Page / user username. Use as {{facebook_username}}. */
+    FACEBOOK_USERNAME = "facebook_username",
     /** Session chat count. Use as {{facebook_session_chat_count}}. */
     FACEBOOK_SESSION_CHAT_COUNT = "facebook_session_chat_count",
     /** Current first chatter. Use as {{facebook_current_first_chatter}}. */
@@ -408,10 +528,18 @@ export declare enum SystemVariables {
     FACEBOOK_TOTAL_FOLLOWER_COUNT = "facebook_total_follower_count",
     /** Session follower count. Use as {{facebook_session_follower_count}}. */
     FACEBOOK_SESSION_FOLLOWER_COUNT = "facebook_session_follower_count",
+    /** Followers for the current calendar week. Use as {{facebook_week_follower_count}}. */
+    FACEBOOK_WEEK_FOLLOWER_COUNT = "facebook_week_follower_count",
+    /** Followers for the current calendar month. Use as {{facebook_month_follower_count}}. */
+    FACEBOOK_MONTH_FOLLOWER_COUNT = "facebook_month_follower_count",
     /** Lifetime fan count. Use as {{facebook_total_fan_count}}. */
     FACEBOOK_TOTAL_FAN_COUNT = "facebook_total_fan_count",
     /** Session fan count. Use as {{facebook_session_fan_count}}. */
     FACEBOOK_SESSION_FAN_COUNT = "facebook_session_fan_count",
+    /** Fans for the current calendar week. Use as {{facebook_week_fan_count}}. */
+    FACEBOOK_WEEK_FAN_COUNT = "facebook_week_fan_count",
+    /** Fans for the current calendar month. Use as {{facebook_month_fan_count}}. */
+    FACEBOOK_MONTH_FAN_COUNT = "facebook_month_fan_count",
     /** Session reaction count. Use as {{facebook_reaction_count}}. */
     FACEBOOK_REACTION_COUNT = "facebook_reaction_count",
     /** Last Stars sender. Use as {{facebook_last_star}}. */
@@ -422,6 +550,10 @@ export declare enum SystemVariables {
     FACEBOOK_SESSION_STARS = "facebook_session_stars",
     /** Session Stars with amounts list. Use as {{facebook_session_stars_with_amount}}. */
     FACEBOOK_SESSION_STARS_WITH_AMOUNT = "facebook_session_stars_with_amount",
+    /** Channel user id. Use as {{tiktok_user_id}}. */
+    TIKTOK_USER_ID = "tiktok_user_id",
+    /** Channel username. Use as {{tiktok_username}}. */
+    TIKTOK_USERNAME = "tiktok_username",
     /** Session chat count. Use as {{tiktok_session_chat_count}}. */
     TIKTOK_SESSION_CHAT_COUNT = "tiktok_session_chat_count",
     /** Current first chatter. Use as {{tiktok_current_first_chatter}}. */
@@ -440,6 +572,10 @@ export declare enum SystemVariables {
     TIKTOK_TOTAL_FOLLOWER_COUNT = "tiktok_total_follower_count",
     /** Session follower count. Use as {{tiktok_session_follower_count}}. */
     TIKTOK_SESSION_FOLLOWER_COUNT = "tiktok_session_follower_count",
+    /** Followers for the current calendar week. Use as {{tiktok_week_follower_count}}. */
+    TIKTOK_WEEK_FOLLOWER_COUNT = "tiktok_week_follower_count",
+    /** Followers for the current calendar month. Use as {{tiktok_month_follower_count}}. */
+    TIKTOK_MONTH_FOLLOWER_COUNT = "tiktok_month_follower_count",
     /** Session super fan count. Use as {{tiktok_session_super_fan_count}}. */
     TIKTOK_SESSION_SUPER_FAN_COUNT = "tiktok_session_super_fan_count",
     /** Session share count. Use as {{tiktok_session_share_count}}. */
@@ -502,10 +638,18 @@ export declare enum SystemVariables {
     KICK_TOTAL_FOLLOWER_COUNT = "kick_total_follower_count",
     /** Session follower count. Use as {{kick_session_follower_count}}. */
     KICK_SESSION_FOLLOWER_COUNT = "kick_session_follower_count",
+    /** Followers for the current calendar week. Use as {{kick_week_follower_count}}. */
+    KICK_WEEK_FOLLOWER_COUNT = "kick_week_follower_count",
+    /** Followers for the current calendar month. Use as {{kick_month_follower_count}}. */
+    KICK_MONTH_FOLLOWER_COUNT = "kick_month_follower_count",
     /** Lifetime total subs. Use as {{kick_total_subscriber_count}}. */
     KICK_TOTAL_SUBSCRIBER_COUNT = "kick_total_subscriber_count",
     /** Session subs count. Use as {{kick_session_subscriber_count}}. */
     KICK_SESSION_SUBSCRIBER_COUNT = "kick_session_subscriber_count",
+    /** Subscribers for the current calendar week. Use as {{kick_week_subscriber_count}}. */
+    KICK_WEEK_SUBSCRIBER_COUNT = "kick_week_subscriber_count",
+    /** Subscribers for the current calendar month. Use as {{kick_month_subscriber_count}}. */
+    KICK_MONTH_SUBSCRIBER_COUNT = "kick_month_subscriber_count",
     /** Session gifts count. Use as {{kick_session_gifts_count}}. */
     KICK_SESSION_GIFTS_COUNT = "kick_session_gifts_count",
     /** Session subscribers list. Use as {{kick_session_subscribers}}. */