@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0-test

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 (285) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/config.d.ts +1 -0
  3. package/cjs/src/config.d.ts.map +1 -1
  4. package/cjs/src/config.js +2 -1
  5. package/cjs/src/config.js.map +1 -1
  6. package/cjs/src/css-variables.d.ts +122 -0
  7. package/cjs/src/css-variables.d.ts.map +1 -1
  8. package/cjs/src/embed/app.d.ts +176 -24
  9. package/cjs/src/embed/app.d.ts.map +1 -1
  10. package/cjs/src/embed/app.js +86 -38
  11. package/cjs/src/embed/app.js.map +1 -1
  12. package/cjs/src/embed/app.spec.js +672 -150
  13. package/cjs/src/embed/app.spec.js.map +1 -1
  14. package/cjs/src/embed/base.d.ts +1 -1
  15. package/cjs/src/embed/base.js +1 -1
  16. package/cjs/src/embed/conversation.d.ts +401 -2
  17. package/cjs/src/embed/conversation.d.ts.map +1 -1
  18. package/cjs/src/embed/conversation.js +32 -16
  19. package/cjs/src/embed/conversation.js.map +1 -1
  20. package/cjs/src/embed/conversation.spec.js +346 -17
  21. package/cjs/src/embed/conversation.spec.js.map +1 -1
  22. package/cjs/src/embed/events.spec.js +638 -0
  23. package/cjs/src/embed/events.spec.js.map +1 -1
  24. package/cjs/src/embed/host-events.spec.js +187 -0
  25. package/cjs/src/embed/host-events.spec.js.map +1 -1
  26. package/cjs/src/embed/hostEventClient/contracts.d.ts +51 -14
  27. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  28. package/cjs/src/embed/hostEventClient/contracts.js +11 -1
  29. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  30. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +2 -1
  31. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  32. package/cjs/src/embed/hostEventClient/host-event-client.js +9 -0
  33. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  34. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +236 -0
  35. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  36. package/cjs/src/embed/hostEventClient/utils.d.ts +2 -0
  37. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
  38. package/cjs/src/embed/hostEventClient/utils.js +32 -2
  39. package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
  40. package/cjs/src/embed/hostEventClient/utils.spec.js +178 -0
  41. package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -1
  42. package/cjs/src/embed/liveboard.d.ts +81 -13
  43. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  44. package/cjs/src/embed/liveboard.js +50 -9
  45. package/cjs/src/embed/liveboard.js.map +1 -1
  46. package/cjs/src/embed/liveboard.spec.js +432 -4
  47. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  48. package/cjs/src/embed/spotter-utils.d.ts +15 -1
  49. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  50. package/cjs/src/embed/spotter-utils.js +28 -1
  51. package/cjs/src/embed/spotter-utils.js.map +1 -1
  52. package/cjs/src/embed/spotter-utils.spec.js +129 -0
  53. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  54. package/cjs/src/embed/spotter-viz-utils.d.ts +37 -4
  55. package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
  56. package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
  57. package/cjs/src/embed/spotter-viz-utils.spec.js +17 -0
  58. package/cjs/src/embed/spotter-viz-utils.spec.js.map +1 -1
  59. package/cjs/src/embed/ts-embed.d.ts +16 -8
  60. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  61. package/cjs/src/embed/ts-embed.js +96 -37
  62. package/cjs/src/embed/ts-embed.js.map +1 -1
  63. package/cjs/src/embed/ts-embed.spec.js +683 -3
  64. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  65. package/cjs/src/errors.d.ts +1 -0
  66. package/cjs/src/errors.d.ts.map +1 -1
  67. package/cjs/src/errors.js +1 -0
  68. package/cjs/src/errors.js.map +1 -1
  69. package/cjs/src/index.d.ts +3 -3
  70. package/cjs/src/index.d.ts.map +1 -1
  71. package/cjs/src/index.js +4 -2
  72. package/cjs/src/index.js.map +1 -1
  73. package/cjs/src/mixpanel-service.d.ts +4 -0
  74. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  75. package/cjs/src/mixpanel-service.js +4 -0
  76. package/cjs/src/mixpanel-service.js.map +1 -1
  77. package/cjs/src/react/all-types-export.d.ts +1 -1
  78. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  79. package/cjs/src/react/all-types-export.js +2 -1
  80. package/cjs/src/react/all-types-export.js.map +1 -1
  81. package/cjs/src/react/all-types-export.parity.spec.d.ts +2 -0
  82. package/cjs/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  83. package/cjs/src/react/all-types-export.parity.spec.js +194 -0
  84. package/cjs/src/react/all-types-export.parity.spec.js.map +1 -0
  85. package/cjs/src/react/index.d.ts +66 -32
  86. package/cjs/src/react/index.d.ts.map +1 -1
  87. package/cjs/src/react/index.js +5 -3
  88. package/cjs/src/react/index.js.map +1 -1
  89. package/cjs/src/react/index.spec.js +101 -0
  90. package/cjs/src/react/index.spec.js.map +1 -1
  91. package/cjs/src/react/util.spec.js +251 -0
  92. package/cjs/src/react/util.spec.js.map +1 -1
  93. package/cjs/src/types.d.ts +902 -28
  94. package/cjs/src/types.d.ts.map +1 -1
  95. package/cjs/src/types.js +701 -14
  96. package/cjs/src/types.js.map +1 -1
  97. package/cjs/src/utils/processData.spec.js +93 -0
  98. package/cjs/src/utils/processData.spec.js.map +1 -1
  99. package/cjs/src/utils/processTrigger.spec.js +61 -0
  100. package/cjs/src/utils/processTrigger.spec.js.map +1 -1
  101. package/cjs/src/utils.spec.js +4 -0
  102. package/cjs/src/utils.spec.js.map +1 -1
  103. package/dist/{index-B5xoN6Cp.js → index-Bivg-mDx.js} +1 -1
  104. package/dist/src/config.d.ts +1 -0
  105. package/dist/src/config.d.ts.map +1 -1
  106. package/dist/src/css-variables.d.ts +122 -0
  107. package/dist/src/css-variables.d.ts.map +1 -1
  108. package/dist/src/embed/app.d.ts +176 -24
  109. package/dist/src/embed/app.d.ts.map +1 -1
  110. package/dist/src/embed/base.d.ts +1 -1
  111. package/dist/src/embed/conversation.d.ts +401 -2
  112. package/dist/src/embed/conversation.d.ts.map +1 -1
  113. package/dist/src/embed/hostEventClient/contracts.d.ts +51 -14
  114. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  115. package/dist/src/embed/hostEventClient/host-event-client.d.ts +2 -1
  116. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  117. package/dist/src/embed/hostEventClient/utils.d.ts +2 -0
  118. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
  119. package/dist/src/embed/liveboard.d.ts +81 -13
  120. package/dist/src/embed/liveboard.d.ts.map +1 -1
  121. package/dist/src/embed/spotter-utils.d.ts +15 -1
  122. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  123. package/dist/src/embed/spotter-viz-utils.d.ts +37 -4
  124. package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
  125. package/dist/src/embed/ts-embed.d.ts +16 -8
  126. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  127. package/dist/src/errors.d.ts +1 -0
  128. package/dist/src/errors.d.ts.map +1 -1
  129. package/dist/src/index.d.ts +3 -3
  130. package/dist/src/index.d.ts.map +1 -1
  131. package/dist/src/mixpanel-service.d.ts +4 -0
  132. package/dist/src/mixpanel-service.d.ts.map +1 -1
  133. package/dist/src/react/all-types-export.d.ts +1 -1
  134. package/dist/src/react/all-types-export.d.ts.map +1 -1
  135. package/dist/src/react/all-types-export.parity.spec.d.ts +2 -0
  136. package/dist/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  137. package/dist/src/react/index.d.ts +66 -32
  138. package/dist/src/react/index.d.ts.map +1 -1
  139. package/dist/src/types.d.ts +902 -28
  140. package/dist/src/types.d.ts.map +1 -1
  141. package/dist/tsembed-react.es.js +1269 -206
  142. package/dist/tsembed-react.js +1268 -205
  143. package/dist/tsembed.es.js +1364 -304
  144. package/dist/tsembed.js +1362 -302
  145. package/dist/visual-embed-sdk-react-full.d.ts +1867 -157
  146. package/dist/visual-embed-sdk-react.d.ts +1872 -161
  147. package/dist/visual-embed-sdk.d.ts +1815 -127
  148. package/lib/package.json +1 -1
  149. package/lib/src/config.d.ts +1 -0
  150. package/lib/src/config.d.ts.map +1 -1
  151. package/lib/src/config.js +1 -0
  152. package/lib/src/config.js.map +1 -1
  153. package/lib/src/css-variables.d.ts +122 -0
  154. package/lib/src/css-variables.d.ts.map +1 -1
  155. package/lib/src/embed/app.d.ts +176 -24
  156. package/lib/src/embed/app.d.ts.map +1 -1
  157. package/lib/src/embed/app.js +87 -39
  158. package/lib/src/embed/app.js.map +1 -1
  159. package/lib/src/embed/app.spec.js +673 -151
  160. package/lib/src/embed/app.spec.js.map +1 -1
  161. package/lib/src/embed/base.d.ts +1 -1
  162. package/lib/src/embed/base.js +1 -1
  163. package/lib/src/embed/conversation.d.ts +401 -2
  164. package/lib/src/embed/conversation.d.ts.map +1 -1
  165. package/lib/src/embed/conversation.js +33 -17
  166. package/lib/src/embed/conversation.js.map +1 -1
  167. package/lib/src/embed/conversation.spec.js +347 -18
  168. package/lib/src/embed/conversation.spec.js.map +1 -1
  169. package/lib/src/embed/events.spec.js +638 -0
  170. package/lib/src/embed/events.spec.js.map +1 -1
  171. package/lib/src/embed/host-events.spec.js +188 -1
  172. package/lib/src/embed/host-events.spec.js.map +1 -1
  173. package/lib/src/embed/hostEventClient/contracts.d.ts +51 -14
  174. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  175. package/lib/src/embed/hostEventClient/contracts.js +10 -0
  176. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  177. package/lib/src/embed/hostEventClient/host-event-client.d.ts +2 -1
  178. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  179. package/lib/src/embed/hostEventClient/host-event-client.js +10 -1
  180. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  181. package/lib/src/embed/hostEventClient/host-event-client.spec.js +236 -0
  182. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  183. package/lib/src/embed/hostEventClient/utils.d.ts +2 -0
  184. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
  185. package/lib/src/embed/hostEventClient/utils.js +28 -1
  186. package/lib/src/embed/hostEventClient/utils.js.map +1 -1
  187. package/lib/src/embed/hostEventClient/utils.spec.js +179 -1
  188. package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -1
  189. package/lib/src/embed/liveboard.d.ts +81 -13
  190. package/lib/src/embed/liveboard.d.ts.map +1 -1
  191. package/lib/src/embed/liveboard.js +50 -9
  192. package/lib/src/embed/liveboard.js.map +1 -1
  193. package/lib/src/embed/liveboard.spec.js +432 -4
  194. package/lib/src/embed/liveboard.spec.js.map +1 -1
  195. package/lib/src/embed/spotter-utils.d.ts +15 -1
  196. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  197. package/lib/src/embed/spotter-utils.js +25 -0
  198. package/lib/src/embed/spotter-utils.js.map +1 -1
  199. package/lib/src/embed/spotter-utils.spec.js +130 -1
  200. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  201. package/lib/src/embed/spotter-viz-utils.d.ts +37 -4
  202. package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
  203. package/lib/src/embed/spotter-viz-utils.js.map +1 -1
  204. package/lib/src/embed/spotter-viz-utils.spec.js +17 -0
  205. package/lib/src/embed/spotter-viz-utils.spec.js.map +1 -1
  206. package/lib/src/embed/ts-embed.d.ts +16 -8
  207. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  208. package/lib/src/embed/ts-embed.js +96 -37
  209. package/lib/src/embed/ts-embed.js.map +1 -1
  210. package/lib/src/embed/ts-embed.spec.js +683 -3
  211. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  212. package/lib/src/errors.d.ts +1 -0
  213. package/lib/src/errors.d.ts.map +1 -1
  214. package/lib/src/errors.js +1 -0
  215. package/lib/src/errors.js.map +1 -1
  216. package/lib/src/index.d.ts +3 -3
  217. package/lib/src/index.d.ts.map +1 -1
  218. package/lib/src/index.js +3 -3
  219. package/lib/src/index.js.map +1 -1
  220. package/lib/src/mixpanel-service.d.ts +4 -0
  221. package/lib/src/mixpanel-service.d.ts.map +1 -1
  222. package/lib/src/mixpanel-service.js +4 -0
  223. package/lib/src/mixpanel-service.js.map +1 -1
  224. package/lib/src/react/all-types-export.d.ts +1 -1
  225. package/lib/src/react/all-types-export.d.ts.map +1 -1
  226. package/lib/src/react/all-types-export.js +1 -1
  227. package/lib/src/react/all-types-export.js.map +1 -1
  228. package/lib/src/react/all-types-export.parity.spec.d.ts +2 -0
  229. package/lib/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  230. package/lib/src/react/all-types-export.parity.spec.js +191 -0
  231. package/lib/src/react/all-types-export.parity.spec.js.map +1 -0
  232. package/lib/src/react/index.d.ts +66 -32
  233. package/lib/src/react/index.d.ts.map +1 -1
  234. package/lib/src/react/index.js +5 -3
  235. package/lib/src/react/index.js.map +1 -1
  236. package/lib/src/react/index.spec.js +102 -1
  237. package/lib/src/react/index.spec.js.map +1 -1
  238. package/lib/src/react/util.spec.js +251 -0
  239. package/lib/src/react/util.spec.js.map +1 -1
  240. package/lib/src/types.d.ts +902 -28
  241. package/lib/src/types.d.ts.map +1 -1
  242. package/lib/src/types.js +701 -14
  243. package/lib/src/types.js.map +1 -1
  244. package/lib/src/utils/processData.spec.js +93 -0
  245. package/lib/src/utils/processData.spec.js.map +1 -1
  246. package/lib/src/utils/processTrigger.spec.js +61 -0
  247. package/lib/src/utils/processTrigger.spec.js.map +1 -1
  248. package/lib/src/utils.spec.js +4 -0
  249. package/lib/src/utils.spec.js.map +1 -1
  250. package/lib/src/visual-embed-sdk.d.ts +1815 -127
  251. package/package.json +1 -1
  252. package/src/config.ts +1 -0
  253. package/src/css-variables.ts +150 -0
  254. package/src/embed/app.spec.ts +877 -196
  255. package/src/embed/app.ts +276 -75
  256. package/src/embed/base.ts +1 -1
  257. package/src/embed/conversation.spec.ts +411 -21
  258. package/src/embed/conversation.ts +441 -18
  259. package/src/embed/events.spec.ts +761 -1
  260. package/src/embed/host-events.spec.ts +242 -0
  261. package/src/embed/hostEventClient/contracts.ts +57 -14
  262. package/src/embed/hostEventClient/host-event-client.spec.ts +372 -0
  263. package/src/embed/hostEventClient/host-event-client.ts +18 -2
  264. package/src/embed/hostEventClient/utils.spec.ts +204 -0
  265. package/src/embed/hostEventClient/utils.ts +37 -10
  266. package/src/embed/liveboard.spec.ts +565 -4
  267. package/src/embed/liveboard.ts +155 -28
  268. package/src/embed/spotter-utils.spec.ts +140 -1
  269. package/src/embed/spotter-utils.ts +36 -1
  270. package/src/embed/spotter-viz-utils.spec.ts +17 -0
  271. package/src/embed/spotter-viz-utils.ts +37 -4
  272. package/src/embed/ts-embed.spec.ts +885 -3
  273. package/src/embed/ts-embed.ts +111 -39
  274. package/src/errors.ts +1 -0
  275. package/src/index.ts +45 -2
  276. package/src/mixpanel-service.ts +4 -0
  277. package/src/react/all-types-export.parity.spec.ts +208 -0
  278. package/src/react/all-types-export.ts +22 -0
  279. package/src/react/index.spec.tsx +158 -0
  280. package/src/react/index.tsx +70 -33
  281. package/src/react/util.spec.tsx +255 -0
  282. package/src/types.ts +904 -24
  283. package/src/utils/processData.spec.ts +97 -0
  284. package/src/utils/processTrigger.spec.ts +91 -0
  285. package/src/utils.spec.ts +5 -0
