@stripchatdev/ext-helper 0.1.5 → 0.1.6

package/dist/index.d.ts

@@ -65,6 +65,15 @@ export declare type TMethods = TV1Methods;
 
 export declare type TModelId = TUserId;
 
+/**
+ * Status of the movable overlay.
+ * `active` - pulsing green
+ * `inactive` - orange
+ * `connecting` - green
+ * `error` - red
+ */
+export declare type TMovableOverlayStatus = 'active' | 'inactive' | 'connecting' | 'error';
+
 export declare type TTheme = 'light' | 'dark';
 
 declare type TTransportPeer = {
@@ -134,7 +143,7 @@ declare type TV1ExtMethods = {
     'v1.ext.movableOverlay.update': {
         params: {
             message?: string;
-            status?: 'active' | 'inactive' | 'connecting' | 'error';
+            status?: TMovableOverlayStatus;
         };
         result: null;
     };
@@ -150,12 +159,19 @@ declare type TV1ExtMethods = {
         };
         result: null;
     };
+    /** 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 */
             data: TV1WhisperData;
+            /** Payment data received from the `payment.tokens.spend.succeeded` event
+             *  This field is required for user in public
+             * */
+            paymentData?: TV1PaymentData;
         };
         result: null;
     };
+    /** Sends a message to every frame of the current user */
     'v1.ext.whisper.local': {
         params: {
             data: TV1WhisperData;
@@ -273,18 +289,39 @@ declare type TV1MonitoringMethods = {
     };
 };
 
+export declare type TV1PaymentData = {
+    /** The amount of tokens spent */
+    amount: string;
+    /** Payment token used for authentication */
+    paymentToken: string;
+    /** Transaction identifier */
+    transactionId: string;
+    /** User's ID */
+    userId: string;
+};
+
 declare type TV1PaymentEvents = {
+    /**
+     * Received when tokens are successfully spent
+     * Contains the payment data which is used for validating whisper calls
+     */
     'v1.payment.tokens.spend.succeeded': {
+        /** Was the tip anonymous */
         isAnonymous: boolean;
-        tokensAmount: number;
+        /** Payment data used for validating `ext.whisper` calls */
+        paymentData: TV1PaymentData;
+        /** Custom data passed in `payment.tokens.spend` method */
         tokensSpendData: TV1TokenSpendData;
     };
 };
 
 declare type TV1PaymentMethods = {
+    /** Requests a confirmation modal to spend tokens */
     'v1.payment.tokens.spend': {
         params: {
+            /** Amount of tokens to spend */
             tokensAmount: number;
+            /** Custom data which will be passed back in the `v1.payment.tokens.spend.succeeded` event */
             tokensSpendData: TV1TokenSpendData;
         };
         result: null;
@@ -379,6 +416,7 @@ declare type TV1TipEvents = {
  */
 declare type TV1TipSource = 'console' | 'tipMenu' | 'goal' | 'epicGoal' | 'fullscreen' | 'interactiveToy' | 'publicChat' | 'privateChat' | 'extension' | 'sendTipButton' | 'feed';
 
+/** Custom data that you can pass when requesting token spend. You will receive it on successful payment */
 export declare type TV1TokenSpendData = TUnknownDictionary;
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stripchatdev/ext-helper",
   "private": false,
-  "version": "0.1.5",
+  "version": "0.1.6",
   "type": "module",
   "module": "./dist/ext-helper.js",
   "types": "./dist/index.d.ts",