@tixyel/streamelements 7.3.1 → 7.5.0

package/dist/index.d.ts

@@ -1001,6 +1001,20 @@ declare namespace StreamElements {
             isEditorMode: boolean;
             muted: boolean;
         };
+        events: {
+            emit<L extends Event.Listener>(event: L, data: Event.EventData<L>['event']): {
+                ok: boolean;
+            };
+            emit<T extends Record<string, any>, E extends string>(event: E extends Event.Listener ? never : E, data: T): {
+                ok: boolean;
+            };
+            broadcast<L extends Event.Listener>(event: L, data: Event.EventData<L>['event']): {
+                ok: boolean;
+            };
+            broadcast<T extends Record<string, any>, E extends string>(event: E extends Event.Listener ? never : E, data: T): {
+                ok: boolean;
+            };
+        };
     };
     namespace Event {
         type onWidgetLoad = {
@@ -1104,6 +1118,17 @@ declare namespace StreamElements {
         type onEventReceived = (Provider.Twitch.Events | Provider.YouTube.Events | Provider.StreamElements.Events) & {
             emulated?: boolean;
         };
+        type Listener = onEventReceived['listener'];
+        type EventByListener = {
+            [L in Listener]: Extract<onEventReceived, {
+                listener: L;
+            }>['event'];
+        };
+        type EventData<L extends Listener = Listener> = {
+            listener: L;
+            event: EventByListener[L];
+            emulated?: boolean;
+        };
     }
     namespace Session {
         type Data = Tip & Host & Raid & Cheer & Merch & Purchase & Follower & Hypetrain & Superchat & Sponsor & Subscriber & CheerPurchase & ChannelPoints & CharityCampaignDonation;
@@ -3353,156 +3378,165 @@ declare namespace Helper {
     const utils: UtilsHelper;
 }
 
-declare namespace Local {
-    type QueueItem = {
-        listener: 'onEventReceived';
-        data: StreamElements.Event.onEventReceived;
-        session?: boolean;
-    } | {
-        listener: 'onWidgetLoad';
-        data: StreamElements.Event.onWidgetLoad;
-    } | {
-        listener: 'onSessionUpdate';
-        data: StreamElements.Event.onSessionUpdate;
-    };
-    const queue: useQueue<QueueItem>;
-    const generate: {
-        session: {
-            types: Record<string, StreamElements.Session.Config.Any>;
-            available(): StreamElements.Session.Config.Available.Data;
-            get(startSession?: StreamElements.Session.Data): Promise<StreamElements.Session.Data>;
-        };
-        event: {
-            /**
-             * Simulates the onWidgetLoad event for a widget.
-             * @param fields - The field values to be included in the event.
-             * @param session - The session data to be included in the event.
-             * @param currency - The currency to be used (default is 'USD').
-             * @returns A Promise that resolves to the simulated onWidgetLoad event data.
-             */
-            onWidgetLoad(fields: Record<string, StreamElements.CustomField.Value>, session: StreamElements.Session.Data, currency?: "BRL" | "USD" | "EUR"): Promise<StreamElements.Event.onWidgetLoad>;
-            /**
-             * Simulates the onSessionUpdate event for a widget.
-             * @param session - The session data to be included in the event.
-             * @returns A Promise that resolves to the simulated onSessionUpdate event data.
-             */
-            onSessionUpdate(session?: StreamElements.Session.Data, update?: ClientEvents$1): Promise<StreamElements.Event.onSessionUpdate>;
-            /**
-             * Simulates the onEventReceived event for a widget.
-             * @param provider - The provider of the event (default is 'random').
-             * @param type - The type of event to simulate (default is 'random').
-             * @param options - Additional options to customize the event data.
-             * @returns A Promise that resolves to the simulated onEventReceived event data, or null if the event type is not supported.
-             * @example
-             * ```javascript
-             * // Simulate a random event
-             * const randomEvent = await Local .generate.event.onEventReceived();
-             *
-             * // Simulate a Twitch message event with custom options
-             * const twitchMessageEvent = await Local .generate.event.onEventReceived('twitch', 'message', { name: 'Streamer', message: 'Hello World!' });
-             * ```
-             */
-            onEventReceived(provider?: Provider$1 | "random", type?: StreamElements.Event.onEventReceived["listener"] | "random" | "tip" | "cheer" | "follower" | "raid" | "subscriber", options?: Record<string, string | number | boolean>): Promise<StreamElements.Event.onEventReceived | null>;
-        };
-    };
-    const emulate: {
-        twitch: {
-            message(data?: Partial<{
-                name: string;
-                message: string;
-                badges: BadgeOptions;
-                color: string;
-                userId: string;
+declare class Emulator {
+    twitch: {
+        message(data?: Partial<{
+            name: string;
+            message: string;
+            badges: BadgeOptions;
+            color: string;
+            userId: string;
+            msgId: string;
+            channel: string;
+            time: number;
+            firstMsg: boolean;
+            returningChatter: boolean;
+            reply: {
                 msgId: string;
-                channel: string;
-                time: number;
-                firstMsg: boolean;
-                returningChatter: boolean;
-                reply: {
-                    msgId: string;
-                    userId: string;
-                    login: string;
-                    name: string;
-                    text: string;
-                };
-                thread: {
-                    msgId: string;
-                    name: string;
-                };
-            }>): void;
-            deleteMessage(msgId: string): void;
-            deleteMessages(userId: string): void;
-            follower(data?: Partial<{
-                avatar: string;
-                name: string;
-            }>): void;
-            raid(data?: Partial<{
-                amount: number;
-                avatar: string;
-                name: string;
-            }>): void;
-            cheer(data?: Partial<{
-                amount: number;
-                avatar: string;
-                name: string;
-                message: string;
-            }>): void;
-            subscriber(data?: Partial<{
-                tier: "1000" | "2000" | "3000" | "prime";
-                amount: number;
-                avatar: string;
-                name: string;
-                sender: string;
-                message: string;
-                subType: "default" | "gift" | "community" | "spam";
-            }> & {
-                subType?: "default" | "gift" | "community" | "spam";
-            }): void;
-        };
-        streamelements: {
-            tip(data?: Partial<{
-                amount: number;
-                avatar: string;
-                name: string;
-            }>): void;
-        };
-        youtube: {
-            message(data?: Partial<{
-                name: string;
-                message: string;
-                badges: BadgeOptions;
-                color: string;
                 userId: string;
-                msgId: string;
-                channel: string;
-                time: number;
-                avatar: string;
-            }>): void;
-            subscriber(data?: Partial<{
-                avatar: string;
+                login: string;
                 name: string;
-            }>): void;
-            superchat(data?: Partial<{
-                amount: number;
-                avatar: string;
-                name: string;
-            }>): void;
-            sponsor(data?: Partial<{
-                tier: "1000" | "2000" | "3000";
-                amount: number;
-                avatar: string;
+                text: string;
+            };
+            thread: {
+                msgId: string;
                 name: string;
-                sender: string;
-                message: string;
-                subType: "default" | "gift" | "community" | "spam";
-            }> & {
-                subType?: "default" | "gift" | "community" | "spam";
-            }): void;
-        };
-        kick: {};
-        facebook: {};
-        send<T extends "onEventReceived" | "onSessionUpdate" | "onWidgetLoad">(listener: T, event: T extends "onEventReceived" ? StreamElements.Event.onEventReceived : T extends "onSessionUpdate" ? StreamElements.Event.onSessionUpdate : StreamElements.Event.onWidgetLoad): void;
+            };
+        }>): void;
+        deleteMessage(msgId: string): void;
+        deleteMessages(userId: string): void;
+        follower(data?: Partial<{
+            avatar: string;
+            name: string;
+        }>): void;
+        raid(data?: Partial<{
+            amount: number;
+            avatar: string;
+            name: string;
+        }>): void;
+        cheer(data?: Partial<{
+            amount: number;
+            avatar: string;
+            name: string;
+            message: string;
+        }>): void;
+        subscriber(data?: Partial<{
+            tier: "1000" | "2000" | "3000" | "prime";
+            amount: number;
+            avatar: string;
+            name: string;
+            sender: string;
+            message: string;
+            subType: "default" | "gift" | "community" | "spam";
+        }> & {
+            subType?: "default" | "gift" | "community" | "spam";
+        }): void;
+    };
+    streamelements: {
+        tip(data?: Partial<{
+            amount: number;
+            avatar: string;
+            name: string;
+        }>): void;
     };
+    youtube: {
+        message(data?: Partial<{
+            name: string;
+            message: string;
+            badges: BadgeOptions;
+            color: string;
+            userId: string;
+            msgId: string;
+            channel: string;
+            time: number;
+            avatar: string;
+        }>): void;
+        subscriber(data?: Partial<{
+            avatar: string;
+            name: string;
+        }>): void;
+        superchat(data?: Partial<{
+            amount: number;
+            avatar: string;
+            name: string;
+        }>): void;
+        sponsor(data?: Partial<{
+            tier: "1000" | "2000" | "3000";
+            amount: number;
+            avatar: string;
+            name: string;
+            sender: string;
+            message: string;
+            subType: "default" | "gift" | "community" | "spam";
+        }> & {
+            subType?: "default" | "gift" | "community" | "spam";
+        }): void;
+    };
+    kick: {};
+    facebook: {};
+    send<T extends 'onEventReceived' | 'onSessionUpdate' | 'onWidgetLoad'>(listener: T, event: T extends 'onEventReceived' ? StreamElements.Event.onEventReceived : T extends 'onSessionUpdate' ? StreamElements.Event.onSessionUpdate : StreamElements.Event.onWidgetLoad): void;
+}
+
+/**
+ * Simulates the onWidgetLoad event for a widget.
+ * @param fields - The field values to be included in the event.
+ * @param session - The session data to be included in the event.
+ * @param currency - The currency to be used (default is 'USD').
+ * @returns A Promise that resolves to the simulated onWidgetLoad event data.
+ */
+declare function onWidgetLoad(fields: Record<string, StreamElements.CustomField.Value>, session: StreamElements.Session.Data, currency?: 'BRL' | 'USD' | 'EUR'): Promise<StreamElements.Event.onWidgetLoad>;
+/**
+ * Simulates the onSessionUpdate event for a widget.
+ * @param session - The session data to be included in the event.
+ * @returns A Promise that resolves to the simulated onSessionUpdate event data.
+ */
+declare function onSessionUpdate(session?: StreamElements.Session.Data, update?: ClientEvents$1): Promise<StreamElements.Event.onSessionUpdate>;
+/**
+ * Simulates the onEventReceived event for a widget.
+ * @param provider - The provider of the event (default is 'random').
+ * @param type - The type of event to simulate (default is 'random').
+ * @param options - Additional options to customize the event data.
+ * @returns A Promise that resolves to the simulated onEventReceived event data, or null if the event type is not supported.
+ * @example
+ * ```javascript
+ * // Simulate a random event
+ * const randomEvent = await onEventReceived();
+ *
+ * // Simulate a Twitch message event with custom options
+ * const twitchMessageEvent = await onEventReceived('twitch', 'message', { name: 'Streamer', message: 'Hello World!' });
+ * ```
+ */
+declare function onEventReceived(provider?: Provider$1 | 'random', type?: StreamElements.Event.onEventReceived['listener'] | 'random' | 'tip' | 'cheer' | 'follower' | 'raid' | 'subscriber', options?: Record<string, string | number | boolean>): Promise<StreamElements.Event.onEventReceived | null>;
+declare class Generator {
+    event: {
+        onWidgetLoad: typeof onWidgetLoad;
+        onSessionUpdate: typeof onSessionUpdate;
+        onEventReceived: typeof onEventReceived;
+    };
+    session: {
+        types: Record<string, StreamElements.Session.Config.Any>;
+        available(): StreamElements.Session.Config.Available.Data;
+        get(startSession?: StreamElements.Session.Data): Promise<StreamElements.Session.Data>;
+    };
+}
+
+type localQueueItem = {
+    listener: 'onEventReceived';
+    data: StreamElements.Event.onEventReceived;
+    session?: boolean;
+} | {
+    listener: 'onWidgetLoad';
+    data: StreamElements.Event.onWidgetLoad;
+} | {
+    listener: 'onSessionUpdate';
+    data: StreamElements.Event.onSessionUpdate;
+};
+
+declare namespace Local {
+    type QueueItem = localQueueItem;
+    const queue: useQueue<localQueueItem>;
+    const generate: Generator;
+    const emulate: Emulator;
     function start(fieldsFile?: string[], dataFiles?: string[], session?: StreamElements.Session.Data): Promise<void>;
 }