@tixyel/streamelements 7.5.1 → 7.6.0

package/README.md

@@ -19,9 +19,11 @@ Add the following to your HTML:
 <script>
   const { Client, Simulation, logger } = window.Tixyel;
 
-  new Client({ id: 'my-widget' }).on('load', (event) => {
-    logger.received('Widget loaded!', event);
-  });
+  const client = new Client({ id: 'my-widget' })
+
+  client.on('load', (event) => {})
+  client.on('event', (provider, event) => {})
+  client.on('session', (session) => {})
 </script>
 ```
 

package/dist/index.d.ts

@@ -8,22 +8,33 @@ import { ComfyJSInstance, OnErrorHandler, OnCommandHandler, OnChatHandler, OnWhi
 export { ComfyJSInstance } from 'comfy.js';
 
 type Provider$1 = 'twitch' | 'youtube' | 'kick' | 'facebook' | 'streamelements';
-type ClientEvents$1 = {
-    provider: 'streamelements';
-    data: StreamElements.Event.Provider.StreamElements.Events;
-} | {
-    provider: 'twitch';
-    data: StreamElements.Event.Provider.Twitch.Events;
-} | {
-    provider: 'youtube';
-    data: StreamElements.Event.Provider.YouTube.Events;
-} | {
-    provider: 'kick';
-    data: StreamElements.Event.Provider.Kick.Events;
-} | {
-    provider: 'facebook';
-    data: StreamElements.Event.Provider.Facebook.Events;
+type ClientProviderEvents = {
+    streamelements: StreamElements.Event.Provider.StreamElements.Events;
+    twitch: StreamElements.Event.Provider.Twitch.Events;
+    youtube: StreamElements.Event.Provider.YouTube.Events;
+    kick: StreamElements.Event.Provider.Kick.Events;
+    facebook: StreamElements.Event.Provider.Facebook.Events;
 };
+type ClientCustomEventPayload = {
+    provider: 'custom';
+};
+type ClientCustomProviderEvents = Record<string, ClientCustomEventPayload>;
+type ValidateCustomProviderEvents<CustomEvents> = CustomEvents extends Record<string, unknown> ? {
+    [K in keyof CustomEvents]: CustomEvents[K] extends ClientCustomEventPayload ? CustomEvents[K] : never;
+} : {};
+type ClientAllProviderEvents<CustomEvents = {}> = ClientProviderEvents & ValidateCustomProviderEvents<CustomEvents>;
+type ClientEvents<CustomEvents = {}> = {
+    [K in keyof ClientAllProviderEvents<CustomEvents> & string]: {
+        provider: K;
+        data: ClientAllProviderEvents<CustomEvents>[K];
+    };
+}[keyof ClientAllProviderEvents<CustomEvents> & string];
+type ClientEventTuple<CustomEvents = {}> = {
+    [K in keyof ClientAllProviderEvents<CustomEvents> & string]: [
+        provider: K,
+        event: ClientAllProviderEvents<CustomEvents>[K]
+    ];
+}[keyof ClientAllProviderEvents<CustomEvents> & string];
 
 declare namespace StreamElementsEvents {
     namespace Tip {
@@ -1860,11 +1871,11 @@ declare namespace Alejo {
     function get(username: string): Promise<Pronouns.name | undefined>;
 }
 
-type ClientEvents = {
+type ClientMapEvents<CustomEvents = {}> = {
     load: [event: StreamElements.Event.onWidgetLoad];
     action: [action: Button | Command, type: 'created' | 'executed' | 'removed'];
     session: [session: StreamElements.Session.Data];
-    event: [provider: 'streamelements', event: StreamElements.Event.Provider.StreamElements.Events] | [provider: 'twitch', event: StreamElements.Event.Provider.Twitch.Events] | [provider: 'youtube', event: StreamElements.Event.Provider.YouTube.Events] | [provider: 'kick', event: StreamElements.Event.Provider.Kick.Events] | [provider: 'facebook', event: StreamElements.Event.Provider.Facebook.Events];
+    event: ClientEventTuple<CustomEvents>;
 };
 type ClientStorageOptions<T> = {
     value: T;
@@ -1881,7 +1892,7 @@ type ClientOptions = {
     id?: string;
     debug?: boolean | (() => boolean);
 };
-declare class Client extends EventProvider<ClientEvents> {
+declare class Client<CustomEvents = {}> extends EventProvider<ClientMapEvents<CustomEvents>> {
     id: string;
     debug: boolean;
     storage: useStorage<ClientStorage>;
@@ -1913,7 +1924,7 @@ declare class Client extends EventProvider<ClientEvents> {
          */
         emote: number;
     };
-    on<K extends keyof ClientEvents>(eventName: K, callback: (this: Client, ...args: ClientEvents[K]) => void): this;
+    on<K extends keyof ClientMapEvents<CustomEvents>>(eventName: K, callback: (this: Client<CustomEvents>, ...args: ClientMapEvents<CustomEvents>[K]) => void): this;
 }
 
 type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
@@ -2742,7 +2753,7 @@ declare class EventHelper {
      * @param detail - The event detail object received from the StreamElements event.
      * @returns An object containing the provider and the original event data.
      */
-    parseProvider(detail: StreamElements.Event.onEventReceived, overrideProvider?: Provider$1): ClientEvents$1;
+    parseProvider(detail: StreamElements.Event.onEventReceived, overrideProvider?: Provider$1): ClientEvents;
 }
 
 type Modifier = (value: string, param: string | null | undefined, values: {
@@ -3490,7 +3501,7 @@ declare function onWidgetLoad(fields: Record<string, StreamElements.CustomField.
  * @param session - The session data to be included in the event.
  * @returns A Promise that resolves to the simulated onSessionUpdate event data.
  */
-declare function onSessionUpdate(session?: StreamElements.Session.Data, update?: ClientEvents$1): Promise<StreamElements.Event.onSessionUpdate>;
+declare function onSessionUpdate(session?: StreamElements.Session.Data, update?: ClientEvents): Promise<StreamElements.Event.onSessionUpdate>;
 /**
  * Simulates the onEventReceived event for a widget.
  * @param provider - The provider of the event (default is 'random').
@@ -3641,6 +3652,30 @@ declare class useComms<T extends MessageMap> extends EventProvider<BaseEvents<T>
     on<K extends keyof BaseEvents<T>>(eventName: K, callback: (this: useComms<T>, ...args: BaseEvents<T>[K]) => void): this;
 }
 
+declare const usedClients: Client[];
+declare const usedStorages: Array<useStorage<any>>;
+declare const usedComms: Array<useComms<any>>;
+declare const usedCommands: Command[];
+declare const usedButtons: Button[];
+declare const fakeUserPools: FakeUserPool[];
+
+declare const internals_fakeUserPools: typeof fakeUserPools;
+declare const internals_usedButtons: typeof usedButtons;
+declare const internals_usedClients: typeof usedClients;
+declare const internals_usedCommands: typeof usedCommands;
+declare const internals_usedComms: typeof usedComms;
+declare const internals_usedStorages: typeof usedStorages;
+declare namespace internals {
+  export {
+    internals_fakeUserPools as fakeUserPools,
+    internals_usedButtons as usedButtons,
+    internals_usedClients as usedClients,
+    internals_usedCommands as usedCommands,
+    internals_usedComms as usedComms,
+    internals_usedStorages as usedStorages,
+  };
+}
+
 declare const main: {
     SeAPI: Promise<StreamElements.SE_API>;
     Client: typeof Client;
@@ -3663,13 +3698,7 @@ declare const main: {
     multistream: {
         useComfyJs: typeof useComfyJs;
     };
-    internal: {
-        usedStorages: useStorage<any>[];
-        usedComms: useComms<any>[];
-        usedCommands: Command[];
-        usedButtons: Button[];
-        fakeUserPools: FakeUserPool[];
-    };
+    internal: typeof internals;
     pronouns: {
         Alejo: typeof Alejo;
     };
@@ -3678,7 +3707,6 @@ declare const main: {
 declare global {
     interface Window {
         Tixyel: typeof main;
-        client: InstanceType<typeof main.Client> | undefined;
         ComfyJS?: ComfyJSInstance;
     }
     interface WindowEventMap {
@@ -3687,9 +3715,8 @@ declare global {
         onEventReceived: CustomEvent<StreamElements.Event.onEventReceived>;
     }
     const Tixyel: typeof main;
-    let client: InstanceType<typeof main.Client> | undefined;
     const SE_API: StreamElements.SE_API;
 }
 
 export { Alejo, Button, Command, EventProvider, StreamElements, StreamElementsEvents, Twitch, TwitchEvents, YoutubeEvents, main as default, useComfyJs, useLogger, useQueue, useStorage };
-export type { BttvEmote, ClientEvents$1 as ClientEvents, 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, RequireAtLeastOne, SeventvEmote, TwitchEmote };