@thoughtspot/visual-embed-sdk 1.50.1 → 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 (238) 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 +63 -0
  7. package/cjs/src/css-variables.d.ts.map +1 -1
  8. package/cjs/src/embed/app.d.ts +148 -25
  9. package/cjs/src/embed/app.d.ts.map +1 -1
  10. package/cjs/src/embed/app.js +74 -37
  11. package/cjs/src/embed/app.js.map +1 -1
  12. package/cjs/src/embed/app.spec.js +571 -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 +375 -2
  17. package/cjs/src/embed/conversation.d.ts.map +1 -1
  18. package/cjs/src/embed/conversation.js +21 -15
  19. package/cjs/src/embed/conversation.js.map +1 -1
  20. package/cjs/src/embed/conversation.spec.js +323 -17
  21. package/cjs/src/embed/conversation.spec.js.map +1 -1
  22. package/cjs/src/embed/events.spec.js +45 -0
  23. package/cjs/src/embed/events.spec.js.map +1 -1
  24. package/cjs/src/embed/host-events.spec.js +81 -0
  25. package/cjs/src/embed/host-events.spec.js.map +1 -1
  26. package/cjs/src/embed/hostEventClient/contracts.d.ts +15 -0
  27. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  28. package/cjs/src/embed/hostEventClient/contracts.js +1 -0
  29. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  30. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +1 -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 +1 -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 +27 -0
  35. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  36. package/cjs/src/embed/liveboard.d.ts +76 -14
  37. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  38. package/cjs/src/embed/liveboard.js +50 -9
  39. package/cjs/src/embed/liveboard.js.map +1 -1
  40. package/cjs/src/embed/liveboard.spec.js +432 -4
  41. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  42. package/cjs/src/embed/spotter-utils.d.ts +15 -1
  43. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  44. package/cjs/src/embed/spotter-utils.js +28 -1
  45. package/cjs/src/embed/spotter-utils.js.map +1 -1
  46. package/cjs/src/embed/spotter-utils.spec.js +129 -0
  47. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  48. package/cjs/src/embed/spotter-viz-utils.d.ts +9 -10
  49. package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
  50. package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
  51. package/cjs/src/embed/ts-embed.d.ts +16 -8
  52. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  53. package/cjs/src/embed/ts-embed.js +82 -30
  54. package/cjs/src/embed/ts-embed.js.map +1 -1
  55. package/cjs/src/embed/ts-embed.spec.js +537 -3
  56. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  57. package/cjs/src/index.d.ts +3 -3
  58. package/cjs/src/index.d.ts.map +1 -1
  59. package/cjs/src/index.js +3 -2
  60. package/cjs/src/index.js.map +1 -1
  61. package/cjs/src/mixpanel-service.d.ts +4 -0
  62. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  63. package/cjs/src/mixpanel-service.js +4 -0
  64. package/cjs/src/mixpanel-service.js.map +1 -1
  65. package/cjs/src/react/all-types-export.d.ts +1 -1
  66. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  67. package/cjs/src/react/all-types-export.js +2 -1
  68. package/cjs/src/react/all-types-export.js.map +1 -1
  69. package/cjs/src/react/all-types-export.parity.spec.d.ts +2 -0
  70. package/cjs/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  71. package/cjs/src/react/all-types-export.parity.spec.js +194 -0
  72. package/cjs/src/react/all-types-export.parity.spec.js.map +1 -0
  73. package/cjs/src/react/index.d.ts +66 -32
  74. package/cjs/src/react/index.d.ts.map +1 -1
  75. package/cjs/src/react/index.js +5 -3
  76. package/cjs/src/react/index.js.map +1 -1
  77. package/cjs/src/react/index.spec.js +101 -0
  78. package/cjs/src/react/index.spec.js.map +1 -1
  79. package/cjs/src/types.d.ts +789 -32
  80. package/cjs/src/types.d.ts.map +1 -1
  81. package/cjs/src/types.js +610 -20
  82. package/cjs/src/types.js.map +1 -1
  83. package/cjs/src/utils.spec.js +4 -0
  84. package/cjs/src/utils.spec.js.map +1 -1
  85. package/dist/{index-fCne7kmU.js → index-Bivg-mDx.js} +1 -1
  86. package/dist/src/config.d.ts +1 -0
  87. package/dist/src/config.d.ts.map +1 -1
  88. package/dist/src/css-variables.d.ts +63 -0
  89. package/dist/src/css-variables.d.ts.map +1 -1
  90. package/dist/src/embed/app.d.ts +148 -25
  91. package/dist/src/embed/app.d.ts.map +1 -1
  92. package/dist/src/embed/base.d.ts +1 -1
  93. package/dist/src/embed/conversation.d.ts +375 -2
  94. package/dist/src/embed/conversation.d.ts.map +1 -1
  95. package/dist/src/embed/hostEventClient/contracts.d.ts +15 -0
  96. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  97. package/dist/src/embed/hostEventClient/host-event-client.d.ts +1 -1
  98. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  99. package/dist/src/embed/liveboard.d.ts +76 -14
  100. package/dist/src/embed/liveboard.d.ts.map +1 -1
  101. package/dist/src/embed/spotter-utils.d.ts +15 -1
  102. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  103. package/dist/src/embed/spotter-viz-utils.d.ts +9 -10
  104. package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
  105. package/dist/src/embed/ts-embed.d.ts +16 -8
  106. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  107. package/dist/src/index.d.ts +3 -3
  108. package/dist/src/index.d.ts.map +1 -1
  109. package/dist/src/mixpanel-service.d.ts +4 -0
  110. package/dist/src/mixpanel-service.d.ts.map +1 -1
  111. package/dist/src/react/all-types-export.d.ts +1 -1
  112. package/dist/src/react/all-types-export.d.ts.map +1 -1
  113. package/dist/src/react/all-types-export.parity.spec.d.ts +2 -0
  114. package/dist/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  115. package/dist/src/react/index.d.ts +66 -32
  116. package/dist/src/react/index.d.ts.map +1 -1
  117. package/dist/src/types.d.ts +789 -32
  118. package/dist/src/types.d.ts.map +1 -1
  119. package/dist/tsembed-react.es.js +878 -120
  120. package/dist/tsembed-react.js +877 -119
  121. package/dist/tsembed.es.js +936 -181
  122. package/dist/tsembed.js +938 -183
  123. package/dist/visual-embed-sdk-react-full.d.ts +1553 -128
  124. package/dist/visual-embed-sdk-react.d.ts +1555 -129
  125. package/dist/visual-embed-sdk.d.ts +1499 -100
  126. package/lib/package.json +1 -1
  127. package/lib/src/config.d.ts +1 -0
  128. package/lib/src/config.d.ts.map +1 -1
  129. package/lib/src/config.js +1 -0
  130. package/lib/src/config.js.map +1 -1
  131. package/lib/src/css-variables.d.ts +63 -0
  132. package/lib/src/css-variables.d.ts.map +1 -1
  133. package/lib/src/embed/app.d.ts +148 -25
  134. package/lib/src/embed/app.d.ts.map +1 -1
  135. package/lib/src/embed/app.js +75 -38
  136. package/lib/src/embed/app.js.map +1 -1
  137. package/lib/src/embed/app.spec.js +572 -151
  138. package/lib/src/embed/app.spec.js.map +1 -1
  139. package/lib/src/embed/base.d.ts +1 -1
  140. package/lib/src/embed/base.js +1 -1
  141. package/lib/src/embed/conversation.d.ts +375 -2
  142. package/lib/src/embed/conversation.d.ts.map +1 -1
  143. package/lib/src/embed/conversation.js +23 -17
  144. package/lib/src/embed/conversation.js.map +1 -1
  145. package/lib/src/embed/conversation.spec.js +323 -17
  146. package/lib/src/embed/conversation.spec.js.map +1 -1
  147. package/lib/src/embed/events.spec.js +45 -0
  148. package/lib/src/embed/events.spec.js.map +1 -1
  149. package/lib/src/embed/host-events.spec.js +81 -0
  150. package/lib/src/embed/host-events.spec.js.map +1 -1
  151. package/lib/src/embed/hostEventClient/contracts.d.ts +15 -0
  152. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  153. package/lib/src/embed/hostEventClient/contracts.js +1 -0
  154. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  155. package/lib/src/embed/hostEventClient/host-event-client.d.ts +1 -1
  156. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  157. package/lib/src/embed/hostEventClient/host-event-client.js +1 -0
  158. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  159. package/lib/src/embed/hostEventClient/host-event-client.spec.js +27 -0
  160. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  161. package/lib/src/embed/liveboard.d.ts +76 -14
  162. package/lib/src/embed/liveboard.d.ts.map +1 -1
  163. package/lib/src/embed/liveboard.js +50 -9
  164. package/lib/src/embed/liveboard.js.map +1 -1
  165. package/lib/src/embed/liveboard.spec.js +432 -4
  166. package/lib/src/embed/liveboard.spec.js.map +1 -1
  167. package/lib/src/embed/spotter-utils.d.ts +15 -1
  168. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  169. package/lib/src/embed/spotter-utils.js +25 -0
  170. package/lib/src/embed/spotter-utils.js.map +1 -1
  171. package/lib/src/embed/spotter-utils.spec.js +130 -1
  172. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  173. package/lib/src/embed/spotter-viz-utils.d.ts +9 -10
  174. package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
  175. package/lib/src/embed/spotter-viz-utils.js.map +1 -1
  176. package/lib/src/embed/ts-embed.d.ts +16 -8
  177. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  178. package/lib/src/embed/ts-embed.js +82 -30
  179. package/lib/src/embed/ts-embed.js.map +1 -1
  180. package/lib/src/embed/ts-embed.spec.js +537 -3
  181. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  182. package/lib/src/index.d.ts +3 -3
  183. package/lib/src/index.d.ts.map +1 -1
  184. package/lib/src/index.js +2 -2
  185. package/lib/src/index.js.map +1 -1
  186. package/lib/src/mixpanel-service.d.ts +4 -0
  187. package/lib/src/mixpanel-service.d.ts.map +1 -1
  188. package/lib/src/mixpanel-service.js +4 -0
  189. package/lib/src/mixpanel-service.js.map +1 -1
  190. package/lib/src/react/all-types-export.d.ts +1 -1
  191. package/lib/src/react/all-types-export.d.ts.map +1 -1
  192. package/lib/src/react/all-types-export.js +1 -1
  193. package/lib/src/react/all-types-export.js.map +1 -1
  194. package/lib/src/react/all-types-export.parity.spec.d.ts +2 -0
  195. package/lib/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  196. package/lib/src/react/all-types-export.parity.spec.js +191 -0
  197. package/lib/src/react/all-types-export.parity.spec.js.map +1 -0
  198. package/lib/src/react/index.d.ts +66 -32
  199. package/lib/src/react/index.d.ts.map +1 -1
  200. package/lib/src/react/index.js +5 -3
  201. package/lib/src/react/index.js.map +1 -1
  202. package/lib/src/react/index.spec.js +102 -1
  203. package/lib/src/react/index.spec.js.map +1 -1
  204. package/lib/src/types.d.ts +789 -32
  205. package/lib/src/types.d.ts.map +1 -1
  206. package/lib/src/types.js +610 -20
  207. package/lib/src/types.js.map +1 -1
  208. package/lib/src/utils.spec.js +4 -0
  209. package/lib/src/utils.spec.js.map +1 -1
  210. package/lib/src/visual-embed-sdk.d.ts +1499 -100
  211. package/package.json +1 -1
  212. package/src/config.ts +1 -0
  213. package/src/css-variables.ts +77 -0
  214. package/src/embed/app.spec.ts +729 -188
  215. package/src/embed/app.ts +240 -75
  216. package/src/embed/base.ts +1 -1
  217. package/src/embed/conversation.spec.ts +379 -20
  218. package/src/embed/conversation.ts +412 -18
  219. package/src/embed/events.spec.ts +56 -0
  220. package/src/embed/host-events.spec.ts +118 -0
  221. package/src/embed/hostEventClient/contracts.ts +16 -0
  222. package/src/embed/hostEventClient/host-event-client.spec.ts +46 -0
  223. package/src/embed/hostEventClient/host-event-client.ts +3 -2
  224. package/src/embed/liveboard.spec.ts +565 -4
  225. package/src/embed/liveboard.ts +150 -29
  226. package/src/embed/spotter-utils.spec.ts +140 -1
  227. package/src/embed/spotter-utils.ts +36 -1
  228. package/src/embed/spotter-viz-utils.ts +9 -10
  229. package/src/embed/ts-embed.spec.ts +699 -3
  230. package/src/embed/ts-embed.ts +99 -35
  231. package/src/index.ts +44 -2
  232. package/src/mixpanel-service.ts +4 -0
  233. package/src/react/all-types-export.parity.spec.ts +208 -0
  234. package/src/react/all-types-export.ts +22 -0
  235. package/src/react/index.spec.tsx +158 -0
  236. package/src/react/index.tsx +70 -33
  237. package/src/types.ts +791 -30
  238. 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;
