@stripchatdev/ext-helper 0.1.48 → 0.2.1

package/dist/helpers/index.d.ts

@@ -132,7 +132,9 @@ declare type TV1ActionParamValue = string | number | boolean | null | undefined
 };
 
 declare type TV1ActionRequestParams = {
+    /** Name of the action as declared in the manifest actions array */
     actionName: string;
+    /** Key-value parameters passed to the action. Used for URL/header placeholders and request body */
     params: Record<string, TV1ActionParamValue>;
 };
 
@@ -169,7 +171,7 @@ declare type TV1ChatMethods = {
      */
     'v1.chat.message.send': {
         params: {
-            /** Whether the username should be hidden. Always respect user's anonimity and use data received in `v1.payment.tokens.spend.succeeded'. */
+            /** Whether to use the anonymous placeholder or not. Always respect the user's anonymity and use data received in `v1.payment.tokens.spend.succeeded`. */
             isAnonymous: boolean;
             /**
              * Chat message text.
@@ -181,6 +183,7 @@ declare type TV1ChatMethods = {
              * Example: `'won {#accent}Alice{/accent} in'`
              */
             message: string;
+            /** User to attribute the message to. Pass null if the user is anonymous or if the username is not needed in the message. */
             user: TV1ExtUser | null;
         };
         result: null;
@@ -234,6 +237,7 @@ declare type TV1ExtEvents = {
     };
     'v1.ext.whispered': TV1WhisperData;
     'v1.ext.whispered.local': TV1WhisperData;
+    'v2.ext.whispered': TV2WhisperData;
 };
 
 /** Guest user (not logged in). */
@@ -291,15 +295,18 @@ declare type TV1ExtLoggedInUser = {
 };
 
 declare type TV1ExtMethods = {
+    /** Triggers a backend action defined in the manifest.json. Stripchat executes the action server side and returns the response */
     'v1.ext.actions.call': {
         params: TV1ActionRequestParams;
         result: TV1ActionResult;
     };
     'v1.ext.activity.request': {
         params: {
+            /** Duration of the activity reservation in milliseconds. Must be a positive finite number up to `30000` (30 seconds) */
             durationMs: number;
         };
         result: {
+            /** Identifier of the started activity */
             activityId: string;
         };
     };
@@ -342,7 +349,7 @@ declare type TV1ExtMethods = {
         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 */
+    /** 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 `v2.ext.whispered` event */
     'v1.ext.whisper': {
         params: {
             /** Any JSON-serializable object to send to every frame.
@@ -588,34 +595,69 @@ declare type TV1SerializedError = {
     stack?: string;
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1Session = TV1SessionSelf | TV1SessionOther;
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionActionType = 'join' | 'finish';
 
 declare type TV1SessionEvents = {
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.updated': {
         data: TV1SessionUpdate;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.whispered.model': TV1SessionWhisperData;
 };
 
 declare type TV1SessionMethods = {
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.finish.model': {
         params: null;
         result: null;
     };
+    /**
+     * Returns the current long-term session.
+     *
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.get': {
         params: null;
         result: {
+            /** Current session snapshot. Returns `null` if the session doesn't exist  **/
             session: TV1Session | null;
         };
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.join.model': {
         params: {
             ttl: string;
         };
         result: null;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.join.user': {
         params: {
             /** @deprecated
@@ -633,6 +675,10 @@ declare type TV1SessionMethods = {
         };
         result: null;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.whisper.user': {
         params: {
             data: TV1SessionWhisperData;
@@ -641,11 +687,19 @@ declare type TV1SessionMethods = {
     };
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionOther = {
     /** The session exists but belongs to a different extension */
     owner: 'other';
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionSelf = {
     meta: {
         /** Platform session id */
@@ -657,12 +711,20 @@ declare type TV1SessionSelf = {
     owner: 'self';
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionUpdate = {
     action: TV1SessionActionType;
     session: TV1Session | null;
     userId: TUserId;
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionWhisperData = TUnknownDictionary;
 
 declare type TV1ShowStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
@@ -1015,6 +1077,15 @@ declare type TV1UserStatus = Exclude<TV1ShowStatus, 'idle'>;
 
 declare type TV1WhisperData = TUnknownDictionary;
 
+declare type TV2WhisperData = {
+    data: TUnknownDictionary;
+    /**
+     * The authoritative amount of tokens actually paid for the broadcast action. Compare this value with an actual price defined in settings or as a contant in your app.
+     * `null` means no payment occurred, e.g. when the whisper was called by user in a private show or it was called by the model.
+     */
+    tokenSum: number | null;
+};
+
 declare const V1_SHOW_STATUSES: {
     /** Ticket show */
     readonly STATUS_TICKET_SHOW: "ticketShow";

package/dist/helpers/react.d.ts

@@ -66,7 +66,9 @@ declare type TV1ActionParamValue = string | number | boolean | null | undefined
 };
 
 declare type TV1ActionRequestParams = {
+    /** Name of the action as declared in the manifest actions array */
     actionName: string;
+    /** Key-value parameters passed to the action. Used for URL/header placeholders and request body */
     params: Record<string, TV1ActionParamValue>;
 };
 
@@ -103,7 +105,7 @@ declare type TV1ChatMethods = {
      */
     'v1.chat.message.send': {
         params: {
-            /** Whether the username should be hidden. Always respect user's anonimity and use data received in `v1.payment.tokens.spend.succeeded'. */
+            /** Whether to use the anonymous placeholder or not. Always respect the user's anonymity and use data received in `v1.payment.tokens.spend.succeeded`. */
             isAnonymous: boolean;
             /**
              * Chat message text.
@@ -115,6 +117,7 @@ declare type TV1ChatMethods = {
              * Example: `'won {#accent}Alice{/accent} in'`
              */
             message: string;
+            /** User to attribute the message to. Pass null if the user is anonymous or if the username is not needed in the message. */
             user: TV1ExtUser | null;
         };
         result: null;
@@ -168,6 +171,7 @@ declare type TV1ExtEvents = {
     };
     'v1.ext.whispered': TV1WhisperData;
     'v1.ext.whispered.local': TV1WhisperData;
+    'v2.ext.whispered': TV2WhisperData;
 };
 
 /** Guest user (not logged in). */
@@ -225,15 +229,18 @@ declare type TV1ExtLoggedInUser = {
 };
 
 declare type TV1ExtMethods = {
+    /** Triggers a backend action defined in the manifest.json. Stripchat executes the action server side and returns the response */
     'v1.ext.actions.call': {
         params: TV1ActionRequestParams;
         result: TV1ActionResult;
     };
     'v1.ext.activity.request': {
         params: {
+            /** Duration of the activity reservation in milliseconds. Must be a positive finite number up to `30000` (30 seconds) */
             durationMs: number;
         };
         result: {
+            /** Identifier of the started activity */
             activityId: string;
         };
     };
@@ -276,7 +283,7 @@ declare type TV1ExtMethods = {
         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 */
+    /** 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 `v2.ext.whispered` event */
     'v1.ext.whisper': {
         params: {
             /** Any JSON-serializable object to send to every frame.
@@ -522,34 +529,69 @@ declare type TV1SerializedError = {
     stack?: string;
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1Session = TV1SessionSelf | TV1SessionOther;
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionActionType = 'join' | 'finish';
 
 declare type TV1SessionEvents = {
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.updated': {
         data: TV1SessionUpdate;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.whispered.model': TV1SessionWhisperData;
 };
 
 declare type TV1SessionMethods = {
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.finish.model': {
         params: null;
         result: null;
     };
+    /**
+     * Returns the current long-term session.
+     *
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.get': {
         params: null;
         result: {
+            /** Current session snapshot. Returns `null` if the session doesn't exist  **/
             session: TV1Session | null;
         };
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.join.model': {
         params: {
             ttl: string;
         };
         result: null;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.join.user': {
         params: {
             /** @deprecated
@@ -567,6 +609,10 @@ declare type TV1SessionMethods = {
         };
         result: null;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.whisper.user': {
         params: {
             data: TV1SessionWhisperData;
@@ -575,11 +621,19 @@ declare type TV1SessionMethods = {
     };
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionOther = {
     /** The session exists but belongs to a different extension */
     owner: 'other';
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionSelf = {
     meta: {
         /** Platform session id */
@@ -591,12 +645,20 @@ declare type TV1SessionSelf = {
     owner: 'self';
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionUpdate = {
     action: TV1SessionActionType;
     session: TV1Session | null;
     userId: TUserId;
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 declare type TV1SessionWhisperData = TUnknownDictionary;
 
 declare type TV1ShowStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
@@ -949,6 +1011,15 @@ declare type TV1UserStatus = Exclude<TV1ShowStatus, 'idle'>;
 
 declare type TV1WhisperData = TUnknownDictionary;
 
+declare type TV2WhisperData = {
+    data: TUnknownDictionary;
+    /**
+     * The authoritative amount of tokens actually paid for the broadcast action. Compare this value with an actual price defined in settings or as a contant in your app.
+     * `null` means no payment occurred, e.g. when the whisper was called by user in a private show or it was called by the model.
+     */
+    tokenSum: number | null;
+};
+
 /**
  * React hook for shared state owned by a background slot.
  *

package/dist/index.d.ts

@@ -102,7 +102,9 @@ export declare type TV1ActionParamValue = string | number | boolean | null | und
 };
 
 export declare type TV1ActionRequestParams = {
+    /** Name of the action as declared in the manifest actions array */
     actionName: string;
+    /** Key-value parameters passed to the action. Used for URL/header placeholders and request body */
     params: Record<string, TV1ActionParamValue>;
 };
 
@@ -139,7 +141,7 @@ declare type TV1ChatMethods = {
      */
     'v1.chat.message.send': {
         params: {
-            /** Whether the username should be hidden. Always respect user's anonimity and use data received in `v1.payment.tokens.spend.succeeded'. */
+            /** Whether to use the anonymous placeholder or not. Always respect the user's anonymity and use data received in `v1.payment.tokens.spend.succeeded`. */
             isAnonymous: boolean;
             /**
              * Chat message text.
@@ -151,6 +153,7 @@ declare type TV1ChatMethods = {
              * Example: `'won {#accent}Alice{/accent} in'`
              */
             message: string;
+            /** User to attribute the message to. Pass null if the user is anonymous or if the username is not needed in the message. */
             user: TV1ExtUser | null;
         };
         result: null;
@@ -204,6 +207,7 @@ declare type TV1ExtEvents = {
     };
     'v1.ext.whispered': TV1WhisperData;
     'v1.ext.whispered.local': TV1WhisperData;
+    'v2.ext.whispered': TV2WhisperData;
 };
 
 /** Guest user (not logged in). */
@@ -261,15 +265,18 @@ export declare type TV1ExtLoggedInUser = {
 };
 
 declare type TV1ExtMethods = {
+    /** Triggers a backend action defined in the manifest.json. Stripchat executes the action server side and returns the response */
     'v1.ext.actions.call': {
         params: TV1ActionRequestParams;
         result: TV1ActionResult;
     };
     'v1.ext.activity.request': {
         params: {
+            /** Duration of the activity reservation in milliseconds. Must be a positive finite number up to `30000` (30 seconds) */
             durationMs: number;
         };
         result: {
+            /** Identifier of the started activity */
             activityId: string;
         };
     };
@@ -312,7 +319,7 @@ declare type TV1ExtMethods = {
         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 */
+    /** 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 `v2.ext.whispered` event */
     'v1.ext.whisper': {
         params: {
             /** Any JSON-serializable object to send to every frame.
@@ -558,34 +565,69 @@ declare type TV1SerializedError = {
     stack?: string;
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 export declare type TV1Session = TV1SessionSelf | TV1SessionOther;
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 export declare type TV1SessionActionType = 'join' | 'finish';
 
 declare type TV1SessionEvents = {
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.updated': {
         data: TV1SessionUpdate;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.whispered.model': TV1SessionWhisperData;
 };
 
 declare type TV1SessionMethods = {
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.finish.model': {
         params: null;
         result: null;
     };
+    /**
+     * Returns the current long-term session.
+     *
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.get': {
         params: null;
         result: {
+            /** Current session snapshot. Returns `null` if the session doesn't exist  **/
             session: TV1Session | null;
         };
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.join.model': {
         params: {
             ttl: string;
         };
         result: null;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.join.user': {
         params: {
             /** @deprecated
@@ -603,6 +645,10 @@ declare type TV1SessionMethods = {
         };
         result: null;
     };
+    /**
+     * Required permission:
+     * - `sessions`
+     */
     'v1.session.whisper.user': {
         params: {
             data: TV1SessionWhisperData;
@@ -611,11 +657,19 @@ declare type TV1SessionMethods = {
     };
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 export declare type TV1SessionOther = {
     /** The session exists but belongs to a different extension */
     owner: 'other';
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 export declare type TV1SessionSelf = {
     meta: {
         /** Platform session id */
@@ -627,12 +681,20 @@ export declare type TV1SessionSelf = {
     owner: 'self';
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 export declare type TV1SessionUpdate = {
     action: TV1SessionActionType;
     session: TV1Session | null;
     userId: TUserId;
 };
 
+/**
+ * Required permission:
+ * - `sessions`
+ */
 export declare type TV1SessionWhisperData = TUnknownDictionary;
 
 export declare type TV1ShowStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
@@ -985,6 +1047,15 @@ export declare type TV1UserStatus = Exclude<TV1ShowStatus, 'idle'>;
 
 export declare type TV1WhisperData = TUnknownDictionary;
 
+export declare type TV2WhisperData = {
+    data: TUnknownDictionary;
+    /**
+     * The authoritative amount of tokens actually paid for the broadcast action. Compare this value with an actual price defined in settings or as a contant in your app.
+     * `null` means no payment occurred, e.g. when the whisper was called by user in a private show or it was called by the model.
+     */
+    tokenSum: number | null;
+};
+
 export declare const V1_SHOW_STATUSES: {
     /** Ticket show */
     readonly STATUS_TICKET_SHOW: "ticketShow";

package/package.json

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