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

package/dist/activity.types.d.ts

@@ -473,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 */
@@ -716,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;

package/dist/activity.types.js

@@ -495,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 */
@@ -748,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',

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

@@ -8994,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

@@ -761,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

@@ -761,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/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",
@@ -783,7 +792,26 @@ export declare const AllVariables: {
             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[];
@@ -851,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) {
@@ -1458,7 +1462,40 @@ exports.AllVariables = {
             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', 'itemsCount', 'itemsDetailed', 'orderItems', 'itemImages', 'friendlyId', 'currency', 'amount', 'firstItem', 'raw'],
+            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',
@@ -1657,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.4",
+  "version": "3.3.5-beta.1",
   "description": "",
   "main": "./dist/index.js",
   "files": [