@lumiastream/lumia-types 3.4.3 → 3.4.5
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.
- package/dist/alert.types.js +1 -1
- package/dist/custom-code/helper-functions.md +1 -2
- package/dist/esm/alert.types.js +1 -1
- package/dist/esm/eventlist.types.js +32 -0
- package/dist/esm/index.js +1 -1
- package/dist/eventlist.types.d.ts +2 -0
- package/dist/eventlist.types.js +34 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3 -1
- package/package.json +1 -1
package/dist/alert.types.js
CHANGED
|
@@ -2792,7 +2792,7 @@ exports.LumiaAlertConfigs = {
|
|
|
2792
2792
|
],
|
|
2793
2793
|
},
|
|
2794
2794
|
[activity_types_1.LumiaAlertValues.TWITCH_CHARITY_DONATION]: {
|
|
2795
|
-
connection: event_types_1.LumiaIntegrations.
|
|
2795
|
+
connection: event_types_1.LumiaIntegrations.TWITCH,
|
|
2796
2796
|
message: '{{username}} just tipped {{amount}} to charity {{charity_name}}',
|
|
2797
2797
|
eventlistMessage: 'Donation',
|
|
2798
2798
|
eventlistDetailedMessage: 'tipped {{amount}} {{currency}}',
|
|
@@ -236,7 +236,7 @@ async function() {
|
|
|
236
236
|
The valid alert keys are:
|
|
237
237
|
|
|
238
238
|
```
|
|
239
|
-
lumia-redemption, twitch-streamLive, twitch-streamOffline, twitch-follower, twitch-subscriber, twitch-giftSubscription, twitch-host, twitch-raid, twitch-bits, twitch-redemption, twitch-hypetrainStarted, twitch-hypetrainProgressed, twitch-hypetrainLevelProgressed, twitch-hypetrainEnded, twitch-pollStarted, twitch-pollProgressed, twitch-pollEnded, twitch-predictionStarted, twitch-predictionProgressed, twitch-predictionLocked, twitch-predictionEnded, twitch-goalStarted, twitch-goalProgressed, twitch-goalEnded, twitch-categoryChanged, twitch-clip, youtube-member, youtube-subscriber, youtube-superchat, youtube-supersticker, facebook-follower, facebook-reaction, facebook-star, facebook-support, facebook-subscriptionGift, facebook-share, facebook-fan, tiktok-follower, tiktok-like, tiktok-gift, tiktok-
|
|
239
|
+
lumia-redemption, twitch-streamLive, twitch-streamOffline, twitch-follower, twitch-subscriber, twitch-giftSubscription, twitch-host, twitch-raid, twitch-bits, twitch-redemption, twitch-hypetrainStarted, twitch-hypetrainProgressed, twitch-hypetrainLevelProgressed, twitch-hypetrainEnded, twitch-pollStarted, twitch-pollProgressed, twitch-pollEnded, twitch-predictionStarted, twitch-predictionProgressed, twitch-predictionLocked, twitch-predictionEnded, twitch-goalStarted, twitch-goalProgressed, twitch-goalEnded, twitch-categoryChanged, twitch-clip, youtube-member, youtube-subscriber, youtube-superchat, youtube-supersticker, facebook-follower, facebook-reaction, facebook-star, facebook-support, facebook-subscriptionGift, facebook-share, facebook-fan, tiktok-follower, tiktok-like, tiktok-gift, tiktok-share, tiktok-streamEnd, streamlabs-donation, streamlabs-charity, streamlabs-merch, streamlabs-redemption, streamlabs-primegift, streamelements-donation, extralife-donation, donordrive-donation, tiltify-campaignDonation, tipeeestream-donation, treatstream-treat, patreon-pledge, obs-switchProfile, obs-switchScene, obs-sceneItemVisibility, obs-sceneItemHidden, obs-switchTransition, obs-transitionBegin, obs-transitionEnd, obs-streamStarting, obs-streamStopping, obs-recordingStarting, obs-recordingStopping, slobs-switchSceneCollection, slobs-switchScene, slobs-sceneItemVisibility, slobs-sceneItemHidden, spotify-switchSong, spotify-songPlayed, spotify-songPaused, vlc-switchSong, vlc-songPlayed, vlc-songPaused, pulse-heartrate, pulse-calories, twitter-follower, twitter-like, twitter-retweet, woocommerce-order, kofi-donation, kofi-subscription, kofi-commission, kofi-shopOrder, streamerbot-action
|
|
240
240
|
```
|
|
241
241
|
|
|
242
242
|
```js
|
|
@@ -279,7 +279,6 @@ async function() {
|
|
|
279
279
|
}
|
|
280
280
|
```
|
|
281
281
|
|
|
282
|
-
|
|
283
282
|
### Read File
|
|
284
283
|
|
|
285
284
|
`readFile(path: string)`: Read from a file on your local computer to get the contents of it to be displayed in your code. This is useful for other Apps that write and read to files so you can combine the usage of them in Lumia. To keep things consistent, try to use an absolute file path
|
package/dist/esm/alert.types.js
CHANGED
|
@@ -2789,7 +2789,7 @@ export const LumiaAlertConfigs = {
|
|
|
2789
2789
|
],
|
|
2790
2790
|
},
|
|
2791
2791
|
[LumiaAlertValues.TWITCH_CHARITY_DONATION]: {
|
|
2792
|
-
connection: LumiaIntegrations.
|
|
2792
|
+
connection: LumiaIntegrations.TWITCH,
|
|
2793
2793
|
message: '{{username}} just tipped {{amount}} to charity {{charity_name}}',
|
|
2794
2794
|
eventlistMessage: 'Donation',
|
|
2795
2795
|
eventlistDetailedMessage: 'tipped {{amount}} {{currency}}',
|
|
@@ -346,3 +346,35 @@ export const AlertsToFilter = [
|
|
|
346
346
|
* LumiaStream `Integrations.types.ts` before being consolidated here.
|
|
347
347
|
*/
|
|
348
348
|
export const PlatformsToFilter = ['obs', 'slobs', 'meld', 'paypal', 'pulsoid', 'hyperate', 'spotify', 'youtubemusic', 'nowplaying', 'vlc', 'streamerbot', 'vtubestudio'];
|
|
349
|
+
export const LumiaEventListTypeColors = {
|
|
350
|
+
[LumiaEventListTypes.FOLLOWER]: '#22c55e',
|
|
351
|
+
[LumiaEventListTypes.SUBSCRIBERS]: '#a855f7',
|
|
352
|
+
[LumiaEventListTypes.GIFTS]: '#ec4899',
|
|
353
|
+
[LumiaEventListTypes.DONATION]: '#10b981',
|
|
354
|
+
[LumiaEventListTypes.CHARITY]: '#f97316',
|
|
355
|
+
[LumiaEventListTypes.BITS]: '#facc15',
|
|
356
|
+
[LumiaEventListTypes.KICKS]: '#84cc16',
|
|
357
|
+
[LumiaEventListTypes.POINTS]: '#3b82f6',
|
|
358
|
+
[LumiaEventListTypes.REDEMPTION]: '#06b6d4',
|
|
359
|
+
[LumiaEventListTypes.EXTENSION]: '#8b5cf6',
|
|
360
|
+
[LumiaEventListTypes.RAIDS]: '#ef4444',
|
|
361
|
+
[LumiaEventListTypes.HOSTS]: '#f43f5e',
|
|
362
|
+
[LumiaEventListTypes.HYPETRAIN]: '#fb7185',
|
|
363
|
+
[LumiaEventListTypes.SPELLS]: '#7c3aed',
|
|
364
|
+
[LumiaEventListTypes.RETWEETS]: '#0ea5e9',
|
|
365
|
+
[LumiaEventListTypes.LIKES]: '#f472b6',
|
|
366
|
+
[LumiaEventListTypes.SHARES]: '#14b8a6',
|
|
367
|
+
[LumiaEventListTypes.PURCHASES]: '#eab308',
|
|
368
|
+
[LumiaEventListTypes.SUPERSTICKERS]: '#fb923c',
|
|
369
|
+
[LumiaEventListTypes.SUPERCHATS]: '#f59e0b',
|
|
370
|
+
[LumiaEventListTypes.STARS]: '#fde047',
|
|
371
|
+
[LumiaEventListTypes.FANS]: '#d946ef',
|
|
372
|
+
[LumiaEventListTypes.RAFFLE]: '#34d399',
|
|
373
|
+
};
|
|
374
|
+
const DEFAULT_EVENTLIST_COLOR = '#9ca3af';
|
|
375
|
+
export const getEventListCategoryColor = (category) => {
|
|
376
|
+
var _a;
|
|
377
|
+
if (!category)
|
|
378
|
+
return DEFAULT_EVENTLIST_COLOR;
|
|
379
|
+
return (_a = LumiaEventListTypeColors[category]) !== null && _a !== void 0 ? _a : DEFAULT_EVENTLIST_COLOR;
|
|
380
|
+
};
|
package/dist/esm/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export { LumiaStreamingSites, LumiaActivityCommandTypes, LumiaExternalActivityCommandTypes, LumiaAlertValues, LumiaAlertFriendlyValues, LumiaActivityOriginTypes, LumiaActivityApiValueType, LumiaActivityNoValueTypes, LumiaActivityTestType, } from './activity.types.js';
|
|
2
2
|
export { LumiaVariationConditions, LumiaVariationCurrency, VariationCurrencySymbol, LumiaRedemptionCurrency, LumiaRedemptionCurrencySymbol, LumiaAlertConfigs, } from './alert.types.js';
|
|
3
3
|
export { LumiaIntegrations, LumiaEventTypes, } from './event.types.js';
|
|
4
|
-
export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType, AlertsToFilter, PlatformsToFilter } from './eventlist.types.js';
|
|
4
|
+
export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType, AlertsToFilter, PlatformsToFilter, LumiaEventListTypeColors, getEventListCategoryColor } from './eventlist.types.js';
|
|
5
5
|
export { SystemVariables, ReservedVariables, AllVariables, getAcceptedVariableName, getAcceptedVariableNames, } from './variables.types.js';
|
|
6
6
|
export { formatCondition } from './helpers.js';
|
|
7
7
|
export { KickKicksData } from './kick_kicks.js';
|
|
@@ -102,3 +102,5 @@ export declare const AlertsToFilter: LumiaAlertValues[];
|
|
|
102
102
|
* LumiaStream `Integrations.types.ts` before being consolidated here.
|
|
103
103
|
*/
|
|
104
104
|
export declare const PlatformsToFilter: string[];
|
|
105
|
+
export declare const LumiaEventListTypeColors: Record<LumiaEventListTypes, string>;
|
|
106
|
+
export declare const getEventListCategoryColor: (category: LumiaEventListTypes | undefined | null) => string;
|
package/dist/eventlist.types.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.PlatformsToFilter = exports.AlertsToFilter = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = void 0;
|
|
3
|
+
exports.getEventListCategoryColor = exports.LumiaEventListTypeColors = exports.PlatformsToFilter = exports.AlertsToFilter = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = void 0;
|
|
4
4
|
const activity_types_1 = require("./activity.types");
|
|
5
5
|
/**
|
|
6
6
|
* Eventlist categories. The eventlist module uses these as a *blacklist* via
|
|
@@ -349,3 +349,36 @@ exports.AlertsToFilter = [
|
|
|
349
349
|
* LumiaStream `Integrations.types.ts` before being consolidated here.
|
|
350
350
|
*/
|
|
351
351
|
exports.PlatformsToFilter = ['obs', 'slobs', 'meld', 'paypal', 'pulsoid', 'hyperate', 'spotify', 'youtubemusic', 'nowplaying', 'vlc', 'streamerbot', 'vtubestudio'];
|
|
352
|
+
exports.LumiaEventListTypeColors = {
|
|
353
|
+
[LumiaEventListTypes.FOLLOWER]: '#22c55e',
|
|
354
|
+
[LumiaEventListTypes.SUBSCRIBERS]: '#a855f7',
|
|
355
|
+
[LumiaEventListTypes.GIFTS]: '#ec4899',
|
|
356
|
+
[LumiaEventListTypes.DONATION]: '#10b981',
|
|
357
|
+
[LumiaEventListTypes.CHARITY]: '#f97316',
|
|
358
|
+
[LumiaEventListTypes.BITS]: '#facc15',
|
|
359
|
+
[LumiaEventListTypes.KICKS]: '#84cc16',
|
|
360
|
+
[LumiaEventListTypes.POINTS]: '#3b82f6',
|
|
361
|
+
[LumiaEventListTypes.REDEMPTION]: '#06b6d4',
|
|
362
|
+
[LumiaEventListTypes.EXTENSION]: '#8b5cf6',
|
|
363
|
+
[LumiaEventListTypes.RAIDS]: '#ef4444',
|
|
364
|
+
[LumiaEventListTypes.HOSTS]: '#f43f5e',
|
|
365
|
+
[LumiaEventListTypes.HYPETRAIN]: '#fb7185',
|
|
366
|
+
[LumiaEventListTypes.SPELLS]: '#7c3aed',
|
|
367
|
+
[LumiaEventListTypes.RETWEETS]: '#0ea5e9',
|
|
368
|
+
[LumiaEventListTypes.LIKES]: '#f472b6',
|
|
369
|
+
[LumiaEventListTypes.SHARES]: '#14b8a6',
|
|
370
|
+
[LumiaEventListTypes.PURCHASES]: '#eab308',
|
|
371
|
+
[LumiaEventListTypes.SUPERSTICKERS]: '#fb923c',
|
|
372
|
+
[LumiaEventListTypes.SUPERCHATS]: '#f59e0b',
|
|
373
|
+
[LumiaEventListTypes.STARS]: '#fde047',
|
|
374
|
+
[LumiaEventListTypes.FANS]: '#d946ef',
|
|
375
|
+
[LumiaEventListTypes.RAFFLE]: '#34d399',
|
|
376
|
+
};
|
|
377
|
+
const DEFAULT_EVENTLIST_COLOR = '#9ca3af';
|
|
378
|
+
const getEventListCategoryColor = (category) => {
|
|
379
|
+
var _a;
|
|
380
|
+
if (!category)
|
|
381
|
+
return DEFAULT_EVENTLIST_COLOR;
|
|
382
|
+
return (_a = exports.LumiaEventListTypeColors[category]) !== null && _a !== void 0 ? _a : DEFAULT_EVENTLIST_COLOR;
|
|
383
|
+
};
|
|
384
|
+
exports.getEventListCategoryColor = getEventListCategoryColor;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export { LumiaStreamingSites, LumiaActivityCommandTypes, LumiaExternalActivityCommandTypes, LumiaAlertValues, LumiaAlertFriendlyValues, LumiaActivityOriginTypes, LumiaActivityApiValueType, LumiaActivityNoValueTypes, LumiaActivityTestType, } from './activity.types';
|
|
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
|
-
export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType, AlertsToFilter, PlatformsToFilter } from './eventlist.types';
|
|
4
|
+
export { LumiaEventListTypes, LumiaMapAlertTypeToEventListType, AlertsToFilter, PlatformsToFilter, LumiaEventListTypeColors, getEventListCategoryColor } from './eventlist.types';
|
|
5
5
|
export { SystemVariables, ReservedVariables, AllVariables, getAcceptedVariableName, getAcceptedVariableNames, type LumiaAcceptedVariable, type LumiaAcceptedVariableDefinition, } from './variables.types';
|
|
6
6
|
export { formatCondition } from './helpers';
|
|
7
7
|
export { KickKicksData } from './kick_kicks';
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SongRequestPlaybackTarget = exports.SongRequestProvider = exports.SongRequestSource = exports.SongRequestStatus = exports.VIEWER_PROFILE_ACHIEVEMENTS = exports.YoutubeSuperstickersData = exports.TiktokGiftsData = exports.KickKicksData = exports.formatCondition = exports.getAcceptedVariableNames = exports.getAcceptedVariableName = exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.PlatformsToFilter = exports.AlertsToFilter = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = exports.LumiaEventTypes = exports.LumiaIntegrations = exports.LumiaAlertConfigs = exports.LumiaRedemptionCurrencySymbol = exports.LumiaRedemptionCurrency = 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;
|
|
3
|
+
exports.SongRequestPlaybackTarget = exports.SongRequestProvider = exports.SongRequestSource = exports.SongRequestStatus = exports.VIEWER_PROFILE_ACHIEVEMENTS = exports.YoutubeSuperstickersData = exports.TiktokGiftsData = exports.KickKicksData = exports.formatCondition = exports.getAcceptedVariableNames = exports.getAcceptedVariableName = exports.AllVariables = exports.ReservedVariables = exports.SystemVariables = exports.getEventListCategoryColor = exports.LumiaEventListTypeColors = exports.PlatformsToFilter = exports.AlertsToFilter = exports.LumiaMapAlertTypeToEventListType = exports.LumiaEventListTypes = exports.LumiaEventTypes = exports.LumiaIntegrations = exports.LumiaAlertConfigs = exports.LumiaRedemptionCurrencySymbol = exports.LumiaRedemptionCurrency = 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;
|
|
4
4
|
var activity_types_1 = require("./activity.types");
|
|
5
5
|
Object.defineProperty(exports, "LumiaStreamingSites", { enumerable: true, get: function () { return activity_types_1.LumiaStreamingSites; } });
|
|
6
6
|
Object.defineProperty(exports, "LumiaActivityCommandTypes", { enumerable: true, get: function () { return activity_types_1.LumiaActivityCommandTypes; } });
|
|
@@ -26,6 +26,8 @@ Object.defineProperty(exports, "LumiaEventListTypes", { enumerable: true, get: f
|
|
|
26
26
|
Object.defineProperty(exports, "LumiaMapAlertTypeToEventListType", { enumerable: true, get: function () { return eventlist_types_1.LumiaMapAlertTypeToEventListType; } });
|
|
27
27
|
Object.defineProperty(exports, "AlertsToFilter", { enumerable: true, get: function () { return eventlist_types_1.AlertsToFilter; } });
|
|
28
28
|
Object.defineProperty(exports, "PlatformsToFilter", { enumerable: true, get: function () { return eventlist_types_1.PlatformsToFilter; } });
|
|
29
|
+
Object.defineProperty(exports, "LumiaEventListTypeColors", { enumerable: true, get: function () { return eventlist_types_1.LumiaEventListTypeColors; } });
|
|
30
|
+
Object.defineProperty(exports, "getEventListCategoryColor", { enumerable: true, get: function () { return eventlist_types_1.getEventListCategoryColor; } });
|
|
29
31
|
var variables_types_1 = require("./variables.types");
|
|
30
32
|
Object.defineProperty(exports, "SystemVariables", { enumerable: true, get: function () { return variables_types_1.SystemVariables; } });
|
|
31
33
|
Object.defineProperty(exports, "ReservedVariables", { enumerable: true, get: function () { return variables_types_1.ReservedVariables; } });
|