@stripchatdev/ext-helper 0.3.2 → 0.4.0

package/dist/helpers/index.d.ts

@@ -235,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;
@@ -251,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`.
      */
@@ -308,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. */
@@ -378,6 +387,8 @@ declare type TV1ExtMethods = {
         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.
@@ -436,16 +447,13 @@ 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;
@@ -468,6 +476,28 @@ declare type TV1ExtModelTag = {
 
 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. */
@@ -536,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;
@@ -558,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'>;
 
@@ -826,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 = {
@@ -1238,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

@@ -169,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;
@@ -185,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`.
      */
@@ -242,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. */
@@ -312,6 +321,8 @@ declare type TV1ExtMethods = {
         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.
@@ -370,16 +381,13 @@ 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;
@@ -402,6 +410,28 @@ declare type TV1ExtModelTag = {
 
 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. */
@@ -470,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;
@@ -492,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'>;
 
@@ -760,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 = {
@@ -1190,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

@@ -210,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;
@@ -232,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`.
      */
@@ -289,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. */
@@ -359,6 +368,8 @@ declare type TV1ExtMethods = {
         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.
@@ -417,16 +428,13 @@ 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;
@@ -449,6 +457,28 @@ export declare type TV1ExtModelTag = {
 
 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. */
@@ -522,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;
@@ -544,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'>;
 
@@ -812,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 = {
@@ -1232,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.2",
+  "version": "0.4.0",
   "license": "Apache-2.0",
   "type": "module",
   "module": "./dist/ext-helper.js",