package/lib/src/types.js CHANGED
@@ -172,7 +172,9 @@ export var AuthType;
172
172
  })(AuthType || (AuthType = {}));
173
173
  /**
174
174
  *
175
- * **Note**: This attribute is not supported in the classic (V1) homepage experience.
175
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
176
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
177
+ * V4 (Focused) home page experiences.
176
178
  *
177
179
  */
178
180
  export var HomeLeftNavItem;
@@ -240,6 +242,13 @@ export var HomeLeftNavItem;
240
242
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
241
243
  */
242
244
  HomeLeftNavItem["Favorites"] = "favorites";
245
+ /**
246
+ * The *Collections* menu option in
247
+ * the *Insights* left navigation panel.
248
+ * Shown when collections are enabled on the cluster.
249
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
250
+ */
251
+ HomeLeftNavItem["Collections"] = "collections";
243
252
  })(HomeLeftNavItem || (HomeLeftNavItem = {}));
244
253
  /**
245
254
  * A map of the supported runtime filter operations
@@ -312,7 +321,9 @@ export var RuntimeFilterOp;
312
321
  * via `hiddenHomepageModules` and reordered via
313
322
  * `reorderedHomepageModules`.
314
323
  *
315
- * **Note**: This option is not supported in the classic (v1) experience.
324
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
325
+ * deprecated. These modules apply to V3 (ModularWithStylingChanges) and
326
+ * V4 (Focused) home page experiences.
316
327
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
317
328
  */