@@ -319,7 +321,9 @@ export var RuntimeFilterOp;
319
321
  * via `hiddenHomepageModules` and reordered via
320
322
  * `reorderedHomepageModules`.
321
323
  *
322
- * **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.
323
327
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
324
328
  */
325
329
  export var HomepageModule;
@@ -497,7 +501,7 @@ export var EmbedEvent;
497
501
  * @returns nonFilteredColumns - The columns that were not filtered
498
502
  * @example
499
503
  * ```js
500
- * searchEmbed.on(EmbedEvent.DrillDown, {
504
+ * searchEmbed.on(EmbedEvent.Drilldown, {
501
505
  * points: {
502
506
  * clickedPoint,
503
507
  * selectedPoints: selectedPoint
@@ -558,7 +562,7 @@ export var EmbedEvent;
558
562
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
559
563
  * @example
560
564
  * ```js
561
- * appEmbed.on(EmbedEvent.customAction, payload => {
565
+ * appEmbed.on(EmbedEvent.CustomAction, payload => {
562
566
  * const data = payload.data;
563
567
  * if (data.id === 'insert Custom Action ID here') {
564
568
  * console.log('Custom Action event:', data.embedAnswerData);
@@ -824,8 +828,8 @@ export var EmbedEvent;
824
828
  *
825
829
  * **Note**: This event is deprecated in v1.21.0.
826
830
  * To fire an event when a download action is initiated on a chart or table,
827
- * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
828
- * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
831
+ * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPdf`,
832
+ * `EmbedEvent.DownloadAsCsv`, or `EmbedEvent.DownloadAsXlsx`
829
833
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
830
834
  * @example
831
835
  * ```js
@@ -875,10 +879,10 @@ export var EmbedEvent;
875
879
  * @example
876
880
  * ```js
877
881
  * //emit when action starts
878
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
882
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
879
883
  * console.log('download CSV', payload)}, {start: true })
880
884
  * //emit when action ends
881
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
885
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
882
886
  * console.log('download CSV', payload)})
883
887
  * ```
884
888
  */
@@ -1277,11 +1281,19 @@ export var EmbedEvent;
1277
1281
  * Emitted when a user changes any filter on a Liveboard.
1278
1282
  * Returns filter type and name, column name and ID, and runtime
1279
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.
1280
1291
  * @example
1281
1292
  *
1282
1293
  * ```js
1283
1294
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1284
1295
  * console.log('payload', payload);
1296
+ * // payload.data optionally includes applicability: { level, targetId }
1285
1297
  * })
1286
1298
  * ```
1287
1299
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -1473,9 +1485,17 @@ export var EmbedEvent;
1473
1485
  /**
1474
1486
  * Emitted when parameter changes in an Answer
1475
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.
1476
1495
  * ```js
1477
1496
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
1478
1497
  * console.log('payload', payload);
1498
+ * // payload.data optionally includes applicability: { level, targetId }
1479
1499
  * })
1480
1500
  * ```
1481
1501
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -1777,6 +1797,158 @@ export var EmbedEvent;
1777
1797
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
1778
1798
  */
1779
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";
1780
1952
  /**
1781
1953
  * Emitted when a Spotter conversation is selected/clicked.
1782
1954
  * @example
@@ -2167,6 +2339,7 @@ export var HostEvent;
2167
2339
  * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
2168
2340
  * console.log("iFrameURL", url);
2169
2341
  * ```
2342
+ * @returns iframeUrl - The URL currently loaded in the embedded iframe.
2170
2343
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2171
2344
  */
2172
2345
  HostEvent["GetIframeUrl"] = "GetIframeUrl";
@@ -2293,6 +2466,17 @@ export var HostEvent;
2293
2466
  * name: string,
2294
2467
  * type: ATTRIBUTE/MEASURE,
2295
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.
2296
2480
  * @example
2297
2481
  * ```js
2298
2482
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -2305,6 +2489,14 @@ export var HostEvent;
2305
2489
  * ```
2306
2490
  * @example
2307
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
2308
2500
  * // Open filter from search context
2309
2501
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
2310
2502
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -2314,6 +2506,73 @@ export var HostEvent;
2314
2506
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2315
2507
  */
2316
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";
2317
2576
  /**
2318
2577
  * Add columns to the current search query.
2319
2578
  * @param - { columnIds: string[] }
@@ -2363,6 +2622,10 @@ export var HostEvent;
2363
2622
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
2364
2623
  * data=>console.log(data))
2365
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`.
2366
2629
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2367
2630
  */
2368
2631
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
@@ -2465,6 +2728,9 @@ export var HostEvent;
2465
2728
  * }, ContextType.Spotter);
2466
2729
  * ```
2467
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.
2468
2734
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2469
2735
  */
2470
2736
  HostEvent["Pin"] = "pin";
@@ -2503,13 +2769,13 @@ export var HostEvent;
2503
2769
  * Trigger the **Manage schedule** action on an embedded Liveboard
2504
2770
  * @example
2505
2771
  * ```js
2506
- * liveboardEmbed.trigger(HostEvent.ScheduleList)
2772
+ * liveboardEmbed.trigger(HostEvent.SchedulesList)
2507
2773
  * ```
2508
2774
  * @example
2509
2775
  * ```js
2510
2776
  * // Manage schedules from liveboard context
2511
2777
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
2512
- * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
2778
+ * liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);
2513
2779
  * ```
2514
2780
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2515
2781
  */
@@ -2954,6 +3220,7 @@ export var HostEvent;
2954
3220
  * console.log(tml.answer);
2955
3221
  * });
2956
3222
  * ```
3223
+ * @returns The TML representation of the current Answer, as an object.
2957
3224
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2958
3225
  * @important
2959
3226
  */
@@ -3378,13 +3645,13 @@ export var HostEvent;
3378
3645
  /**
3379
3646
  * Get details of filters applied on the Liveboard.
3380
3647
  * Returns arrays containing Liveboard filter and runtime filter elements.
3381
- * Each Liveboard filter may include an `applicability` attribute
3648
+ * Each Liveboard filter includes an optional `applicability` attribute
3382
3649
  * indicating the scope of the filter. It contains a `level`
3383
3650
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
3384
3651
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
3385
3652
  * level there is no `targetId`, since the filter applies to the
3386
3653
  * whole Liveboard.
3387
- * The `applicability` attribute is available from SDK: 1.51.0 |
3654
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3388
3655
  * ThoughtSpot: 26.10.0.cl.
3389
3656
  * @example
3390
3657
  * ```js
@@ -3398,6 +3665,8 @@ export var HostEvent;
3398
3665
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
3399
3666
  * console.log('filters', data);
3400
3667
  * ```
3668
+ * @returns liveboardFilters - Filters applied on the Liveboard.
3669
+ * @returns runtimeFilters - Runtime filters applied on the Liveboard.
3401
3670
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3402
3671
  */
3403
3672
  HostEvent["GetFilters"] = "getFilters";
@@ -3427,7 +3696,7 @@ export var HostEvent;
3427
3696
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
3428
3697
  *
3429
3698
  * `applicability` - Optional. Scopes the filter to a specific target,
3430
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
3699
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3431
3700
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3432
3701
  *
3433
3702
  * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -3547,9 +3816,37 @@ export var HostEvent;
3547
3816
  * console.log('tabs', tabDetails);
3548
3817
  * });
