@lumiastream/lumia-types 3.3.5-beta.1 → 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.
Files changed (4) hide show
  1. package/dist/alert.types.js +18 -0
  2. package/dist/variables.types.d.ts +202 -21
  3. package/dist/variables.types.js +335 -47
  4. package/package.json +1 -1
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
  ],
package/dist/variables.types.d.ts CHANGED
@@ -705,24 +705,24 @@ export declare const AllVariables: {
705
705
  variables: string[];
706
706
  chat: {
707
707
  cooldowns: string[];
708
- command: string[];
709
- chatbotCommand: string[];
708
+ command: (string | LumiaAcceptedVariableDefinition)[];
709
+ chatbotCommand: (string | LumiaAcceptedVariableDefinition)[];
710
710
  twitchPoints: string[];
711
711
  kickPoints: string[];
712
712
  twitchExtensions: string[];
713
713
  fileWatcher: string[];
714
714
  chatmatch: string[];
715
- commands: string[];
716
- shoutout: string[];
717
- followage: string[];
718
- uptime: string[];
719
- aichat: string[];
720
- loyaltyPoints: string[];
721
- roulette: string[];
722
- duel: string[];
723
- slots: string[];
724
- raffleEntry: string[];
725
- 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)[];
726
726
  };
727
727
  alerts: {
728
728
  lumiaOpened: string[];
@@ -781,7 +781,7 @@ export declare const AllVariables: {
781
781
  reaction: string[];
782
782
  star: string[];
783
783
  support: string[];
784
- subscriptionGift: string[];
784
+ subscriptionGift: (string | LumiaAcceptedVariableDefinition)[];
785
785
  share: string[];
786
786
  };
787
787
  };
@@ -793,6 +793,28 @@ export declare const AllVariables: {
793
793
  subscriptionExpired: string[];
794
794
  commission: string[];
795
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
+ } | {
796
818
  name: string;
797
819
  example: {
798
820
  id: string;
@@ -812,10 +834,169 @@ export declare const AllVariables: {
812
834
  variant: null;
813
835
  };
814
836
  })[];
815
- giftPurchase: string[];
816
- giveawayStarted: string[];
817
- giveawayEnded: string[];
818
- thankyouSent: string[];
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
+ })[];
819
1000
  newsletterSubscribed: string[];
820
1001
  };
821
1002
  };
