@tixyel/streamelements 6.0.3 → 6.1.0

package/dist/index.d.ts

@@ -1740,15 +1740,12 @@ type UseStorageOptions<T> = {
     data: T;
 };
 declare class useStorage<T extends JSONObject> extends EventProvider<UseStorageEvents<T>> {
-    /**
-     * The unique identifier for the storage instance.
-     */
+    private SE_API;
+    /** The unique identifier for the storage instance. */
     id: string;
     loaded: boolean;
     data: T;
     constructor(options: UseStorageOptions<T>);
-    SE_API: StreamElements.SE_API | null;
-    private start;
     /**
      * Saves the current data to storage.
      * @param data Data to save (defaults to current)
@@ -2829,6 +2826,58 @@ declare namespace Data {
     }[];
 }
 
+type MessageMap = Record<string, any>;
+type MessageTuple<T extends MessageMap> = {
+    [K in keyof T]: [key: K, data: T[K]];
+}[keyof T];
+type BaseEvents<T extends MessageMap> = {
+    load: [];
+    message: MessageTuple<T>;
+};
+type UseCommsOptions = {
+    id?: string;
+};
+type UseCommItem<T extends MessageMap> = {
+    nonce: string;
+    key: keyof T;
+    value: T[keyof T];
+    timestamp: string;
+};
+/**
+ * A module for handling communications between different widgets inside streamelements.
+ * @example
+ * ```ts
+ * type CommsMessages = {
+ *   hello: { loaded: boolean };
+ *   update: { value: number };
+ *   reload: {};
+ *   tags: string[];
+ * }
+ *
+ * const comms = new useComms<CommsMessages>();
+ *
+ * comms.on('message', (message, data) => {
+ *   switch (message) {
+ *     case 'hello': {}
+ *     case 'update': {}
+ *     case 'reload': {}
+ *     case 'tags': {}
+ *   }
+ * })
+ * ```
+ */
+declare class useComms<T extends MessageMap> extends EventProvider<BaseEvents<T>> {
+    private SE_API;
+    id: string;
+    loaded: boolean;
+    private history;
+    private detected;
+    constructor(options?: UseCommsOptions);
+    send<K extends keyof T>(key: K, data: T[K]): Promise<void>;
+    update(history: Array<UseCommItem<T>>): void;
+    on<K extends keyof BaseEvents<T>>(eventName: K, callback: (this: useComms<T>, ...args: BaseEvents<T>[K]) => void): this;
+}
+
 declare const main: {
     SeAPI: Promise<StreamElements.SE_API>;
     Client: typeof Client;
@@ -2841,6 +2890,7 @@ declare const main: {
         useStorage: typeof useStorage;
         useQueue: typeof useQueue;
         useLogger: typeof useLogger;
+        useComms: typeof useComms;
     };
     actions: {
         Button: typeof Button;
@@ -2851,6 +2901,7 @@ declare const main: {
     };
     data: {
         usedStorages: useStorage<any>[];
+        usedComms: useComms<any>[];
     };
     pronouns: {
         Alejo: typeof Alejo;