@lumiastream/lumia-types 2.6.5 → 2.6.7

package/dist/activity.types.d.ts

@@ -153,6 +153,8 @@ export declare enum LumiaAlertValues {
     LUMIASTREAM_VIEWERQUEUE_STARTED = "lumiastream-viewerqueueStarted",
     /** Viewer queue ended */
     LUMIASTREAM_VIEWERQUEUE_ENDED = "lumiastream-viewerqueueEnded",
+    /** Viewer achievement unlocked */
+    LUMIASTREAM_VIEWER_ACHIEVEMENT = "lumiastream-viewerAchievement",
     /** Roulette winner selected */
     LUMIASTREAM_ROULETTE_WINNER = "lumiastream-rouletteWinner",
     /** Slots winner */
@@ -541,6 +543,7 @@ export declare const LumiaAlertFriendlyValues: {
     "lumiastream-pollEnded": string;
     "lumiastream-viewerqueueStarted": string;
     "lumiastream-viewerqueueEnded": string;
+    "lumiastream-viewerAchievement": string;
     "lumiastream-rouletteWinner": string;
     "lumiastream-slotsWinner": string;
     "twitch-extension": string;

package/dist/activity.types.js

@@ -168,6 +168,8 @@ var LumiaAlertValues;
     LumiaAlertValues["LUMIASTREAM_VIEWERQUEUE_STARTED"] = "lumiastream-viewerqueueStarted";
     /** Viewer queue ended */
     LumiaAlertValues["LUMIASTREAM_VIEWERQUEUE_ENDED"] = "lumiastream-viewerqueueEnded";
+    /** Viewer achievement unlocked */
+    LumiaAlertValues["LUMIASTREAM_VIEWER_ACHIEVEMENT"] = "lumiastream-viewerAchievement";
     /** Roulette winner selected */
     LumiaAlertValues["LUMIASTREAM_ROULETTE_WINNER"] = "lumiastream-rouletteWinner";
     /** Slots winner */
@@ -573,6 +575,7 @@ exports.LumiaAlertFriendlyValues = {
     [LumiaAlertValues.LUMIASTREAM_POLL_ENDED]: 'Poll Ended',
     [LumiaAlertValues.LUMIASTREAM_VIEWERQUEUE_STARTED]: 'Viewer Queue Started',
     [LumiaAlertValues.LUMIASTREAM_VIEWERQUEUE_ENDED]: 'Viewer Queue Ended',
+    [LumiaAlertValues.LUMIASTREAM_VIEWER_ACHIEVEMENT]: 'Viewer Achievement',
     [LumiaAlertValues.LUMIASTREAM_ROULETTE_WINNER]: 'Roulette Winner',
     [LumiaAlertValues.LUMIASTREAM_SLOTS_WINNER]: 'Slots Winner',
     [LumiaAlertValues.TWITCH_EXTENSION]: 'Twitch Extension',

package/dist/alert.types.js

@@ -5,6 +5,7 @@ const activity_types_1 = require("./activity.types");
 const event_types_1 = require("./event.types");
 const variables_types_1 = require("./variables.types");
 const youtube_superstickers_1 = require("./youtube_superstickers");
+const viewer_profile_achievements_1 = require("./viewer_profile_achievements");
 var LumiaVariationConditions;
 (function (LumiaVariationConditions) {
     LumiaVariationConditions["RANDOM"] = "RANDOM";
@@ -555,6 +556,24 @@ exports.LumiaAlertConfigs = {
         inputFields: [],
         LumiaVariationConditions: [{ type: LumiaVariationConditions.RANDOM }],
     },
+    [activity_types_1.LumiaAlertValues.LUMIASTREAM_VIEWER_ACHIEVEMENT]: {
+        connection: event_types_1.LumiaIntegrations.LUMIASTREAM,
+        message: '{{username}} unlocked the {{achievement_name}} achievement!',
+        eventlistSpecialUsername: 'lumiastream',
+        eventlistMessage: 'Viewer Achievement',
+        eventlistDetailedMessage: '{{username}} unlocked the {{achievement_name}} achievement!',
+        acceptedVariables: variables_types_1.AllVariables.lumiastream.alerts.viewerAchievement,
+        quickActions: [],
+        inputFields: [],
+        LumiaVariationConditions: [
+            { type: LumiaVariationConditions.RANDOM },
+            {
+                type: LumiaVariationConditions.EQUAL_SELECTION,
+                description: 'Achievement Name',
+                selections: viewer_profile_achievements_1.VIEWER_PROFILE_ACHIEVEMENTS.map((achievement) => ({ label: achievement.label, value: achievement.label })),
+            },
+        ],
+    },
     [activity_types_1.LumiaAlertValues.LUMIASTREAM_ROULETTE_WINNER]: {
         connection: event_types_1.LumiaIntegrations.LUMIASTREAM,
         message: 'Congratulations {{username}}! The ball landed on {{ball_position}}. You win {{outcome_amount}} {{loyalty_currency_name}}! Well played! 🎉',

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

@@ -416,6 +416,8 @@ export declare enum LumiaAlertValues {
     LUMIASTREAM_VIEWERQUEUE_STARTED = "lumiastream-viewerqueueStarted",
     /** Viewer queue ended */
     LUMIASTREAM_VIEWERQUEUE_ENDED = "lumiastream-viewerqueueEnded",
+    /** Viewer achievement unlocked */
+    LUMIASTREAM_VIEWER_ACHIEVEMENT = "lumiastream-viewerAchievement",
     /** Roulette winner selected */
     LUMIASTREAM_ROULETTE_WINNER = "lumiastream-rouletteWinner",
     /** Slots winner */
@@ -959,6 +961,18 @@ export declare enum SystemVariables {
     VIEWERQUEUE_ENTRIES_COUNT = "viewerqueue_entries_count",
     /** Viewer queue max entries limit. Use as {{viewerqueue_queue_limit}}. */
     VIEWERQUEUE_QUEUE_LIMIT = "viewerqueue_queue_limit",
+    /** Achievement id. Use as {{achievement_id}}. */
+    ACHIEVEMENT_ID = "achievement_id",
+    /** Achievement name. Use as {{achievement_name}}. */
+    ACHIEVEMENT_NAME = "achievement_name",
+    /** Achievement description. Use as {{achievement_description}}. */
+    ACHIEVEMENT_DESCRIPTION = "achievement_description",
+    /** Achievements completed count. Use as {{achievements_completed}}. */
+    ACHIEVEMENTS_COMPLETED = "achievements_completed",
+    /** Achievements total count. Use as {{achievements_total}}. */
+    ACHIEVEMENTS_TOTAL = "achievements_total",
+    /** Achievement completion percent. Use as {{achievements_percent}}. */
+    ACHIEVEMENTS_PERCENT = "achievements_percent",
     /** Response from most recent API Action (JSON stringified). Use as {{api_action_global_response}}. */
     API_ACTION_GLOBAL_RESPONSE = "api_action_global_response",
     /** Last RANDOM_INPUT selection. Use as {{last_random_input}}. */

package/dist/custom-overlays.d.ts

@@ -416,6 +416,8 @@ export declare enum LumiaAlertValues {
     LUMIASTREAM_VIEWERQUEUE_STARTED = "lumiastream-viewerqueueStarted",
     /** Viewer queue ended */
     LUMIASTREAM_VIEWERQUEUE_ENDED = "lumiastream-viewerqueueEnded",
+    /** Viewer achievement unlocked */
+    LUMIASTREAM_VIEWER_ACHIEVEMENT = "lumiastream-viewerAchievement",
     /** Roulette winner selected */
     LUMIASTREAM_ROULETTE_WINNER = "lumiastream-rouletteWinner",
     /** Slots winner */
@@ -959,6 +961,18 @@ export declare enum SystemVariables {
     VIEWERQUEUE_ENTRIES_COUNT = "viewerqueue_entries_count",
     /** Viewer queue max entries limit. Use as {{viewerqueue_queue_limit}}. */
     VIEWERQUEUE_QUEUE_LIMIT = "viewerqueue_queue_limit",
+    /** Achievement id. Use as {{achievement_id}}. */
+    ACHIEVEMENT_ID = "achievement_id",
+    /** Achievement name. Use as {{achievement_name}}. */
+    ACHIEVEMENT_NAME = "achievement_name",
+    /** Achievement description. Use as {{achievement_description}}. */
+    ACHIEVEMENT_DESCRIPTION = "achievement_description",
+    /** Achievements completed count. Use as {{achievements_completed}}. */
+    ACHIEVEMENTS_COMPLETED = "achievements_completed",
+    /** Achievements total count. Use as {{achievements_total}}. */
+    ACHIEVEMENTS_TOTAL = "achievements_total",
+    /** Achievement completion percent. Use as {{achievements_percent}}. */
+    ACHIEVEMENTS_PERCENT = "achievements_percent",
     /** Response from most recent API Action (JSON stringified). Use as {{api_action_global_response}}. */
     API_ACTION_GLOBAL_RESPONSE = "api_action_global_response",
     /** Last RANDOM_INPUT selection. Use as {{last_random_input}}. */

package/dist/index.d.ts

@@ -4,3 +4,4 @@ export { ILumiaSendPack, ILumiaEvent, ILumiaEventChatCommandBody, ILumiaEventCha
 export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType } from './eventlist.types';
 export { SystemVariables, ReservedVariables, AllVariables } from './variables.types';
 export { formatCondition } from './helpers';
+export { VIEWER_PROFILE_ACHIEVEMENTS, type ViewerProfileAchievementDefinition, type ViewerProfileAchievementMetric } from './viewer_profile_achievements';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatCondition = exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = exports.LumiaEventTypes = exports.LumiaIntegrations = exports.LumiaAlertConfigs = exports.VariationCurrencySymbol = exports.LumiaVariationCurrency = exports.LumiaVariationConditions = exports.LumiaActivityTestType = exports.LumiaActivityNoValueTypes = exports.LumiaActivityApiValueType = exports.LumiaActivityOriginTypes = exports.LumiaAlertFriendlyValues = exports.LumiaAlertValues = exports.LumiaExternalActivityCommandTypes = exports.LumiaActivityCommandTypes = exports.LumiaStreamingSites = void 0;
+exports.VIEWER_PROFILE_ACHIEVEMENTS = exports.formatCondition = exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = exports.LumiaEventTypes = exports.LumiaIntegrations = exports.LumiaAlertConfigs = exports.VariationCurrencySymbol = exports.LumiaVariationCurrency = exports.LumiaVariationConditions = exports.LumiaActivityTestType = exports.LumiaActivityNoValueTypes = exports.LumiaActivityApiValueType = exports.LumiaActivityOriginTypes = exports.LumiaAlertFriendlyValues = exports.LumiaAlertValues = exports.LumiaExternalActivityCommandTypes = exports.LumiaActivityCommandTypes = exports.LumiaStreamingSites = void 0;
 var activity_types_1 = require("./activity.types");
 Object.defineProperty(exports, "LumiaStreamingSites", { enumerable: true, get: function () { return activity_types_1.LumiaStreamingSites; } });
 Object.defineProperty(exports, "LumiaActivityCommandTypes", { enumerable: true, get: function () { return activity_types_1.LumiaActivityCommandTypes; } });
@@ -28,3 +28,5 @@ Object.defineProperty(exports, "ReservedVariables", { enumerable: true, get: fun
 Object.defineProperty(exports, "AllVariables", { enumerable: true, get: function () { return variables_types_1.AllVariables; } });
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "formatCondition", { enumerable: true, get: function () { return helpers_1.formatCondition; } });
+var viewer_profile_achievements_1 = require("./viewer_profile_achievements");
+Object.defineProperty(exports, "VIEWER_PROFILE_ACHIEVEMENTS", { enumerable: true, get: function () { return viewer_profile_achievements_1.VIEWER_PROFILE_ACHIEVEMENTS; } });

package/dist/variables.types.d.ts

@@ -159,6 +159,18 @@ export declare enum SystemVariables {
     VIEWERQUEUE_ENTRIES_COUNT = "viewerqueue_entries_count",
     /** Viewer queue max entries limit. Use as {{viewerqueue_queue_limit}}. */
     VIEWERQUEUE_QUEUE_LIMIT = "viewerqueue_queue_limit",
+    /** Achievement id. Use as {{achievement_id}}. */
+    ACHIEVEMENT_ID = "achievement_id",
+    /** Achievement name. Use as {{achievement_name}}. */
+    ACHIEVEMENT_NAME = "achievement_name",
+    /** Achievement description. Use as {{achievement_description}}. */
+    ACHIEVEMENT_DESCRIPTION = "achievement_description",
+    /** Achievements completed count. Use as {{achievements_completed}}. */
+    ACHIEVEMENTS_COMPLETED = "achievements_completed",
+    /** Achievements total count. Use as {{achievements_total}}. */
+    ACHIEVEMENTS_TOTAL = "achievements_total",
+    /** Achievement completion percent. Use as {{achievements_percent}}. */
+    ACHIEVEMENTS_PERCENT = "achievements_percent",
     /** Response from most recent API Action (JSON stringified). Use as {{api_action_global_response}}. */
     API_ACTION_GLOBAL_RESPONSE = "api_action_global_response",
     /** Last RANDOM_INPUT selection. Use as {{last_random_input}}. */
@@ -687,6 +699,7 @@ export declare const AllVariables: {
             pollEnded: string[];
             viewerqueueStarted: string[];
             viewerqueueEnded: string[];
+            viewerAchievement: string[];
             rouletteWinner: string[];
             slotsWinner: string[];
         };

package/dist/variables.types.js

@@ -171,6 +171,18 @@ var SystemVariables;
     SystemVariables["VIEWERQUEUE_ENTRIES_COUNT"] = "viewerqueue_entries_count";
     /** Viewer queue max entries limit. Use as {{viewerqueue_queue_limit}}. */
     SystemVariables["VIEWERQUEUE_QUEUE_LIMIT"] = "viewerqueue_queue_limit";
+    /** Achievement id. Use as {{achievement_id}}. */
+    SystemVariables["ACHIEVEMENT_ID"] = "achievement_id";
+    /** Achievement name. Use as {{achievement_name}}. */
+    SystemVariables["ACHIEVEMENT_NAME"] = "achievement_name";
+    /** Achievement description. Use as {{achievement_description}}. */
+    SystemVariables["ACHIEVEMENT_DESCRIPTION"] = "achievement_description";
+    /** Achievements completed count. Use as {{achievements_completed}}. */
+    SystemVariables["ACHIEVEMENTS_COMPLETED"] = "achievements_completed";
+    /** Achievements total count. Use as {{achievements_total}}. */
+    SystemVariables["ACHIEVEMENTS_TOTAL"] = "achievements_total";
+    /** Achievement completion percent. Use as {{achievements_percent}}. */
+    SystemVariables["ACHIEVEMENTS_PERCENT"] = "achievements_percent";
     /** Response from most recent API Action (JSON stringified). Use as {{api_action_global_response}}. */
     SystemVariables["API_ACTION_GLOBAL_RESPONSE"] = "api_action_global_response";
     /** Last RANDOM_INPUT selection. Use as {{last_random_input}}. */
@@ -900,6 +912,7 @@ exports.AllVariables = {
                 'emotesRaw',
                 'timestamp',
                 'points_cost',
+                'voice_command_full_sentence',
             ],
             chatbotCommand: [
                 'username',
@@ -1310,6 +1323,18 @@ exports.AllVariables = {
             pollEnded: ['poll_id', 'poll_title', 'poll_choices', 'poll_winning_title', 'poll_winning_id', 'poll_winning_votes', 'poll_total_votes'],
             viewerqueueStarted: ['viewerqueue_title', 'viewerqueue_entry_command', 'viewerqueue_entries', 'viewerqueue_players', 'viewerqueue_entries_count'],
             viewerqueueEnded: ['viewerqueue_title', 'viewerqueue_entry_command', 'viewerqueue_entries', 'viewerqueue_players', 'viewerqueue_entries_count'],
+            viewerAchievement: [
+                'username',
+                'displayname',
+                'avatar',
+                'platform',
+                'achievement_id',
+                'achievement_name',
+                'achievement_description',
+                'achievements_completed',
+                'achievements_total',
+                'achievements_percent',
+            ],
             rouletteWinner: ['username', 'outcome_amount', 'ball_position'],
             slotsWinner: ['username', 'outcome_amount', 'slots_combo'],
         },

package/dist/viewer_profile_achievements.d.ts

@@ -0,0 +1,9 @@
+export type ViewerProfileAchievementMetric = 'totalCommands' | 'uniqueCommands' | 'totalChatbotCommands' | 'totalPointsCommands' | 'totalPointsSpent' | 'totalTwitchExtensionsCommands' | 'totalBitsSpent' | 'totalKicksSpent' | 'totalMoneySpent' | 'totalAlerts' | 'uniqueAlerts' | 'totalCommandsAndAlerts' | 'daysActive' | 'platforms';
+export type ViewerProfileAchievementDefinition = {
+    id: string;
+    label: string;
+    description: string;
+    metric: ViewerProfileAchievementMetric;
+    threshold: number;
+};
+export declare const VIEWER_PROFILE_ACHIEVEMENTS: ViewerProfileAchievementDefinition[];

package/dist/viewer_profile_achievements.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VIEWER_PROFILE_ACHIEVEMENTS = void 0;
+exports.VIEWER_PROFILE_ACHIEVEMENTS = [
+    {
+        id: 'first-command',
+        label: 'First Command',
+        description: 'Triggered a command.',
+        metric: 'totalCommands',
+        threshold: 1,
+    },
+    {
+        id: 'command-explorer',
+        label: 'Command Explorer',
+        description: 'Triggered 10 unique commands.',
+        metric: 'uniqueCommands',
+        threshold: 10,
+    },
+    {
+        id: 'command-variety-pack',
+        label: 'Command Variety Pack',
+        description: 'Triggered 40 unique commands.',
+        metric: 'uniqueCommands',
+        threshold: 40,
+    },
+    {
+        id: 'command-regular',
+        label: 'Command Regular',
+        description: 'Triggered 25 commands.',
+        metric: 'totalCommands',
+        threshold: 25,
+    },
+    {
+        id: 'command-master',
+        label: 'Command Master',
+        description: 'Triggered 100 commands.',
+        metric: 'totalCommands',
+        threshold: 100,
+    },
+    {
+        id: 'command-addict',
+        label: 'Command Addict',
+        description: 'Triggered 250 commands.',
+        metric: 'totalCommands',
+        threshold: 250,
+    },
+    {
+        id: 'chatbot-whisperer',
+        label: 'Chatbot Whisperer',
+        description: 'Triggered 25 chatbot commands.',
+        metric: 'totalChatbotCommands',
+        threshold: 25,
+    },
+    {
+        id: 'points-spender',
+        label: 'Points Spender',
+        description: 'Triggered 50 Twitch or Kick points commands.',
+        metric: 'totalPointsCommands',
+        threshold: 50,
+    },
+    {
+        id: 'points-grinder',
+        label: 'Points Grinder',
+        description: 'Spent 5,000 points.',
+        metric: 'totalPointsSpent',
+        threshold: 5000,
+    },
+    {
+        id: 'points-mogul',
+        label: 'Points Mogul',
+        description: 'Spent 25,000 points.',
+        metric: 'totalPointsSpent',
+        threshold: 25000,
+    },
+    {
+        id: 'extension-explorer',
+        label: 'Extension Explorer',
+        description: 'Triggered 15 Twitch extensions commands.',
+        metric: 'totalTwitchExtensionsCommands',
+        threshold: 15,
+    },
+    {
+        id: 'bits-backer',
+        label: 'Bits Backer',
+        description: 'Spent 1,000 bits.',
+        metric: 'totalBitsSpent',
+        threshold: 1000,
+    },
+    {
+        id: 'bits-tycoon',
+        label: 'Bits Tycoon',
+        description: 'Spent 10,000 bits.',
+        metric: 'totalBitsSpent',
+        threshold: 10000,
+    },
+    {
+        id: 'kicks-supporter',
+        label: 'Kicks Supporter',
+        description: 'Spent 250 kicks.',
+        metric: 'totalKicksSpent',
+        threshold: 250,
+    },
+    {
+        id: 'kicks-patron',
+        label: 'Kicks Patron',
+        description: 'Spent 1,000 kicks.',
+        metric: 'totalKicksSpent',
+        threshold: 1000,
+    },
+    {
+        id: 'donation-supporter',
+        label: 'Donation Supporter',
+        description: 'Donated 250 in your default currency.',
+        metric: 'totalMoneySpent',
+        threshold: 250,
+    },
+    {
+        id: 'donation-patron',
+        label: 'Donation Patron',
+        description: 'Donated 1,000 in your default currency.',
+        metric: 'totalMoneySpent',
+        threshold: 1000,
+    },
+    {
+        id: 'alert-trigger',
+        label: 'Alert Trigger',
+        description: 'Triggered an alert.',
+        metric: 'totalAlerts',
+        threshold: 1,
+    },
+    {
+        id: 'alert-curator',
+        label: 'Alert Curator',
+        description: 'Triggered 10 unique alerts.',
+        metric: 'uniqueAlerts',
+        threshold: 10,
+    },
+    {
+        id: 'alert-storm',
+        label: 'Alert Storm',
+        description: 'Triggered 10 alerts.',
+        metric: 'totalAlerts',
+        threshold: 10,
+    },
+    {
+        id: 'power-user',
+        label: 'Power User',
+        description: 'Triggered 500 commands or alerts combined.',
+        metric: 'totalCommandsAndAlerts',
+        threshold: 500,
+    },
+    {
+        id: 'loyal-regular',
+        label: 'Loyal Regular',
+        description: 'Active across 60 days or more.',
+        metric: 'daysActive',
+        threshold: 60,
+    },
+    {
+        id: 'multi-platform',
+        label: 'Multi-Platform',
+        description: 'Seen on multiple platforms.',
+        metric: 'platforms',
+        threshold: 2,
+    },
+];

package/package.json

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