@tixyel/streamelements 3.2.0 → 3.3.0

package/dist/index.d.ts

@@ -607,6 +607,26 @@ declare class EventProvider<EventMap extends Record<string, any[]> = Record<stri
     removeAllListeners<K extends keyof EventMap>(eventName: K): this;
 }
 
+type SE_API = {
+    responses: Record<string, any>;
+    sendMessage: (message: string, data: object) => void;
+    counters: {
+        get: (key: string) => number | null;
+    };
+    store: {
+        get: <T>(key: string) => Promise<T | null>;
+        set: <T>(key: string, value: T) => void;
+    };
+    resumeQueue: () => void;
+    sanitize: (message: string) => string;
+    cheerFilter: (message: string) => string;
+    setField: (key: string, value: string | number | boolean | undefined, reload: boolean) => void;
+    getOverlayStatus: () => {
+        isEditorMode: boolean;
+        muted: boolean;
+    };
+};
+
 type PathValue<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? PathValue<T[K], Rest> : never : P extends keyof T ? T[P] : never;
 type NumberAsString<T extends number | bigint | string> = ReturnType<T['toString']>;
 type MapNumberValuesToString<T> = {
@@ -629,6 +649,8 @@ declare class useStorage<T extends object = Record<string, any>> extends EventPr
     loaded: boolean;
     data: T;
     constructor(options: UseStorageOptions<T>);
+    SE_API: SE_API | null;
+    private start;
     /**
      * Saves the current data to storage.
      * @param data Data to save (defaults to current)
@@ -1772,6 +1794,7 @@ 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;
 }
 
+declare const USE_SE_API: Promise<SE_API>;
 declare const Tixyel: {
     readonly Client: typeof Client;
     readonly Simulation: typeof Simulation;
@@ -1787,6 +1810,7 @@ declare const Tixyel: {
         readonly useStorage: typeof useStorage;
         readonly useQueue: typeof useQueue;
     };
+    readonly USE_SE_API: Promise<SE_API>;
 };
 type _Tixyel_ = typeof Tixyel;
 declare global {
@@ -1799,10 +1823,10 @@ declare global {
         onSessionUpdate: onSessionUpdateEvent;
         onEventReceived: onEventReceivedEvent;
     }
-    var Tixyel: _Tixyel_;
+    const Tixyel: _Tixyel_;
     var client: Client;
-    var SE_API: SE_API;
+    const SE_API: SE_API;
 }
 
-export { Alejo$Pronouns, Tixyel };
+export { Alejo$Pronouns, Tixyel, USE_SE_API };
 export type { Alejo$Pronouns$User, Alejo$Pronouns$display, Alejo$Pronouns$name, BttvEmote, ClientEvents$1 as ClientEvents, Facebook, Kick, Provider, SeventvEmote, StreamElements, Twitch, Twitch$Cheer, Twitch$DeleteMessage, Twitch$DeleteMessages, Twitch$Follower, Twitch$IRC, Twitch$Message, Twitch$Raid, Twitch$Subscriber, TwitchBadge, TwitchBadgesKeys, TwitchEmote, Youtube };