318
329
  export var HomepageModule;
@@ -490,7 +501,7 @@ export var EmbedEvent;
490
501
  * @returns nonFilteredColumns - The columns that were not filtered
491
502
  * @example
492
503
  * ```js
493
- * searchEmbed.on(EmbedEvent.DrillDown, {
504
+ * searchEmbed.on(EmbedEvent.Drilldown, {
494
505
  * points: {
495
506
  * clickedPoint,
496
507
  * selectedPoints: selectedPoint
@@ -551,7 +562,7 @@ export var EmbedEvent;
551
562
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
552
563
  * @example
553
564
  * ```js
554
- * appEmbed.on(EmbedEvent.customAction, payload => {
565
+ * appEmbed.on(EmbedEvent.CustomAction, payload => {
555
566
  * const data = payload.data;
556
567
  * if (data.id === 'insert Custom Action ID here') {
557
568
  * console.log('Custom Action event:', data.embedAnswerData);
@@ -817,8 +828,8 @@ export var EmbedEvent;
817
828
  *
818
829
  * **Note**: This event is deprecated in v1.21.0.
819
830
  * To fire an event when a download action is initiated on a chart or table,
820
- * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
821
- * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
831
+ * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPdf`,
832
+ * `EmbedEvent.DownloadAsCsv`, or `EmbedEvent.DownloadAsXlsx`
822
833
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
823
834
  * @example
824
835
  * ```js
@@ -868,10 +879,10 @@ export var EmbedEvent;
868
879
  * @example
869
880
  * ```js
870
881
  * //emit when action starts
871
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
882
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
872
883
  * console.log('download CSV', payload)}, {start: true })
873
884
  * //emit when action ends
874
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
885
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
875
886
  * console.log('download CSV', payload)})
876
887
  * ```
877
888
  */
@@ -1270,11 +1281,19 @@ export var EmbedEvent;
1270
1281
  * Emitted when a user changes any filter on a Liveboard.
1271
1282
  * Returns filter type and name, column name and ID, and runtime
1272
1283
  * filter details.
1284
+ * The payload includes an optional `applicability` attribute indicating the
1285
+ * scope of the changed filter. It contains a `level` (`LIVEBOARD`,
1286
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
1287
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
1288
+ * is no `targetId`, since the filter applies to the whole Liveboard.
1289
+ * The `applicability` attribute is available from SDK: 1.53.0 |
1290
+ * ThoughtSpot: 26.10.0.cl.
1273
1291
  * @example
1274
1292
  *
1275
1293
  * ```js
1276
1294
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1277
1295
  * console.log('payload', payload);
1296
+ * // payload.data optionally includes applicability: { level, targetId }
1278
1297
  * })
1279
1298
  * ```
1280
1299
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -1466,9 +1485,17 @@ export var EmbedEvent;
1466
1485
  /**
1467
1486
  * Emitted when parameter changes in an Answer
1468
1487
  * or Liveboard.
1488
+ * The payload includes an optional `applicability` attribute indicating the
1489
+ * scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
1490
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
1491
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
1492
+ * is no `targetId`, since the parameter applies to the whole Liveboard.
1493
+ * The `applicability` attribute is available from SDK: 1.53.0 |
1494
+ * ThoughtSpot: 26.10.0.cl.
1469
1495
  * ```js
1470
1496
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
1471
1497
  * console.log('payload', payload);
1498
+ * // payload.data optionally includes applicability: { level, targetId }
1472
1499
  * })
1473
1500
  * ```
1474
1501
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -1770,6 +1797,158 @@ export var EmbedEvent;
1770
1797
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
1771
1798
  */
1772
1799
  EmbedEvent["SpotterConversationDeleted"] = "spotterConversationDeleted";
1800
+ /**
1801
+ * Emitted when the header Share button is clicked. Fires `Start` then `End`
1802
+ * to bracket the interaction. App→host counterpart of the
1803
+ * `ShareSpotterConversation` host event (user-driven vs programmatic open).
1804
+ * @example
1805
+ * ```js
1806
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
1807
+ * // payload: { convId: string }
1808
+ * })
1809
+ * ```
1810
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1811
+ */
1812
+ EmbedEvent["SpotterShareConversationButtonHeaderClicked"] = "spotterShareConversationButtonHeaderClicked";
1813
+ /**
1814
+ * Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
1815
+ * to bracket the interaction.
1816
+ * @example
1817
+ * ```js
1818
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
1819
+ * // payload: { convId: string }
1820
+ * })
1821
+ * ```
1822
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1823
+ */
1824
+ EmbedEvent["SpotterShareConversationMenuItemSidebarClicked"] = "spotterShareConversationMenuItemSidebarClicked";
1825
+ /**
1826
+ * Emitted when a Spotter conversation is shared (recipients added, or a new
1827
+ * share created). The host builds its own link from shareId/convId + its
1828
+ * configured CONVERSATION_URL — no link string is sent. Distinct from
1829
+ * `SpotterShareModalConfirmButtonClicked`, which fires at click time before
1830
+ * the save resolves.
1831
+ * @example
1832
+ * ```js
1833
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
1834
+ * // payload: { convId: string, shareId: string,
1835
+ * // recipientsAdded: string[], recipientsRemoved: string[] }
1836
+ * })
1837
+ * ```
1838
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1839
+ */
1840
+ EmbedEvent["SpotterConversationShared"] = "spotterConversationShared";
1841
+ /**
1842
+ * Emitted when access to a shared Spotter conversation is revoked
1843
+ * (recipients removed). `fullyRevoked` is true when the last sharee is removed
1844
+ * and the share is deleted entirely.
1845
+ * @example
1846
+ * ```js
1847
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
1848
+ * // payload: { convId: string, shareId: string,
1849
+ * // recipientsRemoved: string[], fullyRevoked: boolean }
1850
+ * })
1851
+ * ```
1852
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1853
+ */
1854
+ EmbedEvent["SpotterConversationShareRevoked"] = "spotterConversationShareRevoked";
1855
+ /**
1856
+ * Emitted when a recipient opens a shared Spotter conversation (read-only
1857
+ * view). No shareId available viewer-side.
1858
+ * @example
1859
+ * ```js
1860
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
1861
+ * // payload: { convId: string, sourceConvId: string }
1862
+ * // convId = resolved snapshot conv id; sourceConvId = the shared URL id
1863
+ * })
1864
+ * ```
1865
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1866
+ */
1867
+ EmbedEvent["SpotterSharedConversationViewed"] = "spotterSharedConversationViewed";
1868
+ /**
1869
+ * Emitted when the user toggles the share-modal "include new messages since
1870
+ * last shared version" checkbox.
1871
+ * @example
1872
+ * ```js
1873
+ * spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
1874
+ * // payload: { convId: string, includeNewMessages: boolean }
1875
+ * })
1876
+ * ```
1877
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1878
+ */
1879
+ EmbedEvent["SpotterShareIncludeNewMessagesCheckboxToggled"] = "spotterShareIncludeNewMessagesCheckboxToggled";
1880
+ /**
1881
+ * Emitted when the user dismisses the stale-snapshot info banner via its
1882
+ * cross (distinct from the include-new-messages checkbox toggle).
1883
+ * @example
1884
+ * ```js
1885
+ * spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
1886
+ * // payload: { convId: string }
1887
+ * })
1888
+ * ```
1889
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1890
+ */
1891
+ EmbedEvent["SpotterShareStaleInfoBannerDismissed"] = "spotterShareStaleInfoBannerDismissed";
1892
+ /**
1893
+ * Emitted when the modal Share (confirm) button is clicked — fires at click
1894
+ * time, before the save resolves. Distinct from the `SpotterConversationShared`
1895
+ * / `SpotterConversationShareRevoked` result events.
1896
+ * @example
1897
+ * ```js
1898
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
1899
+ * // payload: { convId: string }
1900
+ * })
1901
+ * ```
1902
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1903
+ */
1904
+ EmbedEvent["SpotterShareModalConfirmButtonClicked"] = "spotterShareModalConfirmButtonClicked";
1905
+ /**
1906
+ * Emitted when the share modal is dismissed via the Cancel button.
1907
+ * @example
1908
+ * ```js
1909
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
1910
+ * // payload: { convId: string }
1911
+ * })
1912
+ * ```
1913
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1914
+ */
1915
+ EmbedEvent["SpotterShareModalCancelButtonClicked"] = "spotterShareModalCancelButtonClicked";
1916
+ /**
1917
+ * Emitted when a recipient leaves the read-only shared view via the Exit
1918
+ * button.
1919
+ * @example
1920
+ * ```js
1921
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
1922
+ * // payload: { convId: string }
1923
+ * })
1924
+ * ```
1925
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1926
+ */
1927
+ EmbedEvent["SpotterSharedConversationExitButtonClicked"] = "spotterSharedConversationExitButtonClicked";
1928
+ /**
1929
+ * Emitted when a Spotter conversation is pinned.
1930
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
1931
+ * @example
1932
+ * ```js
1933
+ * spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
1934
+ * console.log('Conversation pinned', payload);
1935
+ * // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
1936
+ * })
1937
+ * ```
1938
+ */
1939
+ EmbedEvent["SpotterConversationPinned"] = "spotterConversationPinned";
1940
+ /**
1941
+ * Emitted when a Spotter conversation is unpinned.
1942
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
1943
+ * @example
1944
+ * ```js
1945
+ * spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
1946
+ * console.log('Conversation unpinned', payload);
1947
+ * // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
1948
+ * })
1949
+ * ```
1950
+ */
1951
+ EmbedEvent["SpotterConversationUnpinned"] = "spotterConversationUnpinned";
1773
1952
  /**
1774
1953
  * Emitted when a Spotter conversation is selected/clicked.
1775
1954
  * @example
@@ -1782,6 +1961,30 @@ export var EmbedEvent;
1782
1961
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
1783
1962
  */
1784
1963
  EmbedEvent["SpotterConversationSelected"] = "spotterConversationSelected";
1964
+ /**
1965
+ * Emitted when the Spotter agent finishes streaming/rendering a response.
1966
+ * Includes the conversation and message identifiers so the host app can
1967
+ * fetch the full conversation history via the REST API if needed.
1968
+ *
1969
+ * The payload data has the shape `{ convId: string, messageId: string }`.
1970
+ *
1971
+ * Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
1972
+ * inside the full application).
1973
+ * @example
1974
+ * ```js
1975
+ * spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
1976
+ * console.log('Spotter response complete', payload);
1977
+ * })
1978
+ * ```
1979
+ * @example
1980
+ * ```js
1981
+ * appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
1982
+ * console.log('Spotter response complete', payload);
1983
+ * })
1984
+ * ```
1985
+ * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
1986
+ */
1987
+ EmbedEvent["SpotterResponseComplete"] = "spotterResponseComplete";
1785
1988
  /**
1786
1989
  * @hidden
1787
1990
  * Emitted when the auth token is about to get expired and needs to be refreshed.
@@ -2136,6 +2339,7 @@ export var HostEvent;
2136
2339
  * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
2137
2340
  * console.log("iFrameURL", url);
2138
2341
  * ```
2342
+ * @returns iframeUrl - The URL currently loaded in the embedded iframe.
2139
2343
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2140
2344
  */
2141
2345
  HostEvent["GetIframeUrl"] = "GetIframeUrl";
@@ -2262,6 +2466,17 @@ export var HostEvent;
2262
2466
  * name: string,
2263
2467
  * type: ATTRIBUTE/MEASURE,
2264
2468
  * dataType: INT64/CHAR/DATE }
2469
+ *
2470
+ * `applicability` - Optional. Scopes the filter to a specific target,
2471
+ * for example, a single Liveboard tab, so the panel for the correct
2472
+ * scoped filter is opened. Available from SDK: 1.53.0 |
2473
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
2474
+ *
2475
+ * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
2476
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
2477
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
2478
+ * `level` is `LIVEBOARD`, since the filter applies to the whole
2479
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
2265
2480
  * @example
2266
2481
  * ```js
2267
2482
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -2274,6 +2489,14 @@ export var HostEvent;
2274
2489
  * ```
2275
2490
  * @example
2276
2491
  * ```js
2492
+ * // Open a filter scoped to a specific Liveboard tab
2493
+ * liveboardEmbed.trigger(HostEvent.OpenFilter, {
2494
+ * column: { columnId: '<column-GUID>' },
2495
+ * applicability: { level: 'TAB', targetId: '<tab-GUID>' }
2496
+ * });
2497
+ * ```
2498
+ * @example
2499
+ * ```js
2277
2500
  * // Open filter from search context
2278
2501
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
2279
2502
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -2283,6 +2506,73 @@ export var HostEvent;
2283
2506
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2284
2507
  */
2285
2508
  HostEvent["OpenFilter"] = "openFilter";
2509
+ /**
2510
+ * Open the add-filter modal of a Liveboard, the same dialog that the
2511
+ * *Add filter* button in the Liveboard edit header opens, so the host
2512
+ * app can start the add-filter flow from its own UI.
2513
+ *
2514
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
2515
+ * Hiding the *Add filter* button with `hiddenActions:
2516
+ * [Action.AddFilter]` does not block this event, but disabling it with
2517
+ * `disabledActions` does.
2518
+ *
2519
+ * Unlike {@link HostEvent.OpenFilter}, which opens the panel of an
2520
+ * existing filter, this event starts the creation of a new filter.
2521
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
2522
+ * @example
2523
+ * ```js
2524
+ * liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);
2525
+ * ```
2526
+ */
2527
+ HostEvent["OpenAddFilterModal"] = "openAddFilterModal";
2528
+ /**
2529
+ * Open the add-parameter panel of a Liveboard, the same panel that the
2530
+ * *Add parameter* button in the Liveboard edit header opens.
2531
+ * Mirrors {@link HostEvent.OpenAddFilterModal} for parameters.
2532
+ *
2533
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
2534
+ * Hiding the *Add parameter* button with `hiddenActions:
2535
+ * [Action.AddParameter]` does not block this event, but disabling it
2536
+ * with `disabledActions` does.
2537
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
2538
+ * @example
2539
+ * ```js
2540
+ * liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);
2541
+ * ```
2542
+ */
2543
+ HostEvent["OpenAddParameterModal"] = "openAddParameterModal";
2544
+ /**
2545
+ * Open the parameter panel for a particular parameter on a Liveboard.
2546
+ * Mirrors {@link HostEvent.OpenFilter} for parameters.
2547
+ * @param - Includes the following keys:
2548
+ * - `parameter`: An object identifying the parameter to open, for
2549
+ * example, `{ parameterId: '<parameter-GUID>' }`.
2550
+ * - `applicability`: Optional. Scopes the parameter to a specific target,
2551
+ * for example, a single Liveboard tab, so the panel for the correct
2552
+ * scoped parameter is opened. Includes the following attributes:
2553
+ *
2554
+ * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
2555
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
2556
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
2557
+ * `level` is `LIVEBOARD`, since the parameter applies to the whole
2558
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
2559
+ * @example
2560
+ * ```js
2561
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
2562
+ * parameter: { parameterId: '<parameter-GUID>' }
2563
+ * });
2564
+ * ```
2565
+ * @example
2566
+ * ```js
2567
+ * // Open a parameter scoped to a specific group
2568
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
2569
+ * parameter: { parameterId: '<parameter-GUID>' },
2570
+ * applicability: { level: 'GROUP', targetId: '<group-GUID>' }
2571
+ * });
2572
+ * ```
2573
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
2574
+ */
2575
+ HostEvent["OpenParameter"] = "openParameter";
2286
2576
  /**
2287
2577
  * Add columns to the current search query.
2288
2578
  * @param - { columnIds: string[] }
@@ -2332,6 +2622,10 @@ export var HostEvent;
2332
2622
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
2333
2623
  * data=>console.log(data))
2334
2624
  * ```
