@stripchatdev/ext-helper 0.1.27 → 0.1.29

package/dist/index.d.ts

@@ -164,6 +164,13 @@ declare type TV1ExtEvents = {
     'v1.ext.context.updated': {
         context: TV1ExtContext;
     };
+    /**
+     * Fired whenever the viewer counts for the room change.
+     * Emitted only for show types: `public`, `groupShow`, `ticketShow`.
+     */
+    'v1.ext.viewers.updated': {
+        viewers: TV1ExtViewers;
+    };
     'v1.ext.whispered': TV1WhisperData;
     'v1.ext.whispered.local': TV1WhisperData;
 };
@@ -257,6 +264,15 @@ declare type TV1ExtMethods = {
         };
         result: null;
     };
+    /**
+     * Returns the current viewer counts for the room.
+     * Supported only for show types: `public`, `groupShow`, `ticketShow`.
+     * Returns `null` for other show types.
+     */
+    'v1.ext.viewers.get': {
+        params: null;
+        result: TV1ExtViewers | 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: {
@@ -317,6 +333,16 @@ export declare type TV1ExtSettings = unknown;
 
 export declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
 
+/** Viewer counts for the current room. */
+export declare type TV1ExtViewers = {
+    /** Number of guest (unauthenticated) viewers. */
+    guests: number;
+    /** Total number of viewers in the room. */
+    total: number;
+    /** Number of viewers who hold tokens. */
+    withTokens: number;
+};
+
 export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
 
 export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods;
@@ -611,6 +637,8 @@ declare type TV1StorageMethods = {
              */
             amount: string;
             key: string;
+            /** An optional string saved for this increment from that user's latest event. */
+            meta?: string;
             /**
              * User id credited for this increment (appears in `top/get` top_users).
              * @format int64
@@ -618,6 +646,8 @@ declare type TV1StorageMethods = {
             userId: string;
         };
         result: {
+            /** An optional string saved for this increment from that user's latest event. */
+            meta?: string;
             success: boolean;
             /** Echo of request `userId`; `windowStats` apply to this user. */
             /** @format int64 */
@@ -760,6 +790,8 @@ export declare type TV1TopIncrementWindowStat = {
 };
 
 export declare type TV1TopUserEntry = {
+    /** An optional string saved for this increment from that user's latest event */
+    meta?: string;
     /** Sum of increment amounts within the sliding window for this user. */
     total: string;
     /** User ID recorded as incrementer. */

package/package.json

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