@stripchatdev/ext-helper 0.1.36 → 0.1.38

package/dist/index.d.ts

@@ -118,7 +118,7 @@ declare type TV1ChatEvents = {
 
 declare type TV1ChatMethods = {
     /**
-     * This method should be used to notify a user in the chat about an event related to the extension, for example, showing the result of a game.
+     * This method should be used to notify a user in the chat about an event related to the extension, for example, showing the result of a game. Therefore, it should be used only after `v1.payment.tokens.spend.succeeded` event.
      *
      * The message is sent locally to each user on behalf of the extension. The message is not sent to the server
      * and is not broadcasted — each user sees it injected into their own local chat feed.
@@ -132,6 +132,7 @@ declare type TV1ChatMethods = {
      */
     'v1.chat.message.send': {
         params: {
+            /** Whether the username should be hidden. Always respect user's anonimity and use data received in `v1.payment.tokens.spend.succeeded'. */
             isAnonymous: boolean;
             /**
              * Chat message text.
@@ -172,7 +173,7 @@ declare type TV1ChatMethods = {
     };
 };
 
-export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents;
+export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents & TV1GoalEvents;
 
 export declare type TV1ExtContext = {
     model?: TV1ExtModel;
@@ -220,6 +221,8 @@ export declare type TV1ExtLoggedInUser = {
     id: TUserId;
     /** User is logged in. */
     isGuest: false;
+    /** User is invisible. Do not expose any data of invisible users. */
+    isInvisible: boolean;
     /** User is the highest tipper in the room over past 12 hours. */
     isKing: boolean;
     /** User is a knight of the model. */
@@ -305,10 +308,12 @@ declare type TV1ExtMethods = {
     /** Broadcasts a message through the server to all clients in the room that have this extension loaded. Every slot iframe of every user receives the corresponding `v1.ext.whispered` event */
     'v1.ext.whisper': {
         params: {
-            /** Any JSON-serializable object to send to every frame */
+            /** Any JSON-serializable object to send to every frame.
+             * Never send any sensetive data through this field, such as username or user id.
+             * */
             data: TV1WhisperData;
-            /** Payment data received from the `payment.tokens.spend.succeeded` event
-             *  This field is required for user in public
+            /** 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;
         };
@@ -374,7 +379,36 @@ export declare type TV1ExtViewers = {
 
 export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
 
-export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods;
+/** Regular goal data */
+export declare type TV1GoalData = {
+    /** Goal description */
+    description: string;
+    /** Whether the goal is fully completed */
+    isCompleted: boolean;
+    /** Amount of tokens already collected */
+    tokensCollected: number;
+    /** Target amount in tokens */
+    tokensTarget: number;
+};
+
+declare type TV1GoalEvents = {
+    /** Fired when any field of the active goal changes (description, isCompleted, tokensTarget, or tokensCollected), or the active goal is removed. */
+    'v1.goal.updated': {
+        goal: TV1GoalData | null;
+    };
+};
+
+declare type TV1GoalMethods = {
+    /** Get the current active goal. Returns null if no goal is active. */
+    'v1.goal.get': {
+        params: null;
+        result: {
+            goal: TV1GoalData | null;
+        };
+    };
+};
+
+export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods & TV1GoalMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -415,6 +449,7 @@ declare type TV1MonitoringMethods = {
     };
 };
 
+/** Payment data returned after a successful token spend. Use it only once for the request it authorizes. Do not store or reuse it. */
 export declare type TV1PaymentData = {
     /** The amount of tokens spent */
     amount: string;
@@ -429,12 +464,12 @@ export declare type TV1PaymentData = {
 declare type TV1PaymentEvents = {
     /**
      * Received when tokens are successfully spent
-     * Contains the payment data which is used for validating whisper calls
+     * Contains payment data returned after a successful token spend. Use it only once for the request it authorizes. Do not store or reuse it.
      */
     'v1.payment.tokens.spend.succeeded': {
-        /** Was the tip anonymous */
+        /** Was the tip anonymous. Use this field in `v1.chat.message.send` */
         isAnonymous: boolean;
-        /** Payment data used for validating `ext.whisper` calls */
+        /** 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;
         /** Custom data passed in `payment.tokens.spend` method */
         tokensSpendData: TV1TokenSpendData;
@@ -498,7 +533,9 @@ 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;
+            /** Session lifetime in seconds (minimum 1). */
             ttl: string;
         };
         result: null;

package/package.json

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