@stripchatdev/ext-helper 0.1.24 → 0.1.26

package/dist/index.d.ts

@@ -149,7 +149,7 @@ declare type TV1ChatMethods = {
     };
 };
 
-export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1TipEvents & TV1ChatEvents;
+export declare type TV1Events = TV1ExtEvents & TV1PaymentEvents & TV1ModelEvents & TV1SessionEvents & TV1TipEvents & TV1ChatEvents;
 
 export declare type TV1ExtContext = {
     model?: TV1ExtModel;
@@ -219,12 +219,6 @@ declare type TV1ExtMethods = {
         params: TV1ActionRequestParams;
         result: TV1ActionResult;
     };
-    'v1.ext.activity.cancel': {
-        params: {
-            activityId: string;
-        };
-        result: null;
-    };
     'v1.ext.activity.request': {
         params: {
             durationMs: number;
@@ -325,7 +319,7 @@ export declare type TV1ExtUser = TV1ExtGuestUser | TV1ExtLoggedInUser;
 
 export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
 
-export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1StorageMethods & TV1TipMethods;
+export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1SessionMethods & TV1StorageMethods & TV1TipMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -419,6 +413,73 @@ declare type TV1SerializedError = {
     stack?: string;
 };
 
+export declare type TV1Session = TV1SessionSelf | TV1SessionOther;
+
+export declare type TV1SessionActionType = 'join' | 'finish';
+
+declare type TV1SessionEvents = {
+    'v1.session.updated': {
+        data: TV1SessionUpdate;
+    };
+    'v1.session.whispered.model': TV1SessionWhisperData;
+};
+
+declare type TV1SessionMethods = {
+    'v1.session.finish.model': {
+        params: null;
+        result: null;
+    };
+    'v1.session.get': {
+        params: null;
+        result: {
+            session: TV1Session | null;
+        };
+    };
+    'v1.session.join.model': {
+        params: {
+            ttl: string;
+        };
+        result: null;
+    };
+    'v1.session.join.user': {
+        params: {
+            payment: TV1PaymentData;
+            ttl: string;
+        };
+        result: null;
+    };
+    'v1.session.whisper.user': {
+        params: {
+            data: TV1SessionWhisperData;
+        };
+        result: null;
+    };
+};
+
+export declare type TV1SessionOther = {
+    /** The session exists but belongs to a different extension */
+    owner: 'other';
+};
+
+export declare type TV1SessionSelf = {
+    meta: {
+        /** Platform session id */
+        sessionId: string;
+        /** Remaining lifetime in seconds */
+        ttlSec: number;
+    };
+    /** The session exists but belongs to a different extension: */
+    owner: 'self';
+};
+
+export declare type TV1SessionUpdate = {
+    action: TV1SessionActionType;
+    session: TV1Session | null;
+    userId: TUserId;
+};
+
+export declare type TV1SessionWhisperData = TUnknownDictionary;
+
 declare type TV1StorageMethods = {
     'v1.storage.int.get': {
         params: {
@@ -476,7 +537,7 @@ declare type TV1StorageMethods = {
             mutexName: string;
             /** Auto-release after this many seconds. Omit or 0 = hold until explicit unlock. */
             /** @format int64 */
-            ttlSeconds?: string;
+            ttl?: string;
         };
         result: {
             success: boolean;
@@ -495,7 +556,7 @@ declare type TV1StorageMethods = {
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
-            ttlSeconds?: string;
+            ttl?: string;
             value: string;
         };
         result: {
@@ -507,6 +568,9 @@ declare type TV1StorageMethods = {
             key: string;
         };
         result: {
+            /** `false` when the key has never been set (value will be `''` empty string).  */
+            exists: boolean;
+            /** Stored string value. Empty string if the key was never set. */
             value: string;
         };
     };
@@ -515,7 +579,7 @@ declare type TV1StorageMethods = {
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
-            ttlSeconds?: string;
+            ttl?: string;
             value: string;
         };
         result: {
@@ -529,10 +593,10 @@ declare type TV1StorageMethods = {
     'v1.storage.top.get': {
         params: {
             key: string;
+            /** Sliding time horizon for summing increments. */
+            top: TV1TopWindow;
             /** How many users to return in `topUsers`. 0 = default 10; max 100. */
             topN?: number;
-            /** Sliding time horizon for summing increments. */
-            window: TV1TopWindow;
         };
         result: {
             topUsers?: TV1TopUserEntry[];
@@ -555,15 +619,11 @@ declare type TV1StorageMethods = {
         };
         result: {
             success: boolean;
-            /** Sum within 1-day window after this increment. */
-            /** @format int64 */
-            value1d?: string;
-            /** Sum within 30-day window after this increment. */
+            /** Echo of request `userId`; `windowStats` apply to this user. */
             /** @format int64 */
-            value30d?: string;
-            /** Sum within 7-day window after this increment. */
-            /** @format int64 */
-            value7d?: string;
+            userId?: string;
+            /** One entry per standard horizon (1d, 7d, 30d) with that user's total in each window after the increment. */
+            windowStats?: TV1TopIncrementWindowStat[];
         };
     };
     /** Clear all increments for a top counter key. */
@@ -688,6 +748,17 @@ declare type TV1TipSource = 'console' | 'tipMenu' | 'goal' | 'epicGoal' | 'fulls
 /** Custom data that you can pass when requesting token spend. You will receive it on successful payment */
 export declare type TV1TokenSpendData = TUnknownDictionary;
 
+/**
+ * Per-window statistics for a user after a top counter increment.
+ * One entry per standard horizon (1d, 7d, 30d).
+ */
+export declare type TV1TopIncrementWindowStat = {
+    /** User's summed total within this window after the increment. */
+    value: string;
+    /** Sliding time horizon (1d, 7d, or 30d). */
+    window: TV1TopWindow;
+};
+
 export declare type TV1TopUserEntry = {
     /** Sum of increment amounts within the sliding window for this user. */
     total: string;

package/package.json

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