@lumiastream/lumia-types 3.2.4 → 3.2.5

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

@@ -13,6 +13,32 @@ 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`.
+
+```js
+async function() {
+	const originType = await getVariable('originType');
+	const commandOrigins = ['chat', 'chatbot', 'twitch-points', 'twitch-extension', 'kick-points'];
+
+	if (originType === 'alert') {
+		chatbot({ message: 'This custom code was triggered by an alert.' });
+		done();
+		return;
+	}
+
+	if (commandOrigins.includes(originType)) {
+		chatbot({ message: `Command trigger detected from ${originType}.` });
+		done();
+		return;
+	}
+
+	log(`Skipping custom code for originType: ${originType}`);
+	done();
+}
+```
+
 - To quickly log out information for easier debugging, use `log("")`. You can also use `console.log` which will do the same thing. This will popup a toast message with what you are trying to log as well as add it to the logs in the dashboard
 
 - Everything ran is in a safe JavaScript worker thread away from the Lumia Stream thread so no need to worry about scripts slowing down the app. Make sure you do avoid memory leaks by calling `done()` when you're done with your script

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

@@ -8,6 +8,8 @@ import { LumiaAlertValues } from './custom-overlays';
 
 /** Known platforms (extendable). */
 type Platform = 'twitch' | 'youtube' | 'kick' | 'tiktok' | 'facebook' | string;
+/** Known Lumia activity origins (extendable). */
+type ActivityOrigin = 'system' | 'alert' | 'chat' | 'chatbot' | 'twitch-points' | 'twitch-extension' | 'kick-points' | 'api' | 'lumiastreamlink' | 'streamdeck' | 'touchportal' | 'avermedia' | 'loupedeck' | string;
 
 /** ISO-8601 timestamp branding for better editor hints. */
 type ISODateString = string & { __iso8601: true };
@@ -27,6 +29,8 @@ type Timing = { checkTimingType: false } | { checkTimingType: true; timingType:
 interface CommonExtras {
 	/** Origin site/platform for this alert (e.g., "twitch"). */
 	site: Platform;
+	/** Lumia queue/activity origin type (e.g., "alert", "chat", "chatbot", "system"). */
+	originType?: ActivityOrigin;
 	/** ISO-8601 timestamp when the alert originated. */
 	timestamp: ISODateString;
 

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

@@ -127,6 +127,8 @@ export interface AlertEvent {
 		timestamp: string;
 		/** Platform where the alert originated */
 		site: 'twitch' | 'kick' | 'youtube' | 'tiktok' | 'facebook' | string;
+		/** Lumia queue/activity origin type (e.g., "alert", "chat", "chatbot", "system") */
+		originType?: 'system' | 'alert' | 'chat' | 'chatbot' | 'twitch-points' | 'twitch-extension' | 'kick-points' | 'api' | 'lumiastreamlink' | 'streamdeck' | 'touchportal' | 'avermedia' | 'loupedeck' | string;
 		/** Whether timing type should be checked */
 		checkTimingType: boolean;
 		/** Type of timing for the alert */

package/dist/custom-overlays.d.ts

@@ -127,6 +127,8 @@ export interface AlertEvent {
 		timestamp: string;
 		/** Platform where the alert originated */
 		site: 'twitch' | 'kick' | 'youtube' | 'tiktok' | 'facebook' | string;
+		/** Lumia queue/activity origin type (e.g., "alert", "chat", "chatbot", "system") */
+		originType?: 'system' | 'alert' | 'chat' | 'chatbot' | 'twitch-points' | 'twitch-extension' | 'kick-points' | 'api' | 'lumiastreamlink' | 'streamdeck' | 'touchportal' | 'avermedia' | 'loupedeck' | string;
 		/** Whether timing type should be checked */
 		checkTimingType: boolean;
 		/** Type of timing for the alert */

package/dist/event.types.d.ts

@@ -1,4 +1,4 @@
-import { LumiaActivityCommandTypes } from './activity.types';
+import { LumiaActivityCommandTypes, LumiaActivityOriginTypes } from './activity.types';
 export interface ILumiaSendPack {
     type: LumiaActivityCommandTypes;
     params?: {
@@ -19,6 +19,7 @@ export interface ILumiaSendPack {
         extraSettings?: {
             username?: string;
             bits?: number;
+            originType?: LumiaActivityOriginTypes;
         };
     };
 }

package/dist/variables.types.js

@@ -723,6 +723,7 @@ exports.ReservedVariables = [
     'userId',
     'value',
     'site',
+    'originType',
     'command',
     'merch',
     'message',
@@ -940,6 +941,7 @@ exports.AllVariables = {
                 'userLevelsRaw',
                 'channelDescription',
                 'channelViews',
+                'originType',
                 'command',
                 'message',
                 'messageId',
@@ -964,6 +966,7 @@ exports.AllVariables = {
                 'userLevelsRaw',
                 'channelDescription',
                 'channelViews',
+                'originType',
                 'command',
                 'message',
                 'messageId',
@@ -984,6 +987,7 @@ exports.AllVariables = {
                 'avatar',
                 'channelDescription',
                 'channelViews',
+                'originType',
                 'command',
                 'prompt',
                 'message',
@@ -1000,6 +1004,7 @@ exports.AllVariables = {
                 'avatar',
                 'channelDescription',
                 'channelViews',
+                'originType',
                 'command',
                 'prompt',
                 'message',
@@ -1016,6 +1021,7 @@ exports.AllVariables = {
                 'avatar',
                 'channelDescription',
                 'channelViews',
+                'originType',
                 'command',
                 'prompt',
                 'message',
@@ -1038,6 +1044,7 @@ exports.AllVariables = {
                 'userLevelsRaw',
                 'channelDescription',
                 'channelViews',
+                'originType',
                 'command',
                 'message',
                 'messageId',

package/package.json

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