2625
+ * @returns data - Object with a `v2Content` string: the export request
2626
+ * payload for the current Liveboard.
2627
+ * @returns type - The passthrough event name,
2628
+ * `getExportRequestForCurrentPinboard`.
2335
2629
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2336
2630
  */
2337
2631
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
@@ -2434,6 +2728,9 @@ export var HostEvent;
2434
2728
  * }, ContextType.Spotter);
2435
2729
  * ```
2436
2730
  *
2731
+ * @returns liveboardId - GUID of the Liveboard the Answer was pinned to.
2732
+ * @returns tabId - GUID of the tab within that Liveboard.
2733
+ * @returns vizId - GUID of the newly created visualization.
2437
2734
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2438
2735
  */
2439
2736
  HostEvent["Pin"] = "pin";
@@ -2472,13 +2769,13 @@ export var HostEvent;
2472
2769
  * Trigger the **Manage schedule** action on an embedded Liveboard
2473
2770
  * @example
2474
2771
  * ```js
2475
- * liveboardEmbed.trigger(HostEvent.ScheduleList)
2772
+ * liveboardEmbed.trigger(HostEvent.SchedulesList)
2476
2773
  * ```
2477
2774
  * @example
2478
2775
  * ```js
2479
2776
  * // Manage schedules from liveboard context
