@tixyel/streamelements 3.9.0 → 4.0.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { ComfyJSInstance, OnErrorHandler, OnCommandHandler, OnChatHandler, OnWhisperHandler, OnMessageDeletedHandler, OnJoinHandler, OnPartHandler, OnHostedHandler, OnRaidHandler, OnSubHandler, OnResubHandler, OnSubGiftHandler, OnSubMysteryGiftHandler, OnGiftSubContinueHandler, OnCheerHandler, OnChatModeHandler, OnRewardHandler, OnConnectedHandler, OnReconnectHandler } from 'comfy.js';
+
 type TwitchEmote = {
     type: 'twitch';
     name: string;
@@ -1953,22 +1955,82 @@ declare namespace Simulation {
     };
     export const emulate: {
         twitch: {
-            message(data?: Record<string, string | number | boolean>): void;
-            follower(data?: Record<string, string | number | boolean>): void;
-            raid(data?: Record<string, string | number | boolean>): void;
-            cheer(data?: Record<string, string | number | boolean>): void;
-            subscriber(data?: Record<string, string | number | boolean> & {
+            message(data?: Partial<{
+                name: string;
+                message: string;
+                badges: BadgeOptions;
+                color: string;
+                userId: string;
+                msgId: string;
+                channel: string;
+                time: number;
+            }>): void;
+            deleteMessage(msgId: string): void;
+            deleteMessages(userId: string): void;
+            follower(data?: Partial<{
+                avatar: string;
+                name: string;
+            }>): void;
+            raid(data?: Partial<{
+                amount: number;
+                avatar: string;
+                name: string;
+            }>): void;
+            cheer(data?: Partial<{
+                amount: number;
+                avatar: string;
+                name: string;
+                message: string;
+            }>): void;
+            subscriber(data?: Partial<{
+                tier: "1000" | "2000" | "3000" | "prime";
+                amount: number;
+                avatar: string;
+                name: string;
+                sender: string;
+                message: string;
+                subType: "default" | "gift" | "community" | "spam";
+            }> & {
                 subType?: "default" | "gift" | "community" | "spam";
             }): void;
         };
         streamelements: {
-            tip(data?: Record<string, string | number | boolean>): void;
+            tip(data?: Partial<{
+                amount: number;
+                avatar: string;
+                name: string;
+            }>): void;
         };
         youtube: {
-            message(data?: Record<string, string | number | boolean>): void;
-            subscriber(data?: Record<string, string | number | boolean>): void;
-            superchat(data?: Record<string, string | number | boolean>): void;
-            sponsor(data?: Record<string, string | number | boolean> & {
+            message(data?: Partial<{
+                name: string;
+                message: string;
+                badges: BadgeOptions;
+                color: string;
+                userId: string;
+                msgId: string;
+                channel: string;
+                time: number;
+                avatar: string;
+            }>): void;
+            subscriber(data?: Partial<{
+                avatar: string;
+                name: string;
+            }>): void;
+            superchat(data?: Partial<{
+                amount: number;
+                avatar: string;
+                name: string;
+            }>): void;
+            sponsor(data?: Partial<{
+                tier: "1000" | "2000" | "3000";
+                amount: number;
+                avatar: string;
+                name: string;
+                sender: string;
+                message: string;
+                subType: "default" | "gift" | "community" | "spam";
+            }> & {
                 subType?: "default" | "gift" | "community" | "spam";
             }): void;
         };
@@ -2042,6 +2104,60 @@ declare class useStorage<T extends Record<string, any>> extends EventProvider<Us
     on<K extends keyof UseStorageEvents<T>>(eventName: K, callback: (this: useStorage<T>, ...args: UseStorageEvents<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;
+    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 Simulation module.
+     */
+    constructor(options: {
+        username: string;
+        password?: string;
+        channels: string[];
+        isDebug?: 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 ButtonOptions {
     field: string | ((field: string, value: string | boolean | number) => boolean);
     template?: string;
@@ -2250,6 +2366,7 @@ declare const Tixyel: {
         readonly Button: typeof Button;
         readonly Command: typeof Command;
         readonly EventProvider: typeof EventProvider;
+        readonly useComfyJs: typeof useComfyJs;
         readonly useStorage: typeof useStorage;
         readonly useQueue: typeof useQueue;
         readonly Logger: typeof Logger;
@@ -2263,6 +2380,7 @@ declare global {
     interface Window {
         Tixyel: Main;
         client: Client;
+        ComfyJS?: ComfyJSInstance;
     }
     interface WindowEventMap {
         onWidgetLoad: CustomEvent<StreamElements.Event.onWidgetLoad>;