@lumiastream/lumia-types 3.7.4 → 3.7.6
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/index.d.ts +1 -1
- package/dist/songrequest.types.d.ts +0 -26
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -10,5 +10,5 @@ export { BLANK_OVERLAY_TEMPLATE_ID, type OverlayTemplate, type OverlayTemplateLa
|
|
|
10
10
|
export { TiktokGiftsData, TiktokGiftImageSelections } from './tiktok_gifts';
|
|
11
11
|
export { YoutubeSuperstickersData, YoutubeSuperstickerImageSelections } from './youtube_superstickers';
|
|
12
12
|
export { VIEWER_PROFILE_ACHIEVEMENTS, type ViewerProfileAchievementColor, type ViewerProfileAchievementDefinition, type ViewerProfileAchievementMetric, type ViewerProfileCollectionMode, type ViewerProfileCollectionRule, type ViewerProfileCollectionSettings, type ViewerProfileCollectionSource, } from './viewer_profile_achievements';
|
|
13
|
-
export { SongRequestStatus, SongRequestSource, SongRequestProvider, SongRequestPlaybackTarget, type SongRequestItem, type SongRequestConfig, type SongRequestState, type SongRequestQueueUpdatePayload, type
|
|
13
|
+
export { SongRequestStatus, SongRequestSource, SongRequestProvider, SongRequestPlaybackTarget, type SongRequestItem, type SongRequestConfig, type SongRequestState, type SongRequestQueueUpdatePayload, type SongRequestNowPlayingPayload, type SongRequestAddParams, } from './songrequest.types';
|
|
14
14
|
export type { IAlertEvent, AlertPlatform, AlertEventUnion, AlertEventInputMap, SessionAggregateDynamic, SessionAggregateExtraSettings, TwitchFollowerDynamic, TwitchFollowerExtraSettings, TwitchSubscriberDynamic, TwitchSubscriberExtraSettings, TwitchGiftSubscriptionRecipient, TwitchGiftSubscriptionDynamic, TwitchGiftSubscriptionExtraSettings, TwitchBitsDynamic, TwitchBitsExtraSettings, TwitchBitsComboDynamic, TwitchBitsComboExtraSettings, TwitchRaidDynamic, TwitchRaidExtraSettings, TwitchRaidOutDynamic, TwitchRaidOutExtraSettings, TwitchChannelJoinDynamic, TwitchChannelJoinExtraSettings, TwitchChannelLeaveDynamic, TwitchChannelLeaveExtraSettings, TwitchFirstChatterDynamic, TwitchFirstChatterExtraSettings, TwitchEntranceDynamic, TwitchEntranceExtraSettings, TwitchTimeoutDynamic, TwitchTimeoutExtraSettings, TwitchTimeoutOverDynamic, TwitchTimeoutOverExtraSettings, TwitchBannedDynamic, TwitchBannedExtraSettings, TwitchClipDynamic, TwitchClipExtraSettings, TwitchCategoryDynamic, TwitchCategoryExtraSettings, TwitchHypeTrainInfo, TwitchHypeTrainDynamic, TwitchHypeTrainExtraSettings, TwitchHypeTrainStartedDynamic, TwitchHypeTrainStartedExtraSettings, TwitchHypeTrainProgressedDynamic, TwitchHypeTrainProgressedExtraSettings, TwitchHypeTrainLevelProgressedDynamic, TwitchHypeTrainLevelProgressedExtraSettings, TwitchHypeTrainEndedDynamic, TwitchHypeTrainEndedExtraSettings, TwitchPollChoice, TwitchPollInfo, TwitchPollDynamic, TwitchPollExtraSettings, TwitchPollStartedDynamic, TwitchPollStartedExtraSettings, TwitchPollProgressedDynamic, TwitchPollProgressedExtraSettings, TwitchPollEndedDynamic, TwitchPollEndedExtraSettings, TwitchPredictionOutcome, TwitchPredictionInfo, TwitchPredictionDynamic, TwitchPredictionExtraSettings, TwitchPredictionStartedDynamic, TwitchPredictionStartedExtraSettings, TwitchPredictionProgressedDynamic, TwitchPredictionProgressedExtraSettings, TwitchPredictionLockedDynamic, TwitchPredictionLockedExtraSettings, TwitchPredictionEndedDynamic, TwitchPredictionEndedExtraSettings, TwitchGoalInfo, TwitchGoalDynamic, TwitchGoalExtraSettings, TwitchGoalStartedDynamic, TwitchGoalStartedExtraSettings, TwitchGoalProgressedDynamic, TwitchGoalProgressedExtraSettings, TwitchGoalEndedDynamic, TwitchGoalEndedExtraSettings, TwitchCharityDonationDynamic, TwitchCharityDonationExtraSettings, TwitchCharityCampaignDynamic, TwitchCharityCampaignExtraSettings, TwitchCharityCampaignStartedDynamic, TwitchCharityCampaignStartedExtraSettings, TwitchCharityCampaignProgressedDynamic, TwitchCharityCampaignProgressedExtraSettings, TwitchCharityCampaignStoppedDynamic, TwitchCharityCampaignStoppedExtraSettings, TwitchShoutoutReceiveDynamic, TwitchShoutoutReceiveExtraSettings, TwitchAdDynamic, TwitchAdStartedExtraSettings, TwitchAdStoppedExtraSettings, TwitchStreamLiveDynamic, TwitchStreamLiveExtraSettings, TwitchStreamOfflineDynamic, TwitchStreamOfflineExtraSettings, TwitchWatchStreakDynamic, TwitchWatchStreakExtraSettings, TwitchPowerupsDynamic, TwitchPowerupsExtraSettings, TwitchRedemptionDynamic, TwitchRedemptionExtraSettings, TwitchSessionFollowersDynamic, TwitchSessionFollowersExtraSettings, TwitchSessionSubsDynamic, TwitchSessionSubsExtraSettings, TwitchSessionGiftSubscriptionsDynamic, TwitchSessionGiftSubscriptionsExtraSettings, TwitchSessionBitsDynamic, TwitchSessionBitsExtraSettings, KickFollowerDynamic, KickFollowerExtraSettings, KickSubscriberDynamic, KickSubscriberExtraSettings, KickGiftSubscriptionRecipient, KickGiftSubscriptionDynamic, KickGiftSubscriptionExtraSettings, KickKicksDynamic, KickKicksExtraSettings, KickHostDynamic, KickHostExtraSettings, KickBannedDynamic, KickBannedExtraSettings, KickUnbannedDynamic, KickUnbannedExtraSettings, KickFirstChatterDynamic, KickFirstChatterExtraSettings, KickEntranceDynamic, KickEntranceExtraSettings, KickSessionFollowersDynamic, KickSessionFollowersExtraSettings, KickSessionSubsDynamic, KickSessionSubsExtraSettings, KickSessionGiftSubscriptionsDynamic, KickSessionGiftSubscriptionsExtraSettings, KickSessionKicksDynamic, KickSessionKicksExtraSettings, } from './wire.types';
|
|
@@ -85,14 +85,7 @@ export interface SongRequestItem {
|
|
|
85
85
|
* duplicate it here.
|
|
86
86
|
*/
|
|
87
87
|
export interface SongRequestConfig {
|
|
88
|
-
enabled: boolean;
|
|
89
|
-
/** Trigger word for the system chatbot command. Default: `!sr`. */
|
|
90
|
-
triggerCommand: string;
|
|
91
|
-
cooldownPerUserSeconds: number;
|
|
92
|
-
cooldownGlobalSeconds: number;
|
|
93
88
|
maxRequestsPerUserInSession: number;
|
|
94
|
-
/** When true, requests land in `pending` until a mod / streamer approves. */
|
|
95
|
-
approvalRequired: boolean;
|
|
96
89
|
maxQueueSize: number;
|
|
97
90
|
maxSongDurationSeconds: number;
|
|
98
91
|
allowYouTubeUrls: boolean;
|
|
@@ -101,18 +94,13 @@ export interface SongRequestConfig {
|
|
|
101
94
|
/** Required for free-text → YouTube Data API v3 search. */
|
|
102
95
|
youtubeApiKey?: string;
|
|
103
96
|
preferredPlaybackTarget: SongRequestPlaybackTarget;
|
|
104
|
-
announceInChat: boolean;
|
|
105
|
-
chatTemplateAdded: string;
|
|
106
97
|
chatTemplateNowPlaying: string;
|
|
107
|
-
chatTemplateDenied: string;
|
|
108
98
|
/** Used for dedup / cooldown / queue-full / disallowed-source rejections. */
|
|
109
99
|
chatTemplateRejected: string;
|
|
110
100
|
}
|
|
111
101
|
/** Runtime queue state. Lives in the LumiaStream Redux slice; the dashboard
|
|
112
102
|
* widgets and the overlay module consume slices of this shape. */
|
|
113
103
|
export interface SongRequestState {
|
|
114
|
-
/** Awaiting moderator approval (empty when `approvalRequired: false`). */
|
|
115
|
-
pending: SongRequestItem[];
|
|
116
104
|
/** Approved, waiting to play. Index 0 plays next. */
|
|
117
105
|
queue: SongRequestItem[];
|
|
118
106
|
/** Currently playing item, if any. */
|
|
@@ -125,10 +113,6 @@ export interface SongRequestQueueUpdatePayload {
|
|
|
125
113
|
queue: SongRequestItem[];
|
|
126
114
|
nowPlaying: SongRequestItem | null;
|
|
127
115
|
}
|
|
128
|
-
/** Fired whenever the pending tray changes (drives the moderation widget). */
|
|
129
|
-
export interface SongRequestPendingUpdatePayload {
|
|
130
|
-
pending: SongRequestItem[];
|
|
131
|
-
}
|
|
132
116
|
/** Lighter-weight ping when only nowPlaying changed (e.g., natural advance). */
|
|
133
117
|
export interface SongRequestNowPlayingPayload {
|
|
134
118
|
nowPlaying: SongRequestItem | null;
|
|
@@ -140,14 +124,4 @@ export interface SongRequestAddParams {
|
|
|
140
124
|
requesterPlatform?: LumiaStreamingSites;
|
|
141
125
|
/** Defaults to `LUMIA_ACTION` when omitted (matches the action call site). */
|
|
142
126
|
source?: SongRequestSource;
|
|
143
|
-
/**
|
|
144
|
-
* Streamer / mod additions can skip the pending state. Chat-command
|
|
145
|
-
* additions ignore this flag — chat is always subject to `approvalRequired`.
|
|
146
|
-
*/
|
|
147
|
-
forceApprove?: boolean;
|
|
148
|
-
}
|
|
149
|
-
export interface SongRequestModerationParams {
|
|
150
|
-
id: string;
|
|
151
|
-
/** Optional reason for deny actions (surfaced in chat / mod log). */
|
|
152
|
-
reason?: string;
|
|
153
127
|
}
|