@lumiastream/lumia-types 3.6.0-beta.2 → 3.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/custom-overlays/custom-overlays.d.ts +16 -6
  2. package/dist/custom-overlays.d.ts +16 -6
  3. package/dist/esm/variables.types.js +16 -6
  4. package/dist/index.d.ts +1 -1
  5. package/dist/variables.types.d.ts +24 -6
  6. package/dist/variables.types.js +16 -6
  7. package/package.json +1 -1
package/dist/custom-overlays/custom-overlays.d.ts CHANGED
@@ -1154,6 +1154,10 @@ export declare enum SystemVariables {
1154
1154
  AI_PROMPT = "ai_prompt",
1155
1155
  /** Current weather for a location via wttr.in. Returns a one-line summary like */
1156
1156
  WEATHER = "weather",
1157
+ /** Save a value to local storage (persists across restarts, kept out of the variables list) and return it. Example: {{save_local=highscore,100}}. Use as {{save_local}}. */
1158
+ SAVE_LOCAL = "save_local",
1159
+ /** Load a value saved with save_local; optional fallback when the key is unset. Example: {{load_local=highscore}} or {{load_local=highscore,0}}. Use as {{load_local}}. */
1160
+ LOAD_LOCAL = "load_local",
1157
1161
  /** Commands URL/page. Use in overlays as {{commands_url}}. */
1158
1162
  COMMANDS_URL = "commands_url",
1159
1163
  /** Session start time (ISO). Use as {{session_start_date}}. */
@@ -1303,12 +1307,16 @@ export declare enum SystemVariables {
1303
1307
  LAST_SUBSCRIBER = "last_subscriber",
1304
1308
  /** All-time top gifter (any platform). Use as {{alltime_top_gifter}}. */
1305
1309
  ALLTIME_TOP_GIFTER = "alltime_top_gifter",
1306
- /** Bits/cheers count this session. Use as {{session_bits_count}}. */
1307
- SESSION_BITS_COUNT = "session_bits_count",
1308
- /** Bits/cheers count this week. Use as {{week_bits_count}}. */
1309
- WEEK_BITS_COUNT = "week_bits_count",
1310
- /** Bits/cheers count this month. Use as {{month_bits_count}}. */
1311
- MONTH_BITS_COUNT = "month_bits_count",
1310
+ /** Most recent gifter (any platform), { name, amount }. Use as {{last_gifter}} / {{last_gifter.amount}}. */
1311
+ LAST_GIFTER = "last_gifter",
1312
+ /** Most recent gift recipient (any platform). Use as {{last_gifted}}. */
1313
+ LAST_GIFTED = "last_gifted",
1314
+ /** Cheers (bits/kicks) this session across all platforms. Use as {{session_cheers_count}}. */
1315
+ SESSION_CHEERS_COUNT = "session_cheers_count",
1316
+ /** Cheers this week across all platforms. Use as {{week_cheers_count}}. */
1317
+ WEEK_CHEERS_COUNT = "week_cheers_count",
1318
+ /** Cheers this month across all platforms. Use as {{month_cheers_count}}. */
1319
+ MONTH_CHEERS_COUNT = "month_cheers_count",
1312
1320
  /** Top cheerer (by total bits) this session. Use as {{session_top_cheerer}}. */
1313
1321
  SESSION_TOP_CHEERER = "session_top_cheerer",
1314
1322
  /** Amount for SESSION_TOP_CHEERER. Use as {{session_top_cheerer_amount}}. */
@@ -1329,6 +1337,8 @@ export declare enum SystemVariables {
1329
1337
  SESSION_TOP_CHEER = "session_top_cheer",
1330
1338
  /** Amount for SESSION_TOP_CHEER. Use as {{session_top_cheer_amount}}. */
1331
1339
  SESSION_TOP_CHEER_AMOUNT = "session_top_cheer_amount",
1340
+ /** Most recent cheer (bits/kicks, any platform), { name, amount }. Use as {{last_cheer}} / {{last_cheer.amount}}. */
1341
+ LAST_CHEER = "last_cheer",
1332
1342
  /** Most recent raider/host (any platform). Use as {{last_raider}}. */
1333
1343
  LAST_RAIDER = "last_raider",
1334
1344
  /** Viewer count for LAST_RAIDER. Use as {{last_raid_amount}}. */
package/dist/custom-overlays.d.ts CHANGED
@@ -1154,6 +1154,10 @@ export declare enum SystemVariables {
1154
1154
  AI_PROMPT = "ai_prompt",
1155
1155
  /** Current weather for a location via wttr.in. Returns a one-line summary like */
1156
1156
  WEATHER = "weather",
1157
+ /** Save a value to local storage (persists across restarts, kept out of the variables list) and return it. Example: {{save_local=highscore,100}}. Use as {{save_local}}. */
1158
+ SAVE_LOCAL = "save_local",
1159
+ /** Load a value saved with save_local; optional fallback when the key is unset. Example: {{load_local=highscore}} or {{load_local=highscore,0}}. Use as {{load_local}}. */
1160
+ LOAD_LOCAL = "load_local",
1157
1161
  /** Commands URL/page. Use in overlays as {{commands_url}}. */
1158
1162
  COMMANDS_URL = "commands_url",
1159
1163
  /** Session start time (ISO). Use as {{session_start_date}}. */
@@ -1303,12 +1307,16 @@ export declare enum SystemVariables {
1303
1307
  LAST_SUBSCRIBER = "last_subscriber",
1304
1308
  /** All-time top gifter (any platform). Use as {{alltime_top_gifter}}. */
1305
1309
  ALLTIME_TOP_GIFTER = "alltime_top_gifter",
1306
- /** Bits/cheers count this session. Use as {{session_bits_count}}. */
1307
- SESSION_BITS_COUNT = "session_bits_count",
1308
- /** Bits/cheers count this week. Use as {{week_bits_count}}. */
1309
- WEEK_BITS_COUNT = "week_bits_count",
1310
- /** Bits/cheers count this month. Use as {{month_bits_count}}. */
1311
- MONTH_BITS_COUNT = "month_bits_count",
1310
+ /** Most recent gifter (any platform), { name, amount }. Use as {{last_gifter}} / {{last_gifter.amount}}. */
1311
+ LAST_GIFTER = "last_gifter",
1312
+ /** Most recent gift recipient (any platform). Use as {{last_gifted}}. */
1313
+ LAST_GIFTED = "last_gifted",
1314
+ /** Cheers (bits/kicks) this session across all platforms. Use as {{session_cheers_count}}. */
1315
+ SESSION_CHEERS_COUNT = "session_cheers_count",
1316
+ /** Cheers this week across all platforms. Use as {{week_cheers_count}}. */
1317
+ WEEK_CHEERS_COUNT = "week_cheers_count",
1318
+ /** Cheers this month across all platforms. Use as {{month_cheers_count}}. */
1319
+ MONTH_CHEERS_COUNT = "month_cheers_count",
1312
1320
  /** Top cheerer (by total bits) this session. Use as {{session_top_cheerer}}. */
1313
1321
  SESSION_TOP_CHEERER = "session_top_cheerer",
1314
1322
  /** Amount for SESSION_TOP_CHEERER. Use as {{session_top_cheerer_amount}}. */
@@ -1329,6 +1337,8 @@ export declare enum SystemVariables {
1329
1337
  SESSION_TOP_CHEER = "session_top_cheer",
1330
1338
  /** Amount for SESSION_TOP_CHEER. Use as {{session_top_cheer_amount}}. */
1331
1339
  SESSION_TOP_CHEER_AMOUNT = "session_top_cheer_amount",
1340
+ /** Most recent cheer (bits/kicks, any platform), { name, amount }. Use as {{last_cheer}} / {{last_cheer.amount}}. */
1341
+ LAST_CHEER = "last_cheer",
1332
1342
  /** Most recent raider/host (any platform). Use as {{last_raider}}. */
1333
1343
  LAST_RAIDER = "last_raider",
1334
1344
  /** Viewer count for LAST_RAIDER. Use as {{last_raid_amount}}. */
package/dist/esm/variables.types.js CHANGED
@@ -75,6 +75,10 @@ export var SystemVariables;
75
75
  SystemVariables["AI_PROMPT"] = "ai_prompt";
76
76
  /** Current weather for a location via wttr.in. Returns a one-line summary like */
77
77
  SystemVariables["WEATHER"] = "weather";
78
+ /** Save a value to local storage (persists across restarts, kept out of the variables list) and return it. Example: {{save_local=highscore,100}}. Use as {{save_local}}. */
79
+ SystemVariables["SAVE_LOCAL"] = "save_local";
80
+ /** Load a value saved with save_local; optional fallback when the key is unset. Example: {{load_local=highscore}} or {{load_local=highscore,0}}. Use as {{load_local}}. */
81
+ SystemVariables["LOAD_LOCAL"] = "load_local";
78
82
  // ─────────────────────────────────── General Variables ───────────────────────
79
83
  /** Commands URL/page. Use in overlays as {{commands_url}}. */
80
84
  SystemVariables["COMMANDS_URL"] = "commands_url";
@@ -233,12 +237,16 @@ export var SystemVariables;
233
237
  SystemVariables["LAST_SUBSCRIBER"] = "last_subscriber";
234
238
  /** All-time top gifter (any platform). Use as {{alltime_top_gifter}}. */
235
239
  SystemVariables["ALLTIME_TOP_GIFTER"] = "alltime_top_gifter";
236
- /** Bits/cheers count this session. Use as {{session_bits_count}}. */
237
- SystemVariables["SESSION_BITS_COUNT"] = "session_bits_count";
238
- /** Bits/cheers count this week. Use as {{week_bits_count}}. */
239
- SystemVariables["WEEK_BITS_COUNT"] = "week_bits_count";
240
- /** Bits/cheers count this month. Use as {{month_bits_count}}. */
241
- SystemVariables["MONTH_BITS_COUNT"] = "month_bits_count";
240
+ /** Most recent gifter (any platform), { name, amount }. Use as {{last_gifter}} / {{last_gifter.amount}}. */
241
+ SystemVariables["LAST_GIFTER"] = "last_gifter";
242
+ /** Most recent gift recipient (any platform). Use as {{last_gifted}}. */
243
+ SystemVariables["LAST_GIFTED"] = "last_gifted";
244
+ /** Cheers (bits/kicks) this session across all platforms. Use as {{session_cheers_count}}. */
245
+ SystemVariables["SESSION_CHEERS_COUNT"] = "session_cheers_count";
246
+ /** Cheers this week across all platforms. Use as {{week_cheers_count}}. */
247
+ SystemVariables["WEEK_CHEERS_COUNT"] = "week_cheers_count";
248
+ /** Cheers this month across all platforms. Use as {{month_cheers_count}}. */
249
+ SystemVariables["MONTH_CHEERS_COUNT"] = "month_cheers_count";
242
250
  /** Top cheerer (by total bits) this session. Use as {{session_top_cheerer}}. */
243
251
  SystemVariables["SESSION_TOP_CHEERER"] = "session_top_cheerer";
244
252
  /** Amount for SESSION_TOP_CHEERER. Use as {{session_top_cheerer_amount}}. */
@@ -259,6 +267,8 @@ export var SystemVariables;
259
267
  SystemVariables["SESSION_TOP_CHEER"] = "session_top_cheer";
260
268
  /** Amount for SESSION_TOP_CHEER. Use as {{session_top_cheer_amount}}. */
261
269
  SystemVariables["SESSION_TOP_CHEER_AMOUNT"] = "session_top_cheer_amount";
270
+ /** Most recent cheer (bits/kicks, any platform), { name, amount }. Use as {{last_cheer}} / {{last_cheer.amount}}. */
271
+ SystemVariables["LAST_CHEER"] = "last_cheer";
262
272
  /** Most recent raider/host (any platform). Use as {{last_raider}}. */
263
273
  SystemVariables["LAST_RAIDER"] = "last_raider";
264
274
  /** Viewer count for LAST_RAIDER. Use as {{last_raid_amount}}. */
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@ export { LumiaStreamingSites, LumiaActivityCommandTypes, LumiaExternalActivityCo
2
2
  export { LumiaVariationConditions, LumiaVariationCurrency, VariationCurrencySymbol, LumiaRedemptionCurrency, LumiaRedemptionCurrencySymbol, LumiaAlertConfigs, LumiaDynamicCondition, type LumiaSelectionOption, } from './alert.types';
3
3
  export { ILumiaSendPack, ILumiaEvent, ILumiaEventChatCommandBody, ILumiaEventChatBody, ILumiaEventAlertBody, ILumiaEventStateBody, ILumiaLight, LumiaIntegrations, LumiaEventTypes, } from './event.types';
4
4
  export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType, AlertsToFilter, PlatformsToFilter, LumiaEventListTypeColors, getEventListCategoryColor } from './eventlist.types';
5
- export { SystemVariables, ReservedVariables, AllVariables, getAcceptedVariableName, getAcceptedVariableNames, type LumiaAcceptedVariable, type LumiaAcceptedVariableDefinition, } from './variables.types';
5
+ export { SystemVariables, ReservedVariables, AllVariables, getAcceptedVariableName, getAcceptedVariableNames, type LumiaAcceptedVariable, type LumiaAcceptedVariableDefinition, type CountableVariableValue, type DonatorVariableValue, } from './variables.types';
6
6
  export { formatCondition } from './helpers';
7
7
  export { EMULATE_EXAMPLE_AVATAR_URL, getExampleAlertVariableValue, buildExampleAlertVariables, coerceNumericAlertFields, aliasContentImageFromLegacy, isRedundantInputField, syncLinkedVariableFields, type InputFieldLike, } from './emulate.helpers';
8
8
  export { KickKicksData } from './kick_kicks';
package/dist/variables.types.d.ts CHANGED
@@ -7,6 +7,14 @@ export interface LumiaAcceptedVariableDefinition {
7
7
  export type LumiaAcceptedVariable = string | LumiaAcceptedVariableDefinition;
8
8
  export declare const getAcceptedVariableName: (entry: LumiaAcceptedVariable) => string;
9
9
  export declare const getAcceptedVariableNames: (entries: LumiaAcceptedVariable[]) => string[];
10
+ export type CountableVariableValue = {
11
+ name: string;
12
+ amount: number;
13
+ };
14
+ export type DonatorVariableValue = CountableVariableValue & {
15
+ currency: string;
16
+ currencySymbol: string;
17
+ };
10
18
  export declare enum SystemVariables {
11
19
  /** Read from a local file. Example: {{read_file=C:\path\file.txt}}. Use in overlays as {{read_file}}. */
12
20
  READ_FILE = "read_file",
@@ -78,6 +86,10 @@ export declare enum SystemVariables {
78
86
  AI_PROMPT = "ai_prompt",
79
87
  /** Current weather for a location via wttr.in. Returns a one-line summary like */
80
88
  WEATHER = "weather",
89
+ /** Save a value to local storage (persists across restarts, kept out of the variables list) and return it. Example: {{save_local=highscore,100}}. Use as {{save_local}}. */
90
+ SAVE_LOCAL = "save_local",
91
+ /** Load a value saved with save_local; optional fallback when the key is unset. Example: {{load_local=highscore}} or {{load_local=highscore,0}}. Use as {{load_local}}. */
92
+ LOAD_LOCAL = "load_local",
81
93
  /** Commands URL/page. Use in overlays as {{commands_url}}. */
82
94
  COMMANDS_URL = "commands_url",
83
95
  /** Session start time (ISO). Use as {{session_start_date}}. */
@@ -227,12 +239,16 @@ export declare enum SystemVariables {
227
239
  LAST_SUBSCRIBER = "last_subscriber",
228
240
  /** All-time top gifter (any platform). Use as {{alltime_top_gifter}}. */
229
241
  ALLTIME_TOP_GIFTER = "alltime_top_gifter",
230
- /** Bits/cheers count this session. Use as {{session_bits_count}}. */
231
- SESSION_BITS_COUNT = "session_bits_count",
232
- /** Bits/cheers count this week. Use as {{week_bits_count}}. */
233
- WEEK_BITS_COUNT = "week_bits_count",
234
- /** Bits/cheers count this month. Use as {{month_bits_count}}. */
235
- MONTH_BITS_COUNT = "month_bits_count",
242
+ /** Most recent gifter (any platform), { name, amount }. Use as {{last_gifter}} / {{last_gifter.amount}}. */
243
+ LAST_GIFTER = "last_gifter",
244
+ /** Most recent gift recipient (any platform). Use as {{last_gifted}}. */
245
+ LAST_GIFTED = "last_gifted",
246
+ /** Cheers (bits/kicks) this session across all platforms. Use as {{session_cheers_count}}. */
247
+ SESSION_CHEERS_COUNT = "session_cheers_count",
248
+ /** Cheers this week across all platforms. Use as {{week_cheers_count}}. */
249
+ WEEK_CHEERS_COUNT = "week_cheers_count",
250
+ /** Cheers this month across all platforms. Use as {{month_cheers_count}}. */
251
+ MONTH_CHEERS_COUNT = "month_cheers_count",
236
252
  /** Top cheerer (by total bits) this session. Use as {{session_top_cheerer}}. */
237
253
  SESSION_TOP_CHEERER = "session_top_cheerer",
238
254
  /** Amount for SESSION_TOP_CHEERER. Use as {{session_top_cheerer_amount}}. */
@@ -253,6 +269,8 @@ export declare enum SystemVariables {
253
269
  SESSION_TOP_CHEER = "session_top_cheer",
254
270
  /** Amount for SESSION_TOP_CHEER. Use as {{session_top_cheer_amount}}. */
255
271
  SESSION_TOP_CHEER_AMOUNT = "session_top_cheer_amount",
272
+ /** Most recent cheer (bits/kicks, any platform), { name, amount }. Use as {{last_cheer}} / {{last_cheer.amount}}. */
273
+ LAST_CHEER = "last_cheer",
256
274
  /** Most recent raider/host (any platform). Use as {{last_raider}}. */
257
275
  LAST_RAIDER = "last_raider",
258
276
  /** Viewer count for LAST_RAIDER. Use as {{last_raid_amount}}. */
package/dist/variables.types.js CHANGED
@@ -80,6 +80,10 @@ var SystemVariables;
80
80
  SystemVariables["AI_PROMPT"] = "ai_prompt";
81
81
  /** Current weather for a location via wttr.in. Returns a one-line summary like */
82
82
  SystemVariables["WEATHER"] = "weather";
83
+ /** Save a value to local storage (persists across restarts, kept out of the variables list) and return it. Example: {{save_local=highscore,100}}. Use as {{save_local}}. */
84
+ SystemVariables["SAVE_LOCAL"] = "save_local";
85
+ /** Load a value saved with save_local; optional fallback when the key is unset. Example: {{load_local=highscore}} or {{load_local=highscore,0}}. Use as {{load_local}}. */
86
+ SystemVariables["LOAD_LOCAL"] = "load_local";
83
87
  // ─────────────────────────────────── General Variables ───────────────────────
84
88
  /** Commands URL/page. Use in overlays as {{commands_url}}. */
85
89
  SystemVariables["COMMANDS_URL"] = "commands_url";
@@ -238,12 +242,16 @@ var SystemVariables;
238
242
  SystemVariables["LAST_SUBSCRIBER"] = "last_subscriber";
239
243
  /** All-time top gifter (any platform). Use as {{alltime_top_gifter}}. */
240
244
  SystemVariables["ALLTIME_TOP_GIFTER"] = "alltime_top_gifter";
241
- /** Bits/cheers count this session. Use as {{session_bits_count}}. */
242
- SystemVariables["SESSION_BITS_COUNT"] = "session_bits_count";
243
- /** Bits/cheers count this week. Use as {{week_bits_count}}. */
244
- SystemVariables["WEEK_BITS_COUNT"] = "week_bits_count";
245
- /** Bits/cheers count this month. Use as {{month_bits_count}}. */
246
- SystemVariables["MONTH_BITS_COUNT"] = "month_bits_count";
245
+ /** Most recent gifter (any platform), { name, amount }. Use as {{last_gifter}} / {{last_gifter.amount}}. */
246
+ SystemVariables["LAST_GIFTER"] = "last_gifter";
247
+ /** Most recent gift recipient (any platform). Use as {{last_gifted}}. */
248
+ SystemVariables["LAST_GIFTED"] = "last_gifted";
249
+ /** Cheers (bits/kicks) this session across all platforms. Use as {{session_cheers_count}}. */
250
+ SystemVariables["SESSION_CHEERS_COUNT"] = "session_cheers_count";
251
+ /** Cheers this week across all platforms. Use as {{week_cheers_count}}. */
252
+ SystemVariables["WEEK_CHEERS_COUNT"] = "week_cheers_count";
253
+ /** Cheers this month across all platforms. Use as {{month_cheers_count}}. */
254
+ SystemVariables["MONTH_CHEERS_COUNT"] = "month_cheers_count";
247
255
  /** Top cheerer (by total bits) this session. Use as {{session_top_cheerer}}. */
248
256
  SystemVariables["SESSION_TOP_CHEERER"] = "session_top_cheerer";
249
257
  /** Amount for SESSION_TOP_CHEERER. Use as {{session_top_cheerer_amount}}. */
@@ -264,6 +272,8 @@ var SystemVariables;
264
272
  SystemVariables["SESSION_TOP_CHEER"] = "session_top_cheer";
265
273
  /** Amount for SESSION_TOP_CHEER. Use as {{session_top_cheer_amount}}. */
266
274
  SystemVariables["SESSION_TOP_CHEER_AMOUNT"] = "session_top_cheer_amount";
275
+ /** Most recent cheer (bits/kicks, any platform), { name, amount }. Use as {{last_cheer}} / {{last_cheer.amount}}. */
276
+ SystemVariables["LAST_CHEER"] = "last_cheer";
267
277
  /** Most recent raider/host (any platform). Use as {{last_raider}}. */
268
278
  SystemVariables["LAST_RAIDER"] = "last_raider";
269
279
  /** Viewer count for LAST_RAIDER. Use as {{last_raid_amount}}. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lumiastream/lumia-types",
3
- "version": "3.6.0-beta.2",
3
+ "version": "3.6.1",
4
4
  "description": "",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/esm/index.js",