@rocketman-streamkit/types 1.0.7 → 1.0.9

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.7`) and start from [`index.md`](https://github.com/RocketMan-StreamKit/types/blob/1.0.7/index.md).
+Open the branch that matches your target app version (for example `1.0.9`) and start from [`index.md`](https://github.com/RocketMan-StreamKit/types/blob/1.0.9/index.md).
 
 This npm package provides **TypeScript typings only**; the docs repo is the full written guide.
 

package/addon.d.ts

@@ -65,6 +65,37 @@ declare global {
     | [LangData, ...(string | number)[]]
     | DashboardLocalizedText;
 
+  type AddonLocalizedString = Partial<Record<AddonConfigLang, string>>;
+
+  /**
+   * Predefined icon names for chat message style headers.
+   */
+  type DashboardChatMessageStyleIcon = | 'exclamation'
+    | 'question'
+    | 'megaphone'
+    | 'list';
+
+  /**
+   * Addon-facing style (no app `LangData` tuple in `header`).
+   */
+  type AddonDashboardChatMessageStyle = {
+    color: string;
+    header?: AddonLocalizedString | string;
+    icon?: DashboardChatMessageStyleIcon;
+  };
+
+  /**
+   * Optional visual frame around a chat message (border + optional header).
+   */
+  type DashboardChatMessageStyle = {
+    /** Border and header background color (CSS color, e.g. hex). */
+    color: string;
+    /** Header text; when omitted only the border is shown. */
+    header?: DashboardLocalizedString;
+    /** Icon displayed next to the header text. */
+    icon?: DashboardChatMessageStyleIcon;
+  };
+
   type DashboardChatEmote = {
     /** Exact text token as it appears in chat (case-sensitive). */
     word: string;
@@ -75,13 +106,28 @@ declare global {
   type DashboardChatMessageValue = {
     id: string;
     content: DashboardLocalizedString;
-    platform: string;
+    /** Optional visual frame (border + optional header). */
+    style?: DashboardChatMessageStyle;
+    /**
+     * When `true`, the message is a system line (not from a platform user).
+     * System messages use `addonId` / `sender` instead of `platform` / `from`.
+     */
+    system?: boolean;
+    /** User message: platform registered via `dashboard.registerPlatform`. */
+    platform?: string;
+    /** User message: author user id (details in `DashboardRecordUsers`). */
     from?: string;
     /**
      * Emotes extracted from message payload (e.g. Twitch fragments).
      * Used by the chat UI to render emote images even without registration.
      */
     emotes?: DashboardChatEmote[];
+    /**
+     * System message: addon id when sent by an addon; omitted = app system message.
+     */
+    addonId?: string;
+    /** System message: optional sender display name. */
+    sender?: DashboardLocalizedString;
   };
 
   /**
@@ -168,8 +214,6 @@ declare global {
     | 'folder'
     | 'file';
 
-  type AddonLocalizedString = Partial<Record<AddonConfigLang, string>>;
-
   /**
    * Options for folder/file picker fields in `GenerateConfig`.
    */
@@ -1050,11 +1094,24 @@ declare global {
       addRecord: (record: { id?: string | undefined; type: "donation" | "subscribe" | "follow" | "custom" | "timer"; amount?: [number, string] | undefined; platform: string; message?: DashboardLocalizedString | undefined; from?: string | undefined; attach?: { type: string; value: string; }[] | undefined; }, user: { id: string; name: string; avatar?: string | undefined; platform: string; color?: string | undefined; icons?: string[] | undefined; } | undefined, options: { trigger?: { type: "donation" | "subscribe" | "subgift" | "follow" | "custom"; key?: string | undefined; value?: string | number | boolean | undefined; } | undefined; triggers?: { type: "donation" | "subscribe" | "subgift" | "follow" | "custom"; key?: string | undefined; value?: string | number | boolean | undefined; }[] | undefined; } | undefined) => Promise<unknown>;
       /**
        * Pushes a chat line into the chat dashboard window.
-      `content` accepts the same formats as `addRecord` `message`: plain
-      string, `[LangData, ...args]` tuple, or `{ en, ru?, uk? }` object.
+      `content` accepts plain string or `{ en, ru?, uk? }` object.
+      Optional `style` adds a colored border and optional header bar.
+       * @requires AddonsPermission.DASHBOARD_CHAT
+       */
+      addChatMessage: (message: { id?: string | undefined; content: string | Partial<Record<AddonConfigLang, string>>; platform: string; from?: string | undefined; emotes?: { word: string; url: string; }[] | undefined; style?: AddonDashboardChatMessageStyle | undefined; }, user: { id: string; name: string; avatar?: string | undefined; platform: string; color?: string | undefined; icons?: string[] | undefined; } | undefined) => Promise<unknown>;
+      /**
+       * Pushes a system chat line (not from a platform user) into the chat window.
+      The message is attributed to this addon (addon icon in the UI).
+      `content` and optional `sender` accept plain string or `{ en, ru?, uk? }`.
+      Optional `style` adds a colored border and optional header bar.
        * @requires AddonsPermission.DASHBOARD_CHAT
+       * @example await dashboard.addSystemChatMessage({
+        content: { en: 'Connected to chat', ru: 'Подключено к чату' },
+        sender: { en: 'Twitch addon' },
+        style: { color: '#4caf50', header: { en: 'Notice' }, icon: 'megaphone' },
+      });
        */
-      addChatMessage: (message: { id?: string | undefined; content: DashboardLocalizedString; platform: string; from?: string | undefined; emotes?: { word: string; url: string; }[] | undefined; }, user: { id: string; name: string; avatar?: string | undefined; platform: string; color?: string | undefined; icons?: string[] | undefined; } | undefined) => Promise<unknown>;
+      addSystemChatMessage: (message: { id?: string | undefined; content: string | Partial<Record<AddonConfigLang, string>>; sender?: string | Partial<Record<AddonConfigLang, string>> | undefined; style?: AddonDashboardChatMessageStyle | undefined; }) => Promise<unknown>;
       /**
        * Subscribes to outgoing messages from the chat window input.
       The handler receives `{ text }` when the user sends a message and this

package/package.json

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