@stripchatdev/ext-helper 0.1.2 → 0.1.3

package/dist/index.d.ts

@@ -100,7 +100,7 @@ declare type TV1ChatMethods = {
     };
 };
 
-export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents;
+export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1TipEvents;
 
 export declare type TV1ExtContext = {
     model?: TV1ExtModel;
@@ -324,6 +324,61 @@ declare type TV1SystemMethods = {
     };
 };
 
+export declare type TV1TipData = {
+    /** Amount of tokens spent */
+    amount: number;
+    /** Is anonymous tip or not */
+    isAnonymous: boolean;
+    /** Is tip sent from the current user or not */
+    isFromTheCurrentUser: boolean;
+    /** Is tip sent from the current extension or not */
+    isOriginalSource: boolean;
+    /** Message  that was sent with the tip. Empty string if no message was sent */
+    message?: string;
+    /** Source of the tip. Could be one of the following:
+     *
+     * `console` - tip was sent using / command
+     * `tipMenu` - tip was sent using tip menu
+     * `goal` - tip was sent via goal button
+     * `epicGoal` - tip was sent to epic goal
+     * `fullscreen` - tip was sent from the fullscreen view
+     * `interactiveToy` - tip was sent from the interactive toy
+     * `privateChat` - tip was sent from the private chat, in any type of show
+     * `publicChat` - tip was sent using publich chat, either in public or group show.
+     * `extension` - tip was sent from one of the extensions
+     * `sendTipButton` - tip was sent using send tip button
+     * `feed` - tip was sent from the feed
+     * */
+    source: TV1TipSource;
+    /** Determins whether tip was sent in public or private chat */
+    type: 'private' | 'public';
+    /** User who sent the tip. Can be null in case of anonymous tip */
+    user?: TV1ExtUser | null;
+};
+
+declare type TV1TipEvents = {
+    /** 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;
+    };
+};
+
+/** Source of the tip. Could be one of the following:
+ *
+ * `console` - tip was sent using / command
+ * `tipMenu` - tip was sent using tip menu
+ * `goal` - tip was sent via goal button
+ * `epicGoal` - tip was sent to epic goal
+ * `fullscreen` - tip was sent from the fullscreen view
+ * `interactiveToy` - tip was sent from the interactive toy
+ * `privateChat` - tip was sent from the private chat, in any type of show
+ * `publicChat` - tip was sent using publich chat, either in public or group show.
+ * `extension` - tip was sent from one of the extensions
+ * `sendTipButton` - tip was sent using send tip button
+ * `feed` - tip was sent from the feed
+ */
+declare type TV1TipSource = 'console' | 'tipMenu' | 'goal' | 'epicGoal' | 'fullscreen' | 'interactiveToy' | 'publicChat' | 'privateChat' | 'extension' | 'sendTipButton' | 'feed';
+
 export declare type TV1TokenSpendData = TUnknownDictionary;
 
 /**

package/package.json

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