@tixyel/streamelements 3.5.0 → 3.7.0

package/dist/index.d.ts

@@ -224,6 +224,25 @@ declare function findEmotesInText(text: string, emotes?: Emote[]): Emote[];
  * @returns The text with emotes replaced by HTML image tags.
  */
 declare function replaceEmotesWithHTML(text: string, emotes: Emote[]): string;
+declare function replaceYoutubeEmotesWithHTML(text: string, emotes?: {
+    emojiId: string;
+    shortcuts: string[];
+    searchTerms: string[];
+    image: {
+        thumbnails: {
+            url: string;
+            width: number;
+            height: number;
+        }[];
+        accessibility: {
+            accessibilityData: {
+                label: string;
+            };
+        };
+    };
+    isCustomEmoji: boolean;
+    index: number;
+}[]): string;
 type TwitchResult = {
     keys: Twitch.roles[];
     badges: Twitch.badge[];
@@ -1351,16 +1370,18 @@ declare namespace StreamElements {
  * @example
  * ```typescript
  * interface TestEvents {
- *   load: [{ type: 'load' }];
- *   event: [{ type: 'event' }];
- * }
+ *   load: [event: { type: 'load' }];
+ *   event: [event: { type: 'event' }];
+ * };
  *
  * class Test extends EventProvider<TestEvents> {}
  *
  * const test = new Test();
- * test.on('load', (data) => {})
- * test.once('event', (data) => {})
+ * 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[]>> {
@@ -1439,11 +1460,13 @@ declare namespace Alejo {
             itits = "It/Its"
         }
     }
+    function list(): Promise<typeof Pronouns.map>;
     type user = {
         id: string;
         login: string;
-        pronouns: Pronouns.name;
+        pronoun_id: Pronouns.name;
     };
+    function get(username: string): Promise<Pronouns.name | undefined>;
 }
 
 declare namespace Simulation {
@@ -1453,6 +1476,25 @@ declare namespace Simulation {
         tiers: string[];
         avatars: string[];
         emotes: (TwitchEmote | BttvEmote | SeventvEmote)[];
+        youtube_emotes: {
+            emojiId: string;
+            shortcuts: string[];
+            searchTerms: string[];
+            image: {
+                thumbnails: {
+                    url: string;
+                    width: number;
+                    height: number;
+                }[];
+                accessibility: {
+                    accessibilityData: {
+                        label: string;
+                    };
+                };
+            };
+            isCustomEmoji: boolean;
+            index: number;
+        }[];
         badges: Record<Twitch.roles, Twitch.badge>;
         items: any[];
         tts: string[];
@@ -1477,6 +1519,20 @@ declare namespace Simulation {
             opacity: number;
         };
         validate(str: string): false | "hex" | "rgb" | "rgba" | "hsl" | "hsla" | "css-color-name";
+        /**
+         * Convert color to different format
+         * @param str - Color string to convert (e.g. "#FF5733", "rgb(255, 87, 51)")
+         * @param format - Target format
+         * @returns - Converted color string
+         * @example
+         * ```javascript
+         * const hexColor = Simulation.color.convert("rgb(255, 87, 51)", "hex"); // "#FF5733"
+         * const rgbColor = Simulation.color.convert("#FF5733", "rgb"); // "rgb(255, 87, 51)"
+         * const hslColor = Simulation.color.convert("#FF5733", "hsl"); // "hsl(14, 100%, 60%)"
+         * const colorName = Simulation.color.convert("#FF5733", "css-color-name"); // "orangered"
+         * ```
+         */
+        convert(str: string, format: "hex" | "rgb" | "rgba" | "hsl" | "hsla" | "css-color-name"): string | null;
     };
     export const rand: {
         /**
@@ -1632,6 +1688,33 @@ declare namespace Simulation {
             aliases?: Record<string, string[]>;
         }): string;
     };
+    export const number: {
+        /**
+         * Translate number to words
+         * @param num - Number to translate
+         * @param type - Translation type
+         * @returns - Number in words
+         * @example
+         * ```javascript
+         * const cardinal = Simulation.number.translate(42, 'cardinal');
+         * console.log(cardinal); // "forty-two"
+         * ```
+         */
+        translate(num: number, type?: "cardinal" | "ordinal" | "suffix"): string;
+        /**
+         * Balances a number within a specified range
+         * @param amount - Number to balance
+         * @param min - Minimum value
+         * @param max - Maximum value
+         * @returns - Balanced number
+         * @example
+         * ```javascript
+         * const balancedValue = Simulation.number.balance(150, 0, 100);
+         * console.log(balancedValue); // 100
+         * ```
+         */
+        balance(amount: number, min?: number, max?: number): number;
+    };
     export const element: {
         /**
          * Merges outer span styles with inner span styles in the provided HTML string.
@@ -1761,6 +1844,13 @@ declare namespace Simulation {
         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;
     };
+    /**
+     * Delays execution for a specified number of milliseconds.
+     * @param ms - The number of milliseconds to delay.
+     * @returns A Promise that resolves after the specified delay.
+     */
+    export function delay(ms: number): Promise<void>;
+    export function probability(items: Record<string, number>): string | undefined;
     export function start(fieldsFile?: string[], dataFiles?: string[]): Promise<void>;
     export {};
 }
@@ -1773,7 +1863,7 @@ type UseStorageOptions<T> = {
     id?: string;
     data: T;
 };
-declare class useStorage<T extends object = Record<string, any>> extends EventProvider<UseStorageEvents<T>> {
+declare class useStorage<T extends Record<string, any>> extends EventProvider<UseStorageEvents<T>> {
     /**
      * The unique identifier for the storage instance.
      */
@@ -1833,10 +1923,7 @@ type ClientEvents = {
     load: [event: StreamElements.Event.onWidgetLoad];
     action: [action: Button | Command, type: 'created' | 'executed' | 'removed'];
     session: [session: StreamElements.Session.Data];
-    event: [event: ClientEvents$1];
-};
-type ClientOptions = {
-    id?: string;
+    event: [provider: 'streamelements', event: StreamElements.Event.Provider.StreamElements.Events] | [provider: 'twitch', event: StreamElements.Event.Provider.Twitch.Events] | [provider: 'youtube', event: StreamElements.Event.Provider.YouTube.Events] | [provider: 'kick', event: StreamElements.Event.Provider.Kick.Events] | [provider: 'facebook', event: StreamElements.Event.Provider.Facebook.Events];
 };
 type ClientStorageOptions<T> = {
     value: T;
@@ -1849,6 +1936,9 @@ type ClientStorage = {
     pronoun: Record<string, ClientStorageOptions<Alejo.Pronouns.name>>;
     emote: Record<string, ClientStorageOptions<string>>;
 };
+type ClientOptions = {
+    id?: string;
+};
 declare class Client extends EventProvider<ClientEvents> {
     id: string;
     storage: useStorage<ClientStorage>;
@@ -1867,8 +1957,17 @@ declare class Client extends EventProvider<ClientEvents> {
         overlay: StreamElements.Event.onWidgetLoad['overlay'];
     };
     cache: {
+        /**
+         * Avatar cache duration in minutes.
+         */
         avatar: number;
+        /**
+         * Pronoun cache duration in minutes.
+         */
         pronoun: number;
+        /**
+         * Emote cache duration in minutes.
+         */
         emote: number;
     };
     on<K extends keyof ClientEvents>(eventName: K, callback: (this: Client, ...args: ClientEvents[K]) => void): this;
@@ -1998,13 +2097,15 @@ declare class Logger {
 declare const USE_SE_API: Promise<StreamElements.SE_API>;
 declare const logger: Logger;
 declare const Tixyel: {
+    readonly Client: typeof Client;
     readonly USE_SE_API: Promise<StreamElements.SE_API>;
     readonly Simulation: typeof Simulation;
-    readonly Client: typeof Client;
     readonly logger: Logger;
+    readonly Alejo: typeof Alejo;
     readonly utils: {
         readonly findEmotesInText: typeof findEmotesInText;
         readonly replaceEmotesWithHTML: typeof replaceEmotesWithHTML;
+        readonly replaceYoutubeEmotesWithHTML: typeof replaceYoutubeEmotesWithHTML;
         readonly generateBadges: typeof generateBadges;
     };
     readonly modules: {
@@ -2015,6 +2116,9 @@ declare const Tixyel: {
         readonly useQueue: typeof useQueue;
         readonly Logger: typeof Logger;
     };
+    readonly data: {
+        readonly usedStorages: useStorage<any>[];
+    };
 };
 type Main = typeof Tixyel;
 declare global {