@stripchatdev/ext-helper 0.1.6 → 0.1.8

package/dist/index.d.ts

@@ -11,6 +11,8 @@ declare class ExtHelper {
     bootstrap(): void;
 }
 
+export declare type IV1IntIncrementFailureReason = 'INT_INCREMENT_FAILURE_REASON_NONE' | 'INT_INCREMENT_FAILURE_REASON_VALIDATION_DENIED';
+
 export declare type IV1ResolveSlotPage = (slotType: string, context: TV1ExtContext, extSettings: TV1ExtSettings) => void;
 
 export declare type TAnyApiEventData<D = unknown> = D;
@@ -248,7 +250,7 @@ export declare type TV1ExtUser = {
 
 export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
 
-export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods;
+export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods & TV1MonitoringMethods & TV1StorageMethods;
 
 declare type TV1ModelEvents = {
     'v1.model.ext.settings.set.requested': null;
@@ -342,6 +344,164 @@ declare type TV1SerializedError = {
     stack?: string;
 };
 
+declare type TV1StorageMethods = {
+    'v1.storage.int.get': {
+        params: {
+            key: string;
+        };
+        result: {
+            /** `false` when the key has never been set (value will be 0). */
+            exists?: boolean;
+            /** @format int64 */
+            value: string;
+        };
+    };
+    /**
+     * Add `delta` to an integer counter. Negative delta subtracts.
+     * When the key is configured with a payment policy, pass `paymentContext`
+     * so the server can validate the transaction before applying the change.
+     */
+    'v1.storage.int.increment': {
+        params: {
+            /** Amount to add (may be negative). Must not be zero. */
+            delta: string;
+            key: string;
+            /** Opaque payload forwarded to server-side payment/policy validation. */
+            paymentContext?: string;
+        };
+        result: {
+            failureReason?: IV1IntIncrementFailureReason;
+            /** New counter value after the increment (present when `success` is true). */
+            success: boolean;
+            value?: string;
+        };
+    };
+    /** Reset an integer counter to 0. */
+    'v1.storage.int.reset': {
+        params: {
+            key: string;
+        };
+        result: {
+            success: boolean;
+            /** Stored value after reset; always 0 when `success` is true. */
+            value?: string;
+        };
+    };
+    'v1.storage.mutex.getState': {
+        params: {
+            mutexName: string;
+        };
+        result: {
+            /** `true` if the mutex is currently locked. */
+            held: boolean;
+        };
+    };
+    'v1.storage.mutex.lock': {
+        params: {
+            mutexName: string;
+            /** Auto-release after this many seconds. Omit or 0 = hold until explicit unlock. */
+            /** @format int64 */
+            ttlSeconds?: string;
+        };
+        result: {
+            success: boolean;
+        };
+    };
+    'v1.storage.mutex.unlock': {
+        params: {
+            mutexName: string;
+        };
+        result: {
+            success: boolean;
+        };
+    };
+    'v1.storage.string.append': {
+        params: {
+            key: string;
+            /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
+            /** @format int64 */
+            ttlSeconds?: string;
+            value: string;
+        };
+        result: {
+            success: boolean;
+        };
+    };
+    'v1.storage.string.get': {
+        params: {
+            key: string;
+        };
+        result: {
+            value: string;
+        };
+    };
+    'v1.storage.string.set': {
+        params: {
+            key: string;
+            /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
+            /** @format int64 */
+            ttlSeconds?: string;
+            value: string;
+        };
+        result: {
+            success: boolean;
+        };
+    };
+    /**
+     * Read a top counter: total sum in the window, last incrementer,
+     * top-N users by total, and per-day breakdown.
+     */
+    'v1.storage.top.get': {
+        params: {
+            key: string;
+            /** 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[];
+        };
+    };
+    /** Append an increment to a top counter for the current model session. */
+    'v1.storage.top.increment': {
+        params: {
+            /**
+             * Positive amount to add.
+             * @format int64
+             */
+            amount: string;
+            key: string;
+            /**
+             * User id credited for this increment (appears in `top/get` top_users).
+             * @format int64
+             */
+            userId: string;
+        };
+        result: {
+            success: boolean;
+            /** Sum within 1-day window after this increment. */
+            /** @format int64 */
+            value1d?: string;
+            /** Sum within 30-day window after this increment. */
+            /** @format int64 */
+            value30d?: string;
+            /** Sum within 7-day window after this increment. */
+            /** @format int64 */
+            value7d?: string;
+        };
+    };
+    /** Clear all increments for a top counter key. */
+    'v1.storage.top.reset': {
+        params: {
+            key: string;
+        };
+        result: {
+            success: boolean;
+        };
+    };
+};
+
 declare type TV1SystemMethods = {
     'v1.system.report.crash': {
         params: {
@@ -419,6 +579,15 @@ 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;
 
+export declare type TV1TopUserEntry = {
+    /** Sum of increment amounts within the sliding window for this user. */
+    total: string;
+    /** User ID recorded as incrementer. */
+    userId: string;
+};
+
+export declare type TV1TopWindow = 'TOP_1D' | 'TOP_7D' | 'TOP_30D';
+
 /**
  * User activity league. Ordered from lowest to highest activity rank:
  * - `grey` — new or low-activity users (level 1–9)

package/package.json

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