@stripchatdev/ext-helper 0.2.1 → 0.2.3

package/dist/helpers/index.d.ts

@@ -146,6 +146,10 @@ declare type TV1ActionResult = {
 declare type TV1ChatEvents = {
     /** Triggered on every new message in a chat */
     'v1.chat.message.received': {
+        /** Unique event id */
+        eventId: string;
+        /** Unique id of the message */
+        messageId: string;
         /** Text of the message */
         messageText: string;
         /** User who sent the message **/
@@ -469,6 +473,7 @@ declare type TV1GoalData = {
 declare type TV1GoalEvents = {
     /** Fired when any field of the active goal changes (description, isCompleted, tokensTarget, or tokensCollected), or the active goal is removed. */
     'v1.goal.updated': {
+        eventId: string;
         goal: TV1GoalData | null;
     };
 };
@@ -750,6 +755,12 @@ declare type TV1StorageMethods = {
         params: {
             /** Amount to add (may be negative). Must not be zero. */
             delta: string;
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Opaque payload forwarded to server-side payment/policy validation. */
             paymentContext?: string;
@@ -764,6 +775,12 @@ declare type TV1StorageMethods = {
     /** Reset an integer counter to 0. */
     'v1.storage.int.reset': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
         };
         result: {
@@ -802,6 +819,12 @@ declare type TV1StorageMethods = {
     };
     'v1.storage.string.append': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
@@ -810,6 +833,7 @@ declare type TV1StorageMethods = {
         };
         result: {
             success: boolean;
+            value: string;
         };
     };
     'v1.storage.string.get': {
@@ -837,6 +861,12 @@ declare type TV1StorageMethods = {
     };
     'v1.storage.string.set': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
@@ -845,6 +875,7 @@ declare type TV1StorageMethods = {
         };
         result: {
             success: boolean;
+            value: string;
         };
     };
     /**
@@ -959,11 +990,15 @@ declare type TV1TipData = {
 declare type TV1TipEvents = {
     /** Fired when the tip menu has been updated.*/
     'v1.tipMenu.updated': {
+        /** Unique event id */
+        eventId: string;
         /** The current tip menu data. */
         tipMenu: TV1TipMenu;
     };
     /** Fired on every tip in chat for both model and user. Doesn't fire on private tips during public shows */
     'v1.tokens.spent': {
+        /** Unique event id */
+        eventId: string;
         tipData: TV1TipData;
     };
 };

package/dist/helpers/react.d.ts

@@ -80,6 +80,10 @@ declare type TV1ActionResult = {
 declare type TV1ChatEvents = {
     /** Triggered on every new message in a chat */
     'v1.chat.message.received': {
+        /** Unique event id */
+        eventId: string;
+        /** Unique id of the message */
+        messageId: string;
         /** Text of the message */
         messageText: string;
         /** User who sent the message **/
@@ -403,6 +407,7 @@ declare type TV1GoalData = {
 declare type TV1GoalEvents = {
     /** Fired when any field of the active goal changes (description, isCompleted, tokensTarget, or tokensCollected), or the active goal is removed. */
     'v1.goal.updated': {
+        eventId: string;
         goal: TV1GoalData | null;
     };
 };
@@ -684,6 +689,12 @@ declare type TV1StorageMethods = {
         params: {
             /** Amount to add (may be negative). Must not be zero. */
             delta: string;
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Opaque payload forwarded to server-side payment/policy validation. */
             paymentContext?: string;
@@ -698,6 +709,12 @@ declare type TV1StorageMethods = {
     /** Reset an integer counter to 0. */
     'v1.storage.int.reset': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
         };
         result: {
@@ -736,6 +753,12 @@ declare type TV1StorageMethods = {
     };
     'v1.storage.string.append': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
@@ -744,6 +767,7 @@ declare type TV1StorageMethods = {
         };
         result: {
             success: boolean;
+            value: string;
         };
     };
     'v1.storage.string.get': {
@@ -771,6 +795,12 @@ declare type TV1StorageMethods = {
     };
     'v1.storage.string.set': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
@@ -779,6 +809,7 @@ declare type TV1StorageMethods = {
         };
         result: {
             success: boolean;
+            value: string;
         };
     };
     /**
@@ -893,11 +924,15 @@ declare type TV1TipData = {
 declare type TV1TipEvents = {
     /** Fired when the tip menu has been updated.*/
     'v1.tipMenu.updated': {
+        /** Unique event id */
+        eventId: string;
         /** The current tip menu data. */
         tipMenu: TV1TipMenu;
     };
     /** Fired on every tip in chat for both model and user. Doesn't fire on private tips during public shows */
     'v1.tokens.spent': {
+        /** Unique event id */
+        eventId: string;
         tipData: TV1TipData;
     };
 };

package/dist/index.d.ts

@@ -116,6 +116,10 @@ export declare type TV1ActionResult = {
 declare type TV1ChatEvents = {
     /** Triggered on every new message in a chat */
     'v1.chat.message.received': {
+        /** Unique event id */
+        eventId: string;
+        /** Unique id of the message */
+        messageId: string;
         /** Text of the message */
         messageText: string;
         /** User who sent the message **/
@@ -439,6 +443,7 @@ export declare type TV1GoalData = {
 declare type TV1GoalEvents = {
     /** Fired when any field of the active goal changes (description, isCompleted, tokensTarget, or tokensCollected), or the active goal is removed. */
     'v1.goal.updated': {
+        eventId: string;
         goal: TV1GoalData | null;
     };
 };
@@ -720,6 +725,12 @@ declare type TV1StorageMethods = {
         params: {
             /** Amount to add (may be negative). Must not be zero. */
             delta: string;
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Opaque payload forwarded to server-side payment/policy validation. */
             paymentContext?: string;
@@ -734,6 +745,12 @@ declare type TV1StorageMethods = {
     /** Reset an integer counter to 0. */
     'v1.storage.int.reset': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
         };
         result: {
@@ -772,6 +789,12 @@ declare type TV1StorageMethods = {
     };
     'v1.storage.string.append': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
@@ -780,6 +803,7 @@ declare type TV1StorageMethods = {
         };
         result: {
             success: boolean;
+            value: string;
         };
     };
     'v1.storage.string.get': {
@@ -807,6 +831,12 @@ declare type TV1StorageMethods = {
     };
     'v1.storage.string.set': {
         params: {
+            /**
+             * Unique key for idempotent storage writes, such as an eventId, messageId, or transactionId.
+             * Warning: Do not use unstable frontend-generated values because they may differ across tabs.
+             * Use the same stable value across tabs and devices.
+             */
+            idempotencyKey?: string;
             key: string;
             /** Auto-delete the key after this many seconds. Omit or 0 = no expiry. */
             /** @format int64 */
@@ -815,6 +845,7 @@ declare type TV1StorageMethods = {
         };
         result: {
             success: boolean;
+            value: string;
         };
     };
     /**
@@ -929,11 +960,15 @@ export declare type TV1TipData = {
 declare type TV1TipEvents = {
     /** Fired when the tip menu has been updated.*/
     'v1.tipMenu.updated': {
+        /** Unique event id */
+        eventId: string;
         /** The current tip menu data. */
         tipMenu: TV1TipMenu;
     };
     /** Fired on every tip in chat for both model and user. Doesn't fire on private tips during public shows */
     'v1.tokens.spent': {
+        /** Unique event id */
+        eventId: string;
         tipData: TV1TipData;
     };
 };

package/package.json

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