2480
2777
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
2481
- * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
2778
+ * liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);
2482
2779
  * ```
2483
2780
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2484
2781
  */
@@ -2923,6 +3220,7 @@ export var HostEvent;
2923
3220
  * console.log(tml.answer);
2924
3221
  * });
2925
3222
  * ```
3223
+ * @returns The TML representation of the current Answer, as an object.
2926
3224
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2927
3225
  * @important
2928
3226
  */
@@ -3347,6 +3645,14 @@ export var HostEvent;
3347
3645
  /**
3348
3646
  * Get details of filters applied on the Liveboard.
3349
3647
  * Returns arrays containing Liveboard filter and runtime filter elements.
3648
+ * Each Liveboard filter includes an optional `applicability` attribute
3649
+ * indicating the scope of the filter. It contains a `level`
3650
+ * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
3651
+ * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
3652
+ * level there is no `targetId`, since the filter applies to the
3653
+ * whole Liveboard.
3654
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3655
+ * ThoughtSpot: 26.10.0.cl.
3350
3656
  * @example
3351
3657
  * ```js
3352
3658
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -3359,6 +3665,8 @@ export var HostEvent;
3359
3665
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
3360
3666
  * console.log('filters', data);
3361
3667
  * ```
3668
+ * @returns liveboardFilters - Filters applied on the Liveboard.
3669
+ * @returns runtimeFilters - Runtime filters applied on the Liveboard.
3362
3670
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3363
3671
  */
3364
3672
  HostEvent["GetFilters"] = "getFilters";
@@ -3386,6 +3694,16 @@ export var HostEvent;
3386
3694
  *
3387
3695
  * `type` - To update filters for date time, specify the date format type.
3388
3696
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
3697
+ *
3698
+ * `applicability` - Optional. Scopes the filter to a specific target,
3699
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3700
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3701
+ *
3702
+ * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
3703
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
3704
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
3705
+ * `level` is `LIVEBOARD`, since the filter applies to the whole
3706
+ * Liveboard.
3389
3707
  * @example
3390
3708
  * ```js
3391
3709
  *
@@ -3462,6 +3780,21 @@ export var HostEvent;
3462
3780
  * }
3463
3781
  * }, ContextType.Liveboard);
3464
3782
  * ```
3783
+ * @example
3784
+ * ```js
3785
+ * // Scope the filter to a specific Liveboard tab
3786
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
3787
+ * filter: {
3788
+ * column: "item type",
3789
+ * oper: "IN",
3790
+ * values: ["bags", "shirts"],
3791
+ * applicability: {
3792
+ * level: "TAB",
3793
+ * targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
3794
+ * }
3795
+ * }
3796
+ * });
3797
+ * ```
3465
3798
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3466
3799
  */
3467
3800
  HostEvent["UpdateFilters"] = "updateFilters";
@@ -3483,9 +3816,37 @@ export var HostEvent;
3483
3816
  * console.log('tabs', tabDetails);
3484
3817
  * });
3485
3818
  * ```
3819
+ * @returns orderedTabIds - Tab GUIDs in the order they appear.
3820
+ * @returns numberOfTabs - Total number of tabs on the Liveboard.
3821
+ * @returns Tabs - Tab details, each with at least `id` and `name`.
3486
3822
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
3487
3823
  */
3488
3824
  HostEvent["GetTabs"] = "getTabs";
3825
+ /**
3826
+ * Get group details for the current Liveboard.
3827
+ * Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
3828
+ * @example
3829
+ * ```js
3830
+ * liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
3831
+ * console.log(
3832
+ * groupDetails // GroupDetails of current Liveboard
3833
+ * );
3834
+ * })
3835
+ * ```
3836
+ * @example
3837
+ * ```js
3838
+ * // Get groups from liveboard context
3839
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3840
+ * liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
3841
+ * console.log('groups', groupDetails);
3842
+ * });
3843
+ * ```
3844
+ * @returns orderedGroupIds - Group GUIDs in the order they appear.
3845
+ * @returns numberOfGroups - Total number of groups on the Liveboard.
3846
+ * @returns Groups - Group details, each with at least `id` and `name`.
3847
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
3848
+ */
3849
+ HostEvent["GetGroups"] = "getGroups";
3489
3850
  /**
3490
3851
  * Set the visible tabs on a Liveboard.
3491
3852
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -3557,6 +3918,9 @@ export var HostEvent;
3557
3918
  * // Alternative direct usage (not recommended)
3558
3919
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
3559
3920
  * ```
