@stripchatdev/ext-helper 0.3.1 → 0.4.0

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.
      * */
@@ -217,10 +235,15 @@ declare type TV1ChatMethods = {
     };
 };
 
-declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents & TV1GoalEvents;
+declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents & TV1GoalEvents & TV1ShowEvents;
 
 declare type TV1ExtContext = {
     model?: TV1ExtModel;
+    /**
+     * Show the current user takes part in. Always present for the model while they are producing a show,
+     * and present for a user only while that user is a participant of the show. Otherwise it is absent.
+     */
+    show?: TV1ExtShow;
     /** Unique identifier for the extension. */
     slug?: string;
     user?: TV1ExtUser;
@@ -233,6 +256,8 @@ declare type TV1ExtEvents = {
         context: TV1ExtContext;
     };
     /**
+     * @deprecated This event will be removed in a future release.
+     *
      * Fired whenever the viewer counts for the room change.
      * Emitted only for show types: `public`, `groupShow`, `ticketShow`.
      */
@@ -290,6 +315,8 @@ declare type TV1ExtLoggedInUser = {
      * - `ticketShow` — ticket show context
      * - `off` — offline
      * - `spy` — spying on a private show
+     *
+     * @deprecated Use `context.show` to check whether the user is a participant of the show. This field will be removed in a future release.
      */
     status: TV1UserStatus;
     /** User username. */
@@ -324,6 +351,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,11 +380,15 @@ 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;
     };
     /**
+     * @deprecated This method will be removed in a future release.
+     *
      * Returns the current viewer counts for the room.
      * Supported only for show types: `public`, `groupShow`, `ticketShow`.
      * Returns `null` for other show types.
@@ -403,23 +447,57 @@ declare type TV1ExtModel = {
     isSpyEnabled: boolean;
     /** Model's name from her profile. If not set, an empty string will be returned */
     name: string;
-    /** Status of the show. Possible values:
+    /** Presence of the model on the site. When it is `show`, read `context.show.status` for the type of the show. */
+    state: TV1ModelState;
+    /**
+     * Status of the show.
      *
-     * - `idle` - model is online but not streaming
-     * - `public` - model is broadcasting public show
-     * - `private` - model is in private show
-     * - `exclusivePrivate` - model is in exclusive private show
-     * - `off` - model is offline
-     * - `groupShow` - model is in group show that is not a ticket show
-     * - `ticketShow` - model is in ticket show
-     * */
+     * @deprecated Use `context.show.status` for show-type checks and `state` for the presence of the model.
+     */
     status: TV1ModelStatus;
     /** Model's username */
     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;
 
+/**
+ * Show that is currently running in the room.
+ *
+ * Present in the extension context only for participants of the show: always for the model,
+ * and for a user only while that user is a participant. It is absent for everyone else,
+ * for example for a user watching the room while the model is in a private show with somebody else,
+ * or while the user is spying on a private show.
+ *
+ * A spy viewer is not a participant of the show, so `context.show` remains undefined in that case.
+ * Extensions are not running while the user spies on a show, so an extension never observes spy mode
+ * and there is no `spy` value in `context.show.status`.
+ *
+ * Use `context.show` to branch on the type of the show and `v1.show.participants.get` to read who takes part in it.
+ */
+declare type TV1ExtShow = {
+    /** Type of the show. */
+    status: TV1ExtShowStatus;
+};
+
+/** Type of the show that is currently running in the room. */
+declare type TV1ExtShowStatus = typeof V1_SHOW_STATUSES.STATUS_PUBLIC | typeof V1_SHOW_STATUSES.STATUS_GROUP_SHOW | typeof V1_SHOW_STATUSES.STATUS_TICKET_SHOW | typeof V1_SHOW_STATUSES.STATUS_PRIVATE | typeof V1_SHOW_STATUSES.STATUS_EXCLUSIVE_PRIVATE;
+
 declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
 
 /** Viewer counts for the current room. */
@@ -488,7 +566,7 @@ declare type TV1GoalMethods = {
     };
 };
 
-declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods & TV1FanClubMethods;
+declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods & TV1FanClubMethods & TV1ShowMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -510,6 +588,15 @@ declare type TV1ModelMethods = {
     };
 };
 
+/**
+ * Presence of the model on the site.
+ *
+ * - `off` — model is not on the site
+ * - `idle` — model is on the site but not producing a show
+ * - `show` — model is producing a show
+ */
+declare type TV1ModelState = (typeof V1_MODEL_STATES)[keyof typeof V1_MODEL_STATES];
+
 /** Status that indicates which type of show model is producing now */
 declare type TV1ModelStatus = Exclude<TV1ShowStatus, 'spy'>;
 
@@ -593,6 +680,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;
@@ -732,6 +865,42 @@ declare type TV1SessionUpdate = {
  */
 declare type TV1SessionWhisperData = TUnknownDictionary;
 
+declare type TV1ShowEvents = {
+    /**
+     * Fired when the participants of the show change, for example when a user joins or leaves the show.
+     *
+     * Emitted for the model and for participants of the show.
+     */
+    'v1.show.participants.updated': {
+        data: {
+            /** Logged-in users that take part in the show. */
+            participants: TV1ExtLoggedInUser[];
+            /** Total number of participants of the show, including guests that are not listed in `participants`. */
+            total: number;
+        };
+    };
+};
+
+declare type TV1ShowMethods = {
+    /**
+     * Returns the users that take part in the show currently running in the room.
+     *
+     * Available for the model and for participants of the show. Check that `context.show` is present before calling.
+     *
+     * Guests are never listed in `participants`, but they are counted in `total`.
+     * Participants might change during the show, so subscribe to `v1.show.participants.updated` to listen to these changes.
+     */
+    'v1.show.participants.get': {
+        params: null;
+        result: {
+            /** Logged-in users that take part in the show. */
+            participants: TV1ExtLoggedInUser[];
+            /** Total number of participants of the show, including guests that are not listed in `participants`. */
+            total: number;
+        };
+    };
+};
+
 declare type TV1ShowStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
 
 declare type TV1StorageMethods = {
@@ -942,6 +1111,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 +1254,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)
@@ -1129,6 +1313,15 @@ declare type TV2WhisperData = {
     tokenSum: number | null;
 };
 
+declare const V1_MODEL_STATES: {
+    /** Model is not on the site */
+    readonly STATUS_OFF: "off";
+    /** Model is on the site but not producing a show */
+    readonly STATUS_IDLE: "idle";
+    /** Model is producing a show */
+    readonly STATUS_SHOW: "show";
+};
+
 declare const V1_SHOW_STATUSES: {
     /** Ticket show */
     readonly STATUS_TICKET_SHOW: "ticketShow";

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.
      * */
@@ -151,10 +169,15 @@ declare type TV1ChatMethods = {
     };
 };
 
-declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents & TV1GoalEvents;
+declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents & TV1GoalEvents & TV1ShowEvents;
 
 declare type TV1ExtContext = {
     model?: TV1ExtModel;
+    /**
+     * Show the current user takes part in. Always present for the model while they are producing a show,
+     * and present for a user only while that user is a participant of the show. Otherwise it is absent.
+     */
+    show?: TV1ExtShow;
     /** Unique identifier for the extension. */
     slug?: string;
     user?: TV1ExtUser;
@@ -167,6 +190,8 @@ declare type TV1ExtEvents = {
         context: TV1ExtContext;
     };
     /**
+     * @deprecated This event will be removed in a future release.
+     *
      * Fired whenever the viewer counts for the room change.
      * Emitted only for show types: `public`, `groupShow`, `ticketShow`.
      */
@@ -224,6 +249,8 @@ declare type TV1ExtLoggedInUser = {
      * - `ticketShow` — ticket show context
      * - `off` — offline
      * - `spy` — spying on a private show
+     *
+     * @deprecated Use `context.show` to check whether the user is a participant of the show. This field will be removed in a future release.
      */
     status: TV1UserStatus;
     /** User username. */
@@ -258,6 +285,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,11 +314,15 @@ 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;
     };
     /**
+     * @deprecated This method will be removed in a future release.
+     *
      * Returns the current viewer counts for the room.
      * Supported only for show types: `public`, `groupShow`, `ticketShow`.
      * Returns `null` for other show types.
@@ -337,23 +381,57 @@ declare type TV1ExtModel = {
     isSpyEnabled: boolean;
     /** Model's name from her profile. If not set, an empty string will be returned */
     name: string;
-    /** Status of the show. Possible values:
+    /** Presence of the model on the site. When it is `show`, read `context.show.status` for the type of the show. */
+    state: TV1ModelState;
+    /**
+     * Status of the show.
      *
-     * - `idle` - model is online but not streaming
-     * - `public` - model is broadcasting public show
-     * - `private` - model is in private show
-     * - `exclusivePrivate` - model is in exclusive private show
-     * - `off` - model is offline
-     * - `groupShow` - model is in group show that is not a ticket show
-     * - `ticketShow` - model is in ticket show
-     * */
+     * @deprecated Use `context.show.status` for show-type checks and `state` for the presence of the model.
+     */
     status: TV1ModelStatus;
     /** Model's username */
     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;
 
+/**
+ * Show that is currently running in the room.
+ *
+ * Present in the extension context only for participants of the show: always for the model,
+ * and for a user only while that user is a participant. It is absent for everyone else,
+ * for example for a user watching the room while the model is in a private show with somebody else,
+ * or while the user is spying on a private show.
+ *
+ * A spy viewer is not a participant of the show, so `context.show` remains undefined in that case.
+ * Extensions are not running while the user spies on a show, so an extension never observes spy mode
+ * and there is no `spy` value in `context.show.status`.
+ *
+ * Use `context.show` to branch on the type of the show and `v1.show.participants.get` to read who takes part in it.
+ */
+declare type TV1ExtShow = {
+    /** Type of the show. */
+    status: TV1ExtShowStatus;
+};
+
+/** Type of the show that is currently running in the room. */
+declare type TV1ExtShowStatus = typeof V1_SHOW_STATUSES.STATUS_PUBLIC | typeof V1_SHOW_STATUSES.STATUS_GROUP_SHOW | typeof V1_SHOW_STATUSES.STATUS_TICKET_SHOW | typeof V1_SHOW_STATUSES.STATUS_PRIVATE | typeof V1_SHOW_STATUSES.STATUS_EXCLUSIVE_PRIVATE;
+
 declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
 
 /** Viewer counts for the current room. */
@@ -422,7 +500,7 @@ declare type TV1GoalMethods = {
     };
 };
 
-declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods & TV1FanClubMethods;
+declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods & TV1FanClubMethods & TV1ShowMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -444,6 +522,15 @@ declare type TV1ModelMethods = {
     };
 };
 
