@tixyel/streamelements 7.7.0 → 7.9.0

package/dist/index.d.ts

@@ -2006,6 +2006,62 @@ declare class useLogger {
     readonly simple: LogMethod;
 }
 
+type ComfyEvents = {
+    load: [instance: ComfyJSInstance];
+    error: Parameters<OnErrorHandler>;
+    command: Parameters<OnCommandHandler>;
+    chat: Parameters<OnChatHandler>;
+    whisper: Parameters<OnWhisperHandler>;
+    messageDeleted: Parameters<OnMessageDeletedHandler>;
+    join: Parameters<OnJoinHandler>;
+    part: Parameters<OnPartHandler>;
+    hosted: Parameters<OnHostedHandler>;
+    raid: Parameters<OnRaidHandler>;
+    sub: Parameters<OnSubHandler>;
+    resub: Parameters<OnResubHandler>;
+    subGift: Parameters<OnSubGiftHandler>;
+    subMysteryGift: Parameters<OnSubMysteryGiftHandler>;
+    giftSubContinue: Parameters<OnGiftSubContinueHandler>;
+    cheer: Parameters<OnCheerHandler>;
+    chatMode: Parameters<OnChatModeHandler>;
+    reward: Parameters<OnRewardHandler>;
+    connected: Parameters<OnConnectedHandler>;
+    reconnect: Parameters<OnReconnectHandler>;
+};
+/**
+ * Creates and manages a ComfyJS instance for Twitch chat interaction.
+ */
+declare class useComfyJs extends EventProvider<ComfyEvents> {
+    instance: ComfyJSInstance;
+    username: string;
+    password?: string;
+    channels: string[];
+    isDebug: boolean;
+    private init;
+    emulate: boolean;
+    /**
+     * Initializes a new ComfyJS instance and connects to Twitch chat.
+     * @param options - Configuration options for ComfyJS instance.
+     * @param emulate - Whether to emulate chat messages in the Local  module.
+     */
+    constructor(options: {
+        username: string;
+        password?: string;
+        channels: string[];
+        isDebug?: boolean;
+        init?: boolean;
+    }, emulate: boolean);
+    /**
+     * Loads the ComfyJS script if not already loaded.
+     * @returns A promise that resolves to the ComfyJS instance.
+     */
+    private load;
+    /**
+     * Connects event handlers to the ComfyJS instance.
+     */
+    private connect;
+}
+
 type QueueEvents<T> = {
     load: [];
     cancel: [];
@@ -2026,7 +2082,7 @@ type QueueProps = {
 type QueueItem<T> = {
     value: T;
 } & QueueProps;
-type QueueProcessor<T> = (this: useQueue<T>, item: T, queue: useQueue<T>) => Promise<any>;
+type QueueProcessor<T> = (this: useQueue<T>, item: QueueItem<T>, queue: useQueue<T>) => Promise<any> | any;
 type QueueDuration = number | boolean | undefined;
 interface QueueOptions<T> {
     /**
@@ -2060,10 +2116,10 @@ declare class useQueue<T> extends EventProvider<QueueEvents<T>> {
     priorityQueue: QueueItem<T>[];
     history: QueueItem<T>[];
     private timeouts;
-    running: boolean;
     duration: QueueDuration;
-    private loaded;
     processor: QueueProcessor<T>;
+    running: boolean;
+    private loaded;
     private readonly clientWaitRetryDelay;
     constructor(options: QueueOptions<T>);
     private waitForClientAndBindLoad;
@@ -2111,7 +2167,11 @@ declare class useQueue<T> extends EventProvider<QueueEvents<T>> {
      * });
      * ```
      */
-    update(save: Partial<useQueue<T>>): this;
+    update(save: Partial<{
+        queue?: QueueItem<T>[];
+        priorityQueue?: QueueItem<T>[];
+        history?: QueueItem<T>[];
+    }>): this;
     /**
      * Cancel all pending timeouts and stop the queue from processing further items. This will clear any scheduled processing and prevent any new items from being processed until `resume()` is called again. The current state of the queue, priority queue, and history will be retained, allowing you to resume processing later without losing any data.
      */
@@ -2124,62 +2184,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 ComfyEvents = {
-    load: [instance: ComfyJSInstance];
-    error: Parameters<OnErrorHandler>;
-    command: Parameters<OnCommandHandler>;
-    chat: Parameters<OnChatHandler>;
-    whisper: Parameters<OnWhisperHandler>;
-    messageDeleted: Parameters<OnMessageDeletedHandler>;
-    join: Parameters<OnJoinHandler>;
-    part: Parameters<OnPartHandler>;
-    hosted: Parameters<OnHostedHandler>;
-    raid: Parameters<OnRaidHandler>;
-    sub: Parameters<OnSubHandler>;
-    resub: Parameters<OnResubHandler>;
-    subGift: Parameters<OnSubGiftHandler>;
-    subMysteryGift: Parameters<OnSubMysteryGiftHandler>;
-    giftSubContinue: Parameters<OnGiftSubContinueHandler>;
-    cheer: Parameters<OnCheerHandler>;
-    chatMode: Parameters<OnChatModeHandler>;
-    reward: Parameters<OnRewardHandler>;
-    connected: Parameters<OnConnectedHandler>;
-    reconnect: Parameters<OnReconnectHandler>;
-};
-/**
- * Creates and manages a ComfyJS instance for Twitch chat interaction.
- */
-declare class useComfyJs extends EventProvider<ComfyEvents> {
-    instance: ComfyJSInstance;
-    username: string;
-    password?: string;
-    channels: string[];
-    isDebug: boolean;
-    private init;
-    emulate: boolean;
-    /**
-     * Initializes a new ComfyJS instance and connects to Twitch chat.
-     * @param options - Configuration options for ComfyJS instance.
-     * @param emulate - Whether to emulate chat messages in the Local  module.
-     */
-    constructor(options: {
-        username: string;
-        password?: string;
-        channels: string[];
-        isDebug?: boolean;
-        init?: boolean;
-    }, emulate: boolean);
-    /**
-     * Loads the ComfyJS script if not already loaded.
-     * @returns A promise that resolves to the ComfyJS instance.
-     */
-    private load;
-    /**
-     * Connects event handlers to the ComfyJS instance.
-     */
-    private connect;
-}
-
 declare namespace Data {
     const avatars: string[];
     const badges: Twitch.GlobalBadge[];
@@ -2503,6 +2507,18 @@ declare class ElementHelper {
      * ```
      */
     CSS(element: HTMLElement | SVGElement, styles: Partial<Record<keyof CSSStyleProperties | `--${string}`, CSSValue>>): void;
+    /**
+     * Escapes special HTML characters in a string to prevent XSS attacks and ensure safe rendering in HTML contexts.
+     * @param value - The input string that may contain special HTML characters such as &, <, >, ", and '.
+     * @returns A new string with special HTML characters replaced by their corresponding HTML entities.
+     * @example
+     * ```javascript
+     * const unsafeString = '<script>alert("XSS")</script>';
+     * const safeString = escapeHtml(unsafeString);
+     * console.log(safeString); // Output: '&lt;script&gt;alert(&quot;XSS&quot;)&lt;/script&gt;'
+     * ```
+     */
+    escapeHtml(value: string): string;
 }
 type CSSValue = string | number | null | undefined;
 
@@ -3097,7 +3113,7 @@ declare class UtilsHelper {
         userId: string;
         name: string;
         broadcasterId?: string;
-    }, session: StreamElements.Session.Data, checkWithAPI?: boolean): Promise<1 | 2 | 3>;
+    }, session: StreamElements.Session.Data, checkWithAPI?: boolean): Promise<3 | 1 | 2>;
     /**
      * Identifies a user based on the received event and session data, returning their ID, name, role, badges, and top status.
      * @param receivedEvent - The event received from the provider (Twitch or YouTube) containing user information.
@@ -3881,4 +3897,4 @@ declare global {
 }
 
 export { Alejo, Button, Command, EventProvider, StreamElements, StreamElementsEvents, Twitch, TwitchEvents, YoutubeEvents, main as default, useComfyJs, useLogger, useQueue, useStorage };
-export type { BttvEmote, ClientCustomEventPayload, ClientCustomProviderEvents, ClientEventTuple, ClientEvents, ClientProviderEvents, Emoji, Emote, FfzEmote, JSONObject, JSONPrimitive, JSONSerializable, MapNumberValuesToString, NumberAsString, PathValue, Provider$1 as Provider, RequireAtLeastOne, SeventvEmote, TwitchEmote };
+export type { BttvEmote, ClientCustomEventPayload, ClientCustomProviderEvents, ClientEventTuple, ClientEvents, ClientProviderEvents, Emoji, Emote, FfzEmote, JSONObject, JSONPrimitive, JSONSerializable, MapNumberValuesToString, NumberAsString, PathValue, Provider$1 as Provider, QueueDuration, QueueItem, QueueOptions, QueueProcessor, QueueProps, RequireAtLeastOne, SeventvEmote, TwitchEmote };

package/dist/index.es.js

@@ -254,6 +254,16 @@ var e = Object.defineProperty, t = (t, n) => {
 			e.style.setProperty(t, a);
 		}
 	}
+	escapeHtml(e) {
+		let t = {
+			"&": "&",
+			"<": "&lt;",
+			">": "&gt;",
+			"\"": "&quot;",
+			"'": "&#39;"
+		};
+		return e.replace(/[&<>"']/g, (e) => t[e]);
+	}
 }, i = class {
 	flatten(e, t = !0, n = "") {
 		let r = {};
@@ -10874,7 +10884,7 @@ var H = class {
 	}
 }, W = class extends H {
 	constructor(e) {
-		if (super(), this.queue = [], this.priorityQueue = [], this.history = [], this.timeouts = [], this.running = !1, this.duration = void 0, this.loaded = !1, this.clientWaitRetryDelay = 50, !e.processor || typeof e.processor != "function") throw Error("A valid processor function must be provided to useQueue.");
+		if (super(), this.queue = [], this.priorityQueue = [], this.history = [], this.timeouts = [], this.duration = void 0, this.running = !1, this.loaded = !1, this.clientWaitRetryDelay = 50, !e.processor || typeof e.processor != "function") throw Error("A valid processor function must be provided to useQueue.");
 		this.processor = e.processor, e.duration !== "client" && (this.duration = e.duration ?? 0), this.waitForClientAndBindLoad(e.duration);
 	}
 	waitForClientAndBindLoad(e = this.duration, t) {
@@ -10922,7 +10932,7 @@ var H = class {
 			return;
 		}
 		try {
-			await this.processor.apply(this, [e.value, this]), this.emit("process", e, this);
+			await this.processor.apply(this, [e, this]), this.emit("process", e, this);
 		} catch (e) {
 			console.error(`Error during item processing: ${e instanceof Error ? e.message : String(e)}`);
 		}
@@ -12544,7 +12554,7 @@ var K = new class {
 	}
 }(), q = new W({
 	duration: "client",
-	processor: async function(e) {
+	processor: async function({ value: e }) {
 		if (window.dispatchEvent(new CustomEvent(e.listener, { detail: e.data })), e.listener === "onEventReceived" && e.session) {
 			let t = await K.event.onSessionUpdate(N?.[0] ? N[0].session : void 0, B.event.parseProvider(e.data));
 			window.dispatchEvent(new CustomEvent("onSessionUpdate", { detail: t }));