@tixyel/streamelements 6.4.8 → 6.5.0

package/dist/index.d.ts

@@ -1622,86 +1622,16 @@ type BttvEmote = {
         height: number;
     };
 };
-type Emote = TwitchEmote | BttvEmote | SeventvEmote;
-
-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;
+type Emoji = {
+    type: 'emoji';
     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;
-    bold?: boolean;
-    italic?: boolean;
-    fontSize?: number;
-    icon?: string;
-}
-interface Options {
-    enabled?: boolean;
-    prefix?: string | (() => string);
-}
-type LogMethod = (...args: unknown[]) => void;
-declare class useLogger {
-    enabled: boolean;
-    prefix: string | (() => string);
-    constructor(options?: Options);
-    apply(theme: Theme): LogMethod;
-    private style;
-    group(label: string): void;
-    groupCollapsed(label: string): void;
-    groupEnd(): void;
-    table(data: unknown): void;
-    time(label: string): void;
-    timeEnd(label: string): void;
-    readonly error: LogMethod;
-    readonly warn: LogMethod;
-    readonly success: LogMethod;
-    readonly info: LogMethod;
-    readonly debug: LogMethod;
-    readonly alert: LogMethod;
-    readonly status: LogMethod;
-    readonly received: LogMethod;
-    readonly simple: LogMethod;
-}
+    id: string;
+    gif: boolean;
+    urls: {
+        '1': string;
+    };
+};
+type Emote = TwitchEmote | BttvEmote | SeventvEmote | Emoji;
 
 /**
  * EventProvider class for managing event listeners and emitters.
@@ -1814,6 +1744,44 @@ declare class useStorage<T extends JSONObject> extends EventProvider<UseStorageE
     on<K extends keyof UseStorageEvents<T>>(eventName: K, callback: (this: useStorage<T>, ...args: UseStorageEvents<T>[K]) => void): this;
 }
 
+interface CommandOptions {
+    prefix?: string;
+    name: string;
+    description?: string;
+    arguments?: boolean;
+    run: (this: Client, args: string[], event: CommandEvent) => void;
+    test?: string;
+    aliases?: string[];
+    permissions?: string[] | boolean;
+    admins?: string[];
+}
+type CommandEvent = {
+    provider: 'twitch';
+    data: StreamElements.Event.Provider.Twitch.Message;
+} | {
+    provider: 'youtube';
+    data: StreamElements.Event.Provider.YouTube.Message;
+} | {
+    provider: 'kick';
+    data: any;
+};
+declare class Command {
+    prefix: string;
+    name: string;
+    description: string;
+    arguments: boolean;
+    test: string | (() => string);
+    aliases: string[];
+    permissions?: string[] | boolean;
+    admins: string[];
+    constructor(options: CommandOptions);
+    run(this: Client | undefined, args: string[], event: CommandEvent): void;
+    verify(nickname: string, roles: string[], args: string[]): boolean;
+    parse(text: string, event: CommandEvent): boolean;
+    remove(): void;
+    static execute(received: CommandEvent): boolean;
+}
+
 declare namespace Alejo {
     namespace Pronouns {
         type name = 'hehim' | 'sheher' | 'theythem' | 'shethem' | 'hethem' | 'heshe' | 'xexem' | 'faefaer' | 'vever' | 'aeaer' | 'ziehir' | 'perper' | 'eem' | 'itits';
@@ -1900,42 +1868,83 @@ declare class Client extends EventProvider<ClientEvents> {
     on<K extends keyof ClientEvents>(eventName: K, callback: (this: Client, ...args: ClientEvents[K]) => void): this;
 }
 
-interface CommandOptions {
-    prefix?: string;
-    name: string;
-    description?: string;
-    arguments?: boolean;
-    run: (this: Client, args: string[], event: CommandEvent) => void;
-    test?: string;
-    aliases?: string[];
-    permissions?: string[] | boolean;
-    admins?: string[];
+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;
 }
-type CommandEvent = {
-    provider: 'twitch';
-    data: StreamElements.Event.Provider.Twitch.Message;
-} | {
-    provider: 'youtube';
-    data: StreamElements.Event.Provider.YouTube.Message;
-} | {
-    provider: 'kick';
-    data: any;
-};
-declare class Command {
-    prefix: string;
+/**
+ * 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;
-    description: string;
-    arguments: boolean;
-    test: string | (() => string);
-    aliases: string[];
-    permissions?: string[] | boolean;
-    admins: string[];
-    constructor(options: CommandOptions);
-    run(this: Client, args: string[], event: CommandEvent): void;
-    verify(nickname: string, roles: string[], args: string[]): boolean;
-    parse(text: string, event: CommandEvent): boolean;
+    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(received: CommandEvent): boolean;
+    static execute(field: string, value: string | boolean | number): boolean;
+}
+
+interface Theme {
+    color?: string;
+    background?: string;
+    bold?: boolean;
+    italic?: boolean;
+    fontSize?: number;
+    icon?: string;
+}
+interface Options {
+    enabled?: boolean;
+    prefix?: string | (() => string);
+}
+type LogMethod = (...args: unknown[]) => void;
+declare class useLogger {
+    enabled: boolean;
+    prefix: string | (() => string);
+    constructor(options?: Options);
+    apply(theme: Theme): LogMethod;
+    private style;
+    group(label: string): void;
+    groupCollapsed(label: string): void;
+    groupEnd(): void;
+    table(data: unknown): void;
+    time(label: string): void;
+    timeEnd(label: string): void;
+    readonly error: LogMethod;
+    readonly warn: LogMethod;
+    readonly success: LogMethod;
+    readonly info: LogMethod;
+    readonly debug: LogMethod;
+    readonly alert: LogMethod;
+    readonly status: LogMethod;
+    readonly received: LogMethod;
+    readonly simple: LogMethod;
 }
 
 type QueueEvents<T> = {
@@ -2345,6 +2354,13 @@ declare namespace Helper {
          * @returns The text with emotes replaced by HTML image tags.
          */
         function replaceEmotesWithHTML(text: string, emotes: Emote[]): string;
+        /**
+         * Checks if the text contains only emotes and whitespace.
+         * @param text - The text to check.
+         * @param emotes - An array of emotes with their positions in the text.
+         * @returns True if the text contains only emotes and whitespace, false otherwise.
+         */
+        function hasOnlyEmotes(text: string, emotes: Emote[]): boolean;
         /**
          * Replaces YouTube emotes in the text with corresponding HTML image tags.
          * @param text - The text containing YouTube emotes.
@@ -2968,9 +2984,11 @@ declare const main: {
     multistream: {
         useComfyJs: typeof useComfyJs;
     };
-    data: {
+    internal: {
         usedStorages: useStorage<any>[];
         usedComms: useComms<any>[];
+        usedCommands: Command[];
+        usedButtons: Button[];
     };
     pronouns: {
         Alejo: typeof Alejo;
@@ -2994,4 +3012,4 @@ declare global {
 }
 
 export { Alejo, Button, Command, EventProvider, StreamElements, StreamElementsEvents, Twitch, TwitchEvents, YoutubeEvents, main as default, useComfyJs, useLogger, useQueue, useStorage };
-export type { BttvEmote, ClientEvents$1 as ClientEvents, Emote, Provider$1 as Provider, SeventvEmote, TwitchEmote };
+export type { BttvEmote, ClientEvents$1 as ClientEvents, Emoji, Emote, Provider$1 as Provider, SeventvEmote, TwitchEmote };