3921
+ * @returns session - Session identifier for the Answer, for use with the
3922
+ * `AnswerService`.
3923
+ * @returns embedAnswerData - Data backing the Answer, when available.
3560
3924
  * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
3561
3925
  */
3562
3926
  HostEvent["GetAnswerSession"] = "getAnswerSession";
@@ -3613,6 +3977,15 @@ export var HostEvent;
3613
3977
  * - `name`: Name of the parameter.
3614
3978
  * - `value`: The value to set for the parameter.
3615
3979
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
3980
+ * - `applicability`: Optional. Scopes the parameter to a specific target,
3981
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3982
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3983
+ *
3984
+ * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
3985
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
3986
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
3987
+ * `level` is `LIVEBOARD`, since the parameter applies to the whole
3988
+ * Liveboard.
3616
3989
  *
3617
3990
  * @example
3618
3991
  * ```js
@@ -3624,6 +3997,18 @@ export var HostEvent;
3624
3997
  * ```
3625
3998
  * @example
3626
3999
  * ```js
4000
+ * // Scope the parameter to a specific Liveboard tab
4001
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
4002
+ * name: "Integer Range Param",
4003
+ * value: 10,
4004
+ * applicability: {
4005
+ * level: "TAB",
4006
+ * targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
4007
+ * }
4008
+ * }])
4009
+ * ```
4010
+ * @example
4011
+ * ```js
3627
4012
  * // Update parameters from liveboard context
3628
4013
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3629
4014
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -3637,6 +4022,14 @@ export var HostEvent;
3637
4022
  HostEvent["UpdateParameters"] = "UpdateParameters";
3638
4023
  /**
3639
4024
  * Triggers GetParameters to fetch the runtime Parameters.
4025
+ * Each parameter includes an optional `applicability` attribute
4026
+ * indicating the scope of the parameter. It contains a `level`
4027
+ * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
4028
+ * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
4029
+ * level there is no `targetId`, since the parameter applies to the
4030
+ * whole Liveboard.
4031
+ * The `applicability` attribute is available from SDK: 1.53.0 |
4032
+ * ThoughtSpot: 26.10.0.cl.
3640
4033
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3641
4034
  * ```js
3642
4035
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
@@ -3661,12 +4054,16 @@ export var HostEvent;
3661
4054
  * console.log('parameters', parameters);
3662
4055
  * });
3663
4056
  * ```
4057
+ * @returns parameters - Parameters currently applied on the Liveboard.
3664
4058
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
3665
4059
  */
3666
4060
  HostEvent["GetParameters"] = "GetParameters";
3667
4061
  /**
3668
4062
  * Triggers an event to update a personalized view of a Liveboard.
3669
- * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
4063
+ * This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
4064
+ * which additionally accepts a `viewName`, resets to the original view when
4065
+ * called with an empty payload, and reports an error when a named view
4066
+ * cannot be found.
3670
4067
  * ```js
3671
4068
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
3672
4069
  * ```
@@ -3684,10 +4081,15 @@ export var HostEvent;
3684
4081
  HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
3685
4082
  /**
3686
4083
  * Triggers an event to update a personalized view of a Liveboard.
4084
+ * This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
4085
+ * which additionally accepts a `viewName`, resets to the original view when
4086
+ * called with an empty payload, and reports an error when a named view
4087
+ * cannot be found.
3687
4088
  * ```js
3688
4089
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
3689
4090
  * ```
3690
4091
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4092
+ * @deprecated SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
3691
4093
  */
3692
4094
  HostEvent["UpdatePersonalizedView"] = "UpdatePersonalisedView";
3693
4095
  /**
@@ -3790,6 +4192,10 @@ export var HostEvent;
3790
4192
  * description: "Generated from Spotter"
3791
4193
  * }, ContextType.Spotter);
3792
4194
  * ```
4195
+ * @returns answerId - GUID of the saved Answer.
4196
+ * @returns saveResponse - Raw response from the save operation.
4197
+ * @returns shareResponse - Raw response from the share operation, when the
4198
+ * Answer was also made discoverable.
3793
4199
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
3794
4200
  */
3795
4201
  HostEvent["SaveAnswer"] = "saveAnswer";
@@ -3903,6 +4309,36 @@ export var HostEvent;
3903
4309
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3904
4310
  */
3905
4311
  HostEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
4312
+ /**
4313
+ * Opens the Spotter share-conversation modal for the given conversation.
4314
+ * `conversationId` is **mandatory** — you must pass the id of the
4315
+ * conversation to share. Also no-op when sharing is disabled
4316
+ * (enableShareConversation off) or when already in the read-only shared view.
4317
+ * @example
4318
+ * ```js
4319
+ * spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
4320
+ * ```
4321
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4322
+ */
4323
+ HostEvent["ShareSpotterConversation"] = "ShareSpotterConversation";
4324
+ /**
4325
+ * Closes the Spotter share-conversation modal. No-op if none is open.
4326
+ * @example
4327
+ * ```js
4328
+ * spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
4329
+ * ```
4330
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4331
+ */
4332
+ HostEvent["CloseSpotterShareConversation"] = "CloseSpotterShareConversation";
4333
+ /**
4334
+ * Exits the read-only shared-conversation view.
4335
+ * @example
4336
+ * ```js
4337
+ * spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
4338
+ * ```
4339
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4340
+ */
4341
+ HostEvent["ExitSpotterSharedConversation"] = "ExitSpotterSharedConversation";
3906
4342
  /**
3907
4343
  * Deletes the last prompt in spotter embed.
3908
4344
  * @example
@@ -3998,6 +4434,41 @@ export var HostEvent;
3998
4434
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3999
4435
  */
4000
4436
  HostEvent["StartNewSpotterConversation"] = "StartNewSpotterConversation";