+/**
+ * Presence of the model on the site.
+ *
+ * - `off` — model is not on the site
+ * - `idle` — model is on the site but not producing a show
+ * - `show` — model is producing a show
+ */
+declare type TV1ModelState = (typeof V1_MODEL_STATES)[keyof typeof V1_MODEL_STATES];
+
 /** Status that indicates which type of show model is producing now */
 declare type TV1ModelStatus = Exclude<TV1ShowStatus, 'spy'>;
 
@@ -527,6 +614,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;
@@ -666,6 +799,42 @@ declare type TV1SessionUpdate = {
  */
 declare type TV1SessionWhisperData = TUnknownDictionary;
 
+declare type TV1ShowEvents = {
+    /**
+     * Fired when the participants of the show change, for example when a user joins or leaves the show.
+     *
+     * Emitted for the model and for participants of the show.
+     */
+    'v1.show.participants.updated': {
+        data: {
+            /** Logged-in users that take part in the show. */
+            participants: TV1ExtLoggedInUser[];
+            /** Total number of participants of the show, including guests that are not listed in `participants`. */
+            total: number;
+        };
+    };
+};
+
+declare type TV1ShowMethods = {
+    /**
+     * Returns the users that take part in the show currently running in the room.
+     *
+     * Available for the model and for participants of the show. Check that `context.show` is present before calling.
+     *
+     * Guests are never listed in `participants`, but they are counted in `total`.
+     * Participants might change during the show, so subscribe to `v1.show.participants.updated` to listen to these changes.
+     */
+    'v1.show.participants.get': {
+        params: null;
+        result: {
+            /** Logged-in users that take part in the show. */
+            participants: TV1ExtLoggedInUser[];
+            /** Total number of participants of the show, including guests that are not listed in `participants`. */
+            total: number;
+        };
+    };
+};
+
 declare type TV1ShowStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
 
 declare type TV1StorageMethods = {
@@ -876,6 +1045,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 +1188,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)
@@ -1081,6 +1265,15 @@ export declare const useSlotState: <State extends object>({ channel, extHelper,
     state: State | null;
 };
 
+declare const V1_MODEL_STATES: {
+    /** Model is not on the site */
+    readonly STATUS_OFF: "off";
+    /** Model is on the site but not producing a show */
+    readonly STATUS_IDLE: "idle";
+    /** Model is producing a show */
+    readonly STATUS_SHOW: "show";
+};
+
 declare const V1_SHOW_STATUSES: {
     /** Ticket show */
     readonly STATUS_TICKET_SHOW: "ticketShow";

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.
      * */
@@ -194,10 +210,15 @@ declare type TV1ChatMethods = {
     };
 };
 
-export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents & TV1GoalEvents;
+export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents & TV1GoalEvents & TV1ShowEvents;
 
 export declare type TV1ExtContext = {
     model?: TV1ExtModel;
+    /**
+     * Show the current user takes part in. Always present for the model while they are producing a show,
+     * and present for a user only while that user is a participant of the show. Otherwise it is absent.
+     */
+    show?: TV1ExtShow;
     /** Unique identifier for the extension. */
     slug?: string;
     user?: TV1ExtUser;
@@ -216,6 +237,8 @@ declare type TV1ExtEvents = {
         context: TV1ExtContext;
     };
     /**
+     * @deprecated This event will be removed in a future release.
+     *
      * Fired whenever the viewer counts for the room change.
      * Emitted only for show types: `public`, `groupShow`, `ticketShow`.
      */
@@ -273,6 +296,8 @@ export declare type TV1ExtLoggedInUser = {
      * - `ticketShow` — ticket show context
      * - `off` — offline
      * - `spy` — spying on a private show
+     *
+     * @deprecated Use `context.show` to check whether the user is a participant of the show. This field will be removed in a future release.
      */
     status: TV1UserStatus;
     /** User username. */
@@ -307,6 +332,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,11 +361,15 @@ 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;
     };
     /**
+     * @deprecated This method will be removed in a future release.
+     *
      * Returns the current viewer counts for the room.
      * Supported only for show types: `public`, `groupShow`, `ticketShow`.
      * Returns `null` for other show types.
@@ -386,23 +428,57 @@ export declare type TV1ExtModel = {
     isSpyEnabled: boolean;
     /** Model's name from her profile. If not set, an empty string will be returned */
     name: string;
-    /** Status of the show. Possible values:
+    /** Presence of the model on the site. When it is `show`, read `context.show.status` for the type of the show. */
+    state: TV1ModelState;
+    /**
+     * Status of the show.
      *
-     * - `idle` - model is online but not streaming
-     * - `public` - model is broadcasting public show
-     * - `private` - model is in private show
-     * - `exclusivePrivate` - model is in exclusive private show
-     * - `off` - model is offline
-     * - `groupShow` - model is in group show that is not a ticket show
-     * - `ticketShow` - model is in ticket show
-     * */
+     * @deprecated Use `context.show.status` for show-type checks and `state` for the presence of the model.
+     */
     status: TV1ModelStatus;
     /** Model's username */
     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;
 
+/**
+ * Show that is currently running in the room.
+ *
+ * Present in the extension context only for participants of the show: always for the model,
+ * and for a user only while that user is a participant. It is absent for everyone else,
+ * for example for a user watching the room while the model is in a private show with somebody else,
+ * or while the user is spying on a private show.
+ *
+ * A spy viewer is not a participant of the show, so `context.show` remains undefined in that case.
+ * Extensions are not running while the user spies on a show, so an extension never observes spy mode
+ * and there is no `spy` value in `context.show.status`.
+ *
+ * Use `context.show` to branch on the type of the show and `v1.show.participants.get` to read who takes part in it.
+ */
+export declare type TV1ExtShow = {
+    /** Type of the show. */
+    status: TV1ExtShowStatus;
+};
+
+/** Type of the show that is currently running in the room. */
+export declare type TV1ExtShowStatus = typeof V1_SHOW_STATUSES.STATUS_PUBLIC | typeof V1_SHOW_STATUSES.STATUS_GROUP_SHOW | typeof V1_SHOW_STATUSES.STATUS_TICKET_SHOW | typeof V1_SHOW_STATUSES.STATUS_PRIVATE | typeof V1_SHOW_STATUSES.STATUS_EXCLUSIVE_PRIVATE;
+
 export declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
 
 /** Viewer counts for the current room. */
@@ -476,7 +552,7 @@ export declare type TV1MethodErrors = {
     'v1.storage.string.set': TV1StorageStringSetError;
 };
 
-export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods & TV1FanClubMethods;
+export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods & TV1FanClubMethods & TV1ShowMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -498,6 +574,15 @@ declare type TV1ModelMethods = {
     };
 };
 
+/**
+ * Presence of the model on the site.
+ *
+ * - `off` — model is not on the site
+ * - `idle` — model is on the site but not producing a show
+ * - `show` — model is producing a show
+ */
+export declare type TV1ModelState = (typeof V1_MODEL_STATES)[keyof typeof V1_MODEL_STATES];
+
 /** Status that indicates which type of show model is producing now */
 export declare type TV1ModelStatus = Exclude<TV1ShowStatus, 'spy'>;
 
@@ -581,6 +666,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;
@@ -720,6 +851,42 @@ export declare type TV1SessionUpdate = {
  */
 export declare type TV1SessionWhisperData = TUnknownDictionary;
 
+declare type TV1ShowEvents = {
+    /**
+     * Fired when the participants of the show change, for example when a user joins or leaves the show.
+     *
+     * Emitted for the model and for participants of the show.
+     */
+    'v1.show.participants.updated': {
+        data: {
+            /** Logged-in users that take part in the show. */
+            participants: TV1ExtLoggedInUser[];
+            /** Total number of participants of the show, including guests that are not listed in `participants`. */
+            total: number;
+        };
+    };
+};
+
+declare type TV1ShowMethods = {
+    /**
+     * Returns the users that take part in the show currently running in the room.
+     *
+     * Available for the model and for participants of the show. Check that `context.show` is present before calling.
+     *
+     * Guests are never listed in `participants`, but they are counted in `total`.
+     * Participants might change during the show, so subscribe to `v1.show.participants.updated` to listen to these changes.
+     */
+    'v1.show.participants.get': {
+        params: null;
+        result: {
+            /** Logged-in users that take part in the show. */
+            participants: TV1ExtLoggedInUser[];
+            /** Total number of participants of the show, including guests that are not listed in `participants`. */
+            total: number;
+        };
+    };
+};
+
 export declare type TV1ShowStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
 
 declare type TV1StorageMethods = {
@@ -938,6 +1105,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 +1248,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)
@@ -1125,6 +1307,15 @@ export declare type TV2WhisperData = {
     tokenSum: number | null;
 };
 
+export declare const V1_MODEL_STATES: {
+    /** Model is not on the site */
+    readonly STATUS_OFF: "off";
+    /** Model is on the site but not producing a show */
+    readonly STATUS_IDLE: "idle";
+    /** Model is producing a show */
+    readonly STATUS_SHOW: "show";
+};
+
 export declare const V1_SHOW_STATUSES: {
     /** Ticket show */
     readonly STATUS_TICKET_SHOW: "ticketShow";

package/package.json

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