3549
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`.
3550
3822
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
3551
3823
  */
3552
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";
3553
3850
  /**
3554
3851
  * Set the visible tabs on a Liveboard.
3555
3852
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -3621,6 +3918,9 @@ export var HostEvent;
3621
3918
  * // Alternative direct usage (not recommended)
3622
3919
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
3623
3920
  * ```
3921
+ * @returns session - Session identifier for the Answer, for use with the
3922
+ * `AnswerService`.
3923
+ * @returns embedAnswerData - Data backing the Answer, when available.
3624
3924
  * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
3625
3925
  */
3626
3926
  HostEvent["GetAnswerSession"] = "getAnswerSession";
@@ -3678,7 +3978,7 @@ export var HostEvent;
3678
3978
  * - `value`: The value to set for the parameter.
3679
3979
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
3680
3980
  * - `applicability`: Optional. Scopes the parameter to a specific target,
3681
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
3981
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3682
3982
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3683
3983
  *
3684
3984
  * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -3722,13 +4022,13 @@ export var HostEvent;
3722
4022
  HostEvent["UpdateParameters"] = "UpdateParameters";
3723
4023
  /**
3724
4024
  * Triggers GetParameters to fetch the runtime Parameters.
3725
- * Each parameter may include an `applicability` attribute
4025
+ * Each parameter includes an optional `applicability` attribute
3726
4026
  * indicating the scope of the parameter. It contains a `level`
3727
4027
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
3728
4028
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
3729
4029
  * level there is no `targetId`, since the parameter applies to the
3730
4030
  * whole Liveboard.
3731
- * The `applicability` attribute is available from SDK: 1.51.0 |
4031
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3732
4032
  * ThoughtSpot: 26.10.0.cl.
3733
4033
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3734
4034
  * ```js
@@ -3754,12 +4054,16 @@ export var HostEvent;
3754
4054
  * console.log('parameters', parameters);
3755
4055
  * });
3756
4056
  * ```
4057
+ * @returns parameters - Parameters currently applied on the Liveboard.
3757
4058
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
3758
4059
  */