4437
+ /**
4438
+ * Pins a saved Spotter conversation so it floats to the top of the past
4439
+ * conversations sidebar. The `conversationId` of the conversation to pin is
4440
+ * required.
4441
+ *
4442
+ * This feature is available only when chat history is enabled on your ThoughtSpot
4443
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
4444
+ * instance.
4445
+ *
4446
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4447
+ * @example
4448
+ * ```js
4449
+ * spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
4450
+ * conversationId: '<conversation-id>',
4451
+ * });
4452
+ * ```
4453
+ */
4454
+ HostEvent["PinSpotterConversation"] = "PinSpotterConversation";
4455
+ /**
4456
+ * Unpins a previously pinned Spotter conversation. The `conversationId` of the
4457
+ * conversation to unpin is required.
4458
+ *
4459
+ * This feature is available only when chat history is enabled on your ThoughtSpot
4460
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
4461
+ * instance.
4462
+ *
4463
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4464
+ * @example
4465
+ * ```js
4466
+ * spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
4467
+ * conversationId: '<conversation-id>',
4468
+ * });
4469
+ * ```
4470
+ */
4471
+ HostEvent["UnpinSpotterConversation"] = "UnpinSpotterConversation";
4001
4472
  /**
4002
4473
  * @hidden
4003
4474
  * Get the current context of the embedded page.
@@ -4206,6 +4677,7 @@ export var Param;
4206
4677
  Param["NumberFormatLocale"] = "numberFormatLocale";
4207
4678
  Param["CurrencyFormat"] = "currencyFormat";
4208
4679
  Param["Enable2ColumnLayout"] = "enable2ColumnLayout";
4680
+ Param["IsLiveboardAlwaysOn12ColLayout"] = "isLiveboardAlwaysOn12ColLayout";
4209
4681
  Param["IsFullAppEmbed"] = "isFullAppEmbed";
4210
4682
  Param["IsOnBeforeGetVizDataInterceptEnabled"] = "isOnBeforeGetVizDataInterceptEnabled";
4211
4683
  Param["FocusSearchBarOnRender"] = "focusSearchBarOnRender";
@@ -4219,6 +4691,7 @@ export var Param;
4219
4691
  Param["SpotterEnabled"] = "isSpotterExperienceEnabled";
4220
4692
  Param["IsUnifiedSearchExperienceEnabled"] = "isUnifiedSearchExperienceEnabled";
4221
4693
  Param["OverrideOrgId"] = "orgId";
4694
+ Param["OverrideHistoryState"] = "overrideHistoryState";
4222
4695
  Param["OauthPollingInterval"] = "oAuthPollingInterval";
4223
4696
  Param["IsForceRedirect"] = "isForceRedirect";
4224
4697
  Param["DataSourceId"] = "dataSourceId";
@@ -4228,6 +4701,7 @@ export var Param;
4228
4701
  Param["PrimaryAction"] = "primaryAction";
4229
4702
  Param["isSpotterAgentEmbed"] = "isSpotterAgentEmbed";
4230
4703
  Param["IsLiveboardStylingAndGroupingEnabled"] = "isLiveboardStylingAndGroupingEnabled";
4704
+ Param["LiveboardGutter"] = "liveboardGutter";
4231
4705
  Param["IsLazyLoadingForEmbedEnabled"] = "isLazyLoadingForEmbedEnabled";
4232
4706
  Param["RootMarginForLazyLoad"] = "rootMarginForLazyLoad";
4233
4707
  Param["isPNGInScheduledEmailsEnabled"] = "isPNGInScheduledEmailsEnabled";
@@ -4236,9 +4710,12 @@ export var Param;
4236
4710
  Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
4237
4711
  Param["isSendNowLiveboardSchedulingEnabled"] = "isSendNowLiveboardSchedulingEnabled";
4238
4712
  Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
4713
+ Param["isScopedLiveboardFilteringEnabled"] = "isScopedLiveboardFilteringEnabled";
4239
4714
  Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
4240
4715
  Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
4241
4716
  Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
4717
+ Param["ShowSpotterRadiance"] = "showSpotterRadiance";
4718
+ Param["DefaultQueryMode"] = "defaultQueryMode";
4242
4719
  Param["EnableStopAnswerGenerationEmbed"] = "enableStopAnswerGenerationEmbed";
4243
4720
  Param["SpotterSidebarTitle"] = "spotterSidebarTitle";
4244
4721
  Param["SpotterSidebarDefaultExpanded"] = "spotterSidebarDefaultExpanded";
@@ -4258,14 +4735,19 @@ export var Param;
4258
4735
  Param["SpotterFileUploadEnabled"] = "spotterFileUploadEnabled";
4259
4736
  Param["SpotterFileUploadFileTypes"] = "spotterFileUploadFileTypes";
4260
4737
  Param["IsStarterPromptsEnabled"] = "enableStarterPrompts";
4738
+ Param["UpdatedSpotterExperience"] = "updatedSpotterExperience";
4739
+ Param["SpotterDataSources"] = "spotterDataSources";
4740
+ Param["AnalystId"] = "analystId";
4741
+ Param["OpenSpotterOnLiveboardByDefault"] = "openSpotterOnLiveboardByDefault";
4261
4742
  })(Param || (Param = {}));
4262
4743
  /**
4263
4744
  * ThoughtSpot application pages include actions and menu commands
4264
4745
  * for various user-initiated operations. These actions are represented
4265
4746
  * as enumeration members in the SDK. To control actions in the embedded view:
4266
- * - disabledActions — the action is grayed out and still visible, but non-interactive (user can see but not click).
4267
- * - hiddenActions — the action is completely removed from the UI (user cannot see it at all).
4268
- * - visibleActions — allowlist, only these actions are shown; all others are hidden.
4747
+ * - disabledActions — the action is grayed out and still visible, but non-interactive
4748
+ * (user can see but not click). - hiddenActions — the action is completely removed from
4749
+ * the UI (user cannot see it at all). - visibleActions — allowlist, only these actions
4750
+ * are shown; all others are hidden.
4269
4751
  *
4270
4752
  * Use disabledActions to disable (gray out) an action.
4271
4753
  * Use hiddenActions to hide (fully remove) an action.
@@ -4319,6 +4801,17 @@ export var Action;
4319
4801
  * ```
4320
4802
  */
4321
4803
  Action["SaveAsView"] = "saveAsView";
4804
+ /**
4805
+ * The **EditInputTable** action on a Liveboard
4806
+ * page. Allows users to edit an input table used in an Answer directly from
4807
+ * a Liveboard.
4808
+ * @example
4809
+ * ```js
4810
+ * disabledActions: [Action.EditInputTable]
4811
+ * ```
4812
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4813
+ */
4814
+ Action["EditInputTable"] = "editInputTable";
4322
4815
  /**
4323
4816
  * The **Make a copy** action on a Liveboard or Answer
4324
4817
  * page. Creates a copy of the Liveboard.
@@ -5522,6 +6015,19 @@ export var Action;
5522
6015
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
5523
6016
  */
5524
6017
  Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
6018
+ /**
6019
+ * Action ID to show, hide, or disable all filter surfaces on a Liveboard,
6020
+ * including filter, parameter, and cross-filter chips at the liveboard,
6021
+ * tab, and group levels. Parameter and cross-filter chips are hide-only.
6022
+ *
6023
+ * @example
6024
+ * ```js
6025
+ * hiddenActions: [Action.AllLiveboardFilters]
6026
+ * disabledActions: [Action.AllLiveboardFilters]
6027
+ * ```
6028
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
6029
+ */
6030
+ Action["AllLiveboardFilters"] = "allLiveboardFilters";
5525
6031
  /**
5526
6032
  * The **Data model instructions** button on the Spotter interface.
5527
6033
  * Allows opening the data model instructions modal.
@@ -5623,6 +6129,10 @@ export var Action;
5623
6129
  * The **Add to Coaching** feature allows adding reference questions and
5624
6130
  * business terms to improve Spotter’s responses. This feature is generally available
5625
6131
  * (GA) from version 26.2.0.cl and enabled by default on embed deployments.
6132
+ *
6133
+ * This action governs both the answer-card **Add to memory** CTA and its
6134
+ * Spotter 3 successor, the response-footer **Remember this** CTA
6135
+ * (they are mutually exclusive).
5626
6136
  * @example
5627
6137
  * ```js
5628
6138
  * hiddenAction: [Action.InConversationTraining]
@@ -5857,6 +6367,89 @@ export var Action;
5857
6367
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5858
6368
  */
5859
6369
  Action["SpotterChatRename"] = "spotterChatRename";
