@lumiastream/lumia-types 0.2.78 → 0.2.80

package/dist/alert.types.js

@@ -1503,7 +1503,7 @@ exports.LumiaAlertConfigs = {
         eventlistSpecialUsername: 'Twitch',
         eventlistMessage: 'Goal start',
         eventlistDetailedMessage: 'Goal {{goal_description}} started with a target of {{goal_target_amount}}',
-        acceptedVariables: ['goal_type', 'goal_id', 'goal_description', 'goal_aomunt', 'goal_target_amount'],
+        acceptedVariables: ['goal_type', 'goal_id', 'goal_description', 'goal_amount', 'goal_target_amount'],
         quickActions: [
             {
                 label: '100 Followers',
@@ -1511,7 +1511,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'follower',
                     goal_description: '100 Followers!',
-                    goal_aomunt: 0,
+                    goal_amount: 0,
                     goal_target_amount: 100,
                 },
             },
@@ -1521,7 +1521,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'subscription',
                     goal_description: '100 Subs!',
-                    goal_aomunt: 0,
+                    goal_amount: 0,
                     goal_target_amount: 100,
                 },
             },
@@ -1531,7 +1531,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'new_subscriptions',
                     goal_description: '100 New Subs!',
-                    goal_aomunt: 0,
+                    goal_amount: 0,
                     goal_target_amount: 100,
                 },
             },
@@ -1560,7 +1560,7 @@ exports.LumiaAlertConfigs = {
             {
                 type: 'number',
                 label: 'Current Amount',
-                variableField: 'goal_aomunt',
+                variableField: 'goal_amount',
                 required: true,
                 default: 0,
             },
@@ -1576,11 +1576,11 @@ exports.LumiaAlertConfigs = {
     },
     [activity_types_1.LumiaAlertValues.TWITCH_GOAL_PROGRESSED]: {
         connection: 'twitch',
-        message: 'Goal {{goal_description}} progressed to {{goal_aomunt}} with a target of {{goal_target_amount}}',
+        message: 'Goal {{goal_description}} progressed to {{goal_amount}} with a target of {{goal_target_amount}}',
         eventlistSpecialUsername: 'Twitch',
         eventlistMessage: 'Goal progressed',
-        eventlistDetailedMessage: 'Goal {{goal_description}} progressed to {{goal_aomunt}} with a target of {{goal_target_amount}}',
-        acceptedVariables: ['goal_type', 'goal_id', 'goal_description', 'goal_aomunt', 'goal_target_amount'],
+        eventlistDetailedMessage: 'Goal {{goal_description}} progressed to {{goal_amount}} with a target of {{goal_target_amount}}',
+        acceptedVariables: ['goal_type', 'goal_id', 'goal_description', 'goal_amount', 'goal_target_amount'],
         quickActions: [
             {
                 label: 'Gained 50 Followers',
@@ -1588,7 +1588,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'follower',
                     goal_description: '100 Followers!',
-                    goal_aomunt: 50,
+                    goal_amount: 50,
                     goal_target_amount: 100,
                 },
             },
@@ -1598,7 +1598,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'subscription',
                     goal_description: '100 Subs!',
-                    goal_aomunt: 50,
+                    goal_amount: 50,
                     goal_target_amount: 50,
                 },
             },
@@ -1608,7 +1608,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'new_subscriptions',
                     goal_description: '100 New Subs!',
-                    goal_aomunt: 50,
+                    goal_amount: 50,
                     goal_target_amount: 100,
                 },
             },
@@ -1637,7 +1637,7 @@ exports.LumiaAlertConfigs = {
                 type: 'number',
                 label: 'Current Amount',
                 dynamicField: 'value',
-                variableField: 'goal_aomunt',
+                variableField: 'goal_amount',
                 required: true,
                 default: 50,
             },
