@lumiastream/lumia-types 3.3.0 → 3.3.2

package/dist/activity.types.d.ts

@@ -407,6 +407,10 @@ export declare enum LumiaAlertValues {
     TILTIFY_DONATION = "tiltify-campaignDonation",
     /** Throne gift purchase */
     THRONE_GIFT_PURCHASE = "throne-giftPurchase",
+    /** Throne contribution purchase */
+    THRONE_CONTRIBUTION_PURCHASE = "throne-contributionPurchase",
+    /** Throne gift crowdfunded */
+    THRONE_GIFT_CROWDFUNDED = "throne-giftCrowdfunded",
     /** TipeeeStream donation */
     TIPEEESTREAM_DONATION = "tipeeestream-donation",
     /** TreatStream treat */
@@ -687,6 +691,8 @@ export declare const LumiaAlertFriendlyValues: {
     "donordrive-donation": string;
     "tiltify-campaignDonation": string;
     "throne-giftPurchase": string;
+    "throne-contributionPurchase": string;
+    "throne-giftCrowdfunded": string;
     "tipeeestream-donation": string;
     "treatstream-treat": string;
     "patreon-campaignPledge": string;

package/dist/activity.types.js

@@ -428,6 +428,10 @@ var LumiaAlertValues;
     LumiaAlertValues["TILTIFY_DONATION"] = "tiltify-campaignDonation";
     /** Throne gift purchase */
     LumiaAlertValues["THRONE_GIFT_PURCHASE"] = "throne-giftPurchase";
+    /** Throne contribution purchase */
+    LumiaAlertValues["THRONE_CONTRIBUTION_PURCHASE"] = "throne-contributionPurchase";
+    /** Throne gift crowdfunded */
+    LumiaAlertValues["THRONE_GIFT_CROWDFUNDED"] = "throne-giftCrowdfunded";
     /** TipeeeStream donation */
     LumiaAlertValues["TIPEEESTREAM_DONATION"] = "tipeeestream-donation";
     /** TreatStream treat */
@@ -717,6 +721,8 @@ exports.LumiaAlertFriendlyValues = {
     [LumiaAlertValues.DONORDRIVE_DONATION]: 'Donordrive Tip',
     [LumiaAlertValues.TILTIFY_DONATION]: 'Tiltify Campaign Tip',
     [LumiaAlertValues.THRONE_GIFT_PURCHASE]: 'Throne Gift Purchase',
+    [LumiaAlertValues.THRONE_CONTRIBUTION_PURCHASE]: 'Throne Contribution Purchase',
+    [LumiaAlertValues.THRONE_GIFT_CROWDFUNDED]: 'Throne Gift Crowdfunded',
     // [LumiaAlertValues.PAYPAL_PAYMENT_COMPLETE]: "Paypal Payment Complete",
     // [LumiaAlertValues.PAYPAL_PAYMENT_DENIED]: "Paypal Payment Denied",
     [LumiaAlertValues.TIPEEESTREAM_DONATION]: 'Tipeeestream Tip',

package/dist/alert.types.js

@@ -7334,6 +7334,116 @@ exports.LumiaAlertConfigs = {
             { type: LumiaVariationConditions.EQUAL_VARIABLE },
         ],
     },
+    [activity_types_1.LumiaAlertValues.THRONE_CONTRIBUTION_PURCHASE]: {
+        connection: event_types_1.LumiaIntegrations.THRONE,
+        message: '{{username}} contributed {{amount}} {{currency}} toward {{itemName}} on Throne. {{message}}',
+        eventlistMessage: 'Contribution Purchase',
+        eventlistDetailedMessage: 'contributed {{amount}} {{currency}} toward {{itemName}}',
+        acceptedVariables: variables_types_1.AllVariables.throne.alerts.contributionPurchase,
+        quickActions: [
+            {
+                label: '$10',
+                dynamic: { value: 10, currency: LumiaVariationCurrency.USD },
+                extraSettings: {
+                    username: 'lumiastream',
+                    displayname: 'lumiastream',
+                    message: 'Happy to contribute!',
+                    itemName: 'AirPods Max',
+                    itemThumbnailUrl: 'https://m.media-amazon.com/images/I/81jqUPkIVRL._AC_SX522_.jpg',
+                    amount: 10,
+                    currency: LumiaVariationCurrency.USD,
+                    creatorUsername: 'lumiastream',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Username',
+                variableField: 'username',
+                required: false,
+                default: 'lumiastream',
+            },
+            {
+                type: 'text',
+                label: 'Item',
+                variableField: 'itemName',
+                required: true,
+                default: 'AirPods Max',
+            },
+            {
+                type: 'number',
+                label: 'Amount',
+                dynamicField: 'value',
+                variableField: 'amount',
+                required: false,
+                default: 10,
+            },
+            {
+                type: 'currency',
+                label: 'Currency',
+                dynamicField: 'currency',
+                variableField: 'currency',
+                required: false,
+                default: LumiaVariationCurrency.USD,
+            },
+            {
+                type: 'text',
+                label: 'Message',
+                variableField: 'message',
+                required: false,
+                default: 'Happy to contribute!',
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            {
+                type: LumiaVariationConditions.EQUAL_CURRENCY_NUMBER,
+            },
+            {
+                type: LumiaVariationConditions.GREATER_CURRENCY_NUMBER,
+            },
+            { type: LumiaVariationConditions.EQUAL_VARIABLE },
+        ],
+    },
+    [activity_types_1.LumiaAlertValues.THRONE_GIFT_CROWDFUNDED]: {
+        connection: event_types_1.LumiaIntegrations.THRONE,
+        message: '{{itemName}} was crowdfunded on Throne.',
+        eventlistMessage: 'Gift Crowdfunded',
+        eventlistDetailedMessage: 'crowdfunded {{itemName}}',
+        acceptedVariables: variables_types_1.AllVariables.throne.alerts.giftCrowdfunded,
+        quickActions: [
+            {
+                label: 'Gift',
+                dynamic: { value: 'AirPods Max', name: 'AirPods Max' },
+                extraSettings: {
+                    username: 'Community',
+                    displayname: 'Community',
+                    itemName: 'AirPods Max',
+                    itemThumbnailUrl: 'https://m.media-amazon.com/images/I/81jqUPkIVRL._AC_SX522_.jpg',
+                    isSurpriseGift: false,
+                    creatorUsername: 'lumiastream',
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Item',
+                dynamicField: 'value',
+                variableField: 'itemName',
+                required: true,
+                default: 'AirPods Max',
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            {
+                type: LumiaVariationConditions.EQUAL_STRING,
+            },
+            { type: LumiaVariationConditions.EQUAL_VARIABLE },
+        ],
+    },
     // },
     // fourthwall: {
     [activity_types_1.LumiaAlertValues.FOURTHWALL_DONATION]: {

package/dist/custom-code/important-notes.md

@@ -13,28 +13,43 @@ title: Important notes
   The different options are: `isSelf, mod, vip, tier3, tier2, tier1, subscriber, follower`.
   In your code you should use `const levels = await getVariable('userLevelsRaw');` and then you can check a level with `if (levels.subscriber) {}` since these are all booleans
 
-- We also expose `{{originType}}` so your custom code can tell where the activity came from. Use `const originType = await getVariable('originType');` when you need to branch between alerts and command-based triggers.
-  Common values are: `alert`, `chat`, `chatbot`, `twitch-points`, `twitch-extension`, `kick-points`, `system`, and `api`.
-  Important: "commands" are not a single origin type. If you want to run only for command-style triggers you will usually want to check for a list like `chat`, `chatbot`, `twitch-points`, `twitch-extension`, and `kick-points`.
+## Origin and queue type variables
+
+We expose `{{originType}}` and `{{queueType}}` so custom code can tell where an activity came from and what kind of queued activity is running.
+
+Use `originType` when you want to branch by the source of the activity. Use `queueType` when you need the specific command category that Lumia is executing.
+
+| Variable | What it means | Common values |
+| --- | --- | --- |
+| `originType` | Where the activity came from. This controls queue priority and groups similar sources together. | `alert`, `chat`, `chatbot`, `twitch-points`, `twitch-extension`, `kick-points`, `system`, `api`, `streamdeck`, `touchportal`, `loupedeck`, `avermedia`, `lumiastreamlink` |
+| `queueType` | The specific queued command/activity type. This is the best value to check when you need to distinguish a normal chat command from a chat match. | `alert`, `chat-command`, `chatbot-command`, `chat-match`, `twitch-points`, `twitch-points-output`, `twitch-extension`, `twitch-extension-hfx`, `kick-points` |
+
+Important: "commands" are not a single `originType`. A normal chat command uses `originType: "chat"` and `queueType: "chat-command"`, while a chat match also uses `originType: "chat"` but uses `queueType: "chat-match"`.
 
 ```js
 async function() {
 	const originType = await getVariable('originType');
-	const commandOrigins = ['chat', 'chatbot', 'twitch-points', 'twitch-extension', 'kick-points'];
+	const queueType = await getVariable('queueType');
 
-	if (originType === 'alert') {
-		chatbot({ message: 'This custom code was triggered by an alert.' });
+	if (queueType === 'chat-match') {
+		log('This ran from a chat match.');
 		done();
 		return;
 	}
 
-	if (commandOrigins.includes(originType)) {
-		chatbot({ message: `Command trigger detected from ${originType}.` });
+	if (queueType === 'chat-command') {
+		log('This ran from a normal chat command.');
+		done();
+		return;
+	}
+
+	if (originType === 'alert') {
+		log('This ran from an alert.');
 		done();
 		return;
 	}
 
-	log(`Skipping custom code for originType: ${originType}`);
+	log(`Skipping custom code for originType=${originType}, queueType=${queueType}`);
 	done();
 }
 ```

package/dist/custom-overlays/custom-overlays.d.ts

@@ -695,6 +695,10 @@ export declare enum LumiaAlertValues {
     TILTIFY_DONATION = "tiltify-campaignDonation",
     /** Throne gift purchase */
     THRONE_GIFT_PURCHASE = "throne-giftPurchase",
+    /** Throne contribution purchase */
+    THRONE_CONTRIBUTION_PURCHASE = "throne-contributionPurchase",
+    /** Throne gift crowdfunded */
+    THRONE_GIFT_CROWDFUNDED = "throne-giftCrowdfunded",
     /** TipeeeStream donation */
     TIPEEESTREAM_DONATION = "tipeeestream-donation",
     /** TreatStream treat */

package/dist/custom-overlays.d.ts

@@ -695,6 +695,10 @@ export declare enum LumiaAlertValues {
     TILTIFY_DONATION = "tiltify-campaignDonation",
     /** Throne gift purchase */
     THRONE_GIFT_PURCHASE = "throne-giftPurchase",
+    /** Throne contribution purchase */
+    THRONE_CONTRIBUTION_PURCHASE = "throne-contributionPurchase",
+    /** Throne gift crowdfunded */
+    THRONE_GIFT_CROWDFUNDED = "throne-giftCrowdfunded",
     /** TipeeeStream donation */
     TIPEEESTREAM_DONATION = "tipeeestream-donation",
     /** TreatStream treat */

package/dist/event.types.d.ts

@@ -20,6 +20,7 @@ export interface ILumiaSendPack {
             username?: string;
             bits?: number;
             originType?: LumiaActivityOriginTypes;
+            queueType?: LumiaActivityCommandTypes;
         };
     };
 }

package/dist/variables.types.d.ts

@@ -936,6 +936,8 @@ export declare const AllVariables: {
         variables: string[];
         alerts: {
             giftPurchase: string[];
+            contributionPurchase: string[];
+            giftCrowdfunded: string[];
         };
     };
     tipeeestream: {

package/dist/variables.types.js

@@ -734,6 +734,7 @@ exports.ReservedVariables = [
     'value',
     'site',
     'originType',
+    'queueType',
     'command',
     'merch',
     'message',
@@ -952,6 +953,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'message',
                 'messageId',
@@ -977,6 +979,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'message',
                 'messageId',
@@ -998,6 +1001,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'prompt',
                 'message',
@@ -1015,6 +1019,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'prompt',
                 'message',
@@ -1032,6 +1037,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'prompt',
                 'message',
@@ -1042,7 +1048,7 @@ exports.AllVariables = {
                 'points_cost',
             ],
             fileWatcher: ['content', 'file', 'path', 'timestamp'],
-            chatmatch: ['language_detect_result', 'detected_language', 'detected_language_code'],
+            chatmatch: ['originType', 'queueType', 'language_detect_result', 'detected_language', 'detected_language_code'],
             commands: [
                 'get_all_commands',
                 'get_commands',
@@ -1055,6 +1061,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'message',
                 'messageId',
@@ -1724,6 +1731,8 @@ exports.AllVariables = {
         variables: ['throne_last_gift'],
         alerts: {
             giftPurchase: ['username', 'displayname', 'message', 'itemName', 'itemThumbnailUrl', 'isSurpriseGift', 'creatorUsername', 'raw'],
+            contributionPurchase: ['username', 'displayname', 'message', 'itemName', 'itemThumbnailUrl', 'amount', 'currency', 'creatorUsername', 'raw'],
+            giftCrowdfunded: ['username', 'displayname', 'itemName', 'itemThumbnailUrl', 'isSurpriseGift', 'creatorUsername', 'raw'],
         },
     },
     tipeeestream: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumiastream/lumia-types",
-  "version": "3.3.0",
+  "version": "3.3.2",
   "description": "",
   "main": "./dist/index.js",
   "files": [