@lumiastream/lumia-types 3.3.3 → 3.3.5-beta.1

package/dist/activity.types.d.ts

@@ -431,6 +431,10 @@ export declare enum LumiaAlertValues {
     FOURTHWALL_DONATION = "fourthwall-donation",
     /** Fourthwall subscription */
     FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
+    /** Fourthwall subscription changed */
+    FOURTHWALL_SUBSCRIPTION_CHANGED = "fourthwall-subscriptionChanged",
+    /** Fourthwall subscription expired */
+    FOURTHWALL_SUBSCRIPTION_EXPIRED = "fourthwall-subscriptionExpired",
     /** Fourthwall gift purchase */
     FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
     /** Fourthwall giveaway started */
@@ -439,6 +443,8 @@ export declare enum LumiaAlertValues {
     FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
     /** Fourthwall thank you sent */
     FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
+    /** Fourthwall newsletter subscribed */
+    FOURTHWALL_NEWSLETTER_SUBSCRIBED = "fourthwall-newsletterSubscribed",
     /** OBS profile switched */
     OBS_SWITCH_PROFILE = "obs-switchProfile",
     /** OBS scene switched */
@@ -467,8 +473,6 @@ export declare enum LumiaAlertValues {
     OBS_MEDIA_INPUT_PLAYBACK_ENDED = "obs-mediaInputPlaybackEnded",
     /** OBS virtual camera state changed */
     OBS_VIRTUALCAM_STATE_CHANGED = "obs-virtualcamStateChanged",
-    /** OBS record file changed */
-    OBS_RECORD_FILE_CHANGED = "obs-recordFileChanged",
     /** OBS screenshot saved */
     OBS_SCREENSHOT_SAVED = "obs-screenshotSaved",
     /** OBS replay buffer saved */
@@ -710,7 +714,6 @@ export declare const LumiaAlertFriendlyValues: {
     "obs-mediaInputPlaybackStarted": string;
     "obs-mediaInputPlaybackEnded": string;
     "obs-virtualcamStateChanged": string;
-    "obs-recordFileChanged": string;
     "obs-screenshotSaved": string;
     "obs-replayBufferSaved": string;
     "obs-verticalBacktrackSaved": string;
@@ -745,10 +748,13 @@ export declare const LumiaAlertFriendlyValues: {
     "fourthwall-shopOrder": string;
     "fourthwall-donation": string;
     "fourthwall-subscription": string;
+    "fourthwall-subscriptionChanged": string;
+    "fourthwall-subscriptionExpired": string;
     "fourthwall-giftpurchase": string;
     "fourthwall-giveawayStarted": string;
     "fourthwall-giveawayEnded": string;
     "fourthwall-thankyouSent": string;
+    "fourthwall-newsletterSubscribed": string;
     "crowdcontrol-effect": string;
     "vtubestudio-hotkeyTriggered": string;
     "vtubestudio-modelLoaded": string;

package/dist/activity.types.js

@@ -452,6 +452,10 @@ var LumiaAlertValues;
     LumiaAlertValues["FOURTHWALL_DONATION"] = "fourthwall-donation";
     /** Fourthwall subscription */
     LumiaAlertValues["FOURTHWALL_SUBSCRIPTION"] = "fourthwall-subscription";
+    /** Fourthwall subscription changed */
+    LumiaAlertValues["FOURTHWALL_SUBSCRIPTION_CHANGED"] = "fourthwall-subscriptionChanged";
+    /** Fourthwall subscription expired */
+    LumiaAlertValues["FOURTHWALL_SUBSCRIPTION_EXPIRED"] = "fourthwall-subscriptionExpired";
     /** Fourthwall gift purchase */
     LumiaAlertValues["FOURTHWALL_GIFTPURCHASE"] = "fourthwall-giftpurchase";
     /** Fourthwall giveaway started */
@@ -460,6 +464,8 @@ var LumiaAlertValues;
     LumiaAlertValues["FOURTHWALL_GIVEAWAY_ENDED"] = "fourthwall-giveawayEnded";
     /** Fourthwall thank you sent */
     LumiaAlertValues["FOURTHWALL_THANKYOU_SENT"] = "fourthwall-thankyouSent";
+    /** Fourthwall newsletter subscribed */
+    LumiaAlertValues["FOURTHWALL_NEWSLETTER_SUBSCRIBED"] = "fourthwall-newsletterSubscribed";
     // OBS Studio events
     /** OBS profile switched */
     LumiaAlertValues["OBS_SWITCH_PROFILE"] = "obs-switchProfile";
@@ -489,8 +495,6 @@ var LumiaAlertValues;
     LumiaAlertValues["OBS_MEDIA_INPUT_PLAYBACK_ENDED"] = "obs-mediaInputPlaybackEnded";
     /** OBS virtual camera state changed */
     LumiaAlertValues["OBS_VIRTUALCAM_STATE_CHANGED"] = "obs-virtualcamStateChanged";
-    /** OBS record file changed */
-    LumiaAlertValues["OBS_RECORD_FILE_CHANGED"] = "obs-recordFileChanged";
     /** OBS screenshot saved */
     LumiaAlertValues["OBS_SCREENSHOT_SAVED"] = "obs-screenshotSaved";
     /** OBS replay buffer saved */
@@ -742,7 +746,6 @@ exports.LumiaAlertFriendlyValues = {
     [LumiaAlertValues.OBS_MEDIA_INPUT_PLAYBACK_STARTED]: 'Obs Media Input Playback Started',
     [LumiaAlertValues.OBS_MEDIA_INPUT_PLAYBACK_ENDED]: 'Obs Media Input Playback Ended',
     [LumiaAlertValues.OBS_VIRTUALCAM_STATE_CHANGED]: 'Obs Virtual Cam State Changed',
-    [LumiaAlertValues.OBS_RECORD_FILE_CHANGED]: 'Obs Record File Changed',
     [LumiaAlertValues.OBS_SCREENSHOT_SAVED]: 'Obs Screenshot Saved',
     [LumiaAlertValues.OBS_REPLAY_BUFFER_SAVED]: 'Obs Replay Buffer Saved',
     [LumiaAlertValues.OBS_VERTICAL_BACKTRACK_SAVED]: 'Obs Vertical Backtrack Saved',
@@ -777,10 +780,13 @@ exports.LumiaAlertFriendlyValues = {
     [LumiaAlertValues.FOURTHWALL_SHOPORDER]: 'Fourthwall Shop Order',
     [LumiaAlertValues.FOURTHWALL_DONATION]: 'Fourthwall Donation',
     [LumiaAlertValues.FOURTHWALL_SUBSCRIPTION]: 'Fourthwall Subscription',
+    [LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_CHANGED]: 'Fourthwall Subscription Changed',
+    [LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_EXPIRED]: 'Fourthwall Subscription Expired',
     [LumiaAlertValues.FOURTHWALL_GIFTPURCHASE]: 'Fourthwall Giftpurchase',
     [LumiaAlertValues.FOURTHWALL_GIVEAWAY_STARTED]: 'Fourthwall Giveaway Started',
     [LumiaAlertValues.FOURTHWALL_GIVEAWAY_ENDED]: 'Fourthwall Giveaway Ended',
     [LumiaAlertValues.FOURTHWALL_THANKYOU_SENT]: 'Fourthwall Thank You Sent',
+    [LumiaAlertValues.FOURTHWALL_NEWSLETTER_SUBSCRIBED]: 'Fourthwall Newsletter Subscribed',
     [LumiaAlertValues.CROWDCONTROL_EFFECT]: 'Crowdcontrol Effect',
     [LumiaAlertValues.VTUBESTUDIO_HOTKEY_TRIGGERED]: 'Vtube Hotkey Triggered',
     [LumiaAlertValues.VTUBESTUDIO_MODEL_LOADED]: 'Vtube Model Loaded',

package/dist/alert.types.d.ts

@@ -1,5 +1,6 @@
 import { LumiaAlertValues } from './activity.types';
 import { LumiaIntegrations } from './event.types';
+import { type LumiaAcceptedVariable } from './variables.types';
 export declare enum LumiaVariationConditions {
     RANDOM = "RANDOM",// Frequency: Percent Chance
     GREATER_NUMBER = "GREATER_NUMBER",
@@ -109,7 +110,7 @@ export declare const LumiaAlertConfigs: Record<LumiaAlertValues | string, {
     eventlistSpecialUsername?: string;
     eventlistMessage?: string;
     eventlistDetailedMessage?: string;
-    acceptedVariables: string[];
+    acceptedVariables: LumiaAcceptedVariable[];
     quickActions?: Array<{
         label: string;
         dynamic: LumiaDynamicCondition;

package/dist/alert.types.js

@@ -7572,12 +7572,136 @@ exports.LumiaAlertConfigs = {
             { type: LumiaVariationConditions.EQUAL_VARIABLE },
         ],
     },
+    [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_CHANGED]: {
+        connection: event_types_1.LumiaIntegrations.FOURTHWALL,
+        message: '{{username}} subscription changed to {{subscriptionType}}',
+        eventlistMessage: 'Subscription Changed',
+        eventlistDetailedMessage: 'subscription changed to {{subscriptionType}}',
+        acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.subscriptionChanged,
+        quickActions: [
+            {
+                label: 'Changed',
+                dynamic: { value: 100, currency: LumiaVariationCurrency.USD },
+                extraSettings: {
+                    username: 'lumiastream',
+                    amount: 100,
+                    currency: LumiaVariationCurrency.USD,
+                    interval: 'MONTHLY',
+                    subscriptionType: 'ACTIVE',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Username',
+                variableField: 'username',
+                required: false,
+                default: 'lumiastream',
+            },
+            {
+                type: 'text',
+                label: 'Subscription Type',
+                variableField: 'subscriptionType',
+                required: false,
+                default: 'ACTIVE',
+            },
+            {
+                type: 'number',
+                label: 'Amount',
+                dynamicField: 'value',
+                variableField: 'amount',
+                required: false,
+                default: 100,
+            },
+            {
+                type: 'currency',
+                label: 'Currency',
+                dynamicField: 'currency',
+                variableField: 'currency',
+                required: false,
+                default: LumiaVariationCurrency.USD,
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            {
+                type: LumiaVariationConditions.EQUAL_CURRENCY_NUMBER,
+            },
+            {
+                type: LumiaVariationConditions.GREATER_CURRENCY_NUMBER,
+            },
+            { type: LumiaVariationConditions.EQUAL_VARIABLE },
+        ],
+    },
+    [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_EXPIRED]: {
+        connection: event_types_1.LumiaIntegrations.FOURTHWALL,
+        message: '{{username}} subscription ended',
+        eventlistMessage: 'Subscription Ended',
+        eventlistDetailedMessage: 'subscription ended with {{subscriptionType}}',
+        acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.subscriptionExpired,
+        quickActions: [
+            {
+                label: 'Ended',
+                dynamic: { value: 100, currency: LumiaVariationCurrency.USD },
+                extraSettings: {
+                    username: 'lumiastream',
+                    amount: 100,
+                    currency: LumiaVariationCurrency.USD,
+                    interval: 'MONTHLY',
+                    subscriptionType: 'CANCELLED',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Username',
+                variableField: 'username',
+                required: false,
+                default: 'lumiastream',
+            },
+            {
+                type: 'text',
+                label: 'Subscription Type',
+                variableField: 'subscriptionType',
+                required: false,
+                default: 'CANCELLED',
+            },
+            {
+                type: 'number',
+                label: 'Amount',
+                dynamicField: 'value',
+                variableField: 'amount',
+                required: false,
+                default: 100,
+            },
+            {
+                type: 'currency',
+                label: 'Currency',
+                dynamicField: 'currency',
+                variableField: 'currency',
+                required: false,
+                default: LumiaVariationCurrency.USD,
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            {
+                type: LumiaVariationConditions.EQUAL_CURRENCY_NUMBER,
+            },
+            {
+                type: LumiaVariationConditions.GREATER_CURRENCY_NUMBER,
+            },
+            { type: LumiaVariationConditions.EQUAL_VARIABLE },
+        ],
+    },
     [activity_types_1.LumiaAlertValues.FOURTHWALL_GIFTPURCHASE]: {
         connection: event_types_1.LumiaIntegrations.FOURTHWALL,
         message: '{{username}} just bought a gift with amount {{amount}}',
         eventlistMessage: 'Gift Purchase',
         eventlistDetailedMessage: 'Gift purchase with {{amount}} {{currency}}',
-        acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.shopOrder,
+        acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.giftPurchase,
         quickActions: [
             {
                 label: '$100',
@@ -7889,6 +8013,32 @@ exports.LumiaAlertConfigs = {
         ],
         LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_VARIABLE }],
     },
+    [activity_types_1.LumiaAlertValues.FOURTHWALL_NEWSLETTER_SUBSCRIBED]: {
+        connection: event_types_1.LumiaIntegrations.FOURTHWALL,
+        message: '{{email}} subscribed to the newsletter',
+        eventlistMessage: 'Newsletter Subscribed',
+        eventlistDetailedMessage: 'subscribed to the newsletter',
+        acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.newsletterSubscribed,
+        quickActions: [
+            {
+                label: 'Subscribed',
+                dynamic: { value: 1 },
+                extraSettings: {
+                    email: 'test@email.com',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Email',
+                variableField: 'email',
+                required: false,
+                default: 'test@email.com',
+            },
+        ],
+        LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_VARIABLE }],
+    },
     // },
     // twitter: {
     [activity_types_1.LumiaAlertValues.TWITTER_FOLLOWER]: {
@@ -8844,19 +8994,6 @@ exports.LumiaAlertConfigs = {
         acceptedVariables: variables_types_1.AllVariables.obs.alerts.virtualcamStateChanged,
         LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_VARIABLE }],
     },
-    [activity_types_1.LumiaAlertValues.OBS_RECORD_FILE_CHANGED]: {
-        connection: event_types_1.LumiaIntegrations.OBS,
-        message: 'OBS record file changed',
-        acceptedVariables: variables_types_1.AllVariables.obs.alerts.recordFileChanged,
-        LumiaVariationConditions: [
-            { type: LumiaVariationConditions.RANDOM },
-            {
-                type: LumiaVariationConditions.EQUAL_STRING,
-                description: 'Path is equal to',
-            },
-            { type: LumiaVariationConditions.EQUAL_VARIABLE },
-        ],
-    },
     [activity_types_1.LumiaAlertValues.OBS_SCREENSHOT_SAVED]: {
         connection: event_types_1.LumiaIntegrations.OBS,
         message: 'OBS screenshot saved',

package/dist/custom-overlays/custom-overlays.d.ts

@@ -719,6 +719,10 @@ export declare enum LumiaAlertValues {
     FOURTHWALL_DONATION = "fourthwall-donation",
     /** Fourthwall subscription */
     FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
+    /** Fourthwall subscription changed */
+    FOURTHWALL_SUBSCRIPTION_CHANGED = "fourthwall-subscriptionChanged",
+    /** Fourthwall subscription expired */
+    FOURTHWALL_SUBSCRIPTION_EXPIRED = "fourthwall-subscriptionExpired",
     /** Fourthwall gift purchase */
     FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
     /** Fourthwall giveaway started */
@@ -727,6 +731,8 @@ export declare enum LumiaAlertValues {
     FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
     /** Fourthwall thank you sent */
     FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
+    /** Fourthwall newsletter subscribed */
+    FOURTHWALL_NEWSLETTER_SUBSCRIBED = "fourthwall-newsletterSubscribed",
     /** OBS profile switched */
     OBS_SWITCH_PROFILE = "obs-switchProfile",
     /** OBS scene switched */
@@ -755,8 +761,6 @@ export declare enum LumiaAlertValues {
     OBS_MEDIA_INPUT_PLAYBACK_ENDED = "obs-mediaInputPlaybackEnded",
     /** OBS virtual camera state changed */
     OBS_VIRTUALCAM_STATE_CHANGED = "obs-virtualcamStateChanged",
-    /** OBS record file changed */
-    OBS_RECORD_FILE_CHANGED = "obs-recordFileChanged",
     /** OBS screenshot saved */
     OBS_SCREENSHOT_SAVED = "obs-screenshotSaved",
     /** OBS replay buffer saved */

package/dist/custom-overlays.d.ts

@@ -719,6 +719,10 @@ export declare enum LumiaAlertValues {
     FOURTHWALL_DONATION = "fourthwall-donation",
     /** Fourthwall subscription */
     FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
+    /** Fourthwall subscription changed */
+    FOURTHWALL_SUBSCRIPTION_CHANGED = "fourthwall-subscriptionChanged",
+    /** Fourthwall subscription expired */
+    FOURTHWALL_SUBSCRIPTION_EXPIRED = "fourthwall-subscriptionExpired",
     /** Fourthwall gift purchase */
     FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
     /** Fourthwall giveaway started */
@@ -727,6 +731,8 @@ export declare enum LumiaAlertValues {
     FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
     /** Fourthwall thank you sent */
     FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
+    /** Fourthwall newsletter subscribed */
+    FOURTHWALL_NEWSLETTER_SUBSCRIBED = "fourthwall-newsletterSubscribed",
     /** OBS profile switched */
     OBS_SWITCH_PROFILE = "obs-switchProfile",
     /** OBS scene switched */
@@ -755,8 +761,6 @@ export declare enum LumiaAlertValues {
     OBS_MEDIA_INPUT_PLAYBACK_ENDED = "obs-mediaInputPlaybackEnded",
     /** OBS virtual camera state changed */
     OBS_VIRTUALCAM_STATE_CHANGED = "obs-virtualcamStateChanged",
-    /** OBS record file changed */
-    OBS_RECORD_FILE_CHANGED = "obs-recordFileChanged",
     /** OBS screenshot saved */
     OBS_SCREENSHOT_SAVED = "obs-screenshotSaved",
     /** OBS replay buffer saved */

package/dist/eventlist.types.d.ts

@@ -47,10 +47,13 @@ export declare const LumiaMapAlertTypeToEventListType: {
     "fourthwall-donation": LumiaEventListTypes;
     "fourthwall-shopOrder": LumiaEventListTypes;
     "fourthwall-subscription": LumiaEventListTypes;
+    "fourthwall-subscriptionChanged": LumiaEventListTypes;
+    "fourthwall-subscriptionExpired": LumiaEventListTypes;
     "fourthwall-giftpurchase": LumiaEventListTypes;
     "fourthwall-giveawayStarted": LumiaEventListTypes;
     "fourthwall-giveawayEnded": LumiaEventListTypes;
     "fourthwall-thankyouSent": LumiaEventListTypes;
+    "fourthwall-newsletterSubscribed": LumiaEventListTypes;
     "patreon-campaignPledge": LumiaEventListTypes;
     "streamelements-donation": LumiaEventListTypes;
     "streamlabs-charity": LumiaEventListTypes;

package/dist/eventlist.types.js

@@ -52,10 +52,13 @@ exports.LumiaMapAlertTypeToEventListType = {
     [activity_types_1.LumiaAlertValues.FOURTHWALL_DONATION]: LumiaEventListTypes.DONATION,
     [activity_types_1.LumiaAlertValues.FOURTHWALL_SHOPORDER]: LumiaEventListTypes.PURCHASES,
     [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION]: LumiaEventListTypes.SUBSCRIBERS,
+    [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_CHANGED]: LumiaEventListTypes.SUBSCRIBERS,
+    [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_EXPIRED]: LumiaEventListTypes.SUBSCRIBERS,
     [activity_types_1.LumiaAlertValues.FOURTHWALL_GIFTPURCHASE]: LumiaEventListTypes.PURCHASES,
     [activity_types_1.LumiaAlertValues.FOURTHWALL_GIVEAWAY_STARTED]: LumiaEventListTypes.GIFTS,
     [activity_types_1.LumiaAlertValues.FOURTHWALL_GIVEAWAY_ENDED]: LumiaEventListTypes.GIFTS,
     [activity_types_1.LumiaAlertValues.FOURTHWALL_THANKYOU_SENT]: LumiaEventListTypes.OTHERS,
+    [activity_types_1.LumiaAlertValues.FOURTHWALL_NEWSLETTER_SUBSCRIBED]: LumiaEventListTypes.OTHERS,
     [activity_types_1.LumiaAlertValues.PATREON_PLEDGE]: LumiaEventListTypes.SUBSCRIBERS,
     [activity_types_1.LumiaAlertValues.STREAMELEMENTS_DONATION]: LumiaEventListTypes.DONATION,
     [activity_types_1.LumiaAlertValues.STREAMLABS_CHARITY]: LumiaEventListTypes.DONATION,

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { LumiaStreamingSites, LumiaActivityCommandTypes, LumiaExternalActivityCo
 export { LumiaVariationConditions, LumiaVariationCurrency, VariationCurrencySymbol, LumiaAlertConfigs, LumiaDynamicCondition, type LumiaSelectionOption } from './alert.types';
 export { ILumiaSendPack, ILumiaEvent, ILumiaEventChatCommandBody, ILumiaEventChatBody, ILumiaEventAlertBody, ILumiaEventStateBody, ILumiaLight, LumiaIntegrations, LumiaEventTypes, } from './event.types';
 export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType } from './eventlist.types';
-export { SystemVariables, ReservedVariables, AllVariables } from './variables.types';
+export { SystemVariables, ReservedVariables, AllVariables, getAcceptedVariableName, getAcceptedVariableNames, type LumiaAcceptedVariable, type LumiaAcceptedVariableDefinition, } from './variables.types';
 export { formatCondition } from './helpers';
 export { KickKicksData } from './kick_kicks';
 export { TiktokGiftsData } from './tiktok_gifts';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VIEWER_PROFILE_ACHIEVEMENTS = exports.YoutubeSuperstickersData = exports.TiktokGiftsData = exports.KickKicksData = exports.formatCondition = exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = exports.LumiaEventTypes = exports.LumiaIntegrations = exports.LumiaAlertConfigs = exports.VariationCurrencySymbol = exports.LumiaVariationCurrency = exports.LumiaVariationConditions = exports.LumiaActivityTestType = exports.LumiaActivityNoValueTypes = exports.LumiaActivityApiValueType = exports.LumiaActivityOriginTypes = exports.LumiaAlertFriendlyValues = exports.LumiaAlertValues = exports.LumiaExternalActivityCommandTypes = exports.LumiaActivityCommandTypes = exports.LumiaStreamingSites = void 0;
+exports.VIEWER_PROFILE_ACHIEVEMENTS = exports.YoutubeSuperstickersData = exports.TiktokGiftsData = exports.KickKicksData = exports.formatCondition = exports.getAcceptedVariableNames = exports.getAcceptedVariableName = exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = exports.LumiaEventTypes = exports.LumiaIntegrations = exports.LumiaAlertConfigs = exports.VariationCurrencySymbol = exports.LumiaVariationCurrency = exports.LumiaVariationConditions = exports.LumiaActivityTestType = exports.LumiaActivityNoValueTypes = exports.LumiaActivityApiValueType = exports.LumiaActivityOriginTypes = exports.LumiaAlertFriendlyValues = exports.LumiaAlertValues = exports.LumiaExternalActivityCommandTypes = exports.LumiaActivityCommandTypes = exports.LumiaStreamingSites = void 0;
 var activity_types_1 = require("./activity.types");
 Object.defineProperty(exports, "LumiaStreamingSites", { enumerable: true, get: function () { return activity_types_1.LumiaStreamingSites; } });
 Object.defineProperty(exports, "LumiaActivityCommandTypes", { enumerable: true, get: function () { return activity_types_1.LumiaActivityCommandTypes; } });
@@ -26,6 +26,8 @@ var variables_types_1 = require("./variables.types");
 Object.defineProperty(exports, "SystemVariables", { enumerable: true, get: function () { return variables_types_1.SystemVariables; } });
 Object.defineProperty(exports, "ReservedVariables", { enumerable: true, get: function () { return variables_types_1.ReservedVariables; } });
 Object.defineProperty(exports, "AllVariables", { enumerable: true, get: function () { return variables_types_1.AllVariables; } });
+Object.defineProperty(exports, "getAcceptedVariableName", { enumerable: true, get: function () { return variables_types_1.getAcceptedVariableName; } });
+Object.defineProperty(exports, "getAcceptedVariableNames", { enumerable: true, get: function () { return variables_types_1.getAcceptedVariableNames; } });
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "formatCondition", { enumerable: true, get: function () { return helpers_1.formatCondition; } });
 var kick_kicks_1 = require("./kick_kicks");

package/dist/variables.types.d.ts

@@ -1,3 +1,12 @@
+export interface LumiaAcceptedVariableDefinition {
+    name: string;
+    description?: string;
+    origin?: string;
+    example?: unknown;
+}
+export type LumiaAcceptedVariable = string | LumiaAcceptedVariableDefinition;
+export declare const getAcceptedVariableName: (entry: LumiaAcceptedVariable) => string;
+export declare const getAcceptedVariableNames: (entries: LumiaAcceptedVariable[]) => string[];
 export declare enum SystemVariables {
     /** Read from a local file. Example: {{read_file=C:\path\file.txt}}. Use in overlays as {{read_file}}. */
     READ_FILE = "read_file",
@@ -780,12 +789,34 @@ export declare const AllVariables: {
         alerts: {
             donation: string[];
             subscription: string[];
+            subscriptionChanged: string[];
+            subscriptionExpired: string[];
             commission: string[];
-            shopOrder: string[];
+            shopOrder: (string | {
+                name: string;
+                example: {
+                    id: string;
+                    name: string;
+                    slug: string;
+                    description: string;
+                    imageUrl: string;
+                    variantName: string;
+                    sku: string;
+                    quantity: number;
+                    size: string;
+                    color: string;
+                    colorSwatch: string;
+                    attributes: string;
+                    unitPrice: number;
+                    price: number;
+                    variant: null;
+                };
+            })[];
             giftPurchase: string[];
             giveawayStarted: string[];
             giveawayEnded: string[];
             thankyouSent: string[];
+            newsletterSubscribed: string[];
         };
     };
     kick: {
@@ -848,7 +879,6 @@ export declare const AllVariables: {
             mediaInputPlaybackStarted: string[];
             mediaInputPlaybackEnded: string[];
             virtualcamStateChanged: string[];
-            recordFileChanged: string[];
             screenshotSaved: string[];
             replayBufferSaved: string[];
             verticalBacktrackSaved: string[];

package/dist/variables.types.js

@@ -1,7 +1,11 @@
 "use strict";
 // [AI] When SystemVariables is used, update custom-overlays.d.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = void 0;
+exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.getAcceptedVariableNames = exports.getAcceptedVariableName = void 0;
+const getAcceptedVariableName = (entry) => typeof entry === 'string' ? entry : entry.name;
+exports.getAcceptedVariableName = getAcceptedVariableName;
+const getAcceptedVariableNames = (entries) => entries.map(exports.getAcceptedVariableName);
+exports.getAcceptedVariableNames = getAcceptedVariableNames;
 // Use the **string values** of this enum inside overlays: e.g. {{twitch_total_subscriber_count}}, not {{TWITCH_TOTAL_SUBSCRIBER_COUNT}}.
 var SystemVariables;
 (function (SystemVariables) {
@@ -1453,14 +1457,112 @@ exports.AllVariables = {
     },
     fourthwall: {
         alerts: {
-            donation: ['username', 'email', 'message', 'currency', 'amount', 'raw'],
-            subscription: ['username', 'email', 'currency', 'amount', 'interval', 'raw'],
+            donation: ['username', 'email', 'message', 'currency', 'amount', 'id', 'status', 'createdAt', 'updatedAt', 'raw'],
+            subscription: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
+            subscriptionChanged: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
+            subscriptionExpired: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
             commission: ['username', 'email', 'message', 'currency', 'amount', 'raw'],
-            shopOrder: ['username', 'email', 'message', 'items', 'currency', 'amount', 'raw'],
-            giftPurchase: ['username', 'email', 'message', 'currency', 'amount', 'raw'],
-            giveawayStarted: ['currency', 'amount', 'giveawayName', 'giveawayId', 'winners', 'winnerNames', 'winnerCount', 'duration', 'allGifts', 'totalGifts', 'offer', 'type'],
-            giveawayEnded: ['currency', 'amount', 'giveawayName', 'giveawayId', 'winners', 'winnerNames', 'winnerCount', 'duration', 'allGifts', 'totalGifts', 'offer', 'type'],
-            thankyouSent: ['username', 'email', 'message', 'mediaUrl', 'contribution'],
+            shopOrder: [
+                'username',
+                'email',
+                'message',
+                'items',
+                'itemsCount',
+                'itemsDetailed',
+                'orderItems',
+                'itemImages',
+                'friendlyId',
+                'currency',
+                'amount',
+                {
+                    name: 'firstItem',
+                    example: {
+                        id: '',
+                        name: '',
+                        slug: '',
+                        description: '',
+                        imageUrl: '',
+                        variantName: '',
+                        sku: '',
+                        quantity: 1,
+                        size: '',
+                        color: '',
+                        colorSwatch: '',
+                        attributes: '',
+                        unitPrice: 0,
+                        price: 0,
+                        variant: null,
+                    },
+                },
+                'raw',
+            ],
+            giftPurchase: [
+                'username',
+                'email',
+                'message',
+                'currency',
+                'amount',
+                'friendlyId',
+                'quantity',
+                'offer',
+                'offerImageUrl',
+                'gifts',
+                'giftCount',
+                'winners',
+                'winnerNames',
+                'winnerCount',
+                'firstWinner',
+                'availableGiftCount',
+                'redeemedGiftCount',
+                'createdAt',
+                'raw',
+            ],
+            giveawayStarted: [
+                'username',
+                'email',
+                'message',
+                'currency',
+                'amount',
+                'giveawayName',
+                'giveawayId',
+                'giveawayFriendlyId',
+                'offerName',
+                'offerImageUrl',
+                'winners',
+                'winnerNames',
+                'winnerCount',
+                'firstWinner',
+                'duration',
+                'allGifts',
+                'gifts',
+                'totalGifts',
+                'offer',
+                'type',
+            ],
+            giveawayEnded: [
+                'username',
+                'email',
+                'message',
+                'currency',
+                'amount',
+                'giveawayName',
+                'giveawayId',
+                'giveawayFriendlyId',
+                'offerName',
+                'offerImageUrl',
+                'winners',
+                'winnerNames',
+                'winnerCount',
+                'firstWinner',
+                'duration',
+                'allGifts',
+                'gifts',
+                'totalGifts',
+                'offer',
+                'type',
+            ],
+            thankyouSent: ['username', 'email', 'message', 'mediaUrl', 'contributionType', 'contribution'],
+            newsletterSubscribed: ['email', 'raw'],
         },
     },
     kick: {
@@ -1592,7 +1694,6 @@ exports.AllVariables = {
             mediaInputPlaybackStarted: ['inputName', 'inputUuid'],
             mediaInputPlaybackEnded: ['inputName', 'inputUuid'],
             virtualcamStateChanged: ['outputActive', 'outputState'],
-            recordFileChanged: ['newOutputPath'],
             screenshotSaved: ['savedScreenshotPath'],
             replayBufferSaved: ['saved_key'],
             verticalBacktrackSaved: ['saved_key', 'height', 'width'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumiastream/lumia-types",
-  "version": "3.3.3",
+  "version": "3.3.5-beta.1",
   "description": "",
   "main": "./dist/index.js",
   "files": [