@@ -1653,11 +1653,11 @@ exports.LumiaAlertConfigs = {
     },
     [activity_types_1.LumiaAlertValues.TWITCH_GOAL_ENDED]: {
         connection: 'twitch',
-        message: 'Goal {{goal_description}} ended at amount {{goal_aomunt}} with a target of {{goal_target_amount}}',
+        message: 'Goal {{goal_description}} ended at amount {{goal_amount}} with a target of {{goal_target_amount}}',
         eventlistSpecialUsername: 'Twitch',
         eventlistMessage: 'Goal ended',
-        eventlistDetailedMessage: 'Goal {{goal_description}} ended at amount {{goal_aomunt}} with a target of {{goal_target_amount}}',
-        acceptedVariables: ['goal_type', 'goal_id', 'goal_description', 'goal_aomunt', 'goal_target_amount', 'goal_achieved', 'goal_status'],
+        eventlistDetailedMessage: 'Goal {{goal_description}} ended at amount {{goal_amount}} with a target of {{goal_target_amount}}',
+        acceptedVariables: ['goal_type', 'goal_id', 'goal_description', 'goal_amount', 'goal_target_amount', 'goal_achieved', 'goal_status'],
         quickActions: [
             {
                 label: 'Reached 100 Followers',
@@ -1665,7 +1665,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'follower',
                     goal_description: '100 Followers!',
-                    goal_aomunt: 100,
+                    goal_amount: 100,
                     goal_target_amount: 100,
                 },
             },
@@ -1675,7 +1675,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'subscription',
                     goal_description: '100 Subs!',
-                    goal_aomunt: 100,
+                    goal_amount: 100,
                     goal_target_amount: 100,
                 },
             },
@@ -1685,7 +1685,7 @@ exports.LumiaAlertConfigs = {
                 extraSettings: {
                     goal_type: 'new_subscriptions',
                     goal_description: '100 New Subs!',
-                    goal_aomunt: 100,
+                    goal_amount: 100,
                     goal_target_amount: 100,
                 },
             },
@@ -1714,7 +1714,7 @@ exports.LumiaAlertConfigs = {
                 type: 'number',
                 label: 'Current Amount',
                 dynamicField: 'value',
-                variableField: 'goal_aomunt',
+                variableField: 'goal_amount',
                 required: true,
                 default: 50,
             },
@@ -1740,6 +1740,414 @@ exports.LumiaAlertConfigs = {
             { type: LumiaVariationConditions.GREATER_NUMBER },
         ],
     },
