@stripchatdev/ext-helper 0.3.1 → 0.3.2

package/dist/helpers/index.d.ts

@@ -119,6 +119,8 @@ export declare type TSlotStateSnapshot<State extends object> = {
     state: State | null;
 };
 
+declare type TTheme = 'light' | 'dark';
+
 declare type TTransportPeer = {
     id: string;
 };
@@ -143,6 +145,8 @@ declare type TV1ActionResult = {
     code: number;
 };
 
+declare type TV1AnalyticsTrackParams = TV1UiInteractionTrackParams;
+
 declare type TV1ChatEvents = {
     /** Triggered on every new message in a chat */
     'v1.chat.message.received': {
@@ -192,6 +196,20 @@ declare type TV1ChatMethods = {
         };
         result: null;
     };
+    /**
+     * Send a rich message to the chat with customizable colors.
+     *
+     * The message is sent locally on behalf of the extension. It is not sent to the server or broadcast — each user sees it only in their own local chat feed.
+     *
+     * Because the message is local, it is **not persisted**: it disappears from chat history when the page is reloaded.
+     *
+     * Required permission:
+     * - `richMessage`
+     */
+    'v1.chat.richMessage.send': {
+        params: TV1RichMessage;
+        result: null;
+    };
     /** Use this method to send a message in the chat as a bot or model.
      *  The message is sent locally to each user and looks like a normal chat message. The message is **not persisted** and will disappear from the chat after the page is reloaded.
      * */
@@ -324,6 +342,19 @@ declare type TV1ExtMethods = {
         params: null;
         result: TV1ExtContext;
     };
+    /**
+     * Returns the tag from which the user navigated to the model.
+     * `tag` is `null` when the source tag is unknown.
+     *
+     * Required permission:
+     * - `modelTag`
+     */
+    'v1.ext.modelTag.get': {
+        params: null;
+        result: {
+            tag: TV1ExtModelTag | null;
+        };
+    };
     'v1.ext.movableOverlay.update': {
         params: {
             message?: string;
@@ -340,6 +371,8 @@ declare type TV1ExtMethods = {
     /** Opens Stripchat sign-up dialog for anonymous users. Use this when your extension requires a registered account to function */
     'v1.ext.signup.open': {
         params: {
+            /** Optional source string to identify the origin of the sign-up request. Internal use only */
+            source?: string;
             type: 'user';
         };
         result: null;
@@ -418,6 +451,21 @@ declare type TV1ExtModel = {
     username: string;
 };
 
+/**
+ * Tag from which the user navigated to the model.
+ *
+ * Required permission:
+ * - `modelTag`
+ */
+declare type TV1ExtModelTag = {
+    /** Tag identifier, for example `autoTagNew` */
+    id: string;
+    /** Primary tag the tag belongs to */
+    primaryTagId: 'girls' | 'men' | 'trans' | 'couples';
+    /** Tag URL path, for example `girls/new` */
+    url: string;
+};
+
 declare type TV1ExtSettings = unknown;
 
 declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
@@ -593,6 +641,52 @@ declare type TV1PrivateMethods = {
     };
 };
 
+declare type TV1RichMessage = {
+    /** The main action appearance. It opens the extension tab on click. If omitted, the default action is a link. */
+    action?: {
+        text?: string;
+        type: 'link' | 'button';
+    };
+    /** One of the predefined extension icons. If omitted, the icon from the manifest is used. */
+    icon?: 'sex-toy-1' | 'sex-toy-2' | 'spicy-pepper';
+    /**
+     * Rich message subtitle.
+     *
+     * Supports inline markup tags:
+     * - `{#primary}...{/primary}` — uses the primary text color.
+     * - `{#secondary}...{/secondary}` — uses the secondary text color.
+     * - `{#accent}...{/accent}` — highlights text with an accent color.
+     * - `{#bold}...{/bold}` — renders bold text.
+     *
+     * Example: `'won {#accent}Alice{/accent} in'`
+     */
+    subtitle: string;
+    /** Optional custom theme. If omitted, the default theme is used. */
+    theme?: {
+        [Property in TTheme]?: TV1RichMessageTheme;
+    };
+    /**
+     * Rich message title.
+     *
+     * Supports inline markup tags:
+     * - `{#primary}...{/primary}` — uses the primary text color.
+     * - `{#secondary}...{/secondary}` — uses the secondary text color.
+     * - `{#accent}...{/accent}` — highlights text with an accent color.
+     * - `{#bold}...{/bold}` — renders bold text.
+     *
+     * Example: `'won {#accent}Alice{/accent} in'`
+     */
+    title: string;
+};
+
+declare type TV1RichMessageTheme = {
+    /** Rich message background color. Use a hex color. */
+    background: string;
+    buttonText: 'white' | 'dark';
+    /** Main accent color of the rich message, used for the sidebar, highlights, links, and buttons. Use a hex color. */
+    main: string;
+};
+
 declare type TV1SerializedError = {
     cause?: TV1SerializedError;
     message: string;
@@ -942,6 +1036,10 @@ declare type TV1StorageMethods = {
 };
 
 declare type TV1SystemMethods = {
+    'v1.system.analytics.track': {
+        params: TV1AnalyticsTrackParams;
+        result: null;
+    };
     'v1.system.report.crash': {
         params: {
             data?: Record<string, unknown>;
@@ -1081,6 +1179,17 @@ declare type TV1TopUserEntry = {
 
 declare type TV1TopWindow = 'TOP_1D' | 'TOP_7D' | 'TOP_30D' | 'TOP_UNSPECIFIED';
 
+declare type TV1UiInteractionTrackParams = {
+    data: {
+        elementId: string;
+        elementType: 'banner' | 'button' | 'tile' | 'popup' | 'extensionButton';
+        interactionType: 'view' | 'click' | 'close' | 'dismiss';
+        optionSelected?: string;
+        pageSection?: string;
+    };
+    type: 'uiInteraction';
+};
+
 /**
  * User activity league. Ordered from lowest to highest activity rank:
  * - `grey` — new or low-activity users (level 1–9)

package/dist/helpers/react.d.ts

@@ -53,6 +53,8 @@ declare type TMethods = TV1Methods;
  */
 declare type TMovableOverlayStatus = 'active' | 'inactive' | 'connecting' | 'error';
 
+declare type TTheme = 'light' | 'dark';
+
 declare type TTransportPeer = {
     id: string;
 };
@@ -77,6 +79,8 @@ declare type TV1ActionResult = {
     code: number;
 };
 
+declare type TV1AnalyticsTrackParams = TV1UiInteractionTrackParams;
+
 declare type TV1ChatEvents = {
     /** Triggered on every new message in a chat */
     'v1.chat.message.received': {
@@ -126,6 +130,20 @@ declare type TV1ChatMethods = {
         };
         result: null;
     };
+    /**
+     * Send a rich message to the chat with customizable colors.
+     *
+     * The message is sent locally on behalf of the extension. It is not sent to the server or broadcast — each user sees it only in their own local chat feed.
+     *
+     * Because the message is local, it is **not persisted**: it disappears from chat history when the page is reloaded.
+     *
+     * Required permission:
+     * - `richMessage`
+     */
+    'v1.chat.richMessage.send': {
+        params: TV1RichMessage;
+        result: null;
+    };
     /** Use this method to send a message in the chat as a bot or model.
      *  The message is sent locally to each user and looks like a normal chat message. The message is **not persisted** and will disappear from the chat after the page is reloaded.
      * */
@@ -258,6 +276,19 @@ declare type TV1ExtMethods = {
         params: null;
         result: TV1ExtContext;
     };
+    /**
+     * Returns the tag from which the user navigated to the model.
+     * `tag` is `null` when the source tag is unknown.
+     *
+     * Required permission:
+     * - `modelTag`
+     */
+    'v1.ext.modelTag.get': {
+        params: null;
+        result: {
+            tag: TV1ExtModelTag | null;
+        };
+    };
     'v1.ext.movableOverlay.update': {
         params: {
             message?: string;
@@ -274,6 +305,8 @@ declare type TV1ExtMethods = {
     /** Opens Stripchat sign-up dialog for anonymous users. Use this when your extension requires a registered account to function */
     'v1.ext.signup.open': {
         params: {
+            /** Optional source string to identify the origin of the sign-up request. Internal use only */
+            source?: string;
             type: 'user';
         };
         result: null;
@@ -352,6 +385,21 @@ declare type TV1ExtModel = {
     username: string;
 };
 
+/**
+ * Tag from which the user navigated to the model.
+ *
+ * Required permission:
+ * - `modelTag`
+ */
+declare type TV1ExtModelTag = {
+    /** Tag identifier, for example `autoTagNew` */
+    id: string;
+    /** Primary tag the tag belongs to */
+    primaryTagId: 'girls' | 'men' | 'trans' | 'couples';
+    /** Tag URL path, for example `girls/new` */
+    url: string;
+};
+
 declare type TV1ExtSettings = unknown;
 
 declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
@@ -527,6 +575,52 @@ declare type TV1PrivateMethods = {
     };
 };
 
+declare type TV1RichMessage = {
+    /** The main action appearance. It opens the extension tab on click. If omitted, the default action is a link. */
+    action?: {
+        text?: string;
+        type: 'link' | 'button';
+    };
+    /** One of the predefined extension icons. If omitted, the icon from the manifest is used. */
+    icon?: 'sex-toy-1' | 'sex-toy-2' | 'spicy-pepper';
+    /**
+     * Rich message subtitle.
+     *
+     * Supports inline markup tags:
+     * - `{#primary}...{/primary}` — uses the primary text color.
+     * - `{#secondary}...{/secondary}` — uses the secondary text color.
+     * - `{#accent}...{/accent}` — highlights text with an accent color.
+     * - `{#bold}...{/bold}` — renders bold text.
+     *
+     * Example: `'won {#accent}Alice{/accent} in'`
+     */
+    subtitle: string;
+    /** Optional custom theme. If omitted, the default theme is used. */
+    theme?: {
+        [Property in TTheme]?: TV1RichMessageTheme;
+    };
+    /**
+     * Rich message title.
+     *
+     * Supports inline markup tags:
+     * - `{#primary}...{/primary}` — uses the primary text color.
+     * - `{#secondary}...{/secondary}` — uses the secondary text color.
+     * - `{#accent}...{/accent}` — highlights text with an accent color.
+     * - `{#bold}...{/bold}` — renders bold text.
+     *
+     * Example: `'won {#accent}Alice{/accent} in'`
+     */
+    title: string;
+};
+
+declare type TV1RichMessageTheme = {
+    /** Rich message background color. Use a hex color. */
+    background: string;
+    buttonText: 'white' | 'dark';
+    /** Main accent color of the rich message, used for the sidebar, highlights, links, and buttons. Use a hex color. */
+    main: string;
+};
+
 declare type TV1SerializedError = {
     cause?: TV1SerializedError;
     message: string;
@@ -876,6 +970,10 @@ declare type TV1StorageMethods = {
 };
 
 declare type TV1SystemMethods = {
+    'v1.system.analytics.track': {
+        params: TV1AnalyticsTrackParams;
+        result: null;
+    };
     'v1.system.report.crash': {
         params: {
             data?: Record<string, unknown>;
@@ -1015,6 +1113,17 @@ declare type TV1TopUserEntry = {
 
 declare type TV1TopWindow = 'TOP_1D' | 'TOP_7D' | 'TOP_30D' | 'TOP_UNSPECIFIED';
 
+declare type TV1UiInteractionTrackParams = {
+    data: {
+        elementId: string;
+        elementType: 'banner' | 'button' | 'tile' | 'popup' | 'extensionButton';
+        interactionType: 'view' | 'click' | 'close' | 'dismiss';
+        optionSelected?: string;
+        pageSection?: string;
+    };
+    type: 'uiInteraction';
+};
+
 /**
  * User activity league. Ordered from lowest to highest activity rank:
  * - `grey` — new or low-activity users (level 1–9)

package/dist/index.d.ts

@@ -120,6 +120,8 @@ export declare type TV1ActionResult = {
     code: number;
 };
 
+export declare type TV1AnalyticsTrackParams = TV1UiInteractionTrackParams;
+
 declare type TV1ChatEvents = {
     /** Triggered on every new message in a chat */
     'v1.chat.message.received': {
@@ -169,6 +171,20 @@ declare type TV1ChatMethods = {
         };
         result: null;
     };
+    /**
+     * Send a rich message to the chat with customizable colors.
+     *
+     * The message is sent locally on behalf of the extension. It is not sent to the server or broadcast — each user sees it only in their own local chat feed.
+     *
+     * Because the message is local, it is **not persisted**: it disappears from chat history when the page is reloaded.
+     *
+     * Required permission:
+     * - `richMessage`
+     */
+    'v1.chat.richMessage.send': {
+        params: TV1RichMessage;
+        result: null;
+    };
     /** Use this method to send a message in the chat as a bot or model.
      *  The message is sent locally to each user and looks like a normal chat message. The message is **not persisted** and will disappear from the chat after the page is reloaded.
      * */
@@ -307,6 +323,19 @@ declare type TV1ExtMethods = {
         params: null;
         result: TV1ExtContext;
     };
+    /**
+     * Returns the tag from which the user navigated to the model.
+     * `tag` is `null` when the source tag is unknown.
+     *
+     * Required permission:
+     * - `modelTag`
+     */
+    'v1.ext.modelTag.get': {
+        params: null;
+        result: {
+            tag: TV1ExtModelTag | null;
+        };
+    };
     'v1.ext.movableOverlay.update': {
         params: {
             message?: string;
@@ -323,6 +352,8 @@ declare type TV1ExtMethods = {
     /** Opens Stripchat sign-up dialog for anonymous users. Use this when your extension requires a registered account to function */
     'v1.ext.signup.open': {
         params: {
+            /** Optional source string to identify the origin of the sign-up request. Internal use only */
+            source?: string;
             type: 'user';
         };
         result: null;
@@ -401,6 +432,21 @@ export declare type TV1ExtModel = {
     username: string;
 };
 
+/**
+ * Tag from which the user navigated to the model.
+ *
+ * Required permission:
+ * - `modelTag`
+ */
+export declare type TV1ExtModelTag = {
+    /** Tag identifier, for example `autoTagNew` */
+    id: string;
+    /** Primary tag the tag belongs to */
+    primaryTagId: 'girls' | 'men' | 'trans' | 'couples';
+    /** Tag URL path, for example `girls/new` */
+    url: string;
+};
+
 export declare type TV1ExtSettings = unknown;
 
 export declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
@@ -581,6 +627,52 @@ declare type TV1PrivateMethods = {
     };
 };
 
+export declare type TV1RichMessage = {
+    /** The main action appearance. It opens the extension tab on click. If omitted, the default action is a link. */
+    action?: {
+        text?: string;
+        type: 'link' | 'button';
+    };
+    /** One of the predefined extension icons. If omitted, the icon from the manifest is used. */
+    icon?: 'sex-toy-1' | 'sex-toy-2' | 'spicy-pepper';
+    /**
+     * Rich message subtitle.
+     *
+     * Supports inline markup tags:
+     * - `{#primary}...{/primary}` — uses the primary text color.
+     * - `{#secondary}...{/secondary}` — uses the secondary text color.
+     * - `{#accent}...{/accent}` — highlights text with an accent color.
+     * - `{#bold}...{/bold}` — renders bold text.
+     *
+     * Example: `'won {#accent}Alice{/accent} in'`
+     */
+    subtitle: string;
+    /** Optional custom theme. If omitted, the default theme is used. */
+    theme?: {
+        [Property in TTheme]?: TV1RichMessageTheme;
+    };
+    /**
+     * Rich message title.
+     *
+     * Supports inline markup tags:
+     * - `{#primary}...{/primary}` — uses the primary text color.
+     * - `{#secondary}...{/secondary}` — uses the secondary text color.
+     * - `{#accent}...{/accent}` — highlights text with an accent color.
+     * - `{#bold}...{/bold}` — renders bold text.
+     *
+     * Example: `'won {#accent}Alice{/accent} in'`
+     */
+    title: string;
+};
+
+export declare type TV1RichMessageTheme = {
+    /** Rich message background color. Use a hex color. */
+    background: string;
+    buttonText: 'white' | 'dark';
+    /** Main accent color of the rich message, used for the sidebar, highlights, links, and buttons. Use a hex color. */
+    main: string;
+};
+
 declare type TV1SerializedError = {
     cause?: TV1SerializedError;
     message: string;
@@ -938,6 +1030,10 @@ export declare type TV1StorageStringSetError = TV1ExtensionError<TV1StorageStrin
 export declare type TV1StorageStringSetErrorCode = 'ERR_CODE_UNSPECIFIED' | 'ERR_STORAGE_VALUE_SIZE_LIMIT_EXCEEDED';
 
 declare type TV1SystemMethods = {
+    'v1.system.analytics.track': {
+        params: TV1AnalyticsTrackParams;
+        result: null;
+    };
     'v1.system.report.crash': {
         params: {
             data?: Record<string, unknown>;
@@ -1077,6 +1173,17 @@ export declare type TV1TopUserEntry = {
 
 export declare type TV1TopWindow = 'TOP_1D' | 'TOP_7D' | 'TOP_30D' | 'TOP_UNSPECIFIED';
 
+export declare type TV1UiInteractionTrackParams = {
+    data: {
+        elementId: string;
+        elementType: 'banner' | 'button' | 'tile' | 'popup' | 'extensionButton';
+        interactionType: 'view' | 'click' | 'close' | 'dismiss';
+        optionSelected?: string;
+        pageSection?: string;
+    };
+    type: 'uiInteraction';
+};
+
 /**
  * User activity league. Ordered from lowest to highest activity rank:
  * - `grey` — new or low-activity users (level 1–9)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stripchatdev/ext-helper",
   "private": false,
-  "version": "0.3.1",
+  "version": "0.3.2",
   "license": "Apache-2.0",
   "type": "module",
   "module": "./dist/ext-helper.js",