@@ -828,7 +1009,7 @@ export declare const AllVariables: {
828
1009
  sessionFollowers: string[];
829
1010
  subscriber: string[];
830
1011
  sessionSubs: string[];
831
- subscriptionGift: string[];
1012
+ subscriptionGift: (string | LumiaAcceptedVariableDefinition)[];
832
1013
  sessionGiftSubscriptions: string[];
833
1014
  kicks: string[];
834
1015
  sessionKicks: string[];
@@ -991,7 +1172,7 @@ export declare const AllVariables: {
991
1172
  sessionFollowers: string[];
992
1173
  subscriber: string[];
993
1174
  sessionSubs: string[];
994
- giftSubscription: string[];
1175
+ giftSubscription: (string | LumiaAcceptedVariableDefinition)[];
995
1176
  sessionGiftSubscriptions: string[];
996
1177
  bits: string[];
997
1178
  bitsCombo: string[];
@@ -1079,7 +1260,7 @@ export declare const AllVariables: {
1079
1260
  sessionSubs: string[];
1080
1261
  member: string[];
1081
1262
  sessionMembers: string[];
1082
- giftMembers: string[];
1263
+ giftMembers: (string | LumiaAcceptedVariableDefinition)[];
1083
1264
  sessionGiftMembers: string[];
1084
1265
  gifts: string[];
1085
1266
  sessionGifts: string[];
package/dist/variables.types.js CHANGED
@@ -837,6 +837,55 @@ exports.ReservedVariables = [
837
837
  'follow_time',
838
838
  'uptime',
839
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
+ };
840
889
  exports.AllVariables = {
841
890
  lumiastream: {
842
891
  variables: [
@@ -953,7 +1002,7 @@ exports.AllVariables = {
953
1002
  'userId',
954
1003
  'avatar',
955
1004
  'userLevels',
956
- 'userLevelsRaw',
1005
+ USER_LEVELS_RAW_VARIABLE,
957
1006
  'channelDescription',
958
1007
  'channelViews',
959
1008
  'originType',
@@ -979,7 +1028,7 @@ exports.AllVariables = {
979
1028
  'userId',
980
1029
  'avatar',
981
1030
  'userLevels',
982
- 'userLevelsRaw',
1031
+ USER_LEVELS_RAW_VARIABLE,
983
1032
  'channelDescription',
984
1033
  'channelViews',
985
1034
  'originType',
@@ -1061,7 +1110,7 @@ exports.AllVariables = {
1061
1110
  'userId',
1062
1111
  'avatar',
1063
1112
  'userLevels',
1064
- 'userLevelsRaw',
1113
+ USER_LEVELS_RAW_VARIABLE,
1065
1114
  'channelDescription',
1066
1115
  'channelViews',
1067
1116
  'originType',
@@ -1110,7 +1159,7 @@ exports.AllVariables = {
1110
1159
  'userId',
1111
1160
  'avatar',
1112
1161
  'userLevels',
1113
- 'userLevelsRaw',
1162
+ USER_LEVELS_RAW_VARIABLE,
1114
1163
  'channelDescription',
1115
1164
  'channelViews',
1116
1165
  'command',
@@ -1131,7 +1180,7 @@ exports.AllVariables = {
1131
1180
  'userId',
1132
1181
  'avatar',
1133
1182
  'userLevels',
1134
- 'userLevelsRaw',
1183
+ USER_LEVELS_RAW_VARIABLE,
1135
1184
  'channelDescription',
1136
1185
  'channelViews',
1137
1186
  'command',
@@ -1152,7 +1201,7 @@ exports.AllVariables = {
1152
1201
  'userId',
1153
1202
  'avatar',
1154
1203
  'userLevels',
1155
- 'userLevelsRaw',
1204
+ USER_LEVELS_RAW_VARIABLE,
1156
1205
  'channelDescription',
1157
1206
  'channelViews',
1158
1207
  'command',
@@ -1173,7 +1222,7 @@ exports.AllVariables = {
1173
1222
  'userId',
1174
1223
  'avatar',
1175
1224
  'userLevels',
1176
- 'userLevelsRaw',
1225
+ USER_LEVELS_RAW_VARIABLE,
1177
1226
  'channelDescription',
1178
1227
  'channelViews',
1179
1228
  'command',
@@ -1198,7 +1247,7 @@ exports.AllVariables = {
1198
1247
  'userId',
1199
1248
  'avatar',
1200
1249
  'userLevels',
1201
- 'userLevelsRaw',
1250
+ USER_LEVELS_RAW_VARIABLE,
1202
1251
  'channelDescription',
1203
1252
  'channelViews',
1204
1253
  'command',
@@ -1221,7 +1270,7 @@ exports.AllVariables = {
1221
1270
  'userId',
1222
1271
  'avatar',
1223
1272
  'userLevels',
1224
- 'userLevelsRaw',
1273
+ USER_LEVELS_RAW_VARIABLE,
1225
1274
  'channelDescription',
1226
1275
  'channelViews',
1227
1276
  'command',
@@ -1247,7 +1296,7 @@ exports.AllVariables = {
1247
1296
  'userId',
1248
1297
  'avatar',
1249
1298
  'userLevels',
1250
- 'userLevelsRaw',
1299
+ USER_LEVELS_RAW_VARIABLE,
1251
1300
  'channelDescription',
1252
1301
  'channelViews',
1253
1302
  'command',
@@ -1270,7 +1319,7 @@ exports.AllVariables = {
1270
1319
  'userId',
1271
1320
  'avatar',
1272
1321
  'userLevels',
1273
- 'userLevelsRaw',
1322
+ USER_LEVELS_RAW_VARIABLE,
1274
1323
  'channelDescription',
1275
1324
  'channelViews',
1276
1325
  'command',
@@ -1300,7 +1349,7 @@ exports.AllVariables = {
1300
1349
  'userId',
1301
1350
  'avatar',
1302
1351
  'userLevels',
1303
- 'userLevelsRaw',
1352
+ USER_LEVELS_RAW_VARIABLE,
1304
1353
  'channelDescription',
1305
1354
  'channelViews',
1306
1355
  'command',
@@ -1326,7 +1375,7 @@ exports.AllVariables = {
1326
1375
  'userId',
1327
1376
  'avatar',
1328
1377
  'userLevels',
1329
- 'userLevelsRaw',
1378
+ USER_LEVELS_RAW_VARIABLE,
1330
1379
  'channelDescription',
1331
1380
  'channelViews',
1332
1381
  'command',
@@ -1451,7 +1500,7 @@ exports.AllVariables = {
1451
1500
  reaction: ['username', 'reaction'],
1452
1501
  star: ['username', 'amount'],
1453
1502
  support: ['username', 'amount'],
1454
- subscriptionGift: ['username', 'recipient', 'recipients', 'recipientsRaw', 'gifter', 'giftAmount', 'message'],
1503
+ subscriptionGift: ['username', 'recipient', 'recipients', TWITCH_RECIPIENTS_RAW_EXAMPLE, 'gifter', 'giftAmount', 'message'],
1455
1504
  share: ['username'],
1456
1505
  },
1457
1506
  },
@@ -1469,28 +1518,52 @@ exports.AllVariables = {
1469
1518
  'items',
1470
1519
  'itemsCount',
1471
1520
  'itemsDetailed',
1472
- 'orderItems',
1473
- 'itemImages',
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
+ },
1474
1547
  'friendlyId',
1475
1548
  'currency',
1476
1549
  'amount',
1477
1550
  {
1478
1551
  name: 'firstItem',
1479
1552
  example: {
1480
- id: '',
1481
- name: '',
1482
- slug: '',
1483
- description: '',
1484
- imageUrl: '',
1485
- variantName: '',
1486
- sku: '',
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',
1487
1560
  quantity: 1,
1488
- size: '',
1489
- color: '',
1490
- colorSwatch: '',
1491
- attributes: '',
1492
- unitPrice: 0,
1493
- price: 0,
1561
+ size: 'Ex: L',
1562
+ color: 'Ex: Black',
1563
+ colorSwatch: 'Ex: #000000',
1564
+ attributes: 'Ex: Black, L',
1565
+ unitPrice: 25,
1566
+ price: 25,
1494
1567
  variant: null,
1495
1568
  },
1496
1569
  },
@@ -1504,12 +1577,65 @@ exports.AllVariables = {
1504
1577
  'amount',
1505
1578
  'friendlyId',
1506
1579
  'quantity',
1507
- 'offer',
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
+ },
1508
1600
  'offerImageUrl',
1509
- 'gifts',
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
+ },
1510
1619
  'giftCount',
1511
- 'winners',
1512
- 'winnerNames',
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
+ },
1513
1639
  'winnerCount',
1514
1640
  'firstWinner',
1515
1641
  'availableGiftCount',
@@ -1528,15 +1654,85 @@ exports.AllVariables = {
1528
1654
  'giveawayFriendlyId',
1529
1655
  'offerName',
1530
1656
  'offerImageUrl',
1531
- 'winners',
1532
- 'winnerNames',
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
+ },
1533
1676
  'winnerCount',
1534
1677
  'firstWinner',
1535
1678
  'duration',
1536
- 'allGifts',
1537
- 'gifts',
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
+ },
1538
1715
  'totalGifts',
1539
- 'offer',
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
+ },
1540
1736
  'type',
1541
1737
  ],
1542
1738
  giveawayEnded: [
@@ -1550,18 +1746,107 @@ exports.AllVariables = {
1550
1746
  'giveawayFriendlyId',
1551
1747
  'offerName',
1552
1748
  'offerImageUrl',
1553
- 'winners',
1554
- 'winnerNames',
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
+ },
1555
1768
  'winnerCount',
1556
1769
  'firstWinner',
1557
1770
  'duration',
1558
- 'allGifts',
1559
- 'gifts',
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
+ },
1560
1807
  'totalGifts',
1561
- 'offer',
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
+ },
1562
1828
  'type',
1563
1829
  ],
1564
- thankyouSent: ['username', 'email', 'message', 'mediaUrl', 'contributionType', 'contribution'],
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
+ ],
1565
1850
  newsletterSubscribed: ['email', 'raw'],
1566
1851
  },
1567
1852
  },
@@ -1612,7 +1897,7 @@ exports.AllVariables = {
1612
1897
  sessionFollowers: ['total', 'previousTotal'],
1613
1898
  subscriber: ['username', 'avatar', 'tier', 'recipient', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
1614
1899
  sessionSubs: ['total', 'previousTotal'],
1615
- subscriptionGift: ['username', 'avatar', 'tier', 'giftAmount', 'recipients', 'recipientsRaw', 'gifter', 'totalGifts', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
1900
+ subscriptionGift: ['username', 'avatar', 'tier', 'giftAmount', 'recipients', KICK_RECIPIENTS_RAW_EXAMPLE, 'gifter', 'totalGifts', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
1616
1901
  sessionGiftSubscriptions: ['total', 'previousTotal'],
1617
1902
  kicks: ['username', 'avatar', 'amount', 'name', 'type', 'tier', 'id', 'message'],
1618
1903
  sessionKicks: ['total', 'previousTotal'],
@@ -1910,7 +2195,7 @@ exports.AllVariables = {
1910
2195
  sessionFollowers: ['total', 'previousTotal'],
1911
2196
  subscriber: ['username', 'avatar', 'tier', 'recipient', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
1912
2197
  sessionSubs: ['total', 'previousTotal'],
1913
- giftSubscription: ['username', 'avatar', 'tier', 'giftAmount', 'recipients', 'recipientsRaw', 'gifter', 'totalGifts', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
2198
+ giftSubscription: ['username', 'avatar', 'tier', 'giftAmount', 'recipients', TWITCH_RECIPIENTS_RAW_EXAMPLE, 'gifter', 'totalGifts', 'subMonths', 'streakMonths', 'message', 'subPlan', 'subPlanName'],
1914
2199
  sessionGiftSubscriptions: ['total', 'previousTotal'],
1915
2200
  bits: ['username', 'avatar', 'amount', 'message'],
1916
2201
  bitsCombo: ['username', 'avatar', 'amount', 'bitsType', 'message'],
@@ -2155,7 +2440,7 @@ exports.AllVariables = {
2155
2440
  'tier',
2156
2441
  'giftAmount',
2157
2442
  'recipients',
2158
- 'recipientsRaw',
2443
+ YOUTUBE_RECIPIENTS_RAW_EXAMPLE,
2159
2444
  'gifter',
2160
2445
  'totalGifts',
2161
2446
  'subMonths',
@@ -2175,6 +2460,9 @@ exports.AllVariables = {
2175
2460
  'comboCount',
2176
2461
  'giftName',
2177
2462
  'giftUrl',
2463
+ 'giftImageUrl',
2464
+ 'giftDurationSeconds',
2465
+ 'giftDurationNanos',
2178
2466
  'hasVisualEffect',
2179
2467
  'altText',
2180
2468
  'language',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lumiastream/lumia-types",
3
- "version": "3.3.5-beta.1",
3
+ "version": "3.3.5",
4
4
  "description": "",
5
5
  "main": "./dist/index.js",
6
6
  "files": [