3759
4060
  HostEvent["GetParameters"] = "GetParameters";
3760
4061
  /**
3761
4062
  * Triggers an event to update a personalized view of a Liveboard.
3762
- * 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.
3763
4067
  * ```js
3764
4068
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
3765
4069
  * ```
@@ -3777,10 +4081,15 @@ export var HostEvent;
3777
4081
  HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
3778
4082
  /**
3779
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.
3780
4088
  * ```js
3781
4089
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
3782
4090
  * ```
3783
4091
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4092
+ * @deprecated SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
3784
4093
  */
3785
4094
  HostEvent["UpdatePersonalizedView"] = "UpdatePersonalisedView";
3786
4095
  /**
@@ -3883,6 +4192,10 @@ export var HostEvent;
3883
4192
  * description: "Generated from Spotter"
3884
4193
  * }, ContextType.Spotter);
3885
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.
3886
4199
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
3887
4200
  */
3888
4201
  HostEvent["SaveAnswer"] = "saveAnswer";
@@ -3996,6 +4309,36 @@ export var HostEvent;
3996
4309
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3997
4310
  */
3998
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";
3999
4342
  /**
4000
4343
  * Deletes the last prompt in spotter embed.
4001
4344
  * @example
@@ -4091,6 +4434,41 @@ export var HostEvent;
4091
4434
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4092
4435
  */