+    [activity_types_1.LumiaAlertValues.TWITCH_CHARITY_DONATION]: {
+        connection: 'streamlabs',
+        message: '{{username}} just donated {{amount}} to charity {{charity_name}}',
+        eventlistMessage: 'Donation',
+        eventlistDetailedMessage: 'donated {{amount}} {{currency}}',
+        acceptedVariables: ['username', 'currency', 'amount', 'message', 'charity_id', 'charity_campaign_id', 'charity_name', 'charity_description', 'charity_logo', 'charity_website'],
+        quickActions: [
+            {
+                label: '$100',
+                dynamic: { value: 100, currency: LumiaVariationCurrency.USD },
+                extraSettings: {
+                    username: 'lumiastream',
+                    avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    amount: 100,
+                    currency: LumiaVariationCurrency.USD,
+                    charity_id: 'lumia123',
+                    charity_name: 'Lumia Charity',
+                    charity_description: 'Give me more lights',
+                    charity_logo: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    charity_website: 'https://lumiastream.com',
+                    started_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+            {
+                label: '$200',
+                dynamic: { value: 200, currency: LumiaVariationCurrency.USD },
+                extraSettings: {
+                    username: 'lumiastream',
+                    avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    amount: 200,
+                    currency: LumiaVariationCurrency.USD,
+                    charity_id: 'lumia123',
+                    charity_name: 'Lumia Charity',
+                    charity_description: 'Give me more lights',
+                    charity_logo: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    charity_website: 'https://lumiastream.com',
+                    started_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+            {
+                label: '$300',
+                dynamic: { value: 300, currency: LumiaVariationCurrency.USD },
+                extraSettings: {
+                    username: 'lumiastream',
+                    avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    amount: 300,
+                    currency: LumiaVariationCurrency.USD,
+                    charity_id: 'lumia123',
+                    charity_name: 'Lumia Charity',
+                    charity_description: 'Give me more lights',
+                    charity_logo: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    charity_website: 'https://lumiastream.com',
+                    started_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Username',
+                variableField: 'username',
+                required: false,
+                default: 'lumiastream',
+            },
+            {
+                type: 'number',
+                label: 'Amount',
+                dynamicField: 'value',
+                variableField: 'amount',
+                required: false,
+                default: 100,
+            },
+            {
+                type: 'currency',
+                label: 'Currency',
+                dynamicField: 'currency',
+                variableField: 'currency',
+                required: false,
+                default: LumiaVariationCurrency.USD,
+            },
+            {
+                type: 'text',
+                label: 'Charity Name',
+                variableField: 'charity_name',
+                required: false,
+                default: 'My Charity',
+            },
+            {
+                type: 'text',
+                label: 'Charity Description',
+                variableField: 'charity_description',
+                required: false,
+                default: '100 dollars!',
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            {
+                type: LumiaVariationConditions.EQUAL_CURRENCY_NUMBER,
+            },
+            {
+                type: LumiaVariationConditions.GREATER_CURRENCY_NUMBER,
+            },
+        ],
+    },
+    [activity_types_1.LumiaAlertValues.TWITCH_CHARITY_CAMPAIGN_STARTED]: {
+        connection: 'twitch',
+        message: 'Charity campaign {{charity_name}} started with a target of {{charity_target_amount}}',
+        eventlistSpecialUsername: 'Twitch',
+        eventlistMessage: 'Charity campaign start',
+        eventlistDetailedMessage: 'Charity campaign {{charity_name}} started with a target of {{charity_target_amount}}',
+        acceptedVariables: [
+            'charity_id',
+            'charity_campaign_id',
+            'charity_name',
+            'charity_description',
+            'charity_logo',
+            'charity_amount',
+            'charity_target_amount',
+            'charity_website',
+            'currency',
+            'started_at',
+        ],
+        quickActions: [
+            {
+                label: 'Charity Started',
+                dynamic: { value: 'lumiastream' },
+                extraSettings: {
+                    charity_id: 'lumia123',
+                    charity_name: 'Lumia Charity',
+                    charity_description: 'Give me more lights',
+                    charity_logo: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    charity_amount: 0,
+                    charity_target_amount: 100,
+                    charity_website: 'https://lumiastream.com',
+                    currency: LumiaVariationCurrency.USD,
+                    started_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Charity Name',
+                variableField: 'charity_name',
+                required: true,
+                default: 'My Charity',
+            },
+            {
+                type: 'text',
+                label: 'Charity Description',
+                variableField: 'charity_description',
+                required: false,
+                default: '100 dollars!',
+            },
+            {
+                type: 'number',
+                label: 'Current Amount',
+                variableField: 'goal_amount',
+                required: true,
+                default: 0,
+            },
+            {
+                type: 'number',
+                label: 'Target Amount',
+                variableField: 'goal_target_amount',
+                required: true,
+                default: 100,
+            },
+            {
+                type: 'text',
+                label: 'Currency',
+                variableField: 'currency',
+                required: true,
+                default: 'usd',
+            },
+        ],
+        LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }],
+    },
+    [activity_types_1.LumiaAlertValues.TWITCH_CHARITY_CAMPAIGN_PROGRESSED]: {
+        connection: 'twitch',
+        message: 'Charity campaign {{charity_name}} progressed to {{charity_amount}} with a target of {{charity_target_amount}}',
+        eventlistSpecialUsername: 'Twitch',
+        eventlistMessage: 'Charity campaign progressed',
+        eventlistDetailedMessage: 'Charity campaign {{charity_name}} progressed to {{charity_amount}} with a target of {{charity_target_amount}}',
+        acceptedVariables: [
+            'charity_id',
+            'charity_campaign_id',
+            'charity_name',
+            'charity_description',
+            'charity_logo',
+            'charity_amount',
+            'charity_target_amount',
+            'charity_website',
+            'currency',
+            'started_at',
+        ],
+        quickActions: [
+            {
+                label: 'Charity Started',
+                dynamic: { value: 'lumiastream' },
+                extraSettings: {
+                    charity_id: 'lumia123',
+                    charity_name: 'Lumia Charity',
+                    charity_description: 'Give me more lights',
+                    charity_logo: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    charity_amount: 20,
+                    charity_target_amount: 100,
+                    charity_website: 'https://lumiastream.com',
+                    currency: LumiaVariationCurrency.USD,
+                    started_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Charity Name',
+                variableField: 'charity_name',
+                required: true,
+                default: 'My Charity',
+            },
+            {
+                type: 'text',
+                label: 'Charity Description',
+                variableField: 'charity_description',
+                required: false,
+                default: '100 dollars!',
+            },
+            {
+                type: 'number',
+                label: 'Current Amount',
+                variableField: 'charity_amount',
+                required: true,
+                default: 20,
+            },
+            {
+                type: 'number',
+                label: 'Target Amount',
+                variableField: 'charity_target_amount',
+                required: true,
+                default: 100,
+            },
+            {
+                type: 'text',
+                label: 'Currency',
+                variableField: 'currency',
+                required: true,
+                default: 'usd',
+            },
+        ],
+        LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }],
+    },
+    [activity_types_1.LumiaAlertValues.TWITCH_CHARITY_CAMPAIGN_PROGRESSED]: {
+        connection: 'twitch',
+        message: 'Charity campaign {{charity_name}} progressed to {{charity_amount}} with a target of {{charity_target_amount}}',
+        eventlistSpecialUsername: 'Twitch',
+        eventlistMessage: 'Charity campaign progressed',
+        eventlistDetailedMessage: 'Charity campaign {{charity_name}} progressed to {{charity_amount}} with a target of {{charity_target_amount}}',
+        acceptedVariables: [
+            'charity_id',
+            'charity_campaign_id',
+            'charity_name',
+            'charity_description',
+            'charity_logo',
+            'charity_amount',
+            'charity_target_amount',
+            'charity_website',
+            'currency',
+            'started_at',
+        ],
+        quickActions: [
+            {
+                label: 'Charity Started',
+                dynamic: { value: 'lumiastream' },
+                extraSettings: {
+                    charity_id: 'lumia123',
+                    charity_name: 'Lumia Charity',
+                    charity_description: 'Give me more lights',
+                    charity_logo: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    charity_amount: 20,
+                    charity_target_amount: 100,
+                    charity_website: 'https://lumiastream.com',
+                    currency: LumiaVariationCurrency.USD,
+                    started_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Charity Name',
+                variableField: 'charity_name',
+                required: true,
+                default: 'My Charity',
+            },
+            {
+                type: 'text',
+                label: 'Charity Description',
+                variableField: 'charity_description',
+                required: false,
+                default: '100 dollars!',
+            },
+            {
+                type: 'number',
+                label: 'Current Amount',
+                variableField: 'charity_amount',
+                required: true,
+                default: 20,
+            },
+            {
+                type: 'number',
+                label: 'Target Amount',
+                variableField: 'charity_target_amount',
+                required: true,
+                default: 100,
+            },
+            {
+                type: 'text',
+                label: 'Currency',
+                variableField: 'currency',
+                required: true,
+                default: 'usd',
+            },
+        ],
+        LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_NUMBER }, { type: LumiaVariationConditions.GREATER_NUMBER }],
+    },
+    [activity_types_1.LumiaAlertValues.TWITCH_CHARITY_CAMPAIGN_STOPPED]: {
+        connection: 'twitch',
+        message: 'Charity campaign {{charity_name}} ended at amount {{charity_amount}} with a target of {{charity_target_amount}}',
+        eventlistSpecialUsername: 'Twitch',
+        eventlistMessage: 'Charity campaign ended',
+        eventlistDetailedMessage: 'Charity campaign {{charity_name}} ended at amount {{charity_amount}} with a target of {{charity_target_amount}}',
+        acceptedVariables: [
+            'charity_id',
+            'charity_campaign_id',
+            'charity_name',
+            'charity_description',
+            'charity_logo',
+            'charity_amount',
+            'charity_target_amount',
+            'charity_website',
+            'currency',
+            'started_at',
+            'ended_at',
+        ],
+        quickActions: [
+            {
+                label: 'Charity Target Achieved',
+                dynamic: { value: 'lumiastream' },
+                extraSettings: {
+                    charity_id: 'lumia123',
+                    charity_name: 'Lumia Charity',
+                    charity_description: 'Give me more lights',
+                    charity_logo: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    charity_amount: 100,
+                    charity_target_amount: 100,
+                    charity_website: 'https://lumiastream.com',
+                    currency: LumiaVariationCurrency.USD,
+                    started_at: '2022-07-26T17:00:03.17106713Z',
+                    ended_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Charity Name',
+                variableField: 'charity_name',
+                required: true,
+                default: 'My Charity',
+            },
+            {
+                type: 'text',
+                label: 'Charity Description',
+                variableField: 'charity_description',
+                required: false,
+                default: '100 dollars!',
+            },
+            {
+                type: 'number',
+                label: 'Current Amount',
+                variableField: 'charity_amount',
+                required: true,
+                default: 20,
+            },
+            {
+                type: 'number',
+                label: 'Target Amount',
+                variableField: 'charity_target_amount',
+                required: true,
+                default: 100,
+            },
+            {
+                type: 'text',
+                label: 'Currency',
+                variableField: 'currency',
+                required: true,
+                default: 'usd',
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            { type: LumiaVariationConditions.TARGET_ACHIEVED },
+            { type: LumiaVariationConditions.EQUAL_NUMBER },
+            { type: LumiaVariationConditions.GREATER_NUMBER },
+        ],
+    },
     [activity_types_1.LumiaAlertValues.TWITCH_CATEGORY]: {
         connection: 'twitch',
         message: 'Category changed to {{category_name}}',
@@ -2042,6 +2450,50 @@ exports.LumiaAlertConfigs = {
         ],
         LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }, { type: LumiaVariationConditions.EQUAL_STRING }],
     },
+    [activity_types_1.LumiaAlertValues.TWITCH_DROP_ENTITLEMENT]: {
+        connection: 'twitch',
+        message: 'Entitlement dropped for {{username}}',
+        eventlistMessage: 'Entitlement Drop',
+        eventlistDetailedMessage: 'entitlement dropped',
+        acceptedVariables: ['username', 'userId', 'displayname', 'avatar', 'organization_id', 'category_id', 'category_name', 'campaign_id', 'entitlement_id', 'benefit_id', 'created_at'],
+        quickActions: [
+            {
+                label: 'Entitlement Dropped',
+                dynamic: { value: 'lumiastream' },
+                extraSettings: {
+                    username: 'lumiastream',
+                    avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    displayname: 'LumiaStream',
+                    userId: '1234',
+                    organization_id: 'lumia123',
+                    category_id: 'lumia123',
+                    category_name: 'Fortnite',
+                    campaign_id: 'lumia123',
+                    entitlement_id: 'lumia123',
+                    benefit_id: 'lumia123',
+                    created_at: '2022-07-26T17:00:03.17106713Z',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Username',
+                dynamicField: 'value',
+                variableField: 'username',
+                required: true,
+                default: 'lumiastream',
+            },
+            {
+                type: 'text',
+                label: 'Category Name',
+                variableField: 'category_name',
+                required: true,
+                default: 'Fortnite',
+            },
+        ],
+        LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }],
+    },
     // },
     // youtube: {
     [activity_types_1.LumiaAlertValues.YOUTUBE_STREAM_LIVE]: {