@tixyel/streamelements 5.2.0 → 5.3.0

package/dist/index.d.ts

@@ -6,243 +6,6 @@
 
 import { ComfyJSInstance, OnErrorHandler, OnCommandHandler, OnChatHandler, OnWhisperHandler, OnMessageDeletedHandler, OnJoinHandler, OnPartHandler, OnHostedHandler, OnRaidHandler, OnSubHandler, OnResubHandler, OnSubGiftHandler, OnSubMysteryGiftHandler, OnGiftSubContinueHandler, OnCheerHandler, OnChatModeHandler, OnRewardHandler, OnConnectedHandler, OnReconnectHandler } from 'comfy.js';
 
-interface ButtonOptions {
-    field: string | ((field: string, value: string | boolean | number) => boolean);
-    template?: string;
-    run: (field: string, value: string | boolean | number) => void;
-}
-declare class Button {
-    field: ButtonOptions['field'];
-    template: string;
-    run: ButtonOptions['run'];
-    constructor(options: ButtonOptions);
-    parse(field: string, value: string | boolean | number): Button;
-    remove(): void;
-    static execute(field: string, value: string | boolean | number): boolean;
-}
-
-type Provider$1 = 'twitch' | 'youtube' | 'kick' | 'facebook' | 'streamelements';
-type ClientEvents$1 = {
-    provider: 'streamelements';
-    data: StreamElements.Event.Provider.StreamElements.Events;
-} | {
-    provider: 'twitch';
-    data: StreamElements.Event.Provider.Twitch.Events;
-} | {
-    provider: 'youtube';
-    data: StreamElements.Event.Provider.YouTube.Events;
-} | {
-    provider: 'kick';
-    data: StreamElements.Event.Provider.Kick.Events;
-} | {
-    provider: 'facebook';
-    data: StreamElements.Event.Provider.Facebook.Events;
-};
-
-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;
-            };
-        }
-    }
-}
-
 declare namespace YoutubeEvents {
     namespace Message {
         export type Data = {
@@ -1584,25 +1347,343 @@ declare namespace StreamElements {
     }
 }
 
-/**
- * EventProvider class for managing event listeners and emitters.
- * This class allows you to register event listeners, emit events, and manage event subscriptions.
- * @example
- * ```typescript
- * type TestEvents = {
- *   load: [event: { type: 'load' }];
- *   event: [event: { type: 'event' }];
- * };
- *
- * class Test extends EventProvider<TestEvents> {}
- *
- * const test = new Test();
- * test.once('load', (data) => {});
- * test.emit('load', { type: 'load' });
- *
- * test.on('event', (data) => {});
- * test.emit('event', { type: 'event' });
- * ```
+type Provider$1 = 'twitch' | 'youtube' | 'kick' | 'facebook' | 'streamelements';
+type ClientEvents$1 = {
+    provider: 'streamelements';
+    data: StreamElements.Event.Provider.StreamElements.Events;
+} | {
+    provider: 'twitch';
+    data: StreamElements.Event.Provider.Twitch.Events;
+} | {
+    provider: 'youtube';
+    data: StreamElements.Event.Provider.YouTube.Events;
+} | {
+    provider: 'kick';
+    data: StreamElements.Event.Provider.Kick.Events;
+} | {
+    provider: 'facebook';
+    data: StreamElements.Event.Provider.Facebook.Events;
+};
+
+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;
+    id: string;
+    gif: boolean;
+    urls: {
+        '1': string;
+        '2': string;
+        '4': string;
+    };
+    start: number;
+    end: number;
+};
+type SeventvEmote = {
+    type: '7tv';
+    name: string;
+    id: string;
+    gif: boolean;
+    animated: boolean;
+    urls: {
+        '1': string;
+        '2': string;
+        '3': string;
+        '4': string;
+    };
+    start: number;
+    end: number;
+    cords: {
+        x: number;
+        y: number;
+    };
+};
+type BttvEmote = {
+    type: 'bttv';
+    name: string;
+    id: string;
+    gif: boolean;
+    animated: boolean;
+    urls: {
+        '1': string;
+        '2': string;
+        '4': string;
+    };
+    start: number;
+    end: number;
+    coords: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+};
+
+interface ButtonOptions {
+    field: string | ((field: string, value: string | boolean | number) => boolean);
+    template?: string;
+    name?: string;
+    value?: string;
+    run: (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;
+}
+
+/**
+ * EventProvider class for managing event listeners and emitters.
+ * This class allows you to register event listeners, emit events, and manage event subscriptions.
+ * @example
+ * ```typescript
+ * type TestEvents = {
+ *   load: [event: { type: 'load' }];
+ *   event: [event: { type: 'event' }];
+ * };
+ *
+ * class Test extends EventProvider<TestEvents> {}
+ *
+ * const test = new Test();
+ * test.once('load', (data) => {});
+ * test.emit('load', { type: 'load' });
+ *
+ * test.on('event', (data) => {});
+ * test.emit('event', { type: 'event' });
+ * ```
  */
 declare class EventProvider<EventMap extends Record<string, any[]> = Record<string, any[]>> {
     /**
@@ -1810,7 +1891,7 @@ declare class Command {
     name: string;
     description: string;
     arguments: boolean;
-    test: string;
+    test: string | (() => string);
     aliases: string[];
     permissions?: string[] | boolean;
     admins: string[];
@@ -1886,59 +1967,6 @@ declare class useQueue<T> extends EventProvider<QueueEvents<T>> {
     on<K extends keyof QueueEvents<T>>(eventName: K, callback: (this: useQueue<T>, ...args: QueueEvents<T>[K]) => void): this;
 }
 
-type TwitchEmote = {
-    type: 'twitch';
-    name: string;
-    id: string;
-    gif: boolean;
-    urls: {
-        '1': string;
-        '2': string;
-        '4': string;
-    };
-    start: number;
-    end: number;
-};
-type SeventvEmote = {
-    type: '7tv';
-    name: string;
-    id: string;
-    gif: boolean;
-    animated: boolean;
-    urls: {
-        '1': string;
-        '2': string;
-        '3': string;
-        '4': string;
-    };
-    start: number;
-    end: number;
-    cords: {
-        x: number;
-        y: number;
-    };
-};
-type BttvEmote = {
-    type: 'bttv';
-    name: string;
-    id: string;
-    gif: boolean;
-    animated: boolean;
-    urls: {
-        '1': string;
-        '2': string;
-        '4': string;
-    };
-    start: number;
-    end: number;
-    coords: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-};
-
 type Emote = TwitchEmote | BttvEmote | SeventvEmote;
 type BadgeOptions = Twitch.roles[] | Twitch.roles | `${Twitch.roles}, ${Twitch.roles}` | `${Twitch.roles}, ${Twitch.roles}, ${Twitch.roles}`;
 
@@ -2243,7 +2271,9 @@ declare namespace Helper {
     };
     const utils: {
         delay<R extends unknown, M extends number>(ms: M, callback?: () => R): Promise<R | null>;
-        typedEntries<K extends string, V>(obj: Record<K, V>): [K, V][];
+        typedEntries<K extends string, V>(obj: Record<K, V> | Array<V>): [K, V][];
+        typedValues<K extends string, V>(obj: Record<K, V> | Array<V>): V[];
+        typedKeys<K extends string, V>(obj: Record<K, V> | Array<V>): K[];
         probability<K extends string, V extends number>(items: Record<K, V>): K | undefined;
     };
     const random: {