4093
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";
4094
4472
  /**
4095
4473
  * @hidden
4096
4474
  * Get the current context of the embedded page.
@@ -4299,6 +4677,7 @@ export var Param;
4299
4677
  Param["NumberFormatLocale"] = "numberFormatLocale";
4300
4678
  Param["CurrencyFormat"] = "currencyFormat";
4301
4679
  Param["Enable2ColumnLayout"] = "enable2ColumnLayout";
4680
+ Param["IsLiveboardAlwaysOn12ColLayout"] = "isLiveboardAlwaysOn12ColLayout";
4302
4681
  Param["IsFullAppEmbed"] = "isFullAppEmbed";
4303
4682
  Param["IsOnBeforeGetVizDataInterceptEnabled"] = "isOnBeforeGetVizDataInterceptEnabled";
4304
4683
  Param["FocusSearchBarOnRender"] = "focusSearchBarOnRender";
@@ -4322,6 +4701,7 @@ export var Param;
4322
4701
  Param["PrimaryAction"] = "primaryAction";
4323
4702
  Param["isSpotterAgentEmbed"] = "isSpotterAgentEmbed";
4324
4703
  Param["IsLiveboardStylingAndGroupingEnabled"] = "isLiveboardStylingAndGroupingEnabled";
4704
+ Param["LiveboardGutter"] = "liveboardGutter";
4325
4705
  Param["IsLazyLoadingForEmbedEnabled"] = "isLazyLoadingForEmbedEnabled";
4326
4706
  Param["RootMarginForLazyLoad"] = "rootMarginForLazyLoad";
4327
4707
  Param["isPNGInScheduledEmailsEnabled"] = "isPNGInScheduledEmailsEnabled";
@@ -4330,9 +4710,11 @@ export var Param;
4330
4710
  Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
4331
4711
  Param["isSendNowLiveboardSchedulingEnabled"] = "isSendNowLiveboardSchedulingEnabled";
4332
4712
  Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
4713
+ Param["isScopedLiveboardFilteringEnabled"] = "isScopedLiveboardFilteringEnabled";
4333
4714
  Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
4334
4715
  Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
4335
4716
  Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
4717
+ Param["ShowSpotterRadiance"] = "showSpotterRadiance";
4336
4718
  Param["DefaultQueryMode"] = "defaultQueryMode";
4337
4719
  Param["EnableStopAnswerGenerationEmbed"] = "enableStopAnswerGenerationEmbed";
4338
4720
  Param["SpotterSidebarTitle"] = "spotterSidebarTitle";
@@ -4353,14 +4735,19 @@ export var Param;
4353
4735
  Param["SpotterFileUploadEnabled"] = "spotterFileUploadEnabled";
4354
4736
  Param["SpotterFileUploadFileTypes"] = "spotterFileUploadFileTypes";
4355
4737
  Param["IsStarterPromptsEnabled"] = "enableStarterPrompts";
4738
+ Param["UpdatedSpotterExperience"] = "updatedSpotterExperience";
4739
+ Param["SpotterDataSources"] = "spotterDataSources";
4740
+ Param["AnalystId"] = "analystId";
4741
+ Param["OpenSpotterOnLiveboardByDefault"] = "openSpotterOnLiveboardByDefault";
4356
4742
  })(Param || (Param = {}));
4357
4743
  /**
4358
4744
  * ThoughtSpot application pages include actions and menu commands
4359
4745
  * for various user-initiated operations. These actions are represented
4360
4746
  * as enumeration members in the SDK. To control actions in the embedded view:
4361
- * - disabledActions — the action is grayed out and still visible, but non-interactive (user can see but not click).
4362
- * - hiddenActions — the action is completely removed from the UI (user cannot see it at all).
4363
- * - 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.
4364
4751
  *
4365
4752
  * Use disabledActions to disable (gray out) an action.
4366
4753
  * Use hiddenActions to hide (fully remove) an action.
@@ -4414,6 +4801,17 @@ export var Action;
4414
4801
  * ```
4415
4802
  */
