@lumiastream/lumia-types 3.2.9 → 3.3.1

package/dist/activity.types.d.ts

@@ -287,6 +287,10 @@ export declare enum LumiaAlertValues {
     YOUTUBE_SUPERSTICKER = "youtube-supersticker",
     /** YouTube session superstickers */
     YOUTUBE_SESSION_SUPERSTICKERS = "youtube-sessionSuperstickers",
+    /** YouTube gift event (jewel-based) */
+    YOUTUBE_GIFTS = "youtube-gifts",
+    /** YouTube session gifts */
+    YOUTUBE_SESSION_GIFTS = "youtube-sessionGifts",
     /** YouTube total likes */
     YOUTUBE_LIKE = "youtube-like",
     /** YouTube total views */
@@ -622,6 +626,8 @@ export declare const LumiaAlertFriendlyValues: {
     "youtube-subscriber": string;
     "youtube-superchat": string;
     "youtube-supersticker": string;
+    "youtube-gifts": string;
+    "youtube-sessionGifts": string;
     "youtube-entrance": string;
     "youtube-like": string;
     "youtube-viewers": string;

package/dist/activity.types.js

@@ -303,6 +303,10 @@ var LumiaAlertValues;
     LumiaAlertValues["YOUTUBE_SUPERSTICKER"] = "youtube-supersticker";
     /** YouTube session superstickers */
     LumiaAlertValues["YOUTUBE_SESSION_SUPERSTICKERS"] = "youtube-sessionSuperstickers";
+    /** YouTube gift event (jewel-based) */
+    LumiaAlertValues["YOUTUBE_GIFTS"] = "youtube-gifts";
+    /** YouTube session gifts */
+    LumiaAlertValues["YOUTUBE_SESSION_GIFTS"] = "youtube-sessionGifts";
     /** YouTube total likes */
     LumiaAlertValues["YOUTUBE_LIKE"] = "youtube-like";
     /** YouTube total views */
@@ -652,6 +656,8 @@ exports.LumiaAlertFriendlyValues = {
     [LumiaAlertValues.YOUTUBE_SUBSCRIBER]: 'Youtube Subscriber',
     [LumiaAlertValues.YOUTUBE_SUPERCHAT]: 'Youtube Superchat',
     [LumiaAlertValues.YOUTUBE_SUPERSTICKER]: 'Youtube Supersticker',
+    [LumiaAlertValues.YOUTUBE_GIFTS]: 'Youtube Gifts',
+    [LumiaAlertValues.YOUTUBE_SESSION_GIFTS]: 'Youtube Session Gifts',
     [LumiaAlertValues.YOUTUBE_ENTRANCE]: 'Youtube Entrance',
     [LumiaAlertValues.YOUTUBE_LIKE]: 'Youtube Like',
     [LumiaAlertValues.YOUTUBE_VIEWERS]: 'Youtube Viewers',

package/dist/alert.types.js

@@ -3906,6 +3906,152 @@ exports.LumiaAlertConfigs = {
             { type: LumiaVariationConditions.COUNT_IS_MULTIPLE_OF, description: 'Total Session Gift Member Count is a multiple of' },
         ],
     },
+    [activity_types_1.LumiaAlertValues.YOUTUBE_GIFTS]: {
+        connection: event_types_1.LumiaIntegrations.YOUTUBE,
+        message: '{{username}} sent x{{comboCount}} {{giftName}} ({{jewelsAmount}} jewels)',
+        eventlistMessage: 'Gift',
+        eventlistDetailedMessage: 'sent x{{comboCount}} {{giftName}} worth {{jewelsAmount}} jewels',
+        acceptedVariables: variables_types_1.AllVariables.youtube.alerts.gifts,
+        quickActions: [
+            {
+                label: '10 Jewels',
+                dynamic: { value: 10, name: 'Heart' },
+                extraSettings: {
+                    username: 'lumiastream',
+                    displayname: 'LumiaStream',
+                    avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    giftName: 'Heart',
+                    jewelsAmount: 10,
+                    totalJewels: 10,
+                    comboCount: 1,
+                    hasVisualEffect: false,
+                },
+            },
+            {
+                label: '100 Jewels',
+                dynamic: { value: 100, name: 'Rose' },
+                extraSettings: {
+                    username: 'lumiastream',
+                    displayname: 'LumiaStream',
+                    avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    giftName: 'Rose',
+                    jewelsAmount: 100,
+                    totalJewels: 100,
+                    comboCount: 1,
+                    hasVisualEffect: true,
+                },
+            },
+            {
+                label: '500 Jewels Combo',
+                dynamic: { value: 500, name: 'Star' },
+                extraSettings: {
+                    username: 'lumiastream',
+                    displayname: 'LumiaStream',
+                    avatar: 'https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png',
+                    giftName: 'Star',
+                    jewelsAmount: 500,
+                    totalJewels: 500,
+                    comboCount: 5,
+                    hasVisualEffect: true,
+                },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'text',
+                label: 'Username',
+                variableField: 'username',
+                required: false,
+                default: 'lumiastream',
+            },
+            {
+                type: 'text',
+                label: 'Gift Name',
+                variableField: 'giftName',
+                required: false,
+                default: 'Rose',
+            },
+            {
+                type: 'number',
+                label: 'Jewels Amount',
+                dynamicField: 'value',
+                variableField: 'jewelsAmount',
+                required: true,
+                default: 100,
+            },
+            {
+                type: 'number',
+                label: 'Combo Count',
+                variableField: 'comboCount',
+                required: false,
+                default: 1,
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            {
+                type: LumiaVariationConditions.EQUAL_STRING,
+                description: 'Gift Name is equal to',
+            },
+            {
+                type: LumiaVariationConditions.EQUAL_NUMBER,
+                description: 'Jewels is equal to',
+            },
+            {
+                type: LumiaVariationConditions.GREATER_NUMBER,
+                description: 'Jewels is greater than',
+            },
+            { type: LumiaVariationConditions.EQUAL_USERNAME },
+            { type: LumiaVariationConditions.EQUAL_VARIABLE },
+        ],
+    },
+    [activity_types_1.LumiaAlertValues.YOUTUBE_SESSION_GIFTS]: {
+        connection: event_types_1.LumiaIntegrations.YOUTUBE,
+        message: 'Reached {{total}} jewels this session',
+        eventlistMessage: 'Total Gifts {{total}}',
+        eventlistDetailedMessage: 'reached {{total}} jewels',
+        acceptedVariables: variables_types_1.AllVariables.youtube.alerts.sessionGifts,
+        eventlistSpecialUsername: 'Total Gifts',
+        quickActions: [
+            {
+                label: '100 Total Jewels',
+                dynamic: { value: 100, total: 100, previousTotal: 50 },
+                extraSettings: { total: 100, previousTotal: 50 },
+            },
+            {
+                label: '500 Total Jewels',
+                dynamic: { value: 500, total: 500, previousTotal: 100 },
+                extraSettings: { total: 500, previousTotal: 100 },
+            },
+            {
+                label: '1000 Total Jewels',
+                dynamic: { value: 1000, total: 1000, previousTotal: 500 },
+                extraSettings: { total: 1000, previousTotal: 500 },
+            },
+        ],
+        inputFields: [
+            {
+                type: 'number',
+                label: 'Total Jewels',
+                dynamicField: 'value',
+                variableField: 'total',
+                required: true,
+                default: 100,
+            },
+            {
+                type: 'number',
+                label: 'Previous Total',
+                dynamicField: 'previousTotal',
+                variableField: 'previousTotal',
+                required: false,
+                default: 0,
+            },
+        ],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.GREATER_NUMBER, description: 'Total Session Jewels Greater Than' },
+            { type: LumiaVariationConditions.COUNT_IS_MULTIPLE_OF, description: 'Total Session Jewels is a multiple of' },
+        ],
+    },
     [activity_types_1.LumiaAlertValues.YOUTUBE_SUPERCHAT]: {
         connection: event_types_1.LumiaIntegrations.YOUTUBE,
         message: '{{username}} just super chatted with {{currencySymbol}}{{amount}}. They said {{message}}',

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

@@ -575,6 +575,10 @@ export declare enum LumiaAlertValues {
     YOUTUBE_SUPERSTICKER = "youtube-supersticker",
     /** YouTube session superstickers */
     YOUTUBE_SESSION_SUPERSTICKERS = "youtube-sessionSuperstickers",
+    /** YouTube gift event (jewel-based) */
+    YOUTUBE_GIFTS = "youtube-gifts",
+    /** YouTube session gifts */
+    YOUTUBE_SESSION_GIFTS = "youtube-sessionGifts",
     /** YouTube total likes */
     YOUTUBE_LIKE = "youtube-like",
     /** YouTube total views */
@@ -1210,6 +1214,16 @@ export declare enum SystemVariables {
     YOUTUBE_LAST_GIFT_MEMBER = "youtube_last_gift_member",
     /** Session gift members (list). Use as {{youtube_session_gift_members}}. */
     YOUTUBE_SESSION_GIFT_MEMBERS = "youtube_session_gift_members",
+    /** Lifetime jewels count. Use as {{youtube_total_jewels_count}}. */
+    YOUTUBE_TOTAL_JEWELS_COUNT = "youtube_total_jewels_count",
+    /** Session jewels count. Use as {{youtube_session_jewels_count}}. */
+    YOUTUBE_SESSION_JEWELS_COUNT = "youtube_session_jewels_count",
+    /** Last jewel amount. Use as {{youtube_last_jewels}}. */
+    YOUTUBE_LAST_JEWELS = "youtube_last_jewels",
+    /** Last user that sent jewels. Use as {{youtube_last_jewels_user}}. */
+    YOUTUBE_LAST_JEWELS_USER = "youtube_last_jewels_user",
+    /** Session jewel gifters (list). Use as {{youtube_session_jewels_gifters}}. */
+    YOUTUBE_SESSION_JEWELS_GIFTERS = "youtube_session_jewels_gifters",
     /** Last subscriber. Use as {{youtube_last_subscriber}}. */
     YOUTUBE_LAST_SUBSCRIBER = "youtube_last_subscriber",
     /** Total uploaded videos. Use as {{youtube_total_video_count}}. */

package/dist/custom-overlays.d.ts

@@ -575,6 +575,10 @@ export declare enum LumiaAlertValues {
     YOUTUBE_SUPERSTICKER = "youtube-supersticker",
     /** YouTube session superstickers */
     YOUTUBE_SESSION_SUPERSTICKERS = "youtube-sessionSuperstickers",
+    /** YouTube gift event (jewel-based) */
+    YOUTUBE_GIFTS = "youtube-gifts",
+    /** YouTube session gifts */
+    YOUTUBE_SESSION_GIFTS = "youtube-sessionGifts",
     /** YouTube total likes */
     YOUTUBE_LIKE = "youtube-like",
     /** YouTube total views */
@@ -1210,6 +1214,16 @@ export declare enum SystemVariables {
     YOUTUBE_LAST_GIFT_MEMBER = "youtube_last_gift_member",
     /** Session gift members (list). Use as {{youtube_session_gift_members}}. */
     YOUTUBE_SESSION_GIFT_MEMBERS = "youtube_session_gift_members",
+    /** Lifetime jewels count. Use as {{youtube_total_jewels_count}}. */
+    YOUTUBE_TOTAL_JEWELS_COUNT = "youtube_total_jewels_count",
+    /** Session jewels count. Use as {{youtube_session_jewels_count}}. */
+    YOUTUBE_SESSION_JEWELS_COUNT = "youtube_session_jewels_count",
+    /** Last jewel amount. Use as {{youtube_last_jewels}}. */
+    YOUTUBE_LAST_JEWELS = "youtube_last_jewels",
+    /** Last user that sent jewels. Use as {{youtube_last_jewels_user}}. */
+    YOUTUBE_LAST_JEWELS_USER = "youtube_last_jewels_user",
+    /** Session jewel gifters (list). Use as {{youtube_session_jewels_gifters}}. */
+    YOUTUBE_SESSION_JEWELS_GIFTERS = "youtube_session_jewels_gifters",
     /** Last subscriber. Use as {{youtube_last_subscriber}}. */
     YOUTUBE_LAST_SUBSCRIBER = "youtube_last_subscriber",
     /** Total uploaded videos. Use as {{youtube_total_video_count}}. */

package/dist/event.types.d.ts

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

package/dist/eventlist.types.d.ts

@@ -116,6 +116,7 @@ export declare const LumiaMapAlertTypeToEventListType: {
     "youtube-subscriber": LumiaEventListTypes;
     "youtube-superchat": LumiaEventListTypes;
     "youtube-supersticker": LumiaEventListTypes;
+    "youtube-gifts": LumiaEventListTypes;
     "youtube-like": LumiaEventListTypes;
     "youtube-viewers": LumiaEventListTypes;
     "crowdcontrol-effect": LumiaEventListTypes;

package/dist/eventlist.types.js

@@ -121,6 +121,7 @@ exports.LumiaMapAlertTypeToEventListType = {
     [activity_types_1.LumiaAlertValues.YOUTUBE_SUBSCRIBER]: LumiaEventListTypes.FOLLOWER,
     [activity_types_1.LumiaAlertValues.YOUTUBE_SUPERCHAT]: LumiaEventListTypes.SUPERCHATS,
     [activity_types_1.LumiaAlertValues.YOUTUBE_SUPERSTICKER]: LumiaEventListTypes.SUPERSTICKERS,
+    [activity_types_1.LumiaAlertValues.YOUTUBE_GIFTS]: LumiaEventListTypes.GIFTS,
     [activity_types_1.LumiaAlertValues.YOUTUBE_LIKE]: LumiaEventListTypes.LIKES,
     [activity_types_1.LumiaAlertValues.YOUTUBE_VIEWERS]: LumiaEventListTypes.OTHERS,
     [activity_types_1.LumiaAlertValues.CROWDCONTROL_EFFECT]: LumiaEventListTypes.OTHERS,

package/dist/variables.types.d.ts

@@ -367,6 +367,16 @@ export declare enum SystemVariables {
     YOUTUBE_LAST_GIFT_MEMBER = "youtube_last_gift_member",
     /** Session gift members (list). Use as {{youtube_session_gift_members}}. */
     YOUTUBE_SESSION_GIFT_MEMBERS = "youtube_session_gift_members",
+    /** Lifetime jewels count. Use as {{youtube_total_jewels_count}}. */
+    YOUTUBE_TOTAL_JEWELS_COUNT = "youtube_total_jewels_count",
+    /** Session jewels count. Use as {{youtube_session_jewels_count}}. */
+    YOUTUBE_SESSION_JEWELS_COUNT = "youtube_session_jewels_count",
+    /** Last jewel amount. Use as {{youtube_last_jewels}}. */
+    YOUTUBE_LAST_JEWELS = "youtube_last_jewels",
+    /** Last user that sent jewels. Use as {{youtube_last_jewels_user}}. */
+    YOUTUBE_LAST_JEWELS_USER = "youtube_last_jewels_user",
+    /** Session jewel gifters (list). Use as {{youtube_session_jewels_gifters}}. */
+    YOUTUBE_SESSION_JEWELS_GIFTERS = "youtube_session_jewels_gifters",
     /** Last subscriber. Use as {{youtube_last_subscriber}}. */
     YOUTUBE_LAST_SUBSCRIBER = "youtube_last_subscriber",
     /** Total uploaded videos. Use as {{youtube_total_video_count}}. */
@@ -1039,6 +1049,8 @@ export declare const AllVariables: {
             sessionMembers: string[];
             giftMembers: string[];
             sessionGiftMembers: string[];
+            gifts: string[];
+            sessionGifts: string[];
             superchat: string[];
             sessionSuperchats: string[];
             supersticker: string[];

package/dist/variables.types.js

@@ -381,6 +381,16 @@ var SystemVariables;
     SystemVariables["YOUTUBE_LAST_GIFT_MEMBER"] = "youtube_last_gift_member";
     /** Session gift members (list). Use as {{youtube_session_gift_members}}. */
     SystemVariables["YOUTUBE_SESSION_GIFT_MEMBERS"] = "youtube_session_gift_members";
+    /** Lifetime jewels count. Use as {{youtube_total_jewels_count}}. */
+    SystemVariables["YOUTUBE_TOTAL_JEWELS_COUNT"] = "youtube_total_jewels_count";
+    /** Session jewels count. Use as {{youtube_session_jewels_count}}. */
+    SystemVariables["YOUTUBE_SESSION_JEWELS_COUNT"] = "youtube_session_jewels_count";
+    /** Last jewel amount. Use as {{youtube_last_jewels}}. */
+    SystemVariables["YOUTUBE_LAST_JEWELS"] = "youtube_last_jewels";
+    /** Last user that sent jewels. Use as {{youtube_last_jewels_user}}. */
+    SystemVariables["YOUTUBE_LAST_JEWELS_USER"] = "youtube_last_jewels_user";
+    /** Session jewel gifters (list). Use as {{youtube_session_jewels_gifters}}. */
+    SystemVariables["YOUTUBE_SESSION_JEWELS_GIFTERS"] = "youtube_session_jewels_gifters";
     /** Last subscriber. Use as {{youtube_last_subscriber}}. */
     SystemVariables["YOUTUBE_LAST_SUBSCRIBER"] = "youtube_last_subscriber";
     /** Total uploaded videos. Use as {{youtube_total_video_count}}. */
@@ -724,6 +734,7 @@ exports.ReservedVariables = [
     'value',
     'site',
     'originType',
+    'queueType',
     'command',
     'merch',
     'message',
@@ -942,6 +953,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'message',
                 'messageId',
@@ -967,6 +979,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'message',
                 'messageId',
@@ -988,6 +1001,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'prompt',
                 'message',
@@ -1005,6 +1019,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'prompt',
                 'message',
@@ -1022,6 +1037,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'prompt',
                 'message',
@@ -1032,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',
@@ -1045,6 +1061,7 @@ exports.AllVariables = {
                 'channelDescription',
                 'channelViews',
                 'originType',
+                'queueType',
                 'command',
                 'message',
                 'messageId',
@@ -2011,6 +2028,11 @@ exports.AllVariables = {
             'youtube_session_gift_members_count',
             'youtube_last_gift_member',
             'youtube_session_gift_members',
+            'youtube_total_jewels_count',
+            'youtube_session_jewels_count',
+            'youtube_last_jewels',
+            'youtube_last_jewels_user',
+            'youtube_session_jewels_gifters',
             'youtube_total_video_count',
             'youtube_total_view_count',
         ],
@@ -2040,6 +2062,22 @@ exports.AllVariables = {
                 'subPlanName',
             ],
             sessionGiftMembers: ['total', 'previousTotal'],
+            gifts: [
+                'username',
+                'displayname',
+                'avatar',
+                'userId',
+                'jewelsAmount',
+                'totalJewels',
+                'comboCount',
+                'giftName',
+                'giftUrl',
+                'hasVisualEffect',
+                'altText',
+                'language',
+                'message',
+            ],
+            sessionGifts: ['total', 'previousTotal'],
             superchat: ['username', 'displayname', 'currency', 'currencySymbol', 'amount', 'message'],
             sessionSuperchats: ['total', 'previousTotal', 'currency', 'currencySymbol'],
             supersticker: ['username', 'displayname', 'stickerId', 'stickerName', 'amount', 'currency', 'currencySymbol', 'imageUrl'],

package/package.json

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