@rocketman-streamkit/types 1.0.4 → 1.0.6

package/README.md

@@ -14,7 +14,7 @@ API reference, manifest format, permissions, and addon categories are published
 
 **[github.com/RocketMan-StreamKit/types](https://github.com/RocketMan-StreamKit/types)**
 
-Open the branch that matches your target app version (for example `1.0.0`) and start from [`index.md`](https://github.com/RocketMan-StreamKit/types/blob/1.0.0/index.md).
+Open the branch that matches your target app version (for example `1.0.6`) and start from [`index.md`](https://github.com/RocketMan-StreamKit/types/blob/1.0.6/index.md).
 
 This npm package provides **TypeScript typings only**; the docs repo is the full written guide.
 

package/addon.d.ts

@@ -103,6 +103,60 @@ declare global {
     sourceAddonId?: string;
   };
 
+  type OverlayTriggerType = | 'donation'
+    | 'subscribe'
+    | 'subgift'
+    | 'follow'
+    | 'custom';
+
+  type OverlayEventTrigger = {
+    type: OverlayTriggerType;
+    key?: string;
+    value?: string | number | boolean;
+  };
+
+  /**
+   * Currency code key from the built-in exchange rates table.
+   */
+  type CurrencyCode = string;
+
+  type DashboardRecordType = | 'donation'
+    | 'subscribe'
+    | 'follow'
+    | 'custom'
+    | 'timer';
+
+  type DashboardRecordValue = {
+    id: string;
+    type: DashboardRecordType;
+    amount?: [number, CurrencyCode];
+    platform: string;
+    message?: DashboardLocalizedString;
+    from?: string;
+    attach?: { type: string; value: string }[];
+  };
+
+  /**
+   * Payload delivered to addons subscribed via `dashboard.onRecord`.
+   */
+  type DashboardRecordIncomingPayload = {
+    id: string;
+    created: number;
+    updated: number;
+    record: DashboardRecordValue;
+    user?: {
+      id: string;
+      name: string;
+      avatar: string;
+      platform: string;
+      color?: string;
+      icons?: string[];
+    };
+    sourceAddonId?: string;
+    /** Trigger entries used for overlay/sound/hotkey/timer matching. */
+    triggers?: OverlayEventTrigger[];
+  };
+
   type AddonConfigFieldType = | 'text'
     | 'color'
     | 'number'
@@ -350,6 +404,19 @@ declare global {
        * @requires AddonsPermission.NOTIFY
        */
       Send: (payload: { id?: string | undefined; type?: "error" | "success" | "info" | "warning" | undefined; title?: DashboardLocalizedString | undefined; message: DashboardLocalizedString; temp?: boolean | undefined; }) => void;
+      /**
+       * Removes a notification previously created by this addon.
+      Notifications from other addons or the main process are ignored.
+       * @requires AddonsPermission.NOTIFY
+       * @param id Notification record id (same value passed to `Send`).
+       * @example notify.Send({
+        id: `${data.id}_status`,
+        type: 'success',
+        message: { en: 'Connected' },
+      });
+      notify.Remove(`${data.id}_status`);
+       */
+      Remove: (id: string) => void;
     };
     /**
      * Permission helpers for the running addon instance.
@@ -984,6 +1051,24 @@ declare global {
        * @requires AddonsPermission.DASHBOARD_CHAT_INCOMING
        */
       offChatMessage: () => Promise<unknown>;
+      /**
+       * Subscribes to new event records shown in the latest-events dashboard widget.
+      The handler receives the stored record (including system `attach` entries
+      for matched overlays, sounds, hotkeys, and timers), resolved user info,
+      trigger entries used for matching, and the source addon id (if any).
+      Unlike chat incoming, the source addon also receives its own records so it
+      can inspect match results after `dashboard.addRecord`.
+       * @requires AddonsPermission.DASHBOARD_EVENTS_INCOMING
+       * @example dashboard.onRecord(payload => {
+        console.log(payload.record.type, payload.record.attach, payload.sourceAddonId);
+      });
+       */
+      onRecord: (handler: (payload: DashboardRecordIncomingPayload) => void | Promise<void>) => Promise<unknown>;
+      /**
+       * Unsubscribes from incoming dashboard event records.
+       * @requires AddonsPermission.DASHBOARD_EVENTS_INCOMING
+       */
+      offRecord: () => Promise<unknown>;
     };
     /**
      * Game integration API for `manifest.type: "game"` addons.
@@ -1144,6 +1229,10 @@ declare global {
    * Receive new chat messages from the chat dashboard window
    */
     | 'DASHBOARD_CHAT_INCOMING'
+  /**
+   * Receive new event records from the latest-events dashboard widget
+   */
+    | 'DASHBOARD_EVENTS_INCOMING'
   /**
    * Create Socket.IO namespaces for addon web pages and external clients
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketman-streamkit/types",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "TypeScript declarations for the StreamKit+ integration addon sandbox API",
   "types": "addon.d.ts",
   "files": [