@tixyel/streamelements 7.5.2 → 7.6.0

package/dist/index.d.ts

@@ -7,6 +7,239 @@
 import { ComfyJSInstance, OnErrorHandler, OnCommandHandler, OnChatHandler, OnWhisperHandler, OnMessageDeletedHandler, OnJoinHandler, OnPartHandler, OnHostedHandler, OnRaidHandler, OnSubHandler, OnResubHandler, OnSubGiftHandler, OnSubMysteryGiftHandler, OnGiftSubContinueHandler, OnCheerHandler, OnChatModeHandler, OnRewardHandler, OnConnectedHandler, OnReconnectHandler } from 'comfy.js';
 export { ComfyJSInstance } from 'comfy.js';
 
+type Provider$1 = 'twitch' | 'youtube' | 'kick' | 'facebook' | 'streamelements';
+type ClientProviderEvents = {
+    streamelements: StreamElements.Event.Provider.StreamElements.Events;
+    twitch: StreamElements.Event.Provider.Twitch.Events;
+    youtube: StreamElements.Event.Provider.YouTube.Events;
+    kick: StreamElements.Event.Provider.Kick.Events;
+    facebook: StreamElements.Event.Provider.Facebook.Events;
+};
+type ClientCustomEventPayload = {
+    provider: 'custom';
+};
+type ClientCustomProviderEvents = Record<string, ClientCustomEventPayload>;
+type ValidateCustomProviderEvents<CustomEvents> = CustomEvents extends Record<string, unknown> ? {
+    [K in keyof CustomEvents]: CustomEvents[K] extends ClientCustomEventPayload ? CustomEvents[K] : never;
+} : {};
+type ClientAllProviderEvents<CustomEvents = {}> = ClientProviderEvents & ValidateCustomProviderEvents<CustomEvents>;
+type ClientEvents<CustomEvents = {}> = {
+    [K in keyof ClientAllProviderEvents<CustomEvents> & string]: {
+        provider: K;
+        data: ClientAllProviderEvents<CustomEvents>[K];
+    };
+}[keyof ClientAllProviderEvents<CustomEvents> & string];
+type ClientEventTuple<CustomEvents = {}> = {
+    [K in keyof ClientAllProviderEvents<CustomEvents> & string]: [
+        provider: K,
+        event: ClientAllProviderEvents<CustomEvents>[K]
+    ];
+}[keyof ClientAllProviderEvents<CustomEvents> & string];
+
+declare namespace StreamElementsEvents {
+    namespace Tip {
+        type Data = {
+            listener: 'tip-latest';
+            event: Event;
+        };
+        type Event = {
+            amount: number;
+            avatar: string;
+            name: string;
+            displayName: string;
+            providerId: string;
+            _id: string;
+            sessionTop: boolean;
+            type: 'tip';
+            originalEventName: 'tip-latest';
+        };
+    }
+    namespace KVStore {
+        type Data = {
+            listener: 'kvstore:update';
+            event: Event;
+        };
+        type Event = {
+            data: {
+                key: `customWidget.${string}`;
+                value: string | number | boolean | Record<string, any>;
+            };
+        };
+    }
+    namespace BotCounter {
+        type Data = {
+            listener: 'bot:counter';
+            event: Event;
+        };
+        type Event = {
+            counter: string;
+            value: number;
+        };
+    }
+    namespace AlertService {
+        type Data = {
+            listener: 'alertService:toggleSound';
+            event: Event;
+        };
+        type Event = {
+            muted: boolean;
+        };
+    }
+    namespace EventSkip {
+        type Data = {
+            listener: 'event:skip';
+            event: Event;
+        };
+        type Event = {};
+    }
+    namespace EventTest {
+        export type Data = {
+            listener: 'event:test';
+            event: Event;
+        };
+        export type Event = widgetButton | emulatedEvents<EventType> | Session;
+        type items = {
+            name: string;
+            price: number;
+            quantity: number;
+        };
+        type widgetButton = {
+            listener: 'widget-button';
+            field: string;
+            value: string | number | boolean;
+        };
+        type EventType = 'follower' | 'subscriber' | 'tip' | 'cheer' | 'raid';
+        type EventTier = 'prime' | '1000' | '2000' | '3000';
+        type emulatedEvents<T extends EventType> = {
+            listener: `${T}-latest`;
+            event: {
+                type: T;
+                name: string;
+                amount: number;
+                count: number;
+                message?: string;
+                gifted?: boolean;
+                bulkGifted?: boolean;
+                sender?: string;
+                subExtension?: boolean;
+                items: items[];
+                tier: EventTier;
+                month: string;
+                isTest: true;
+            };
+        };
+        type Session = SessionCount | SessionTotal | SessionTop | SessionGoal | SessionRecent | SessionPoints;
+        type SessionCount = {
+            listener: `${EventType}-count`;
+            event: {
+                type: EventType;
+                name: string;
+                count: number;
+                items: items[];
+                tier: EventTier;
+                month: string;
+                isTest: true;
+            };
+        };
+        type SessionTotal = {
+            listener: `${EventType}-total`;
+            event: {
+                type: EventType;
+                name: string;
+                amount: number;
+                count: number;
+                items: items[];
+                tier: EventTier;
+                month: string;
+                isTest: true;
+            };
+        };
+        type SessionTop = {
+            listener: `${EventType}-top`;
+            event: {
+                type: EventType;
+                name: string;
+                amount: number;
+                count: number;
+                items: items[];
+                tier: EventTier;
+                month: string;
+                isTest: true;
+            };
+        };
+        type SessionGoal = {
+            listener: `${EventType}-goal`;
+            event: {
+                type: EventType;
+                name: string;
+                amount: number;
+                count: number;
+                items: items[];
+                tier: EventTier;
+                month: string;
+                isTest: true;
+            };
+        };
+        type SessionRecent = {
+            listener: `${EventType}-recent`;
+            event: {
+                event: SessionRecentEvent[];
+            };
+        };
+        type SessionRecentEvent = {
+            type: EventType;
+            name: string;
+            amount: number;
+            count: number;
+            tier: EventTier;
+            isTest: true;
+        };
+        type SessionPoints = {
+            listener: `${EventType}-points`;
+            event: {
+                type: EventType;
+                name: string;
+                amount: number;
+                count: number;
+                items: items[];
+                tier: EventTier;
+                month: string;
+                isTest: true;
+            };
+        };
+        export {};
+    }
+    interface BaseEvent {
+        provider: Provider$1;
+        flagged: boolean;
+        channel: string;
+        createdAt: string;
+        _id: string;
+        expiresAt: string;
+        updatedAt: string;
+        activityId: string;
+        sessionEventsCount: number;
+        isMock?: boolean;
+    }
+    namespace Event {
+        type Data = {
+            listener: 'event';
+            event: Event;
+        };
+        type Event = Tip;
+        interface Tip extends BaseEvent {
+            type: 'tip';
+            data: {
+                amount: string;
+                currency: string;
+                username: string;
+                message: string;
+                avatar: string;
+            };
+        }
+    }
+}
+
 type TwitchEmote = {
     type: 'twitch';
     name: string;
@@ -1385,368 +1618,80 @@ declare namespace StreamElements {
                 amount: number;
             };
             'tip-alltime-top-donation': {
-                name: string;
-                amount: number;
-            };
-            'tip-session-top-donator': {
-                name: string;
-                amount: number;
-            };
-            'tip-weekly-top-donator': {
-                name: string;
-                amount: number;
-            };
-            'tip-monthly-top-donator': {
-                name: string;
-                amount: number;
-            };
-            'tip-alltime-top-donator': {
-                name: string;
-                amount: number;
-            };
-            'tip-session': {
-                amount: number;
-            };
-            'tip-week': {
-                amount: number;
-            };
-            'tip-month': {
-                amount: number;
-            };
-            'tip-total': {
-                amount: number;
-            };
-            'tip-count': {
-                count: number;
-            };
-            'tip-goal': {
-                amount: number;
-            };
-            'tip-recent': {
-                name: string;
-                amount: number;
-                createdAt: string;
-            }[];
-        }
-        interface Merch {
-            'merch-latest': {
-                name: string;
-                amount: number;
-                items: any[];
-            };
-            'merch-goal-orders': {
-                amount: number;
-            };
-            'merch-goal-items': {
-                amount: number;
-            };
-            'merch-goal-total': {
-                amount: number;
-            };
-            'merch-recent': {
-                name: string;
-            }[];
-        }
-        interface Purchase {
-            'purchase-latest': {
-                name: string;
-                amount: number;
-                items: any[];
-                avatar: string;
-                message: string;
-            };
-        }
-    }
-}
-
-type Provider$1 = 'twitch' | 'youtube' | 'kick' | 'facebook' | 'streamelements';
-type ClientProviderEvents = {
-    streamelements: StreamElements.Event.Provider.StreamElements.Events;
-    twitch: StreamElements.Event.Provider.Twitch.Events;
-    youtube: StreamElements.Event.Provider.YouTube.Events;
-    kick: StreamElements.Event.Provider.Kick.Events;
-    facebook: StreamElements.Event.Provider.Facebook.Events;
-};
-type ClientCustomEventPayload = {
-    provider: 'custom';
-};
-type ClientCustomProviderEvents = Record<string, ClientCustomEventPayload>;
-type ValidateCustomProviderEvents<CustomEvents> = CustomEvents extends Record<string, unknown> ? {
-    [K in keyof CustomEvents]: CustomEvents[K] extends ClientCustomEventPayload ? CustomEvents[K] : never;
-} : {};
-type ClientAllProviderEvents<CustomEvents = {}> = ClientProviderEvents & ValidateCustomProviderEvents<CustomEvents>;
-type ClientEvents<CustomEvents = {}> = {
-    [K in keyof ClientAllProviderEvents<CustomEvents> & string]: {
-        provider: K;
-        data: ClientAllProviderEvents<CustomEvents>[K];
-    };
-}[keyof ClientAllProviderEvents<CustomEvents> & string];
-type ClientEventTuple<CustomEvents = {}> = {
-    [K in keyof ClientAllProviderEvents<CustomEvents> & string]: [
-        provider: K,
-        event: ClientAllProviderEvents<CustomEvents>[K]
-    ];
-}[keyof ClientAllProviderEvents<CustomEvents> & string];
-
-declare namespace StreamElementsEvents {
-    namespace Tip {
-        type Data = {
-            listener: 'tip-latest';
-            event: Event;
-        };
-        type Event = {
-            amount: number;
-            avatar: string;
-            name: string;
-            displayName: string;
-            providerId: string;
-            _id: string;
-            sessionTop: boolean;
-            type: 'tip';
-            originalEventName: 'tip-latest';
-        };
-    }
-    namespace KVStore {
-        type Data = {
-            listener: 'kvstore:update';
-            event: Event;
-        };
-        type Event = {
-            data: {
-                key: `customWidget.${string}`;
-                value: string | number | boolean | Record<string, any>;
-            };
-        };
-    }
-    namespace BotCounter {
-        type Data = {
-            listener: 'bot:counter';
-            event: Event;
-        };
-        type Event = {
-            counter: string;
-            value: number;
-        };
-    }
-    namespace AlertService {
-        type Data = {
-            listener: 'alertService:toggleSound';
-            event: Event;
-        };
-        type Event = {
-            muted: boolean;
-        };
-    }
-    namespace EventSkip {
-        type Data = {
-            listener: 'event:skip';
-            event: Event;
-        };
-        type Event = {};
-    }
-    namespace EventTest {
-        export type Data = {
-            listener: 'event:test';
-            event: Event;
-        };
-        export type Event = widgetButton | emulatedEvents<EventType> | Session;
-        type items = {
-            name: string;
-            price: number;
-            quantity: number;
-        };
-        type widgetButton = {
-            listener: 'widget-button';
-            field: string;
-            value: string | number | boolean;
-        };
-        type EventType = 'follower' | 'subscriber' | 'tip' | 'cheer' | 'raid';
-        type EventTier = 'prime' | '1000' | '2000' | '3000';
-        type emulatedEvents<T extends EventType> = {
-            listener: `${T}-latest`;
-            event: {
-                type: T;
-                name: string;
-                amount: number;
-                count: number;
-                message?: string;
-                gifted?: boolean;
-                bulkGifted?: boolean;
-                sender?: string;
-                subExtension?: boolean;
-                items: items[];
-                tier: EventTier;
-                month: string;
-                isTest: true;
+                name: string;
+                amount: number;
             };
-        };
-        type Session = SessionCount | SessionTotal | SessionTop | SessionGoal | SessionRecent | SessionPoints;
-        type SessionCount = {
-            listener: `${EventType}-count`;
-            event: {
-                type: EventType;
+            'tip-session-top-donator': {
                 name: string;
-                count: number;
-                items: items[];
-                tier: EventTier;
-                month: string;
-                isTest: true;
+                amount: number;
             };
-        };
-        type SessionTotal = {
-            listener: `${EventType}-total`;
-            event: {
-                type: EventType;
+            'tip-weekly-top-donator': {
                 name: string;
                 amount: number;
-                count: number;
-                items: items[];
-                tier: EventTier;
-                month: string;
-                isTest: true;
             };
-        };
-        type SessionTop = {
-            listener: `${EventType}-top`;
-            event: {
-                type: EventType;
+            'tip-monthly-top-donator': {
                 name: string;
                 amount: number;
-                count: number;
-                items: items[];
-                tier: EventTier;
-                month: string;
-                isTest: true;
             };
-        };
-        type SessionGoal = {
-            listener: `${EventType}-goal`;
-            event: {
-                type: EventType;
+            'tip-alltime-top-donator': {
                 name: string;
                 amount: number;
+            };
+            'tip-session': {
+                amount: number;
+            };
+            'tip-week': {
+                amount: number;
+            };
+            'tip-month': {
+                amount: number;
+            };
+            'tip-total': {
+                amount: number;
+            };
+            'tip-count': {
                 count: number;
-                items: items[];
-                tier: EventTier;
-                month: string;
-                isTest: true;
             };
-        };
-        type SessionRecent = {
-            listener: `${EventType}-recent`;
-            event: {
-                event: SessionRecentEvent[];
+            'tip-goal': {
+                amount: number;
             };
-        };
-        type SessionRecentEvent = {
-            type: EventType;
-            name: string;
-            amount: number;
-            count: number;
-            tier: EventTier;
-            isTest: true;
-        };
-        type SessionPoints = {
-            listener: `${EventType}-points`;
-            event: {
-                type: EventType;
+            'tip-recent': {
                 name: string;
                 amount: number;
-                count: number;
-                items: items[];
-                tier: EventTier;
-                month: string;
-                isTest: true;
+                createdAt: string;
+            }[];
+        }
+        interface Merch {
+            'merch-latest': {
+                name: string;
+                amount: number;
+                items: any[];
             };
-        };
-        export {};
-    }
-    interface BaseEvent {
-        provider: Provider$1;
-        flagged: boolean;
-        channel: string;
-        createdAt: string;
-        _id: string;
-        expiresAt: string;
-        updatedAt: string;
-        activityId: string;
-        sessionEventsCount: number;
-        isMock?: boolean;
-    }
-    namespace Event {
-        type Data = {
-            listener: 'event';
-            event: Event;
-        };
-        type Event = Tip;
-        interface Tip extends BaseEvent {
-            type: 'tip';
-            data: {
-                amount: string;
-                currency: string;
-                username: string;
-                message: string;
+            'merch-goal-orders': {
+                amount: number;
+            };
+            'merch-goal-items': {
+                amount: number;
+            };
+            'merch-goal-total': {
+                amount: number;
+            };
+            'merch-recent': {
+                name: string;
+            }[];
+        }
+        interface Purchase {
+            'purchase-latest': {
+                name: string;
+                amount: number;
+                items: any[];
                 avatar: string;
+                message: string;
             };
         }
     }
 }
 
-type JSONPrimitive = string | number | boolean | null;
-type JSONSerializable = JSONPrimitive | JSONSerializable[] | {
-    [k: string]: JSONSerializable | undefined;
-};
-type JSONObject = {
-    [key: string]: JSONSerializable | undefined;
-};
-
-type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
-    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
-}[Keys];
-
-interface ButtonOptions {
-    field: string | ((field: string, value: string | boolean | number) => boolean);
-    template?: string;
-    name?: string;
-    value?: string;
-    run: (this: Client | undefined, field: string, value: string | boolean | number) => void;
-}
-/**
- * Represents a button action that can be triggered by custom fields in StreamElements.
- * The button can be configured with a template and a name, and it will execute a specified function when triggered.
- * @example
- * ```javascript
- * const button = new Button({
- *   field: (field, value) => field.startsWith('message-') && field.split('-')[1],
- *   template: 'message-{role}',
- *   // name: '[CAP={role}] role message',
- *   name: 'Generate {role} message',
- *   run(field, value) {
- *     console.log(`Button ${field} was clicked with value: ${value}`);
- *   }
- * })
- *
- * const field = button.generate([{ role: 'broadcaster' }, { role: 'moderator' }]);
- * // This will create buttons with fields "message-broadcaster" and "message-moderator" and names "Generate broadcaster message" and "Generate moderator message".
- * // field['message-broadcaster'] => { type: 'button', label: 'Generate broadcaster message' }
- * // field['message-moderator'] => { type: 'button', label: 'Generate moderator message' }
- *
- * // When a custom field with the name "message-broadcaster" or "message-moderator" is triggered, the run function will be called with the field and value.
- * ```
- */
-declare class Button {
-    field: ButtonOptions['field'];
-    template: string;
-    name: string;
-    value: string;
-    run: ButtonOptions['run'];
-    constructor(options: ButtonOptions);
-    generate(values: Array<Record<string, string | number>>): Record<string, StreamElements.CustomField.Schema>;
-    parse(field: string, value: string | boolean | number): Button;
-    remove(): void;
-    static execute(field: string, value: string | boolean | number): boolean;
-}
-
 interface CommandOptions {
     prefix?: string;
     name: string;
@@ -1842,6 +1787,14 @@ declare class EventProvider<EventMap extends Record<string, any[]> = Record<stri
     removeAllListeners<K extends keyof EventMap>(eventName: K): this;
 }
 
+type JSONPrimitive = string | number | boolean | null;
+type JSONSerializable = JSONPrimitive | JSONSerializable[] | {
+    [k: string]: JSONSerializable | undefined;
+};
+type JSONObject = {
+    [key: string]: JSONSerializable | undefined;
+};
+
 type UseStorageEvents<T> = {
     load: [T | null];
     update: [T];
@@ -1974,6 +1927,53 @@ declare class Client<CustomEvents = {}> extends EventProvider<ClientMapEvents<Cu
     on<K extends keyof ClientMapEvents<CustomEvents>>(eventName: K, callback: (this: Client<CustomEvents>, ...args: ClientMapEvents<CustomEvents>[K]) => void): this;
 }
 
+type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+
+interface ButtonOptions {
+    field: string | ((field: string, value: string | boolean | number) => boolean);
+    template?: string;
+    name?: string;
+    value?: string;
+    run: (this: Client | undefined, field: string, value: string | boolean | number) => void;
+}
+/**
+ * Represents a button action that can be triggered by custom fields in StreamElements.
+ * The button can be configured with a template and a name, and it will execute a specified function when triggered.
+ * @example
+ * ```javascript
+ * const button = new Button({
+ *   field: (field, value) => field.startsWith('message-') && field.split('-')[1],
+ *   template: 'message-{role}',
+ *   // name: '[CAP={role}] role message',
+ *   name: 'Generate {role} message',
+ *   run(field, value) {
+ *     console.log(`Button ${field} was clicked with value: ${value}`);
+ *   }
+ * })
+ *
+ * const field = button.generate([{ role: 'broadcaster' }, { role: 'moderator' }]);
+ * // This will create buttons with fields "message-broadcaster" and "message-moderator" and names "Generate broadcaster message" and "Generate moderator message".
+ * // field['message-broadcaster'] => { type: 'button', label: 'Generate broadcaster message' }
+ * // field['message-moderator'] => { type: 'button', label: 'Generate moderator message' }
+ *
+ * // When a custom field with the name "message-broadcaster" or "message-moderator" is triggered, the run function will be called with the field and value.
+ * ```
+ */
+declare class Button {
+    field: ButtonOptions['field'];
+    template: string;
+    name: string;
+    value: string;
+    run: ButtonOptions['run'];
+    constructor(options: ButtonOptions);
+    generate(values: Array<Record<string, string | number>>): Record<string, StreamElements.CustomField.Schema>;
+    parse(field: string, value: string | boolean | number): Button;
+    remove(): void;
+    static execute(field: string, value: string | boolean | number): boolean;
+}
+
 interface Theme {
     color?: string;
     background?: string;
@@ -3652,6 +3652,30 @@ declare class useComms<T extends MessageMap> extends EventProvider<BaseEvents<T>
     on<K extends keyof BaseEvents<T>>(eventName: K, callback: (this: useComms<T>, ...args: BaseEvents<T>[K]) => void): this;
 }
 
+declare const usedClients: Client[];
+declare const usedStorages: Array<useStorage<any>>;
+declare const usedComms: Array<useComms<any>>;
+declare const usedCommands: Command[];
+declare const usedButtons: Button[];
+declare const fakeUserPools: FakeUserPool[];
+
+declare const internals_fakeUserPools: typeof fakeUserPools;
+declare const internals_usedButtons: typeof usedButtons;
+declare const internals_usedClients: typeof usedClients;
+declare const internals_usedCommands: typeof usedCommands;
+declare const internals_usedComms: typeof usedComms;
+declare const internals_usedStorages: typeof usedStorages;
+declare namespace internals {
+  export {
+    internals_fakeUserPools as fakeUserPools,
+    internals_usedButtons as usedButtons,
+    internals_usedClients as usedClients,
+    internals_usedCommands as usedCommands,
+    internals_usedComms as usedComms,
+    internals_usedStorages as usedStorages,
+  };
+}
+
 declare const main: {
     SeAPI: Promise<StreamElements.SE_API>;
     Client: typeof Client;
@@ -3674,13 +3698,7 @@ declare const main: {
     multistream: {
         useComfyJs: typeof useComfyJs;
     };
-    internal: {
-        usedStorages: useStorage<any>[];
-        usedComms: useComms<any>[];
-        usedCommands: Command[];
-        usedButtons: Button[];
-        fakeUserPools: FakeUserPool[];
-    };
+    internal: typeof internals;
     pronouns: {
         Alejo: typeof Alejo;
     };
@@ -3689,7 +3707,6 @@ declare const main: {
 declare global {
     interface Window {
         Tixyel: typeof main;
-        client: Client | undefined;
         ComfyJS?: ComfyJSInstance;
     }
     interface WindowEventMap {
@@ -3698,7 +3715,6 @@ declare global {
         onEventReceived: CustomEvent<StreamElements.Event.onEventReceived>;
     }
     const Tixyel: typeof main;
-    let client: Client | undefined;
     const SE_API: StreamElements.SE_API;
 }