6370
+ /**
6371
+ * Controls visibility and disable state of the Spotter conversation Share
6372
+ * button in the chat header. Only takes effect once sharing is enabled
6373
+ * (enableShareConversation on).
6374
+ * @example
6375
+ * ```js
6376
+ * disabledActions: [Action.SpotterShareConversationButtonHeader]
6377
+ * ```
6378
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6379
+ */
6380
+ Action["SpotterShareConversationButtonHeader"] = "spotterShareConversationButtonHeader";
6381
+ /**
6382
+ * Controls visibility and disable state of the Share item in the Spotter
6383
+ * conversation history (sidebar) edit menu. Independent of the header button
6384
+ * above, so a host can show Share in one entry point and hide it in the other.
6385
+ * @example
6386
+ * ```js
6387
+ * disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
6388
+ * ```
6389
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6390
+ */
6391
+ Action["SpotterShareConversationMenuItemSidebar"] = "spotterShareConversationMenuItemSidebar";
6392
+ /**
6393
+ * Controls visibility of the entire read-only shared-conversation data-access
6394
+ * banner shown when a recipient opens a shared view. Hide-only.
6395
+ * @example
6396
+ * ```js
6397
+ * hiddenActions: [Action.SpotterSharedConversationBanner]
6398
+ * ```
6399
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6400
+ */
6401
+ Action["SpotterSharedConversationBanner"] = "spotterSharedConversationBanner";
6402
+ /**
6403
+ * Controls visibility and disable state of the cross/close button on the
6404
+ * read-only shared-conversation data-access banner (keeps the banner itself).
6405
+ * @example
6406
+ * ```js
6407
+ * hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
6408
+ * ```
6409
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6410
+ */
6411
+ Action["SpotterSharedConversationBannerDismissButton"] = "spotterSharedConversationBannerDismissButton";
6412
+ /**
6413
+ * Controls visibility and disable state of the Exit button in the read-only
6414
+ * shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
6415
+ * host event.
6416
+ * @example
6417
+ * ```js
6418
+ * hiddenActions: [Action.SpotterSharedConversationExitButton]
6419
+ * ```
6420
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6421
+ */
6422
+ Action["SpotterSharedConversationExitButton"] = "spotterSharedConversationExitButton";
6423
+ /**
6424
+ * Controls visibility of the share-modal footer note ("Chat will be shared up
6425
+ * to the current moment…"). Hide-only.
6426
+ * @example
6427
+ * ```js
6428
+ * hiddenActions: [Action.SpotterShareUpToCurrentInfo]
6429
+ * ```
6430
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6431
+ */
6432
+ Action["SpotterShareUpToCurrentInfo"] = "spotterShareUpToCurrentInfo";
6433
+ /**
6434
+ * Controls visibility and disable state of the share-modal "include new
6435
+ * messages since last shared version" checkbox.
6436
+ * @example
6437
+ * ```js
6438
+ * disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
6439
+ * ```
6440
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6441
+ */
6442
+ Action["SpotterShareIncludeNewMessagesCheckbox"] = "spotterShareIncludeNewMessagesCheckbox";
6443
+ /**
6444
+ * Controls visibility and disable state of the cross on the share-modal
6445
+ * stale-snapshot info banner.
6446
+ * @example
6447
+ * ```js
6448
+ * hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
6449
+ * ```
6450
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6451
+ */
6452
+ Action["SpotterShareStaleInfoBannerDismissButton"] = "spotterShareStaleInfoBannerDismissButton";
5860
6453
  /**
5861
6454
  * Controls visibility and disable state of the delete action
5862
6455
  * in the Spotter conversation edit menu.
@@ -5867,6 +6460,16 @@ export var Action;
5867
6460
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5868
6461
  */
5869
6462
  Action["SpotterChatDelete"] = "spotterChatDelete";
6463
+ /**
6464
+ * Controls visibility and disable state of the pin/unpin action
6465
+ * in the Spotter conversation edit menu.
6466
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6467
+ * @example
6468
+ * ```js
6469
+ * disabledActions: [Action.SpotterChatPin]
6470
+ * ```
6471
+ */
6472
+ Action["SpotterChatPin"] = "spotterChatPin";
5870
6473
  /**
5871
6474
  * Controls visibility and disable state of the documentation/best practices
5872
6475
  * link in the Spotter sidebar footer.
@@ -5910,6 +6513,56 @@ export var Action;
5910
6513
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
5911
6514
  */
5912
6515
  Action["SpotterChatModeSwitcher"] = "spotterChatModeSwitcher";
6516
+ /**
6517
+ * The **Basic Search** starter prompt pill.
6518
+ *
6519
+ * Starter prompt pills are the row of category buttons shown above the
6520
+ * Spotter chat input before a conversation starts. They give a new user
6521
+ * ready-made questions to click instead of typing one from scratch, and
6522
+ * disappear once the conversation begins. There are three, one per action
6523
+ * below.
6524
+ *
6525
+ * Clicking this pill opens a card of suggested simple questions; picking one
6526
+ * submits it to Spotter right away. Visible by default, and hidden along
6527
+ * with the other pills when the surface itself is off (see
6528
+ * {@link SpotterChatViewConfig.starterPrompts}).
6529
+ * @example
6530
+ * ```js
6531
+ * hiddenActions: [Action.QuickSearchPill]
6532
+ * ```
6533
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6534
+ */
6535
+ Action["QuickSearchPill"] = "quickSearchPill";
6536
+ /**
6537
+ * The **Deep Analysis** starter prompt pill, next to
6538
+ * {@link Action.QuickSearchPill} above the Spotter chat input.
6539
+ *
6540
+ * Clicking it opens a card of suggested investigative questions ("why did
6541
+ * revenue drop?"). Picking one fills the chat input in Deep Analysis mode
6542
+ * rather than submitting immediately, so the user can edit it first.
6543
+ * Visible by default.
6544
+ * @example
6545
+ * ```js
6546
+ * hiddenActions: [Action.DeepAnalysisPill]
6547
+ * ```
6548
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6549
+ */
6550
+ Action["DeepAnalysisPill"] = "deepAnalysisPill";
6551
+ /**
6552
+ * The **Data Literacy** starter prompt pill, next to
6553
+ * {@link Action.QuickSearchPill} above the Spotter chat input.
6554
+ *
6555
+ * Unlike the other two pills it opens no card: clicking it submits a prompt
6556
+ * that describes the data the model can answer over, helping a user who does
6557
+ * not yet know what is in the data source. The prompt text always comes from
6558
+ * ThoughtSpot, so only its label is customizable. Visible by default.
6559
+ * @example
6560
+ * ```js
6561
+ * hiddenActions: [Action.DataLiteracyPill]
6562
+ * ```
6563
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6564
+ */
6565
+ Action["DataLiteracyPill"] = "dataLiteracyPill";
5913
6566
  /**
5914
6567
  * The **Include current period** checkbox for date filters.
5915
6568
  * Controls the visibility and availability of the option to include
@@ -6058,6 +6711,38 @@ export var Action;
6058
6711
  * ```
6059
6712
  */
6060
6713
  Action["SpotterAnalystSidebar"] = "spotterAnalystSidebar";
6714
+ /**
6715
+ * Controls visibility and disable state of the analyst list
6716
+ * ("Show all") in the Spotter Analyst interface.
6717
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6718
+ * @example
6719
+ * ```js
6720
+ * hiddenActions: [Action.SpotterAnalystList]
6721
+ * disabledActions: [Action.SpotterAnalystList]
6722
+ * ```
6723
+ */
6724
+ Action["SpotterAnalystList"] = "spotterAnalystList";
6725
+ /**
6726
+ * Controls visibility and disable state of the default Spotter analyst
6727
+ * entry in the Spotter Analyst interface.
6728
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6729
+ * @example
6730
+ * ```js
6731
+ * hiddenActions: [Action.SpotterDefaultAnalyst]
6732
+ * disabledActions: [Action.SpotterDefaultAnalyst]
6733
+ * ```
6734
+ */
6735
+ Action["SpotterDefaultAnalyst"] = "spotterDefaultAnalyst";
6736
+ /**
6737
+ * The **Spotter** button in the Liveboard header.
6738
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6739
+ * @example
6740
+ * ```js
6741
+ * hiddenActions: [Action.SpotterOnLiveboard]
6742
+ * disabledActions: [Action.SpotterOnLiveboard]
6743
+ * ```
6744
+ */
6745
+ Action["SpotterOnLiveboard"] = "spotterOnLiveboard";
6061
6746
  })(Action || (Action = {}));
6062
6747
  export var PrefetchFeatures;
6063
6748
  (function (PrefetchFeatures) {
@@ -6345,6 +7030,8 @@ export var EmbedErrorCodes;
6345
7030
  EmbedErrorCodes["UPDATEFILTERS_INVALID_PAYLOAD"] = "UPDATEFILTERS_INVALID_PAYLOAD";
6346
7031
  /** DrillDown payload is invalid - missing or malformed points */
6347
7032
  EmbedErrorCodes["DRILLDOWN_INVALID_PAYLOAD"] = "DRILLDOWN_INVALID_PAYLOAD";
7033
+ /** UpdateParameters payload is invalid - malformed applicability */
7034
+ EmbedErrorCodes["UPDATEPARAMETERS_INVALID_PAYLOAD"] = "UPDATEPARAMETERS_INVALID_PAYLOAD";
6348
7035
  })(EmbedErrorCodes || (EmbedErrorCodes = {}));
6349
7036
  /**
6350
7037
  * Context types for specifying the page context when triggering host events.