4416
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";
4417
4815
  /**
4418
4816
  * The **Make a copy** action on a Liveboard or Answer
4419
4817
  * page. Creates a copy of the Liveboard.
@@ -5617,6 +6015,19 @@ export var Action;
5617
6015
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
5618
6016
  */
5619
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";
5620
6031
  /**
5621
6032
  * The **Data model instructions** button on the Spotter interface.
5622
6033
  * Allows opening the data model instructions modal.
@@ -5718,6 +6129,10 @@ export var Action;
5718
6129
  * The **Add to Coaching** feature allows adding reference questions and
5719
6130
  * business terms to improve Spotter’s responses. This feature is generally available
5720
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).
5721
6136
  * @example
5722
6137
  * ```js
5723
6138
  * hiddenAction: [Action.InConversationTraining]
@@ -5952,6 +6367,89 @@ export var Action;
5952
6367
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5953
6368
  */
5954
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";
5955
6453
  /**
5956
6454
  * Controls visibility and disable state of the delete action
5957
6455
  * in the Spotter conversation edit menu.
@@ -5962,6 +6460,16 @@ export var Action;
5962
6460
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5963
6461
  */
5964
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";
5965
6473
  /**
5966
6474
  * Controls visibility and disable state of the documentation/best practices
5967
6475
  * link in the Spotter sidebar footer.
@@ -6005,6 +6513,56 @@ export var Action;
6005
6513
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
6006
6514
  */
6007
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";
6008
6566
  /**
6009
6567
  * The **Include current period** checkbox for date filters.
6010
6568
  * Controls the visibility and availability of the option to include
@@ -6153,6 +6711,38 @@ export var Action;
6153
6711
  * ```
6154
6712
  */
6155
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";
6156
6746
  })(Action || (Action = {}));
6157
6747
  export var PrefetchFeatures;
6158
6748
  (function (PrefetchFeatures) {