@stripchatdev/ext-helper 0.1.33 → 0.1.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +7 -5
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -105,7 +105,7 @@ export declare type TV1ActionResult = {
105
105
  };
106
106
 
107
107
  declare type TV1ChatEvents = {
108
- /** Triggered on every new message in chat */
108
+ /** Triggered on every new message in a chat */
109
109
  'v1.chat.message.received': {
110
110
  /** Text of the message */
111
111
  messageText: string;
@@ -118,8 +118,10 @@ declare type TV1ChatEvents = {
118
118
 
119
119
  declare type TV1ChatMethods = {
120
120
  /**
121
- * Renders a message in the chat locally for each user. The message is not sent to the server
122
- * and is not broadcast — each user sees it injected into their own local chat feed.
121
+ * This method should be used to notify a user in the chat about an event related to the extension, for example, showing the result of a game.
122
+ *
123
+ * The message is sent locally to each user on behalf of the extension. The message is not sent to the server
124
+ * and is not broadcasted — each user sees it injected into their own local chat feed.
123
125
  *
124
126
  * Because the message is local only, it is **not persisted**: it will disappear from the chat
125
127
  * history after the page is reloaded.
@@ -145,8 +147,8 @@ declare type TV1ChatMethods = {
145
147
  };
146
148
  result: null;
147
149
  };
148
- /** Use this method to send a message in the chat as a bot or model
149
- * The message is sent locally to each user.
150
+ /** Use this method to send a message in the chat as a bot or model.
151
+ * The message is sent locally to each user and looks like a normal chat message. The message is **not persisted** and will disappear from the chat after the page is reloaded.
150
152
  * */
151
153
  'v1.chatbot.message.send': {
152
154
  params: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stripchatdev/ext-helper",
3
3
  "private": false,
4
- "version": "0.1.33",
4
+ "version": "0.1.34",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",
7
7
  "module": "./dist/ext-helper.js",