@lumiastream/lumia-types 3.3.2 → 3.3.4

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.
@@ -431,6 +431,10 @@ export declare enum LumiaAlertValues {
431
431
  FOURTHWALL_DONATION = "fourthwall-donation",
432
432
  /** Fourthwall subscription */
433
433
  FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
434
+ /** Fourthwall subscription changed */
435
+ FOURTHWALL_SUBSCRIPTION_CHANGED = "fourthwall-subscriptionChanged",
436
+ /** Fourthwall subscription expired */
437
+ FOURTHWALL_SUBSCRIPTION_EXPIRED = "fourthwall-subscriptionExpired",
434
438
  /** Fourthwall gift purchase */
435
439
  FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
436
440
  /** Fourthwall giveaway started */
@@ -439,6 +443,8 @@ export declare enum LumiaAlertValues {
439
443
  FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
440
444
  /** Fourthwall thank you sent */
441
445
  FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
446
+ /** Fourthwall newsletter subscribed */
447
+ FOURTHWALL_NEWSLETTER_SUBSCRIBED = "fourthwall-newsletterSubscribed",
442
448
  /** OBS profile switched */
443
449
  OBS_SWITCH_PROFILE = "obs-switchProfile",
444
450
  /** OBS scene switched */
@@ -745,10 +751,13 @@ export declare const LumiaAlertFriendlyValues: {
745
751
  "fourthwall-shopOrder": string;
746
752
  "fourthwall-donation": string;
747
753
  "fourthwall-subscription": string;
754
+ "fourthwall-subscriptionChanged": string;
755
+ "fourthwall-subscriptionExpired": string;
748
756
  "fourthwall-giftpurchase": string;
749
757
  "fourthwall-giveawayStarted": string;
750
758
  "fourthwall-giveawayEnded": string;
751
759
  "fourthwall-thankyouSent": string;
760
+ "fourthwall-newsletterSubscribed": string;
752
761
  "crowdcontrol-effect": string;
753
762
  "vtubestudio-hotkeyTriggered": string;
754
763
  "vtubestudio-modelLoaded": string;
@@ -452,6 +452,10 @@ var LumiaAlertValues;
452
452
  LumiaAlertValues["FOURTHWALL_DONATION"] = "fourthwall-donation";
453
453
  /** Fourthwall subscription */
454
454
  LumiaAlertValues["FOURTHWALL_SUBSCRIPTION"] = "fourthwall-subscription";
455
+ /** Fourthwall subscription changed */
456
+ LumiaAlertValues["FOURTHWALL_SUBSCRIPTION_CHANGED"] = "fourthwall-subscriptionChanged";
457
+ /** Fourthwall subscription expired */
458
+ LumiaAlertValues["FOURTHWALL_SUBSCRIPTION_EXPIRED"] = "fourthwall-subscriptionExpired";
455
459
  /** Fourthwall gift purchase */
456
460
  LumiaAlertValues["FOURTHWALL_GIFTPURCHASE"] = "fourthwall-giftpurchase";
457
461
  /** Fourthwall giveaway started */
@@ -460,6 +464,8 @@ var LumiaAlertValues;
460
464
  LumiaAlertValues["FOURTHWALL_GIVEAWAY_ENDED"] = "fourthwall-giveawayEnded";
461
465
  /** Fourthwall thank you sent */
462
466
  LumiaAlertValues["FOURTHWALL_THANKYOU_SENT"] = "fourthwall-thankyouSent";
467
+ /** Fourthwall newsletter subscribed */
468
+ LumiaAlertValues["FOURTHWALL_NEWSLETTER_SUBSCRIBED"] = "fourthwall-newsletterSubscribed";
463
469
  // OBS Studio events
464
470
  /** OBS profile switched */
465
471
  LumiaAlertValues["OBS_SWITCH_PROFILE"] = "obs-switchProfile";
@@ -777,10 +783,13 @@ exports.LumiaAlertFriendlyValues = {
777
783
  [LumiaAlertValues.FOURTHWALL_SHOPORDER]: 'Fourthwall Shop Order',
778
784
  [LumiaAlertValues.FOURTHWALL_DONATION]: 'Fourthwall Donation',
779
785
  [LumiaAlertValues.FOURTHWALL_SUBSCRIPTION]: 'Fourthwall Subscription',
786
+ [LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_CHANGED]: 'Fourthwall Subscription Changed',
787
+ [LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_EXPIRED]: 'Fourthwall Subscription Expired',
780
788
  [LumiaAlertValues.FOURTHWALL_GIFTPURCHASE]: 'Fourthwall Giftpurchase',
781
789
  [LumiaAlertValues.FOURTHWALL_GIVEAWAY_STARTED]: 'Fourthwall Giveaway Started',
782
790
  [LumiaAlertValues.FOURTHWALL_GIVEAWAY_ENDED]: 'Fourthwall Giveaway Ended',
783
791
  [LumiaAlertValues.FOURTHWALL_THANKYOU_SENT]: 'Fourthwall Thank You Sent',
792
+ [LumiaAlertValues.FOURTHWALL_NEWSLETTER_SUBSCRIBED]: 'Fourthwall Newsletter Subscribed',
784
793
  [LumiaAlertValues.CROWDCONTROL_EFFECT]: 'Crowdcontrol Effect',
785
794
  [LumiaAlertValues.VTUBESTUDIO_HOTKEY_TRIGGERED]: 'Vtube Hotkey Triggered',
786
795
  [LumiaAlertValues.VTUBESTUDIO_MODEL_LOADED]: 'Vtube Model Loaded',
@@ -7572,12 +7572,136 @@ exports.LumiaAlertConfigs = {
7572
7572
  { type: LumiaVariationConditions.EQUAL_VARIABLE },
7573
7573
  ],
7574
7574
  },
7575
+ [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_CHANGED]: {
7576
+ connection: event_types_1.LumiaIntegrations.FOURTHWALL,
7577
+ message: '{{username}} subscription changed to {{subscriptionType}}',
7578
+ eventlistMessage: 'Subscription Changed',
7579
+ eventlistDetailedMessage: 'subscription changed to {{subscriptionType}}',
7580
+ acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.subscriptionChanged,
7581
+ quickActions: [
7582
+ {
7583
+ label: 'Changed',
7584
+ dynamic: { value: 100, currency: LumiaVariationCurrency.USD },
7585
+ extraSettings: {
7586
+ username: 'lumiastream',
7587
+ amount: 100,
7588
+ currency: LumiaVariationCurrency.USD,
7589
+ interval: 'MONTHLY',
7590
+ subscriptionType: 'ACTIVE',
7591
+ },
7592
+ },
7593
+ ],
7594
+ inputFields: [
7595
+ {
7596
+ type: 'text',
7597
+ label: 'Username',
7598
+ variableField: 'username',
7599
+ required: false,
7600
+ default: 'lumiastream',
7601
+ },
7602
+ {
7603
+ type: 'text',
7604
+ label: 'Subscription Type',
7605
+ variableField: 'subscriptionType',
7606
+ required: false,
7607
+ default: 'ACTIVE',
7608
+ },
7609
+ {
7610
+ type: 'number',
7611
+ label: 'Amount',
7612
+ dynamicField: 'value',
7613
+ variableField: 'amount',
7614
+ required: false,
7615
+ default: 100,
7616
+ },
7617
+ {
7618
+ type: 'currency',
7619
+ label: 'Currency',
7620
+ dynamicField: 'currency',
7621
+ variableField: 'currency',
7622
+ required: false,
7623
+ default: LumiaVariationCurrency.USD,
7624
+ },
7625
+ ],
7626
+ LumiaVariationConditions: [
7627
+ { type: LumiaVariationConditions.RANDOM },
7628
+ {
7629
+ type: LumiaVariationConditions.EQUAL_CURRENCY_NUMBER,
7630
+ },
7631
+ {
7632
+ type: LumiaVariationConditions.GREATER_CURRENCY_NUMBER,
7633
+ },
7634
+ { type: LumiaVariationConditions.EQUAL_VARIABLE },
7635
+ ],
7636
+ },
7637
+ [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_EXPIRED]: {
7638
+ connection: event_types_1.LumiaIntegrations.FOURTHWALL,
7639
+ message: '{{username}} subscription ended',
7640
+ eventlistMessage: 'Subscription Ended',
7641
+ eventlistDetailedMessage: 'subscription ended with {{subscriptionType}}',
7642
+ acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.subscriptionExpired,
7643
+ quickActions: [
7644
+ {
7645
+ label: 'Ended',
7646
+ dynamic: { value: 100, currency: LumiaVariationCurrency.USD },
7647
+ extraSettings: {
7648
+ username: 'lumiastream',
7649
+ amount: 100,
7650
+ currency: LumiaVariationCurrency.USD,
7651
+ interval: 'MONTHLY',
7652
+ subscriptionType: 'CANCELLED',
7653
+ },
7654
+ },
7655
+ ],
7656
+ inputFields: [
7657
+ {
7658
+ type: 'text',
7659
+ label: 'Username',
7660
+ variableField: 'username',
7661
+ required: false,
7662
+ default: 'lumiastream',
7663
+ },
7664
+ {
7665
+ type: 'text',
7666
+ label: 'Subscription Type',
7667
+ variableField: 'subscriptionType',
7668
+ required: false,
7669
+ default: 'CANCELLED',
7670
+ },
7671
+ {
7672
+ type: 'number',
7673
+ label: 'Amount',
7674
+ dynamicField: 'value',
7675
+ variableField: 'amount',
7676
+ required: false,
7677
+ default: 100,
7678
+ },
7679
+ {
7680
+ type: 'currency',
7681
+ label: 'Currency',
7682
+ dynamicField: 'currency',
7683
+ variableField: 'currency',
7684
+ required: false,
7685
+ default: LumiaVariationCurrency.USD,
7686
+ },
7687
+ ],
7688
+ LumiaVariationConditions: [
7689
+ { type: LumiaVariationConditions.RANDOM },
7690
+ {
7691
+ type: LumiaVariationConditions.EQUAL_CURRENCY_NUMBER,
7692
+ },
7693
+ {
7694
+ type: LumiaVariationConditions.GREATER_CURRENCY_NUMBER,
7695
+ },
7696
+ { type: LumiaVariationConditions.EQUAL_VARIABLE },
7697
+ ],
7698
+ },
7575
7699
  [activity_types_1.LumiaAlertValues.FOURTHWALL_GIFTPURCHASE]: {
7576
7700
  connection: event_types_1.LumiaIntegrations.FOURTHWALL,
7577
7701
  message: '{{username}} just bought a gift with amount {{amount}}',
7578
7702
  eventlistMessage: 'Gift Purchase',
7579
7703
  eventlistDetailedMessage: 'Gift purchase with {{amount}} {{currency}}',
7580
- acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.shopOrder,
7704
+ acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.giftPurchase,
7581
7705
  quickActions: [
7582
7706
  {
7583
7707
  label: '$100',
@@ -7889,6 +8013,32 @@ exports.LumiaAlertConfigs = {
7889
8013
  ],
7890
8014
  LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_VARIABLE }],
7891
8015
  },
8016
+ [activity_types_1.LumiaAlertValues.FOURTHWALL_NEWSLETTER_SUBSCRIBED]: {
8017
+ connection: event_types_1.LumiaIntegrations.FOURTHWALL,
8018
+ message: '{{email}} subscribed to the newsletter',
8019
+ eventlistMessage: 'Newsletter Subscribed',
8020
+ eventlistDetailedMessage: 'subscribed to the newsletter',
8021
+ acceptedVariables: variables_types_1.AllVariables.fourthwall.alerts.newsletterSubscribed,
8022
+ quickActions: [
8023
+ {
8024
+ label: 'Subscribed',
8025
+ dynamic: { value: 1 },
8026
+ extraSettings: {
8027
+ email: 'test@email.com',
8028
+ },
8029
+ },
8030
+ ],
8031
+ inputFields: [
8032
+ {
8033
+ type: 'text',
8034
+ label: 'Email',
8035
+ variableField: 'email',
8036
+ required: false,
8037
+ default: 'test@email.com',
8038
+ },
8039
+ ],
8040
+ LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_VARIABLE }],
8041
+ },
7892
8042
  // },
7893
8043
  // twitter: {
7894
8044
  [activity_types_1.LumiaAlertValues.TWITTER_FOLLOWER]: {
@@ -719,6 +719,10 @@ export declare enum LumiaAlertValues {
719
719
  FOURTHWALL_DONATION = "fourthwall-donation",
720
720
  /** Fourthwall subscription */
721
721
  FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
722
+ /** Fourthwall subscription changed */
723
+ FOURTHWALL_SUBSCRIPTION_CHANGED = "fourthwall-subscriptionChanged",
724
+ /** Fourthwall subscription expired */
725
+ FOURTHWALL_SUBSCRIPTION_EXPIRED = "fourthwall-subscriptionExpired",
722
726
  /** Fourthwall gift purchase */
723
727
  FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
724
728
  /** Fourthwall giveaway started */
@@ -727,6 +731,8 @@ export declare enum LumiaAlertValues {
727
731
  FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
728
732
  /** Fourthwall thank you sent */
729
733
  FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
734
+ /** Fourthwall newsletter subscribed */
735
+ FOURTHWALL_NEWSLETTER_SUBSCRIBED = "fourthwall-newsletterSubscribed",
730
736
  /** OBS profile switched */
731
737
  OBS_SWITCH_PROFILE = "obs-switchProfile",
732
738
  /** OBS scene switched */
@@ -719,6 +719,10 @@ export declare enum LumiaAlertValues {
719
719
  FOURTHWALL_DONATION = "fourthwall-donation",
720
720
  /** Fourthwall subscription */
721
721
  FOURTHWALL_SUBSCRIPTION = "fourthwall-subscription",
722
+ /** Fourthwall subscription changed */
723
+ FOURTHWALL_SUBSCRIPTION_CHANGED = "fourthwall-subscriptionChanged",
724
+ /** Fourthwall subscription expired */
725
+ FOURTHWALL_SUBSCRIPTION_EXPIRED = "fourthwall-subscriptionExpired",
722
726
  /** Fourthwall gift purchase */
723
727
  FOURTHWALL_GIFTPURCHASE = "fourthwall-giftpurchase",
724
728
  /** Fourthwall giveaway started */
@@ -727,6 +731,8 @@ export declare enum LumiaAlertValues {
727
731
  FOURTHWALL_GIVEAWAY_ENDED = "fourthwall-giveawayEnded",
728
732
  /** Fourthwall thank you sent */
729
733
  FOURTHWALL_THANKYOU_SENT = "fourthwall-thankyouSent",
734
+ /** Fourthwall newsletter subscribed */
735
+ FOURTHWALL_NEWSLETTER_SUBSCRIBED = "fourthwall-newsletterSubscribed",
730
736
  /** OBS profile switched */
731
737
  OBS_SWITCH_PROFILE = "obs-switchProfile",
732
738
  /** OBS scene switched */
@@ -47,10 +47,13 @@ export declare const LumiaMapAlertTypeToEventListType: {
47
47
  "fourthwall-donation": LumiaEventListTypes;
48
48
  "fourthwall-shopOrder": LumiaEventListTypes;
49
49
  "fourthwall-subscription": LumiaEventListTypes;
50
+ "fourthwall-subscriptionChanged": LumiaEventListTypes;
51
+ "fourthwall-subscriptionExpired": LumiaEventListTypes;
50
52
  "fourthwall-giftpurchase": LumiaEventListTypes;
51
53
  "fourthwall-giveawayStarted": LumiaEventListTypes;
52
54
  "fourthwall-giveawayEnded": LumiaEventListTypes;
53
55
  "fourthwall-thankyouSent": LumiaEventListTypes;
56
+ "fourthwall-newsletterSubscribed": LumiaEventListTypes;
54
57
  "patreon-campaignPledge": LumiaEventListTypes;
55
58
  "streamelements-donation": LumiaEventListTypes;
56
59
  "streamlabs-charity": LumiaEventListTypes;
@@ -52,10 +52,13 @@ exports.LumiaMapAlertTypeToEventListType = {
52
52
  [activity_types_1.LumiaAlertValues.FOURTHWALL_DONATION]: LumiaEventListTypes.DONATION,
53
53
  [activity_types_1.LumiaAlertValues.FOURTHWALL_SHOPORDER]: LumiaEventListTypes.PURCHASES,
54
54
  [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION]: LumiaEventListTypes.SUBSCRIBERS,
55
+ [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_CHANGED]: LumiaEventListTypes.SUBSCRIBERS,
56
+ [activity_types_1.LumiaAlertValues.FOURTHWALL_SUBSCRIPTION_EXPIRED]: LumiaEventListTypes.SUBSCRIBERS,
55
57
  [activity_types_1.LumiaAlertValues.FOURTHWALL_GIFTPURCHASE]: LumiaEventListTypes.PURCHASES,
56
58
  [activity_types_1.LumiaAlertValues.FOURTHWALL_GIVEAWAY_STARTED]: LumiaEventListTypes.GIFTS,
57
59
  [activity_types_1.LumiaAlertValues.FOURTHWALL_GIVEAWAY_ENDED]: LumiaEventListTypes.GIFTS,
58
60
  [activity_types_1.LumiaAlertValues.FOURTHWALL_THANKYOU_SENT]: LumiaEventListTypes.OTHERS,
61
+ [activity_types_1.LumiaAlertValues.FOURTHWALL_NEWSLETTER_SUBSCRIBED]: LumiaEventListTypes.OTHERS,
59
62
  [activity_types_1.LumiaAlertValues.PATREON_PLEDGE]: LumiaEventListTypes.SUBSCRIBERS,
60
63
  [activity_types_1.LumiaAlertValues.STREAMELEMENTS_DONATION]: LumiaEventListTypes.DONATION,
61
64
  [activity_types_1.LumiaAlertValues.STREAMLABS_CHARITY]: LumiaEventListTypes.DONATION,
@@ -780,12 +780,15 @@ export declare const AllVariables: {
780
780
  alerts: {
781
781
  donation: string[];
782
782
  subscription: string[];
783
+ subscriptionChanged: string[];
784
+ subscriptionExpired: string[];
783
785
  commission: string[];
784
786
  shopOrder: string[];
785
787
  giftPurchase: string[];
786
788
  giveawayStarted: string[];
787
789
  giveawayEnded: string[];
788
790
  thankyouSent: string[];
791
+ newsletterSubscribed: string[];
789
792
  };
790
793
  };
791
794
  kick: {
@@ -1453,14 +1453,79 @@ exports.AllVariables = {
1453
1453
  },
1454
1454
  fourthwall: {
1455
1455
  alerts: {
1456
- donation: ['username', 'email', 'message', 'currency', 'amount', 'raw'],
1457
- subscription: ['username', 'email', 'currency', 'amount', 'interval', 'raw'],
1456
+ donation: ['username', 'email', 'message', 'currency', 'amount', 'id', 'status', 'createdAt', 'updatedAt', 'raw'],
1457
+ subscription: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
1458
+ subscriptionChanged: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
1459
+ subscriptionExpired: ['username', 'email', 'currency', 'amount', 'interval', 'id', 'subscriptionType', 'tierId', 'variantId', 'createdAt', 'raw'],
1458
1460
  commission: ['username', 'email', 'message', 'currency', 'amount', 'raw'],
1459
- shopOrder: ['username', 'email', 'message', 'items', 'currency', 'amount', 'raw'],
1460
- giftPurchase: ['username', 'email', 'message', 'currency', 'amount', 'raw'],
1461
- giveawayStarted: ['currency', 'amount', 'giveawayName', 'giveawayId', 'winners', 'winnerNames', 'winnerCount', 'duration', 'allGifts', 'totalGifts', 'offer', 'type'],
1462
- giveawayEnded: ['currency', 'amount', 'giveawayName', 'giveawayId', 'winners', 'winnerNames', 'winnerCount', 'duration', 'allGifts', 'totalGifts', 'offer', 'type'],
1463
- thankyouSent: ['username', 'email', 'message', 'mediaUrl', 'contribution'],
1461
+ shopOrder: ['username', 'email', 'message', 'items', 'itemsCount', 'itemsDetailed', 'orderItems', 'itemImages', 'friendlyId', 'currency', 'amount', 'firstItem', 'raw'],
1462
+ giftPurchase: [
1463
+ 'username',
1464
+ 'email',
1465
+ 'message',
1466
+ 'currency',
1467
+ 'amount',
1468
+ 'friendlyId',
1469
+ 'quantity',
1470
+ 'offer',
1471
+ 'offerImageUrl',
1472
+ 'gifts',
1473
+ 'giftCount',
1474
+ 'winners',
1475
+ 'winnerNames',
1476
+ 'winnerCount',
1477
+ 'firstWinner',
1478
+ 'availableGiftCount',
1479
+ 'redeemedGiftCount',
1480
+ 'createdAt',
1481
+ 'raw',
1482
+ ],
1483
+ giveawayStarted: [
1484
+ 'username',
1485
+ 'email',
1486
+ 'message',
1487
+ 'currency',
1488
+ 'amount',
1489
+ 'giveawayName',
1490
+ 'giveawayId',
1491
+ 'giveawayFriendlyId',
1492
+ 'offerName',
1493
+ 'offerImageUrl',
1494
+ 'winners',
1495
+ 'winnerNames',
1496
+ 'winnerCount',
1497
+ 'firstWinner',
1498
+ 'duration',
1499
+ 'allGifts',
1500
+ 'gifts',
1501
+ 'totalGifts',
1502
+ 'offer',
1503
+ 'type',
1504
+ ],
1505
+ giveawayEnded: [
1506
+ 'username',
1507
+ 'email',
1508
+ 'message',
1509
+ 'currency',
1510
+ 'amount',
1511
+ 'giveawayName',
1512
+ 'giveawayId',
1513
+ 'giveawayFriendlyId',
1514
+ 'offerName',
1515
+ 'offerImageUrl',
1516
+ 'winners',
1517
+ 'winnerNames',
1518
+ 'winnerCount',
1519
+ 'firstWinner',
1520
+ 'duration',
1521
+ 'allGifts',
1522
+ 'gifts',
1523
+ 'totalGifts',
1524
+ 'offer',
1525
+ 'type',
1526
+ ],
1527
+ thankyouSent: ['username', 'email', 'message', 'mediaUrl', 'contributionType', 'contribution'],
1528
+ newsletterSubscribed: ['email', 'raw'],
1464
1529
  },
1465
1530
  },
1466
1531
  kick: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lumiastream/lumia-types",
3
- "version": "3.3.2",
3
+ "version": "3.3.4",
4
4
  "description": "",
5
5
  "main": "./dist/index.js",
6
6
  "files": [