@stripchatdev/ext-helper 0.1.41 → 0.1.43

package/dist/index.d.ts

@@ -312,10 +312,17 @@ declare type TV1ExtMethods = {
              * Never send any sensetive data through this field, such as username or user id.
              * */
             data: TV1WhisperData;
-            /** Payment data returned by the `payment.tokens.spend.succeeded` event.
+            /** @deprecated
+             * Use `paymentHash` instead
+             *
+             * Payment data returned by the `payment.tokens.spend.succeeded` event.
              *  Required for users in public shows. Use it only once for the request it authorizes. Do not store or reuse it.
              * */
             paymentData?: TV1PaymentData;
+            /** Payment hash returned by the `payment.tokens.spend.succeeded` event.
+             * Payment hash is used for authentication. Required for users in public shows. Use it only once for the request it authorizes. Do not store or reuse it.
+             * */
+            paymentHash?: TV1PaymentHash;
         };
         result: null;
     };
@@ -377,6 +384,30 @@ export declare type TV1ExtViewers = {
     withTokens: number;
 };
 
+declare type TV1FanClubMethods = {
+    /**
+     * Opens the fan club subscription modal for the current model.
+     * Read `context.user.fanClub` from the extension context to verify the user is eligible before calling.
+     * This field is available only for logged-in users (`context.user.isGuest === false`).
+     * Pass `null` for params to open the modal with the `soldier` tab selected by default.
+     */
+    'v1.fanClub.request': {
+        params: {
+            /** Which tier tab to show in the modal. */
+            tier: TV1FanClubTier;
+        } | null;
+        result: null;
+    };
+};
+
+/**
+ * Fan club subscription tier. Ordered from lowest to highest:
+ * - `soldier` — first tier with basic benefits
+ * - `lord` — second tier with more benefits than `soldier`
+ * - `prince` — third tier with the most benefits
+ */
+export declare type TV1FanClubTier = 'soldier' | 'lord' | 'prince';
+
 export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
 
 /** Regular goal data */
@@ -408,7 +439,7 @@ declare type TV1GoalMethods = {
     };
 };
 
-export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods;
+export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods & TV1FanClubMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -469,13 +500,23 @@ declare type TV1PaymentEvents = {
     'v1.payment.tokens.spend.succeeded': {
         /** Was the tip anonymous. Use this field in `v1.chat.message.send` */
         isAnonymous: boolean;
-        /** Payment data returned after a successful token spend. Use it only once for the request it authorizes. Do not store or reuse it. */
+        /** @deprecated
+         * Use `paymentHash` instead.
+         *
+         * Payment data returned after a successful token spend. Use it only once for the request it authorizes. Do not store or reuse it. */
         paymentData: TV1PaymentData;
+        /**
+         * Payment hash used for authentication. Required for users in public shows. Use it only once for the request it authorizes. Do not store or reuse it.
+         */
+        paymentHash: TV1PaymentHash;
         /** Custom data passed in `payment.tokens.spend` method */
         tokensSpendData: TV1TokenSpendData;
     };
 };
 
+/** Payment hash used for authentication. Do not store or reuse it. Use it only once for the request it authorizes. */
+export declare type TV1PaymentHash = string;
+
 declare type TV1PaymentMethods = {
     /** Requests a confirmation modal to spend tokens */
     'v1.payment.tokens.spend': {
@@ -539,8 +580,16 @@ declare type TV1SessionMethods = {
     };
     'v1.session.join.user': {
         params: {
-            /** Payment data returned by the `payment.tokens.spend.succeeded` event. Use it only once for the request it authorizes. Do not store or reuse it. */
-            payment: TV1PaymentData;
+            /** @deprecated
+             * Use `paymentHash` instead.
+             *
+             * Payment data returned by the `payment.tokens.spend.succeeded` event. Use it only once for the request it authorizes. Do not store or reuse it. */
+            payment?: TV1PaymentData;
+            /**
+             * Payment hash returned by the `payment.tokens.spend.succeeded` event.
+             * Use it only once for the request it authorizes. Do not store or reuse it.
+             */
+            paymentHash: TV1PaymentHash;
             /** Session lifetime in seconds (minimum 1). */
             ttl: string;
         };
@@ -917,14 +966,8 @@ export declare type TV1UsersFanClubNotSubscribed = {
 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';
+    /** The tier of the fan club subscription. Could be `soldier`, `lord` or `prince`. Higher tiers provide more benefits. */
+    tier: TV1FanClubTier;
 };
 
 export declare type TV1UserStatus = Exclude<(typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES], 'idle'>;

package/package.json

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