@tixyel/streamelements 6.2.2 → 6.4.0

package/dist/index.d.ts

@@ -5,6 +5,7 @@
  */
 
 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';
 
 declare namespace YoutubeEvents {
     namespace Message {
@@ -1666,6 +1667,42 @@ declare class Button {
     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;
+}
+
 /**
  * EventProvider class for managing event listeners and emitters.
  * This class allows you to register event listeners, emit events, and manage event subscriptions.
@@ -2019,6 +2056,62 @@ 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 Helper {
     namespace number {
         /**
@@ -2616,7 +2709,7 @@ declare namespace Helper {
 }
 
 declare namespace Local {
-    type Queue = useQueue<{
+    type QueueItem = {
         listener: 'onEventReceived';
         data: StreamElements.Event.onEventReceived;
         session?: boolean;
@@ -2626,9 +2719,9 @@ declare namespace Local {
     } | {
         listener: 'onSessionUpdate';
         data: StreamElements.Event.onSessionUpdate;
-    }>;
-    export var queue: Queue | undefined;
-    export const generate: {
+    };
+    const queue: useQueue<QueueItem>;
+    const generate: {
         session: {
             types: Record<string, StreamElements.Session.Config.Any>;
             available(): StreamElements.Session.Config.Available.Data;
@@ -2667,7 +2760,7 @@ declare namespace Local {
             onEventReceived(provider?: Provider$1 | "random", type?: StreamElements.Event.onEventReceived["listener"] | "random" | "tip" | "cheer" | "follower" | "raid" | "subscriber", options?: Record<string, string | number | boolean>): Promise<StreamElements.Event.onEventReceived | null>;
         };
     };
-    export const emulate: {
+    const emulate: {
         twitch: {
             message(data?: Partial<{
                 name: string;
@@ -2752,100 +2845,7 @@ declare namespace Local {
         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;
     };
-    export function start(fieldsFile?: string[], dataFiles?: string[], session?: StreamElements.Session.Data): Promise<void>;
-    export {};
-}
-
-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;
-}
-
-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;
+    function start(fieldsFile?: string[], dataFiles?: string[], session?: StreamElements.Session.Data): Promise<void>;
 }
 
 declare namespace Data {