@stripchatdev/ext-helper 0.1.14 → 0.1.16

package/dist/index.d.ts

@@ -63,6 +63,9 @@ export declare type TExtPageResolverMethods = {
     };
 };
 
+/** Unique identifier for a guest user **/
+export declare type TGuestHash = string;
+
 export declare type TMethods = TV1Methods;
 
 export declare type TModelId = TUserId;
@@ -163,6 +166,52 @@ declare type TV1ExtEvents = {
     'v1.ext.whispered.local': TV1WhisperData;
 };
 
+/** Guest user (not logged in). */
+export declare type TV1ExtGuestUser = {
+    /** Unique identifier for a guest user. */
+    guestHash: TGuestHash;
+    /** User is a guest (not logged in). */
+    isGuest: true;
+};
+
+/** Logged-in user. */
+export declare type TV1ExtLoggedInUser = {
+    /** User's fan club data. Contains information regarding user's subscription to the model's fan club.  */
+    fanClub: TV1UsersFanClub;
+    /** User previously purchased tokens. */
+    hasPaidBefore: boolean;
+    /** User has tokens. */
+    hasTokens: boolean;
+    /** User currently has Ultimate membership. */
+    hasUltimateSubscription: boolean;
+    /** User ID. */
+    id: TUserId;
+    /** User is logged in. */
+    isGuest: false;
+    /** User is the highest tipper in the room over past 12 hours. */
+    isKing: boolean;
+    /** User is a knight of the model. */
+    isKnight: boolean;
+    /** Current user is a model. */
+    isModel: boolean;
+    /**
+     * Current show/session state for this user.
+     *
+     * - `public` — public broadcast context
+     * - `private` — private show context
+     * - `exclusivePrivate` — exclusive private show context
+     * - `groupShow` — group show context
+     * - `ticketShow` — ticket show context
+     * - `off` — offline
+     * - `spy` — spying on a private show
+     */
+    status: TV1UserStatus;
+    /** User username. */
+    username: string;
+    /** User activity ranking data when available. */
+    userRanking?: TV1UserRanking;
+};
+
 declare type TV1ExtMethods = {
     'v1.ext.actions.call': {
         params: TV1ActionRequestParams;
@@ -205,6 +254,7 @@ declare type TV1ExtMethods = {
             settings: TV1ExtSettings;
         };
     };
+    /** Opens Stripchat sign-up dialog for anonymous users. Use this when your extension requires a registered account to function */
     'v1.ext.signup.open': {
         params: {
             type: 'user';
@@ -269,38 +319,11 @@ export declare type TV1ExtModel = {
 
 export declare type TV1ExtSettings = unknown;
 
-export declare type TV1ExtUser = {
-    /** User previously purchased tokens */
-    hasPaidBefore: boolean;
-    /** User has tokens */
-    hasTokens: boolean;
-    /** User currently has Ultimate membership */
-    hasUltimateSubscription: boolean;
-    /** User ID. */
-    id: TUserId;
-    /** Current user is a model. */
-    isModel: boolean;
-    /**
-     * Current show/session state for this user.
-     *
-     * - `public` — public broadcast context
-     * - `private` — private show context
-     * - `exclusivePrivate` — exclusive private show context
-     * - `groupShow` — group show context
-     * - `ticketShow` — ticket show context
-     * - `off` — offline
-     * - `spy` — spying on a private show
-     */
-    status: TV1UserStatus;
-    /** User username. */
-    username: string;
-    /** User activity ranking data when available. */
-    userRanking?: TV1UserRanking;
-};
+export declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
 
 export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
 
-export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1StorageMethods;
+export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1StorageMethods & TV1TipMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -604,12 +627,46 @@ export declare type TV1TipData = {
 };
 
 declare type TV1TipEvents = {
+    /** Fired when the tip menu has been updated.*/
+    'v1.tipMenu.updated': {
+        /** The current tip menu data. */
+        tipMenu: TV1TipMenu;
+    };
     /** Fired on every tip in chat for both model and user. Doesn't fire on private tips during public shows */
     'v1.tokens.spent': {
         tipData: TV1TipData;
     };
 };
 
+/** Tip menu data */
+export declare type TV1TipMenu = {
+    /** Whether tip menu is enabled or not. If it's disabled, the `items` array will be empty. */
+    isEnabled: boolean;
+    /** The list of tip menu items sorted by the model. */
+    items: TV1TipMenuItem[];
+};
+
+/** Tip menu item defined by the model. */
+export declare type TV1TipMenuItem = {
+    /** Activity name */
+    activity: string;
+    /** Price of the activity for the current user applying all discounts.
+     *  Discounds can be applied based on the user's fan club memberhip.
+     * */
+    price: number;
+};
+
+declare type TV1TipMethods = {
+    /** Get the current tip menu. Tip menu data might change during the broadcast, so subscribe to `v1.tipMenu.updated` to listen to these changes. */
+    'v1.tipMenu.get': {
+        params: null;
+        result: {
+            /** The current tip menu data. */
+            tipMenu: TV1TipMenu;
+        };
+    };
+};
+
 /** Source of the tip. Could be one of the following:
  *
  * `console` - tip was sent using / command
@@ -658,6 +715,26 @@ export declare type TV1UserRanking = {
     level: number;
 };
 
+export declare type TV1UsersFanClub = TV1UsersFanClubSubscribed | TV1UsersFanClubNotSubscribed;
+
+export declare type TV1UsersFanClubNotSubscribed = {
+    /** Whether user is subscribed to the model's fan club or not */
+    isSubscribed: false;
+};
+
+export declare type TV1UsersFanClubSubscribed = {
+    /** Whether user is subscribed to the model's fan club or not */
+    isSubscribed: true;
+    /** The tier of the fan club subscription. Could be `soldier`, `lord` or `prince`.
+     *  The higher the tier, the more benefits the user gets.
+     *
+     * `Soldier` is the first tier. It has basic benefits
+     * `Lord` is the second tier. It has more benefits than `soldier`
+     * `Prince` is the third tier. It has the most benefits.
+     * **/
+    tier: 'soldier' | 'lord' | 'prince';
+};
+
 export declare type TV1UserStatus = Exclude<(typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES], 'idle'>;
 
 export declare type TV1WhisperData = TUnknownDictionary;

package/package.json

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