@lumiastream/lumia-types 3.3.4 → 3.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/activity.types.d.ts +0 -3
- package/dist/activity.types.js +0 -3
- package/dist/alert.types.d.ts +2 -1
- package/dist/alert.types.js +18 -13
- package/dist/custom-overlays/custom-overlays.d.ts +0 -2
- package/dist/custom-overlays.d.ts +0 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3 -1
- package/dist/variables.types.d.ts +231 -23
- package/dist/variables.types.js +359 -35
- package/package.json +1 -1
package/dist/activity.types.d.ts
CHANGED
|
@@ -473,8 +473,6 @@ export declare enum LumiaAlertValues {
|
|
|
473
473
|
OBS_MEDIA_INPUT_PLAYBACK_ENDED = "obs-mediaInputPlaybackEnded",
|
|
474
474
|
/** OBS virtual camera state changed */
|
|
475
475
|
OBS_VIRTUALCAM_STATE_CHANGED = "obs-virtualcamStateChanged",
|
|
476
|
-
/** OBS record file changed */
|
|
477
|
-
OBS_RECORD_FILE_CHANGED = "obs-recordFileChanged",
|
|
478
476
|
/** OBS screenshot saved */
|
|
479
477
|
OBS_SCREENSHOT_SAVED = "obs-screenshotSaved",
|
|
480
478
|
/** OBS replay buffer saved */
|
|
@@ -716,7 +714,6 @@ export declare const LumiaAlertFriendlyValues: {
|
|
|
716
714
|
"obs-mediaInputPlaybackStarted": string;
|
|
717
715
|
"obs-mediaInputPlaybackEnded": string;
|
|
718
716
|
"obs-virtualcamStateChanged": string;
|
|
719
|
-
"obs-recordFileChanged": string;
|
|
720
717
|
"obs-screenshotSaved": string;
|
|
721
718
|
"obs-replayBufferSaved": string;
|
|
722
719
|
"obs-verticalBacktrackSaved": string;
|
package/dist/activity.types.js
CHANGED
|
@@ -495,8 +495,6 @@ var LumiaAlertValues;
|
|
|
495
495
|
LumiaAlertValues["OBS_MEDIA_INPUT_PLAYBACK_ENDED"] = "obs-mediaInputPlaybackEnded";
|
|
496
496
|
/** OBS virtual camera state changed */
|
|
497
497
|
LumiaAlertValues["OBS_VIRTUALCAM_STATE_CHANGED"] = "obs-virtualcamStateChanged";
|
|
498
|
-
/** OBS record file changed */
|
|
499
|
-
LumiaAlertValues["OBS_RECORD_FILE_CHANGED"] = "obs-recordFileChanged";
|
|
500
498
|
/** OBS screenshot saved */
|
|
501
499
|
LumiaAlertValues["OBS_SCREENSHOT_SAVED"] = "obs-screenshotSaved";
|
|
502
500
|
/** OBS replay buffer saved */
|
|
@@ -748,7 +746,6 @@ exports.LumiaAlertFriendlyValues = {
|
|
|
748
746
|
[LumiaAlertValues.OBS_MEDIA_INPUT_PLAYBACK_STARTED]: 'Obs Media Input Playback Started',
|
|
749
747
|
[LumiaAlertValues.OBS_MEDIA_INPUT_PLAYBACK_ENDED]: 'Obs Media Input Playback Ended',
|
|
750
748
|
[LumiaAlertValues.OBS_VIRTUALCAM_STATE_CHANGED]: 'Obs Virtual Cam State Changed',
|
|
751
|
-
[LumiaAlertValues.OBS_RECORD_FILE_CHANGED]: 'Obs Record File Changed',
|
|
752
749
|
[LumiaAlertValues.OBS_SCREENSHOT_SAVED]: 'Obs Screenshot Saved',
|
|
753
750
|
[LumiaAlertValues.OBS_REPLAY_BUFFER_SAVED]: 'Obs Replay Buffer Saved',
|
|
754
751
|
[LumiaAlertValues.OBS_VERTICAL_BACKTRACK_SAVED]: 'Obs Vertical Backtrack Saved',
|
package/dist/alert.types.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { LumiaAlertValues } from './activity.types';
|
|
2
2
|
import { LumiaIntegrations } from './event.types';
|
|
3
|
+
import { type LumiaAcceptedVariable } from './variables.types';
|
|
3
4
|
export declare enum LumiaVariationConditions {
|
|
4
5
|
RANDOM = "RANDOM",// Frequency: Percent Chance
|
|
5
6
|
GREATER_NUMBER = "GREATER_NUMBER",
|
|
@@ -109,7 +110,7 @@ export declare const LumiaAlertConfigs: Record<LumiaAlertValues | string, {
|
|
|
109
110
|
eventlistSpecialUsername?: string;
|
|
110
111
|
eventlistMessage?: string;
|
|
111
112
|
eventlistDetailedMessage?: string;
|
|
112
|
-
acceptedVariables:
|
|
113
|
+
acceptedVariables: LumiaAcceptedVariable[];
|
|
113
114
|
quickActions?: Array<{
|
|
114
115
|
label: string;
|
|
115
116
|
dynamic: LumiaDynamicCondition;
|
package/dist/alert.types.js
CHANGED
|
@@ -3925,6 +3925,12 @@ exports.LumiaAlertConfigs = {
|
|
|
3925
3925
|
totalJewels: 10,
|
|
3926
3926
|
comboCount: 1,
|
|
3927
3927
|
hasVisualEffect: false,
|
|
3928
|
+
giftUrl: 'https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png',
|
|
3929
|
+
giftImageUrl: 'https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png',
|
|
3930
|
+
giftDurationSeconds: 3,
|
|
3931
|
+
giftDurationNanos: 0,
|
|
3932
|
+
altText: 'Heart',
|
|
3933
|
+
language: 'en_US',
|
|
3928
3934
|
},
|
|
3929
3935
|
},
|
|
3930
3936
|
{
|
|
@@ -3939,6 +3945,12 @@ exports.LumiaAlertConfigs = {
|
|
|
3939
3945
|
totalJewels: 100,
|
|
3940
3946
|
comboCount: 1,
|
|
3941
3947
|
hasVisualEffect: true,
|
|
3948
|
+
giftUrl: 'https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png',
|
|
3949
|
+
giftImageUrl: 'https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png',
|
|
3950
|
+
giftDurationSeconds: 3,
|
|
3951
|
+
giftDurationNanos: 0,
|
|
3952
|
+
altText: 'Rose',
|
|
3953
|
+
language: 'en_US',
|
|
3942
3954
|
},
|
|
3943
3955
|
},
|
|
3944
3956
|
{
|
|
@@ -3953,6 +3965,12 @@ exports.LumiaAlertConfigs = {
|
|
|
3953
3965
|
totalJewels: 500,
|
|
3954
3966
|
comboCount: 5,
|
|
3955
3967
|
hasVisualEffect: true,
|
|
3968
|
+
giftUrl: 'https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png',
|
|
3969
|
+
giftImageUrl: 'https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png',
|
|
3970
|
+
giftDurationSeconds: 3,
|
|
3971
|
+
giftDurationNanos: 0,
|
|
3972
|
+
altText: 'Star',
|
|
3973
|
+
language: 'en_US',
|
|
3956
3974
|
},
|
|
3957
3975
|
},
|
|
3958
3976
|
],
|
|
@@ -8994,19 +9012,6 @@ exports.LumiaAlertConfigs = {
|
|
|
8994
9012
|
acceptedVariables: variables_types_1.AllVariables.obs.alerts.virtualcamStateChanged,
|
|
8995
9013
|
LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_VARIABLE }],
|
|
8996
9014
|
},
|
|
8997
|
-
[activity_types_1.LumiaAlertValues.OBS_RECORD_FILE_CHANGED]: {
|
|
8998
|
-
connection: event_types_1.LumiaIntegrations.OBS,
|
|
8999
|
-
message: 'OBS record file changed',
|
|
9000
|
-
acceptedVariables: variables_types_1.AllVariables.obs.alerts.recordFileChanged,
|
|
9001
|
-
LumiaVariationConditions: [
|
|
9002
|
-
{ type: LumiaVariationConditions.RANDOM },
|
|
9003
|
-
{
|
|
9004
|
-
type: LumiaVariationConditions.EQUAL_STRING,
|
|
9005
|
-
description: 'Path is equal to',
|
|
9006
|
-
},
|
|
9007
|
-
{ type: LumiaVariationConditions.EQUAL_VARIABLE },
|
|
9008
|
-
],
|
|
9009
|
-
},
|
|
9010
9015
|
[activity_types_1.LumiaAlertValues.OBS_SCREENSHOT_SAVED]: {
|
|
9011
9016
|
connection: event_types_1.LumiaIntegrations.OBS,
|
|
9012
9017
|
message: 'OBS screenshot saved',
|
|
@@ -761,8 +761,6 @@ export declare enum LumiaAlertValues {
|
|
|
761
761
|
OBS_MEDIA_INPUT_PLAYBACK_ENDED = "obs-mediaInputPlaybackEnded",
|
|
762
762
|
/** OBS virtual camera state changed */
|
|
763
763
|
OBS_VIRTUALCAM_STATE_CHANGED = "obs-virtualcamStateChanged",
|
|
764
|
-
/** OBS record file changed */
|
|
765
|
-
OBS_RECORD_FILE_CHANGED = "obs-recordFileChanged",
|
|
766
764
|
/** OBS screenshot saved */
|
|
767
765
|
OBS_SCREENSHOT_SAVED = "obs-screenshotSaved",
|
|
768
766
|
/** OBS replay buffer saved */
|
|
@@ -761,8 +761,6 @@ export declare enum LumiaAlertValues {
|
|
|
761
761
|
OBS_MEDIA_INPUT_PLAYBACK_ENDED = "obs-mediaInputPlaybackEnded",
|
|
762
762
|
/** OBS virtual camera state changed */
|
|
763
763
|
OBS_VIRTUALCAM_STATE_CHANGED = "obs-virtualcamStateChanged",
|
|
764
|
-
/** OBS record file changed */
|
|
765
|
-
OBS_RECORD_FILE_CHANGED = "obs-recordFileChanged",
|
|
766
764
|
/** OBS screenshot saved */
|
|
767
765
|
OBS_SCREENSHOT_SAVED = "obs-screenshotSaved",
|
|
768
766
|
/** OBS replay buffer saved */
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ export { LumiaStreamingSites, LumiaActivityCommandTypes, LumiaExternalActivityCo
|
|
|
2
2
|
export { LumiaVariationConditions, LumiaVariationCurrency, VariationCurrencySymbol, LumiaAlertConfigs, LumiaDynamicCondition, type LumiaSelectionOption } from './alert.types';
|
|
3
3
|
export { ILumiaSendPack, ILumiaEvent, ILumiaEventChatCommandBody, ILumiaEventChatBody, ILumiaEventAlertBody, ILumiaEventStateBody, ILumiaLight, LumiaIntegrations, LumiaEventTypes, } from './event.types';
|
|
4
4
|
export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType } from './eventlist.types';
|
|
5
|
-
export { SystemVariables, ReservedVariables, AllVariables } from './variables.types';
|
|
5
|
+
export { SystemVariables, ReservedVariables, AllVariables, getAcceptedVariableName, getAcceptedVariableNames, type LumiaAcceptedVariable, type LumiaAcceptedVariableDefinition, } from './variables.types';
|
|
6
6
|
export { formatCondition } from './helpers';
|
|
7
7
|
export { KickKicksData } from './kick_kicks';
|
|
8
8
|
export { TiktokGiftsData } from './tiktok_gifts';
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
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;
|
|
3
|
+
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;
|
|
4
4
|
var activity_types_1 = require("./activity.types");
|
|
5
5
|
Object.defineProperty(exports, "LumiaStreamingSites", { enumerable: true, get: function () { return activity_types_1.LumiaStreamingSites; } });
|
|
6
6
|
Object.defineProperty(exports, "LumiaActivityCommandTypes", { enumerable: true, get: function () { return activity_types_1.LumiaActivityCommandTypes; } });
|
|
@@ -26,6 +26,8 @@ var variables_types_1 = require("./variables.types");
|
|
|
26
26
|
Object.defineProperty(exports, "SystemVariables", { enumerable: true, get: function () { return variables_types_1.SystemVariables; } });
|
|
27
27
|
Object.defineProperty(exports, "ReservedVariables", { enumerable: true, get: function () { return variables_types_1.ReservedVariables; } });
|
|
28
28
|
Object.defineProperty(exports, "AllVariables", { enumerable: true, get: function () { return variables_types_1.AllVariables; } });
|
|
29
|
+
Object.defineProperty(exports, "getAcceptedVariableName", { enumerable: true, get: function () { return variables_types_1.getAcceptedVariableName; } });
|
|
30
|
+
Object.defineProperty(exports, "getAcceptedVariableNames", { enumerable: true, get: function () { return variables_types_1.getAcceptedVariableNames; } });
|
|
29
31
|
var helpers_1 = require("./helpers");
|
|
30
32
|
Object.defineProperty(exports, "formatCondition", { enumerable: true, get: function () { return helpers_1.formatCondition; } });
|
|
31
33
|
var kick_kicks_1 = require("./kick_kicks");
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
export interface LumiaAcceptedVariableDefinition {
|
|
2
|
+
name: string;
|
|
3
|
+
description?: string;
|
|
4
|
+
origin?: string;
|
|
5
|
+
example?: unknown;
|
|
6
|
+
}
|
|
7
|
+
export type LumiaAcceptedVariable = string | LumiaAcceptedVariableDefinition;
|
|
8
|
+
export declare const getAcceptedVariableName: (entry: LumiaAcceptedVariable) => string;
|
|
9
|
+
export declare const getAcceptedVariableNames: (entries: LumiaAcceptedVariable[]) => string[];
|
|
1
10
|
export declare enum SystemVariables {
|
|
2
11
|
/** Read from a local file. Example: {{read_file=C:\path\file.txt}}. Use in overlays as {{read_file}}. */
|
|
3
12
|
READ_FILE = "read_file",
|
|
@@ -696,24 +705,24 @@ export declare const AllVariables: {
|
|
|
696
705
|
variables: string[];
|
|
697
706
|
chat: {
|
|
698
707
|
cooldowns: string[];
|
|
699
|
-
command: string[];
|
|
700
|
-
chatbotCommand: string[];
|
|
708
|
+
command: (string | LumiaAcceptedVariableDefinition)[];
|
|
709
|
+
chatbotCommand: (string | LumiaAcceptedVariableDefinition)[];
|
|
701
710
|
twitchPoints: string[];
|
|
702
711
|
kickPoints: string[];
|
|
703
712
|
twitchExtensions: string[];
|
|
704
713
|
fileWatcher: string[];
|
|
705
714
|
chatmatch: string[];
|
|
706
|
-
commands: string[];
|
|
707
|
-
shoutout: string[];
|
|
708
|
-
followage: string[];
|
|
709
|
-
uptime: string[];
|
|
710
|
-
aichat: string[];
|
|
711
|
-
loyaltyPoints: string[];
|
|
712
|
-
roulette: string[];
|
|
713
|
-
duel: string[];
|
|
714
|
-
slots: string[];
|
|
715
|
-
raffleEntry: string[];
|
|
716
|
-
viewerQueueEntry: string[];
|
|
715
|
+
commands: (string | LumiaAcceptedVariableDefinition)[];
|
|
716
|
+
shoutout: (string | LumiaAcceptedVariableDefinition)[];
|
|
717
|
+
followage: (string | LumiaAcceptedVariableDefinition)[];
|
|
718
|
+
uptime: (string | LumiaAcceptedVariableDefinition)[];
|
|
719
|
+
aichat: (string | LumiaAcceptedVariableDefinition)[];
|
|
720
|
+
loyaltyPoints: (string | LumiaAcceptedVariableDefinition)[];
|
|
721
|
+
roulette: (string | LumiaAcceptedVariableDefinition)[];
|
|
722
|
+
duel: (string | LumiaAcceptedVariableDefinition)[];
|
|
723
|
+
slots: (string | LumiaAcceptedVariableDefinition)[];
|
|
724
|
+
raffleEntry: (string | LumiaAcceptedVariableDefinition)[];
|
|
725
|
+
viewerQueueEntry: (string | LumiaAcceptedVariableDefinition)[];
|
|
717
726
|
};
|
|
718
727
|
alerts: {
|
|
719
728
|
lumiaOpened: string[];
|
|
@@ -772,7 +781,7 @@ export declare const AllVariables: {
|
|
|
772
781
|
reaction: string[];
|
|
773
782
|
star: string[];
|
|
774
783
|
support: string[];
|
|
775
|
-
subscriptionGift: string[];
|
|
784
|
+
subscriptionGift: (string | LumiaAcceptedVariableDefinition)[];
|
|
776
785
|
share: string[];
|
|
777
786
|
};
|
|
778
787
|
};
|
|
@@ -783,11 +792,211 @@ export declare const AllVariables: {
|
|
|
783
792
|
subscriptionChanged: string[];
|
|
784
793
|
subscriptionExpired: string[];
|
|
785
794
|
commission: string[];
|
|
786
|
-
shopOrder: string
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
795
|
+
shopOrder: (string | {
|
|
796
|
+
name: string;
|
|
797
|
+
example: {
|
|
798
|
+
id: string;
|
|
799
|
+
name: string;
|
|
800
|
+
slug: string;
|
|
801
|
+
description: string;
|
|
802
|
+
imageUrl: string;
|
|
803
|
+
variantName: string;
|
|
804
|
+
sku: string;
|
|
805
|
+
quantity: number;
|
|
806
|
+
size: string;
|
|
807
|
+
color: string;
|
|
808
|
+
colorSwatch: string;
|
|
809
|
+
attributes: string;
|
|
810
|
+
unitPrice: number;
|
|
811
|
+
price: number;
|
|
812
|
+
variant: null;
|
|
813
|
+
}[];
|
|
814
|
+
} | {
|
|
815
|
+
name: string;
|
|
816
|
+
example: string[];
|
|
817
|
+
} | {
|
|
818
|
+
name: string;
|
|
819
|
+
example: {
|
|
820
|
+
id: string;
|
|
821
|
+
name: string;
|
|
822
|
+
slug: string;
|
|
823
|
+
description: string;
|
|
824
|
+
imageUrl: string;
|
|
825
|
+
variantName: string;
|
|
826
|
+
sku: string;
|
|
827
|
+
quantity: number;
|
|
828
|
+
size: string;
|
|
829
|
+
color: string;
|
|
830
|
+
colorSwatch: string;
|
|
831
|
+
attributes: string;
|
|
832
|
+
unitPrice: number;
|
|
833
|
+
price: number;
|
|
834
|
+
variant: null;
|
|
835
|
+
};
|
|
836
|
+
})[];
|
|
837
|
+
giftPurchase: (string | {
|
|
838
|
+
name: string;
|
|
839
|
+
example: {
|
|
840
|
+
id: string;
|
|
841
|
+
name: string;
|
|
842
|
+
slug: string;
|
|
843
|
+
description: string;
|
|
844
|
+
imageUrl: string;
|
|
845
|
+
variantName: string;
|
|
846
|
+
sku: string;
|
|
847
|
+
quantity: number;
|
|
848
|
+
size: string;
|
|
849
|
+
color: string;
|
|
850
|
+
colorSwatch: string;
|
|
851
|
+
attributes: string;
|
|
852
|
+
unitPrice: number;
|
|
853
|
+
price: number;
|
|
854
|
+
variant: null;
|
|
855
|
+
};
|
|
856
|
+
} | {
|
|
857
|
+
name: string;
|
|
858
|
+
example: {
|
|
859
|
+
id: string;
|
|
860
|
+
status: string;
|
|
861
|
+
winner: {
|
|
862
|
+
username: string;
|
|
863
|
+
email: string;
|
|
864
|
+
selectedAt: string;
|
|
865
|
+
redeemUri: string;
|
|
866
|
+
};
|
|
867
|
+
orderId: string;
|
|
868
|
+
orderFriendlyId: string;
|
|
869
|
+
promotionId: string;
|
|
870
|
+
}[];
|
|
871
|
+
} | {
|
|
872
|
+
name: string;
|
|
873
|
+
example: {
|
|
874
|
+
username: string;
|
|
875
|
+
email: string;
|
|
876
|
+
status: string;
|
|
877
|
+
selectedAt: string;
|
|
878
|
+
redeemUri: string;
|
|
879
|
+
orderId: string;
|
|
880
|
+
orderFriendlyId: string;
|
|
881
|
+
promotionId: string;
|
|
882
|
+
}[];
|
|
883
|
+
} | {
|
|
884
|
+
name: string;
|
|
885
|
+
example: string[];
|
|
886
|
+
})[];
|
|
887
|
+
giveawayStarted: (string | {
|
|
888
|
+
name: string;
|
|
889
|
+
example: {
|
|
890
|
+
username: string;
|
|
891
|
+
email: string;
|
|
892
|
+
status: string;
|
|
893
|
+
selectedAt: string;
|
|
894
|
+
redeemUri: string;
|
|
895
|
+
orderId: string;
|
|
896
|
+
orderFriendlyId: string;
|
|
897
|
+
promotionId: string;
|
|
898
|
+
}[];
|
|
899
|
+
} | {
|
|
900
|
+
name: string;
|
|
901
|
+
example: string[];
|
|
902
|
+
} | {
|
|
903
|
+
name: string;
|
|
904
|
+
example: {
|
|
905
|
+
id: string;
|
|
906
|
+
status: string;
|
|
907
|
+
winner: {
|
|
908
|
+
username: string;
|
|
909
|
+
email: string;
|
|
910
|
+
selectedAt: string;
|
|
911
|
+
redeemUri: string;
|
|
912
|
+
};
|
|
913
|
+
orderId: string;
|
|
914
|
+
orderFriendlyId: string;
|
|
915
|
+
promotionId: string;
|
|
916
|
+
}[];
|
|
917
|
+
} | {
|
|
918
|
+
name: string;
|
|
919
|
+
example: {
|
|
920
|
+
id: string;
|
|
921
|
+
name: string;
|
|
922
|
+
slug: string;
|
|
923
|
+
description: string;
|
|
924
|
+
imageUrl: string;
|
|
925
|
+
variantName: string;
|
|
926
|
+
sku: string;
|
|
927
|
+
quantity: number;
|
|
928
|
+
size: string;
|
|
929
|
+
color: string;
|
|
930
|
+
colorSwatch: string;
|
|
931
|
+
attributes: string;
|
|
932
|
+
unitPrice: number;
|
|
933
|
+
price: number;
|
|
934
|
+
variant: null;
|
|
935
|
+
};
|
|
936
|
+
})[];
|
|
937
|
+
giveawayEnded: (string | {
|
|
938
|
+
name: string;
|
|
939
|
+
example: {
|
|
940
|
+
username: string;
|
|
941
|
+
email: string;
|
|
942
|
+
status: string;
|
|
943
|
+
selectedAt: string;
|
|
944
|
+
redeemUri: string;
|
|
945
|
+
orderId: string;
|
|
946
|
+
orderFriendlyId: string;
|
|
947
|
+
promotionId: string;
|
|
948
|
+
}[];
|
|
949
|
+
} | {
|
|
950
|
+
name: string;
|
|
951
|
+
example: string[];
|
|
952
|
+
} | {
|
|
953
|
+
name: string;
|
|
954
|
+
example: {
|
|
955
|
+
id: string;
|
|
956
|
+
status: string;
|
|
957
|
+
winner: {
|
|
958
|
+
username: string;
|
|
959
|
+
email: string;
|
|
960
|
+
selectedAt: string;
|
|
961
|
+
redeemUri: string;
|
|
962
|
+
};
|
|
963
|
+
orderId: string;
|
|
964
|
+
orderFriendlyId: string;
|
|
965
|
+
promotionId: string;
|
|
966
|
+
}[];
|
|
967
|
+
} | {
|
|
968
|
+
name: string;
|
|
969
|
+
example: {
|
|
970
|
+
id: string;
|
|
971
|
+
name: string;
|
|
972
|
+
slug: string;
|
|
973
|
+
description: string;
|
|
974
|
+
imageUrl: string;
|
|
975
|
+
variantName: string;
|
|
976
|
+
sku: string;
|
|
977
|
+
quantity: number;
|
|
978
|
+
size: string;
|
|
979
|
+
color: string;
|
|
980
|
+
colorSwatch: string;
|
|
981
|
+
attributes: string;
|
|
982
|
+
unitPrice: number;
|
|
983
|
+
price: number;
|
|
984
|
+
variant: null;
|
|
985
|
+
};
|
|
986
|
+
})[];
|
|
987
|
+
thankyouSent: (string | {
|
|
988
|
+
name: string;
|
|
989
|
+
example: {
|
|
990
|
+
id: string;
|
|
991
|
+
type: string;
|
|
992
|
+
shopId: string;
|
|
993
|
+
supporter: {
|
|
994
|
+
username: string;
|
|
995
|
+
email: string;
|
|
996
|
+
message: string;
|
|
997
|
+
};
|
|
998
|
+
};
|
|
999
|
+
})[];
|
|
791
1000
|
newsletterSubscribed: string[];
|
|
792
1001
|
};
|
|
793
1002
|
};
|
|
@@ -800,7 +1009,7 @@ export declare const AllVariables: {
|
|
|
800
1009
|
sessionFollowers: string[];
|
|
801
1010
|
subscriber: string[];
|
|
802
1011
|
sessionSubs: string[];
|
|
803
|
-
subscriptionGift: string[];
|
|
1012
|
+
subscriptionGift: (string | LumiaAcceptedVariableDefinition)[];
|
|
804
1013
|
sessionGiftSubscriptions: string[];
|
|
805
1014
|
kicks: string[];
|
|
806
1015
|
sessionKicks: string[];
|
|
@@ -851,7 +1060,6 @@ export declare const AllVariables: {
|
|
|
851
1060
|
mediaInputPlaybackStarted: string[];
|
|
852
1061
|
mediaInputPlaybackEnded: string[];
|
|
853
1062
|
virtualcamStateChanged: string[];
|
|
854
|
-
recordFileChanged: string[];
|
|
855
1063
|
screenshotSaved: string[];
|
|
856
1064
|
replayBufferSaved: string[];
|
|
857
1065
|
verticalBacktrackSaved: string[];
|
|
@@ -964,7 +1172,7 @@ export declare const AllVariables: {
|
|
|
964
1172
|
sessionFollowers: string[];
|
|
965
1173
|
subscriber: string[];
|
|
966
1174
|
sessionSubs: string[];
|
|
967
|
-
giftSubscription: string[];
|
|
1175
|
+
giftSubscription: (string | LumiaAcceptedVariableDefinition)[];
|
|
968
1176
|
sessionGiftSubscriptions: string[];
|
|
969
1177
|
bits: string[];
|
|
970
1178
|
bitsCombo: string[];
|
|
@@ -1052,7 +1260,7 @@ export declare const AllVariables: {
|
|
|
1052
1260
|
sessionSubs: string[];
|
|
1053
1261
|
member: string[];
|
|
1054
1262
|
sessionMembers: string[];
|
|
1055
|
-
giftMembers: string[];
|
|
1263
|
+
giftMembers: (string | LumiaAcceptedVariableDefinition)[];
|
|
1056
1264
|
sessionGiftMembers: string[];
|
|
1057
1265
|
gifts: string[];
|
|
1058
1266
|
sessionGifts: string[];
|
package/dist/variables.types.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// [AI] When SystemVariables is used, update custom-overlays.d.ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = void 0;
|
|
4
|
+
exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.getAcceptedVariableNames = exports.getAcceptedVariableName = void 0;
|
|
5
|
+
const getAcceptedVariableName = (entry) => typeof entry === 'string' ? entry : entry.name;
|
|
6
|
+
exports.getAcceptedVariableName = getAcceptedVariableName;
|
|
7
|
+
const getAcceptedVariableNames = (entries) => entries.map(exports.getAcceptedVariableName);
|
|
8
|
+
exports.getAcceptedVariableNames = getAcceptedVariableNames;
|
|
5
9
|
// Use the **string values** of this enum inside overlays: e.g. {{twitch_total_subscriber_count}}, not {{TWITCH_TOTAL_SUBSCRIBER_COUNT}}.
|
|
6
10
|
var SystemVariables;
|
|
7
11
|
(function (SystemVariables) {
|
|
@@ -833,6 +837,55 @@ exports.ReservedVariables = [
|
|
|
833
837
|
'follow_time',
|
|
834
838
|
'uptime',
|
|
835
839
|
];
|
|
840
|
+
// Shared example shapes for object/array variables that recur across alerts.
|
|
841
|
+
const USER_LEVELS_RAW_EXAMPLE = {
|
|
842
|
+
isSelf: false,
|
|
843
|
+
mod: false,
|
|
844
|
+
vip: false,
|
|
845
|
+
tier3: false,
|
|
846
|
+
tier2: false,
|
|
847
|
+
tier1: false,
|
|
848
|
+
subscriber: true,
|
|
849
|
+
follower: true,
|
|
850
|
+
};
|
|
851
|
+
const TWITCH_RECIPIENTS_RAW_EXAMPLE = {
|
|
852
|
+
name: 'recipientsRaw',
|
|
853
|
+
example: [
|
|
854
|
+
{
|
|
855
|
+
displayname: 'Ex: LumiaFan',
|
|
856
|
+
username: 'Ex: lumia_fan',
|
|
857
|
+
userId: 'Ex: 123456789',
|
|
858
|
+
avatar: 'Ex: https://static-cdn.jtvnw.net/jtv_user_pictures/lumia.png',
|
|
859
|
+
},
|
|
860
|
+
],
|
|
861
|
+
};
|
|
862
|
+
const KICK_RECIPIENTS_RAW_EXAMPLE = {
|
|
863
|
+
name: 'recipientsRaw',
|
|
864
|
+
example: [
|
|
865
|
+
{
|
|
866
|
+
username: 'Ex: lumia_fan',
|
|
867
|
+
userId: 'Ex: 987654',
|
|
868
|
+
displayname: 'Ex: LumiaFan',
|
|
869
|
+
avatar: 'Ex: https://files.kick.com/images/user/lumia.jpg',
|
|
870
|
+
},
|
|
871
|
+
],
|
|
872
|
+
};
|
|
873
|
+
const YOUTUBE_RECIPIENTS_RAW_EXAMPLE = {
|
|
874
|
+
name: 'recipientsRaw',
|
|
875
|
+
example: [
|
|
876
|
+
{
|
|
877
|
+
username: 'Ex: lumia_member',
|
|
878
|
+
displayname: 'Ex: LumiaMember',
|
|
879
|
+
userId: 'Ex: UCabc123',
|
|
880
|
+
avatar: 'Ex: https://yt3.ggpht.com/lumia-avatar.jpg',
|
|
881
|
+
memberLevelName: 'Ex: Level 1',
|
|
882
|
+
},
|
|
883
|
+
],
|
|
884
|
+
};
|
|
885
|
+
const USER_LEVELS_RAW_VARIABLE = {
|
|
886
|
+
name: 'userLevelsRaw',
|
|
887
|
+
example: USER_LEVELS_RAW_EXAMPLE,
|
|
888
|
+
};
|
|
836
889
|
exports.AllVariables = {
|
|
837
890
|
lumiastream: {
|
|
838
891
|
variables: [
|
|
@@ -949,7 +1002,7 @@ exports.AllVariables = {
|
|
|
949
1002
|
'userId',
|
|
950
1003
|
'avatar',
|
|
951
1004
|
'userLevels',
|
|
952
|
-
|
|
1005
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
953
1006
|
'channelDescription',
|
|
954
1007
|
'channelViews',
|
|
955
1008
|
'originType',
|
|
@@ -975,7 +1028,7 @@ exports.AllVariables = {
|
|
|
975
1028
|
'userId',
|
|
976
1029
|
'avatar',
|
|
977
1030
|
'userLevels',
|
|
978
|
-
|
|
1031
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
979
1032
|
'channelDescription',
|
|
980
1033
|
'channelViews',
|
|
981
1034
|
'originType',
|
|
@@ -1057,7 +1110,7 @@ exports.AllVariables = {
|
|
|
1057
1110
|
'userId',
|
|
1058
1111
|
'avatar',
|
|
1059
1112
|
'userLevels',
|
|
1060
|
-
|
|
1113
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1061
1114
|
'channelDescription',
|
|
1062
1115
|
'channelViews',
|
|
1063
1116
|
'originType',
|
|
@@ -1106,7 +1159,7 @@ exports.AllVariables = {
|
|
|
1106
1159
|
'userId',
|
|
1107
1160
|
'avatar',
|
|
1108
1161
|
'userLevels',
|
|
1109
|
-
|
|
1162
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1110
1163
|
'channelDescription',
|
|
1111
1164
|
'channelViews',
|
|
1112
1165
|
'command',
|
|
@@ -1127,7 +1180,7 @@ exports.AllVariables = {
|
|
|
1127
1180
|
'userId',
|
|
1128
1181
|
'avatar',
|
|
1129
1182
|
'userLevels',
|
|
1130
|
-
|
|
1183
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1131
1184
|
'channelDescription',
|
|
1132
1185
|
'channelViews',
|
|
1133
1186
|
'command',
|
|
@@ -1148,7 +1201,7 @@ exports.AllVariables = {
|
|
|
1148
1201
|
'userId',
|
|
1149
1202
|
'avatar',
|
|
1150
1203
|
'userLevels',
|
|
1151
|
-
|
|
1204
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1152
1205
|
'channelDescription',
|
|
1153
1206
|
'channelViews',
|
|
1154
1207
|
'command',
|
|
@@ -1169,7 +1222,7 @@ exports.AllVariables = {
|
|
|
1169
1222
|
'userId',
|
|
1170
1223
|
'avatar',
|
|
1171
1224
|
'userLevels',
|
|
1172
|
-
|
|
1225
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1173
1226
|
'channelDescription',
|
|
1174
1227
|
'channelViews',
|
|
1175
1228
|
'command',
|
|
@@ -1194,7 +1247,7 @@ exports.AllVariables = {
|
|
|
1194
1247
|
'userId',
|
|
1195
1248
|
'avatar',
|
|
1196
1249
|
'userLevels',
|
|
1197
|
-
|
|
1250
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1198
1251
|
'channelDescription',
|
|
1199
1252
|
'channelViews',
|
|
1200
1253
|
'command',
|
|
@@ -1217,7 +1270,7 @@ exports.AllVariables = {
|
|
|
1217
1270
|
'userId',
|
|
1218
1271
|
'avatar',
|
|
1219
1272
|
'userLevels',
|
|
1220
|
-
|
|
1273
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1221
1274
|
'channelDescription',
|
|
1222
1275
|
'channelViews',
|
|
1223
1276
|
'command',
|
|
@@ -1243,7 +1296,7 @@ exports.AllVariables = {
|
|
|
1243
1296
|
'userId',
|
|
1244
1297
|
'avatar',
|
|
1245
1298
|
'userLevels',
|
|
1246
|
-
|
|
1299
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1247
1300
|
'channelDescription',
|
|
1248
1301
|
'channelViews',
|
|
1249
1302
|
'command',
|
|
@@ -1266,7 +1319,7 @@ exports.AllVariables = {
|
|
|
1266
1319
|
'userId',
|
|
1267
1320
|
'avatar',
|
|
1268
1321
|
'userLevels',
|
|
1269
|
-
|
|
1322
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1270
1323
|
'channelDescription',
|
|
1271
1324
|
'channelViews',
|
|
1272
1325
|
'command',
|
|
@@ -1296,7 +1349,7 @@ exports.AllVariables = {
|
|
|
1296
1349
|
'userId',
|
|
1297
1350
|
'avatar',
|
|
1298
1351
|
'userLevels',
|
|
1299
|
-
|
|
1352
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1300
1353
|
'channelDescription',
|
|
1301
1354
|
'channelViews',
|
|
1302
1355
|
'command',
|
|
@@ -1322,7 +1375,7 @@ exports.AllVariables = {
|
|
|
1322
1375
|
'userId',
|
|
1323
1376
|
'avatar',
|
|
1324
1377
|
'userLevels',
|
|
1325
|
-
|
|
1378
|
+
USER_LEVELS_RAW_VARIABLE,
|
|
1326
1379
|
'channelDescription',
|
|
1327
1380
|
'channelViews',
|
|
1328
1381
|
'command',
|
|
@@ -1447,7 +1500,7 @@ exports.AllVariables = {
|
|
|
1447
1500
|
reaction: ['username', 'reaction'],
|
|
1448
1501
|
star: ['username', 'amount'],
|
|
1449
1502
|
support: ['username', 'amount'],
|
|
1450
|
-
subscriptionGift: ['username', 'recipient', 'recipients',
|
|
1503
|
+
subscriptionGift: ['username', 'recipient', 'recipients', TWITCH_RECIPIENTS_RAW_EXAMPLE, 'gifter', 'giftAmount', 'message'],
|
|
1451
1504
|
share: ['username'],
|
|
1452
1505
|
},
|
|
1453
1506
|
},
|
|
@@ -1458,7 +1511,64 @@ exports.AllVariables = {
|
|
|
1458
1511
|
subscriptionChanged: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
|
|
1459
1512
|
subscriptionExpired: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
|
|
1460
1513
|
commission: ['username', 'email', 'message', 'currency', 'amount', 'raw'],
|
|
1461
|
-
shopOrder: [
|
|
1514
|
+
shopOrder: [
|
|
1515
|
+
'username',
|
|
1516
|
+
'email',
|
|
1517
|
+
'message',
|
|
1518
|
+
'items',
|
|
1519
|
+
'itemsCount',
|
|
1520
|
+
'itemsDetailed',
|
|
1521
|
+
{
|
|
1522
|
+
name: 'orderItems',
|
|
1523
|
+
example: [
|
|
1524
|
+
{
|
|
1525
|
+
id: 'Ex: lumia-shirt-001',
|
|
1526
|
+
name: 'Ex: Lumia Stream Tee',
|
|
1527
|
+
slug: 'Ex: lumia-stream-tee',
|
|
1528
|
+
description: 'Ex: Official Lumia Stream merch',
|
|
1529
|
+
imageUrl: 'Ex: https://lumiastream.com/merch/lumia-tee.png',
|
|
1530
|
+
variantName: 'Ex: Lumia Logo - Black - L',
|
|
1531
|
+
sku: 'Ex: LUMIA-TEE-BLK-L',
|
|
1532
|
+
quantity: 1,
|
|
1533
|
+
size: 'Ex: L',
|
|
1534
|
+
color: 'Ex: Black',
|
|
1535
|
+
colorSwatch: 'Ex: #000000',
|
|
1536
|
+
attributes: 'Ex: Black, L',
|
|
1537
|
+
unitPrice: 25,
|
|
1538
|
+
price: 25,
|
|
1539
|
+
variant: null,
|
|
1540
|
+
},
|
|
1541
|
+
],
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
name: 'itemImages',
|
|
1545
|
+
example: ['Ex: https://lumiastream.com/merch/lumia-tee.png'],
|
|
1546
|
+
},
|
|
1547
|
+
'friendlyId',
|
|
1548
|
+
'currency',
|
|
1549
|
+
'amount',
|
|
1550
|
+
{
|
|
1551
|
+
name: 'firstItem',
|
|
1552
|
+
example: {
|
|
1553
|
+
id: 'Ex: lumia-shirt-001',
|
|
1554
|
+
name: 'Ex: Lumia Stream Tee',
|
|
1555
|
+
slug: 'Ex: lumia-stream-tee',
|
|
1556
|
+
description: 'Ex: Official Lumia Stream merch',
|
|
1557
|
+
imageUrl: 'Ex: https://lumiastream.com/merch/lumia-tee.png',
|
|
1558
|
+
variantName: 'Ex: Lumia Logo - Black - L',
|
|
1559
|
+
sku: 'Ex: LUMIA-TEE-BLK-L',
|
|
1560
|
+
quantity: 1,
|
|
1561
|
+
size: 'Ex: L',
|
|
1562
|
+
color: 'Ex: Black',
|
|
1563
|
+
colorSwatch: 'Ex: #000000',
|
|
1564
|
+
attributes: 'Ex: Black, L',
|
|
1565
|
+
unitPrice: 25,
|
|
1566
|
+
price: 25,
|
|
1567
|
+
variant: null,
|
|
1568
|
+
},
|
|
1569
|
+
},
|
|
1570
|
+
'raw',
|
|
1571
|
+
],
|
|
1462
1572
|
giftPurchase: [
|
|
1463
1573
|
'username',
|
|
1464
1574
|
'email',
|
|
@@ -1467,12 +1577,65 @@ exports.AllVariables = {
|
|
|
1467
1577
|
'amount',
|
|
1468
1578
|
'friendlyId',
|
|
1469
1579
|
'quantity',
|
|
1470
|
-
|
|
1580
|
+
{
|
|
1581
|
+
name: 'offer',
|
|
1582
|
+
example: {
|
|
1583
|
+
id: 'Ex: lumia-shirt-001',
|
|
1584
|
+
name: 'Ex: Lumia Stream Tee',
|
|
1585
|
+
slug: 'Ex: lumia-stream-tee',
|
|
1586
|
+
description: 'Ex: Official Lumia Stream merch',
|
|
1587
|
+
imageUrl: 'Ex: https://lumiastream.com/merch/lumia-tee.png',
|
|
1588
|
+
variantName: 'Ex: Lumia Logo - Black - L',
|
|
1589
|
+
sku: 'Ex: LUMIA-TEE-BLK-L',
|
|
1590
|
+
quantity: 1,
|
|
1591
|
+
size: 'Ex: L',
|
|
1592
|
+
color: 'Ex: Black',
|
|
1593
|
+
colorSwatch: 'Ex: #000000',
|
|
1594
|
+
attributes: 'Ex: Black, L',
|
|
1595
|
+
unitPrice: 25,
|
|
1596
|
+
price: 25,
|
|
1597
|
+
variant: null,
|
|
1598
|
+
},
|
|
1599
|
+
},
|
|
1471
1600
|
'offerImageUrl',
|
|
1472
|
-
|
|
1601
|
+
{
|
|
1602
|
+
name: 'gifts',
|
|
1603
|
+
example: [
|
|
1604
|
+
{
|
|
1605
|
+
id: 'Ex: gift-001',
|
|
1606
|
+
status: 'Ex: AVAILABLE',
|
|
1607
|
+
winner: {
|
|
1608
|
+
username: 'Ex: lumiastream',
|
|
1609
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1610
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1611
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1612
|
+
},
|
|
1613
|
+
orderId: 'Ex: ord-12345',
|
|
1614
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1615
|
+
promotionId: 'Ex: prm-001',
|
|
1616
|
+
},
|
|
1617
|
+
],
|
|
1618
|
+
},
|
|
1473
1619
|
'giftCount',
|
|
1474
|
-
|
|
1475
|
-
|
|
1620
|
+
{
|
|
1621
|
+
name: 'winners',
|
|
1622
|
+
example: [
|
|
1623
|
+
{
|
|
1624
|
+
username: 'Ex: lumiastream',
|
|
1625
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1626
|
+
status: 'Ex: REDEEMED',
|
|
1627
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1628
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1629
|
+
orderId: 'Ex: ord-12345',
|
|
1630
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1631
|
+
promotionId: 'Ex: prm-001',
|
|
1632
|
+
},
|
|
1633
|
+
],
|
|
1634
|
+
},
|
|
1635
|
+
{
|
|
1636
|
+
name: 'winnerNames',
|
|
1637
|
+
example: ['Ex: lumiastream'],
|
|
1638
|
+
},
|
|
1476
1639
|
'winnerCount',
|
|
1477
1640
|
'firstWinner',
|
|
1478
1641
|
'availableGiftCount',
|
|
@@ -1491,15 +1654,85 @@ exports.AllVariables = {
|
|
|
1491
1654
|
'giveawayFriendlyId',
|
|
1492
1655
|
'offerName',
|
|
1493
1656
|
'offerImageUrl',
|
|
1494
|
-
|
|
1495
|
-
|
|
1657
|
+
{
|
|
1658
|
+
name: 'winners',
|
|
1659
|
+
example: [
|
|
1660
|
+
{
|
|
1661
|
+
username: 'Ex: lumiastream',
|
|
1662
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1663
|
+
status: 'Ex: REDEEMED',
|
|
1664
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1665
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1666
|
+
orderId: 'Ex: ord-12345',
|
|
1667
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1668
|
+
promotionId: 'Ex: prm-001',
|
|
1669
|
+
},
|
|
1670
|
+
],
|
|
1671
|
+
},
|
|
1672
|
+
{
|
|
1673
|
+
name: 'winnerNames',
|
|
1674
|
+
example: ['Ex: lumiastream'],
|
|
1675
|
+
},
|
|
1496
1676
|
'winnerCount',
|
|
1497
1677
|
'firstWinner',
|
|
1498
1678
|
'duration',
|
|
1499
|
-
|
|
1500
|
-
|
|
1679
|
+
{
|
|
1680
|
+
name: 'allGifts',
|
|
1681
|
+
example: [
|
|
1682
|
+
{
|
|
1683
|
+
id: 'Ex: gift-001',
|
|
1684
|
+
status: 'Ex: AVAILABLE',
|
|
1685
|
+
winner: {
|
|
1686
|
+
username: 'Ex: lumiastream',
|
|
1687
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1688
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1689
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1690
|
+
},
|
|
1691
|
+
orderId: 'Ex: ord-12345',
|
|
1692
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1693
|
+
promotionId: 'Ex: prm-001',
|
|
1694
|
+
},
|
|
1695
|
+
],
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
name: 'gifts',
|
|
1699
|
+
example: [
|
|
1700
|
+
{
|
|
1701
|
+
id: 'Ex: gift-001',
|
|
1702
|
+
status: 'Ex: AVAILABLE',
|
|
1703
|
+
winner: {
|
|
1704
|
+
username: 'Ex: lumiastream',
|
|
1705
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1706
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1707
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1708
|
+
},
|
|
1709
|
+
orderId: 'Ex: ord-12345',
|
|
1710
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1711
|
+
promotionId: 'Ex: prm-001',
|
|
1712
|
+
},
|
|
1713
|
+
],
|
|
1714
|
+
},
|
|
1501
1715
|
'totalGifts',
|
|
1502
|
-
|
|
1716
|
+
{
|
|
1717
|
+
name: 'offer',
|
|
1718
|
+
example: {
|
|
1719
|
+
id: 'Ex: lumia-shirt-001',
|
|
1720
|
+
name: 'Ex: Lumia Stream Tee',
|
|
1721
|
+
slug: 'Ex: lumia-stream-tee',
|
|
1722
|
+
description: 'Ex: Official Lumia Stream merch',
|
|
1723
|
+
imageUrl: 'Ex: https://lumiastream.com/merch/lumia-tee.png',
|
|
1724
|
+
variantName: 'Ex: Lumia Logo - Black - L',
|
|
1725
|
+
sku: 'Ex: LUMIA-TEE-BLK-L',
|
|
1726
|
+
quantity: 1,
|
|
1727
|
+
size: 'Ex: L',
|
|
1728
|
+
color: 'Ex: Black',
|
|
1729
|
+
colorSwatch: 'Ex: #000000',
|
|
1730
|
+
attributes: 'Ex: Black, L',
|
|
1731
|
+
unitPrice: 25,
|
|
1732
|
+
price: 25,
|
|
1733
|
+
variant: null,
|
|
1734
|
+
},
|
|
1735
|
+
},
|
|
1503
1736
|
'type',
|
|
1504
1737
|
],
|
|
1505
1738
|
giveawayEnded: [
|
|
@@ -1513,18 +1746,107 @@ exports.AllVariables = {
|
|
|
1513
1746
|
'giveawayFriendlyId',
|
|
1514
1747
|
'offerName',
|
|
1515
1748
|
'offerImageUrl',
|
|
1516
|
-
|
|
1517
|
-
|
|
1749
|
+
{
|
|
1750
|
+
name: 'winners',
|
|
1751
|
+
example: [
|
|
1752
|
+
{
|
|
1753
|
+
username: 'Ex: lumiastream',
|
|
1754
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1755
|
+
status: 'Ex: REDEEMED',
|
|
1756
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1757
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1758
|
+
orderId: 'Ex: ord-12345',
|
|
1759
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1760
|
+
promotionId: 'Ex: prm-001',
|
|
1761
|
+
},
|
|
1762
|
+
],
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
name: 'winnerNames',
|
|
1766
|
+
example: ['Ex: lumiastream'],
|
|
1767
|
+
},
|
|
1518
1768
|
'winnerCount',
|
|
1519
1769
|
'firstWinner',
|
|
1520
1770
|
'duration',
|
|
1521
|
-
|
|
1522
|
-
|
|
1771
|
+
{
|
|
1772
|
+
name: 'allGifts',
|
|
1773
|
+
example: [
|
|
1774
|
+
{
|
|
1775
|
+
id: 'Ex: gift-001',
|
|
1776
|
+
status: 'Ex: AVAILABLE',
|
|
1777
|
+
winner: {
|
|
1778
|
+
username: 'Ex: lumiastream',
|
|
1779
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1780
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1781
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1782
|
+
},
|
|
1783
|
+
orderId: 'Ex: ord-12345',
|
|
1784
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1785
|
+
promotionId: 'Ex: prm-001',
|
|
1786
|
+
},
|
|
1787
|
+
],
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
name: 'gifts',
|
|
1791
|
+
example: [
|
|
1792
|
+
{
|
|
1793
|
+
id: 'Ex: gift-001',
|
|
1794
|
+
status: 'Ex: REDEEMED',
|
|
1795
|
+
winner: {
|
|
1796
|
+
username: 'Ex: lumiastream',
|
|
1797
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1798
|
+
selectedAt: 'Ex: 2026-05-14T15:55:15Z',
|
|
1799
|
+
redeemUri: 'Ex: https://shop.lumiastream.com/redeem',
|
|
1800
|
+
},
|
|
1801
|
+
orderId: 'Ex: ord-12345',
|
|
1802
|
+
orderFriendlyId: 'Ex: LSORDER1',
|
|
1803
|
+
promotionId: 'Ex: prm-001',
|
|
1804
|
+
},
|
|
1805
|
+
],
|
|
1806
|
+
},
|
|
1523
1807
|
'totalGifts',
|
|
1524
|
-
|
|
1808
|
+
{
|
|
1809
|
+
name: 'offer',
|
|
1810
|
+
example: {
|
|
1811
|
+
id: 'Ex: lumia-shirt-001',
|
|
1812
|
+
name: 'Ex: Lumia Stream Tee',
|
|
1813
|
+
slug: 'Ex: lumia-stream-tee',
|
|
1814
|
+
description: 'Ex: Official Lumia Stream merch',
|
|
1815
|
+
imageUrl: 'Ex: https://lumiastream.com/merch/lumia-tee.png',
|
|
1816
|
+
variantName: 'Ex: Lumia Logo - Black - L',
|
|
1817
|
+
sku: 'Ex: LUMIA-TEE-BLK-L',
|
|
1818
|
+
quantity: 1,
|
|
1819
|
+
size: 'Ex: L',
|
|
1820
|
+
color: 'Ex: Black',
|
|
1821
|
+
colorSwatch: 'Ex: #000000',
|
|
1822
|
+
attributes: 'Ex: Black, L',
|
|
1823
|
+
unitPrice: 25,
|
|
1824
|
+
price: 25,
|
|
1825
|
+
variant: null,
|
|
1826
|
+
},
|
|
1827
|
+
},
|
|
1525
1828
|
'type',
|
|
1526
1829
|
],
|
|
1527
|
-
thankyouSent: [
|
|
1830
|
+
thankyouSent: [
|
|
1831
|
+
'username',
|
|
1832
|
+
'email',
|
|
1833
|
+
'message',
|
|
1834
|
+
'mediaUrl',
|
|
1835
|
+
'contributionType',
|
|
1836
|
+
{
|
|
1837
|
+
name: 'contribution',
|
|
1838
|
+
example: {
|
|
1839
|
+
id: 'Ex: contrib-12345',
|
|
1840
|
+
type: 'Ex: ORDER',
|
|
1841
|
+
shopId: 'Ex: sh_lumiastream',
|
|
1842
|
+
supporter: {
|
|
1843
|
+
username: 'Ex: lumiastream',
|
|
1844
|
+
email: 'Ex: viewer@lumiastream.com',
|
|
1845
|
+
message: 'Ex: Thanks for the stream!',
|
|
1846
|
+
},
|
|
1847
|
+
},
|
|
1848
|
+
},
|
|
1849
|
+
],
|
|
1528
1850
|
newsletterSubscribed: ['email', 'raw'],
|
|
1529
1851
|
},
|
|
1530
1852
|
},
|
|
@@ -1575,7 +1897,7 @@ exports.AllVariables = {
|
|
|
1575
1897
|
sessionFollowers: ['total', 'previousTotal'],
|
|
1576
1898
|
subscriber: ['username', 'avatar', 'tier', 'recipient', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
|
|
1577
1899
|
sessionSubs: ['total', 'previousTotal'],
|
|
1578
|
-
subscriptionGift: ['username', 'avatar', 'tier', 'giftAmount', 'recipients',
|
|
1900
|
+
subscriptionGift: ['username', 'avatar', 'tier', 'giftAmount', 'recipients', KICK_RECIPIENTS_RAW_EXAMPLE, 'gifter', 'totalGifts', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
|
|
1579
1901
|
sessionGiftSubscriptions: ['total', 'previousTotal'],
|
|
1580
1902
|
kicks: ['username', 'avatar', 'amount', 'name', 'type', 'tier', 'id', 'message'],
|
|
1581
1903
|
sessionKicks: ['total', 'previousTotal'],
|
|
@@ -1657,7 +1979,6 @@ exports.AllVariables = {
|
|
|
1657
1979
|
mediaInputPlaybackStarted: ['inputName', 'inputUuid'],
|
|
1658
1980
|
mediaInputPlaybackEnded: ['inputName', 'inputUuid'],
|
|
1659
1981
|
virtualcamStateChanged: ['outputActive', 'outputState'],
|
|
1660
|
-
recordFileChanged: ['newOutputPath'],
|
|
1661
1982
|
screenshotSaved: ['savedScreenshotPath'],
|
|
1662
1983
|
replayBufferSaved: ['saved_key'],
|
|
1663
1984
|
verticalBacktrackSaved: ['saved_key', 'height', 'width'],
|
|
@@ -1874,7 +2195,7 @@ exports.AllVariables = {
|
|
|
1874
2195
|
sessionFollowers: ['total', 'previousTotal'],
|
|
1875
2196
|
subscriber: ['username', 'avatar', 'tier', 'recipient', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
|
|
1876
2197
|
sessionSubs: ['total', 'previousTotal'],
|
|
1877
|
-
giftSubscription: ['username', 'avatar', 'tier', 'giftAmount', 'recipients',
|
|
2198
|
+
giftSubscription: ['username', 'avatar', 'tier', 'giftAmount', 'recipients', TWITCH_RECIPIENTS_RAW_EXAMPLE, 'gifter', 'totalGifts', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
|
|
1878
2199
|
sessionGiftSubscriptions: ['total', 'previousTotal'],
|
|
1879
2200
|
bits: ['username', 'avatar', 'amount', 'message'],
|
|
1880
2201
|
bitsCombo: ['username', 'avatar', 'amount', 'bitsType', 'message'],
|
|
@@ -2119,7 +2440,7 @@ exports.AllVariables = {
|
|
|
2119
2440
|
'tier',
|
|
2120
2441
|
'giftAmount',
|
|
2121
2442
|
'recipients',
|
|
2122
|
-
|
|
2443
|
+
YOUTUBE_RECIPIENTS_RAW_EXAMPLE,
|
|
2123
2444
|
'gifter',
|
|
2124
2445
|
'totalGifts',
|
|
2125
2446
|
'subMonths',
|
|
@@ -2139,6 +2460,9 @@ exports.AllVariables = {
|
|
|
2139
2460
|
'comboCount',
|
|
2140
2461
|
'giftName',
|
|
2141
2462
|
'giftUrl',
|
|
2463
|
+
'giftImageUrl',
|
|
2464
|
+
'giftDurationSeconds',
|
|
2465
|
+
'giftDurationNanos',
|
|
2142
2466
|
'hasVisualEffect',
|
|
2143
2467
|
'altText',
|
|
2144
2468
|
'language',
|