@lumiastream/lumia-types 3.0.2 → 3.0.3
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/alert.types.js +14 -84
- package/dist/custom-overlays/custom-overlays-examples.md +2 -0
- package/dist/custom-overlays/custom-overlays.d.ts +10 -0
- package/dist/custom-overlays.d.ts +10 -0
- package/dist/variables.types.d.ts +10 -0
- package/dist/variables.types.js +15 -0
- package/package.json +1 -1
package/dist/alert.types.js
CHANGED
|
@@ -3909,101 +3909,45 @@ exports.LumiaAlertConfigs = {
|
|
|
3909
3909
|
acceptedVariables: variables_types_1.AllVariables.youtube.alerts.supersticker,
|
|
3910
3910
|
quickActions: [
|
|
3911
3911
|
{
|
|
3912
|
-
label: 'Beaming Face ($
|
|
3913
|
-
dynamic: { value:
|
|
3912
|
+
label: 'Emoji Beaming Face ($100)',
|
|
3913
|
+
dynamic: { value: 100, currency: LumiaVariationCurrency.USD, name: 'emoji_beaming_face' },
|
|
3914
3914
|
extraSettings: {
|
|
3915
3915
|
username: 'lumiastream',
|
|
3916
3916
|
displayname: 'LumiaStream',
|
|
3917
3917
|
avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
|
|
3918
|
-
amount:
|
|
3918
|
+
amount: 100,
|
|
3919
3919
|
currency: LumiaVariationCurrency.USD,
|
|
3920
3920
|
currencySymbol: '$',
|
|
3921
3921
|
stickerId: 'emoji_beaming_face',
|
|
3922
|
-
stickerName: 'Beaming
|
|
3923
|
-
},
|
|
3924
|
-
},
|
|
3925
|
-
{
|
|
3926
|
-
label: 'Pear Hey You ($2.00)',
|
|
3927
|
-
dynamic: { value: 2, currency: LumiaVariationCurrency.USD, name: 'pearfect_hey_you_ja_v2' },
|
|
3928
|
-
extraSettings: {
|
|
3929
|
-
username: 'lumiastream',
|
|
3930
|
-
displayname: 'LumiaStream',
|
|
3931
|
-
avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
|
|
3932
|
-
amount: 2,
|
|
3933
|
-
currency: LumiaVariationCurrency.USD,
|
|
3934
|
-
currencySymbol: '$',
|
|
3935
|
-
stickerId: 'pearfect_hey_you_ja_v2',
|
|
3936
|
-
stickerName: "Pear character turning around waving his hand, saying 'Hey you' while lowering his glasses",
|
|
3937
|
-
},
|
|
3938
|
-
},
|
|
3939
|
-
{
|
|
3940
|
-
label: 'Pear LOL ($5.00)',
|
|
3941
|
-
dynamic: { value: 5, currency: LumiaVariationCurrency.USD, name: 'pearfect_lol_ja_v2' },
|
|
3942
|
-
extraSettings: {
|
|
3943
|
-
username: 'lumiastream',
|
|
3944
|
-
displayname: 'LumiaStream',
|
|
3945
|
-
avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
|
|
3946
|
-
amount: 5,
|
|
3947
|
-
currency: LumiaVariationCurrency.USD,
|
|
3948
|
-
currencySymbol: '$',
|
|
3949
|
-
stickerId: 'pearfect_lol_ja_v2',
|
|
3950
|
-
stickerName: 'Pear character holding his belly laughing out loud',
|
|
3922
|
+
stickerName: 'Emoji Beaming Face',
|
|
3951
3923
|
},
|
|
3952
3924
|
},
|
|
3953
3925
|
{
|
|
3954
|
-
label: '
|
|
3955
|
-
dynamic: { value:
|
|
3926
|
+
label: 'Emoji Laughing ($200)',
|
|
3927
|
+
dynamic: { value: 200, currency: LumiaVariationCurrency.USD, name: 'emoji_laughing' },
|
|
3956
3928
|
extraSettings: {
|
|
3957
3929
|
username: 'lumiastream',
|
|
3958
3930
|
displayname: 'LumiaStream',
|
|
3959
3931
|
avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
|
|
3960
|
-
amount:
|
|
3961
|
-
currency: LumiaVariationCurrency.USD,
|
|
3962
|
-
currencySymbol: '$',
|
|
3963
|
-
stickerId: 'hi_po_po_hype_v2',
|
|
3964
|
-
stickerName: "Hippo character with stars growing in his eyes, pumping his arms in the air with the word 'Hype' pulsating above him",
|
|
3965
|
-
},
|
|
3966
|
-
},
|
|
3967
|
-
{
|
|
3968
|
-
label: 'Hippo Chair Spin ($10.00)',
|
|
3969
|
-
dynamic: { value: 10, currency: LumiaVariationCurrency.USD, name: 'hi_po_po_chair_spin_yay' },
|
|
3970
|
-
extraSettings: {
|
|
3971
|
-
username: 'lumiastream',
|
|
3972
|
-
displayname: 'LumiaStream',
|
|
3973
|
-
avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
|
|
3974
|
-
amount: 10,
|
|
3975
|
-
currency: LumiaVariationCurrency.USD,
|
|
3976
|
-
currencySymbol: '$',
|
|
3977
|
-
stickerId: 'hi_po_po_chair_spin_yay',
|
|
3978
|
-
stickerName: 'Hippo character spins around in his chair, arms flung up in the air',
|
|
3979
|
-
},
|
|
3980
|
-
},
|
|
3981
|
-
{
|
|
3982
|
-
label: 'Pear GOAL ($20.00)',
|
|
3983
|
-
dynamic: { value: 20, currency: LumiaVariationCurrency.USD, name: 'pearfect_goal_ja_v2' },
|
|
3984
|
-
extraSettings: {
|
|
3985
|
-
username: 'lumiastream',
|
|
3986
|
-
displayname: 'LumiaStream',
|
|
3987
|
-
avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
|
|
3988
|
-
amount: 20,
|
|
3932
|
+
amount: 200,
|
|
3989
3933
|
currency: LumiaVariationCurrency.USD,
|
|
3990
3934
|
currencySymbol: '$',
|
|
3991
|
-
stickerId: '
|
|
3992
|
-
stickerName: '
|
|
3935
|
+
stickerId: 'emoji_laughing',
|
|
3936
|
+
stickerName: 'Emoji Laughing',
|
|
3993
3937
|
},
|
|
3994
3938
|
},
|
|
3995
3939
|
{
|
|
3996
|
-
label: '
|
|
3997
|
-
dynamic: { value:
|
|
3940
|
+
label: 'Emoji Sad ($300)',
|
|
3941
|
+
dynamic: { value: 300, currency: LumiaVariationCurrency.USD, name: 'emoji_sad' },
|
|
3998
3942
|
extraSettings: {
|
|
3999
3943
|
username: 'lumiastream',
|
|
4000
3944
|
displayname: 'LumiaStream',
|
|
4001
3945
|
avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
|
|
4002
|
-
amount:
|
|
3946
|
+
amount: 300,
|
|
4003
3947
|
currency: LumiaVariationCurrency.USD,
|
|
4004
3948
|
currencySymbol: '$',
|
|
4005
|
-
stickerId: '
|
|
4006
|
-
stickerName:
|
|
3949
|
+
stickerId: 'emoji_sad',
|
|
3950
|
+
stickerName: 'Emoji Sad',
|
|
4007
3951
|
},
|
|
4008
3952
|
},
|
|
4009
3953
|
],
|
|
@@ -4039,20 +3983,6 @@ exports.LumiaAlertConfigs = {
|
|
|
4039
3983
|
required: false,
|
|
4040
3984
|
default: '$',
|
|
4041
3985
|
},
|
|
4042
|
-
{
|
|
4043
|
-
type: 'text',
|
|
4044
|
-
label: 'Sticker ID',
|
|
4045
|
-
variableField: 'stickerId',
|
|
4046
|
-
required: false,
|
|
4047
|
-
default: 'emoji_beaming_face',
|
|
4048
|
-
},
|
|
4049
|
-
{
|
|
4050
|
-
type: 'text',
|
|
4051
|
-
label: 'Sticker Name',
|
|
4052
|
-
variableField: 'stickerName',
|
|
4053
|
-
required: false,
|
|
4054
|
-
default: 'Beaming face with smiling eyes',
|
|
4055
|
-
},
|
|
4056
3986
|
],
|
|
4057
3987
|
LumiaVariationConditions: [
|
|
4058
3988
|
{ type: LumiaVariationConditions.RANDOM },
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Custom Overlays Examples
|
|
2
2
|
|
|
3
|
+
> Need to inspect what an alert returns? Open the [alert explorer](/docs/variables#alert-explorer) on the Platform Variables page to browse `data.alert`, `data.extraSettings.*`, and the fields available for each alert.
|
|
4
|
+
|
|
3
5
|
## Custom Alert
|
|
4
6
|
|
|
5
7
|
### JS Code
|
|
@@ -1023,6 +1023,10 @@ export declare enum SystemVariables {
|
|
|
1023
1023
|
TWITCH_SESSION_FOLLOWERS = "twitch_session_follower",
|
|
1024
1024
|
/** Last subscriber. Use as {{twitch_last_subscriber}}. */
|
|
1025
1025
|
TWITCH_LAST_SUBSCRIBER = "twitch_last_subscriber",
|
|
1026
|
+
/** Last gifter. Use as {{twitch_last_gifter}}. */
|
|
1027
|
+
TWITCH_LAST_GIFTER = "twitch_last_gifter",
|
|
1028
|
+
/** Last gifted sub amount. Use as {{twitch_last_gifter_amount}}. */
|
|
1029
|
+
TWITCH_LAST_GIFTER_AMOUNT = "twitch_last_gifter_amount",
|
|
1026
1030
|
/** Session subscribers list. Use as {{twitch_session_subscribers}}. */
|
|
1027
1031
|
TWITCH_SESSION_SUBSCRIBERS = "twitch_session_subscribers",
|
|
1028
1032
|
/** Session chat count. Use as {{twitch_session_chat_count}}. */
|
|
@@ -1271,8 +1275,14 @@ export declare enum SystemVariables {
|
|
|
1271
1275
|
KICK_LAST_FOLLOWER = "kick_last_follower",
|
|
1272
1276
|
/** Last subscriber. Use as {{kick_last_subscriber}}. */
|
|
1273
1277
|
KICK_LAST_SUBSCRIBER = "kick_last_subscriber",
|
|
1278
|
+
/** Last gifter. Use as {{kick_last_gifter}}. */
|
|
1279
|
+
KICK_LAST_GIFTER = "kick_last_gifter",
|
|
1280
|
+
/** Last gifted sub amount. Use as {{kick_last_gifter_amount}}. */
|
|
1281
|
+
KICK_LAST_GIFTER_AMOUNT = "kick_last_gifter_amount",
|
|
1274
1282
|
/** Last host. Use as {{kick_last_host}}. */
|
|
1275
1283
|
KICK_LAST_HOST = "kick_last_host",
|
|
1284
|
+
/** Last host viewer amount. Use as {{kick_last_host_amount}}. */
|
|
1285
|
+
KICK_LAST_HOST_AMOUNT = "kick_last_host_amount",
|
|
1276
1286
|
/** Lifetime gift members count. Use as {{kick_total_gift_subscription_count}}. */
|
|
1277
1287
|
KICK_TOTAL_GIFT_SUBSCRIPTION_COUNT = "kick_total_gift_subscription_count",
|
|
1278
1288
|
/** Get avatar by username. Use as {{kick_get_avatar}}. */
|
|
@@ -1023,6 +1023,10 @@ export declare enum SystemVariables {
|
|
|
1023
1023
|
TWITCH_SESSION_FOLLOWERS = "twitch_session_follower",
|
|
1024
1024
|
/** Last subscriber. Use as {{twitch_last_subscriber}}. */
|
|
1025
1025
|
TWITCH_LAST_SUBSCRIBER = "twitch_last_subscriber",
|
|
1026
|
+
/** Last gifter. Use as {{twitch_last_gifter}}. */
|
|
1027
|
+
TWITCH_LAST_GIFTER = "twitch_last_gifter",
|
|
1028
|
+
/** Last gifted sub amount. Use as {{twitch_last_gifter_amount}}. */
|
|
1029
|
+
TWITCH_LAST_GIFTER_AMOUNT = "twitch_last_gifter_amount",
|
|
1026
1030
|
/** Session subscribers list. Use as {{twitch_session_subscribers}}. */
|
|
1027
1031
|
TWITCH_SESSION_SUBSCRIBERS = "twitch_session_subscribers",
|
|
1028
1032
|
/** Session chat count. Use as {{twitch_session_chat_count}}. */
|
|
@@ -1271,8 +1275,14 @@ export declare enum SystemVariables {
|
|
|
1271
1275
|
KICK_LAST_FOLLOWER = "kick_last_follower",
|
|
1272
1276
|
/** Last subscriber. Use as {{kick_last_subscriber}}. */
|
|
1273
1277
|
KICK_LAST_SUBSCRIBER = "kick_last_subscriber",
|
|
1278
|
+
/** Last gifter. Use as {{kick_last_gifter}}. */
|
|
1279
|
+
KICK_LAST_GIFTER = "kick_last_gifter",
|
|
1280
|
+
/** Last gifted sub amount. Use as {{kick_last_gifter_amount}}. */
|
|
1281
|
+
KICK_LAST_GIFTER_AMOUNT = "kick_last_gifter_amount",
|
|
1274
1282
|
/** Last host. Use as {{kick_last_host}}. */
|
|
1275
1283
|
KICK_LAST_HOST = "kick_last_host",
|
|
1284
|
+
/** Last host viewer amount. Use as {{kick_last_host_amount}}. */
|
|
1285
|
+
KICK_LAST_HOST_AMOUNT = "kick_last_host_amount",
|
|
1276
1286
|
/** Lifetime gift members count. Use as {{kick_total_gift_subscription_count}}. */
|
|
1277
1287
|
KICK_TOTAL_GIFT_SUBSCRIPTION_COUNT = "kick_total_gift_subscription_count",
|
|
1278
1288
|
/** Get avatar by username. Use as {{kick_get_avatar}}. */
|
|
@@ -237,6 +237,10 @@ export declare enum SystemVariables {
|
|
|
237
237
|
TWITCH_SESSION_FOLLOWERS = "twitch_session_follower",
|
|
238
238
|
/** Last subscriber. Use as {{twitch_last_subscriber}}. */
|
|
239
239
|
TWITCH_LAST_SUBSCRIBER = "twitch_last_subscriber",
|
|
240
|
+
/** Last gifter. Use as {{twitch_last_gifter}}. */
|
|
241
|
+
TWITCH_LAST_GIFTER = "twitch_last_gifter",
|
|
242
|
+
/** Last gifted sub amount. Use as {{twitch_last_gifter_amount}}. */
|
|
243
|
+
TWITCH_LAST_GIFTER_AMOUNT = "twitch_last_gifter_amount",
|
|
240
244
|
/** Session subscribers list. Use as {{twitch_session_subscribers}}. */
|
|
241
245
|
TWITCH_SESSION_SUBSCRIBERS = "twitch_session_subscribers",
|
|
242
246
|
/** Session chat count. Use as {{twitch_session_chat_count}}. */
|
|
@@ -485,8 +489,14 @@ export declare enum SystemVariables {
|
|
|
485
489
|
KICK_LAST_FOLLOWER = "kick_last_follower",
|
|
486
490
|
/** Last subscriber. Use as {{kick_last_subscriber}}. */
|
|
487
491
|
KICK_LAST_SUBSCRIBER = "kick_last_subscriber",
|
|
492
|
+
/** Last gifter. Use as {{kick_last_gifter}}. */
|
|
493
|
+
KICK_LAST_GIFTER = "kick_last_gifter",
|
|
494
|
+
/** Last gifted sub amount. Use as {{kick_last_gifter_amount}}. */
|
|
495
|
+
KICK_LAST_GIFTER_AMOUNT = "kick_last_gifter_amount",
|
|
488
496
|
/** Last host. Use as {{kick_last_host}}. */
|
|
489
497
|
KICK_LAST_HOST = "kick_last_host",
|
|
498
|
+
/** Last host viewer amount. Use as {{kick_last_host_amount}}. */
|
|
499
|
+
KICK_LAST_HOST_AMOUNT = "kick_last_host_amount",
|
|
490
500
|
/** Lifetime gift members count. Use as {{kick_total_gift_subscription_count}}. */
|
|
491
501
|
KICK_TOTAL_GIFT_SUBSCRIPTION_COUNT = "kick_total_gift_subscription_count",
|
|
492
502
|
/** Get avatar by username. Use as {{kick_get_avatar}}. */
|
package/dist/variables.types.js
CHANGED
|
@@ -250,6 +250,10 @@ var SystemVariables;
|
|
|
250
250
|
SystemVariables["TWITCH_SESSION_FOLLOWERS"] = "twitch_session_follower";
|
|
251
251
|
/** Last subscriber. Use as {{twitch_last_subscriber}}. */
|
|
252
252
|
SystemVariables["TWITCH_LAST_SUBSCRIBER"] = "twitch_last_subscriber";
|
|
253
|
+
/** Last gifter. Use as {{twitch_last_gifter}}. */
|
|
254
|
+
SystemVariables["TWITCH_LAST_GIFTER"] = "twitch_last_gifter";
|
|
255
|
+
/** Last gifted sub amount. Use as {{twitch_last_gifter_amount}}. */
|
|
256
|
+
SystemVariables["TWITCH_LAST_GIFTER_AMOUNT"] = "twitch_last_gifter_amount";
|
|
253
257
|
/** Session subscribers list. Use as {{twitch_session_subscribers}}. */
|
|
254
258
|
SystemVariables["TWITCH_SESSION_SUBSCRIBERS"] = "twitch_session_subscribers";
|
|
255
259
|
/** Session chat count. Use as {{twitch_session_chat_count}}. */
|
|
@@ -502,8 +506,14 @@ var SystemVariables;
|
|
|
502
506
|
SystemVariables["KICK_LAST_FOLLOWER"] = "kick_last_follower";
|
|
503
507
|
/** Last subscriber. Use as {{kick_last_subscriber}}. */
|
|
504
508
|
SystemVariables["KICK_LAST_SUBSCRIBER"] = "kick_last_subscriber";
|
|
509
|
+
/** Last gifter. Use as {{kick_last_gifter}}. */
|
|
510
|
+
SystemVariables["KICK_LAST_GIFTER"] = "kick_last_gifter";
|
|
511
|
+
/** Last gifted sub amount. Use as {{kick_last_gifter_amount}}. */
|
|
512
|
+
SystemVariables["KICK_LAST_GIFTER_AMOUNT"] = "kick_last_gifter_amount";
|
|
505
513
|
/** Last host. Use as {{kick_last_host}}. */
|
|
506
514
|
SystemVariables["KICK_LAST_HOST"] = "kick_last_host";
|
|
515
|
+
/** Last host viewer amount. Use as {{kick_last_host_amount}}. */
|
|
516
|
+
SystemVariables["KICK_LAST_HOST_AMOUNT"] = "kick_last_host_amount";
|
|
507
517
|
/** Lifetime gift members count. Use as {{kick_total_gift_subscription_count}}. */
|
|
508
518
|
SystemVariables["KICK_TOTAL_GIFT_SUBSCRIPTION_COUNT"] = "kick_total_gift_subscription_count";
|
|
509
519
|
/** Get avatar by username. Use as {{kick_get_avatar}}. */
|
|
@@ -1418,7 +1428,10 @@ exports.AllVariables = {
|
|
|
1418
1428
|
'kick_session_kicks_with_amount',
|
|
1419
1429
|
'kick_last_follower',
|
|
1420
1430
|
'kick_last_subscriber',
|
|
1431
|
+
'kick_last_gifter',
|
|
1432
|
+
'kick_last_gifter_amount',
|
|
1421
1433
|
'kick_last_host',
|
|
1434
|
+
'kick_last_host_amount',
|
|
1422
1435
|
'kick_total_gift_subscription_count',
|
|
1423
1436
|
'kick_get_avatar',
|
|
1424
1437
|
],
|
|
@@ -1655,6 +1668,8 @@ exports.AllVariables = {
|
|
|
1655
1668
|
'twitch_last_follower',
|
|
1656
1669
|
'twitch_session_follower',
|
|
1657
1670
|
'twitch_last_subscriber',
|
|
1671
|
+
'twitch_last_gifter',
|
|
1672
|
+
'twitch_last_gifter_amount',
|
|
1658
1673
|
'twitch_session_subscribers',
|
|
1659
1674
|
'twitch_session_chat_count',
|
|
1660
1675
|
'twitch_current_first_chatter',
|