@tixyel/streamelements 3.0.0 → 3.1.0

package/README.md

@@ -1,40 +1,40 @@
-# @tixyel/streamelements
-
-TypeScript/JavaScript helper library for building custom widgets for [StreamElements](https://streamelements.com/), focused on productivity, type safety, and local development. Designed for browser usage via CDN, with TypeScript types for IDE autocompletion.
-
-## Features
-
-- **Typed event helpers** for Twitch, YouTube, and Kick (in development)
-- **Utility functions** for common widget tasks
-- **TypeScript types** for all major StreamElements events
-- **Local development support**: Test your widget locally without uploading to StreamElements
-- **Easy integration**: Use directly in the browser via CDN
-
-## Usage
-
-Add the following to your HTML:
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@tixyel/streamelements"></script>
-<script>
-  const { Client, Simulation, logger } = window.Tixyel;
-
-  new Client({ id: 'my-widget' }).on('load', (event) => {
-    logger.received('Widget loaded!', event);
-  });
-</script>
-```
-
-> **Note:** This package is designed for browser usage via CDN only.
-> TypeScript is used only to provide type definitions and autocompletion in your IDE when working with `window.Tixyel`.
-
-## API Overview
-
-- **Client**: Manages events and integration with StreamElements.
-- **Simulation**: Simulates events for local testing.
-- **Logger**: Utility for formatted logs.
-- **Button/Command**: Helpers for custom actions.
-
-## License
-
-Apache-2.0
+# @tixyel/streamelements
+
+TypeScript/JavaScript helper library for building custom widgets for [StreamElements](https://streamelements.com/), focused on productivity, type safety, and local development. Designed for browser usage via CDN, with TypeScript types for IDE autocompletion.
+
+## Features
+
+- **Typed event helpers** for Twitch, YouTube, and Kick (in development)
+- **Utility functions** for common widget tasks
+- **TypeScript types** for all major StreamElements events
+- **Local development support**: Test your widget locally without uploading to StreamElements
+- **Easy integration**: Use directly in the browser via CDN
+
+## Usage
+
+Add the following to your HTML:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@tixyel/streamelements"></script>
+<script>
+  const { Client, Simulation, logger } = window.Tixyel;
+
+  new Client({ id: 'my-widget' }).on('load', (event) => {
+    logger.received('Widget loaded!', event);
+  });
+</script>
+```
+
+> **Note:** This package is designed for browser usage via CDN only.
+> TypeScript is used only to provide type definitions and autocompletion in your IDE when working with `window.Tixyel`.
+
+## API Overview
+
+- **Client**: Manages events and integration with StreamElements.
+- **Simulation**: Simulates events for local testing.
+- **Logger**: Utility for formatted logs.
+- **Button/Command**: Helpers for custom actions.
+
+## License
+
+Apache-2.0

package/dist/index.d.ts

@@ -654,7 +654,7 @@ declare class useStorage<T extends object = Record<string, any>> extends EventPr
      * @returns The updated object
      */
     static setByPath<P extends string, T extends object>(obj: T, path: P, value: PathValue<T, P>): void;
-    on<K extends keyof UseStorageEvents<T>>(eventName: K, callback: (...args: UseStorageEvents<T>[K]) => void): this;
+    on<K extends keyof UseStorageEvents<T>>(eventName: K, callback: (this: useStorage<T>, ...args: UseStorageEvents<T>[K]) => void): this;
 }
 
 type StreamElements$AlertService = {
@@ -1297,7 +1297,7 @@ interface CommandOptions {
     name: string;
     description?: string;
     arguments?: boolean;
-    run: () => void;
+    run: (this: Client, args: string[], event: CommandEvent) => void;
     test?: string;
     aliases?: string[];
     permissions?: string[];
@@ -1344,10 +1344,10 @@ declare class Button {
 }
 
 type ClientEvents = {
-    load: [this: Client, event: onWidgetLoad];
-    action: [this: Client, action: Button | Command, type: 'created' | 'executed'];
-    session: [this: Client, session: Session$1];
-    event: [this: Client, event: ClientEvents$1];
+    load: [event: onWidgetLoad];
+    action: [action: Button | Command, type: 'created' | 'executed'];
+    session: [session: Session$1];
+    event: [event: ClientEvents$1];
 };
 type ClientOptions = {
     id?: string;
@@ -1385,7 +1385,7 @@ declare class Client extends EventProvider<ClientEvents> {
         pronoun: number;
         emote: number;
     };
-    on<K extends keyof ClientEvents>(eventName: K, callback: (...args: ClientEvents[K]) => void): this;
+    on<K extends keyof ClientEvents>(eventName: K, callback: (this: Client, ...args: ClientEvents[K]) => void): this;
 }
 
 type TwitchBadge = {