@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/cjs/src/types.js CHANGED
@@ -175,7 +175,9 @@ var AuthType;
175
175
  })(AuthType = exports.AuthType || (exports.AuthType = {}));
176
176
  /**
177
177
  *
178
- * **Note**: This attribute is not supported in the classic (V1) homepage experience.
178
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
179
+ * deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
180
+ * V4 (Focused) home page experiences.
179
181
  *
180
182
  */
181
183
  var HomeLeftNavItem;
@@ -322,7 +324,9 @@ var RuntimeFilterOp;
322
324
  * via `hiddenHomepageModules` and reordered via
323
325
  * `reorderedHomepageModules`.
324
326
  *
325
- * **Note**: This option is not supported in the classic (v1) experience.
327
+ * **Note**: The classic (V1) and Modular (V2) home page experiences are
328
+ * deprecated. These modules apply to V3 (ModularWithStylingChanges) and
329
+ * V4 (Focused) home page experiences.
326
330
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
327
331
  */
328
332
  var HomepageModule;
@@ -500,7 +504,7 @@ var EmbedEvent;
500
504
  * @returns nonFilteredColumns - The columns that were not filtered
501
505
  * @example
502
506
  * ```js
503
- * searchEmbed.on(EmbedEvent.DrillDown, {
507
+ * searchEmbed.on(EmbedEvent.Drilldown, {
504
508
  * points: {
505
509
  * clickedPoint,
506
510
  * selectedPoints: selectedPoint
@@ -561,7 +565,7 @@ var EmbedEvent;
561
565
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
562
566
  * @example
563
567
  * ```js
564
- * appEmbed.on(EmbedEvent.customAction, payload => {
568
+ * appEmbed.on(EmbedEvent.CustomAction, payload => {
565
569
  * const data = payload.data;
566
570
  * if (data.id === 'insert Custom Action ID here') {
567
571
  * console.log('Custom Action event:', data.embedAnswerData);
@@ -827,8 +831,8 @@ var EmbedEvent;
827
831
  *
828
832
  * **Note**: This event is deprecated in v1.21.0.
829
833
  * To fire an event when a download action is initiated on a chart or table,
830
- * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
831
- * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
834
+ * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPdf`,
835
+ * `EmbedEvent.DownloadAsCsv`, or `EmbedEvent.DownloadAsXlsx`
832
836
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
833
837
  * @example
834
838
  * ```js
@@ -878,10 +882,10 @@ var EmbedEvent;
878
882
  * @example
879
883
  * ```js
880
884
  * //emit when action starts
881
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
885
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
882
886
  * console.log('download CSV', payload)}, {start: true })
883
887
  * //emit when action ends
884
- * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
888
+ * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
885
889
  * console.log('download CSV', payload)})
886
890
  * ```
887
891
  */
@@ -1280,11 +1284,19 @@ var EmbedEvent;
1280
1284
  * Emitted when a user changes any filter on a Liveboard.
1281
1285
  * Returns filter type and name, column name and ID, and runtime
1282
1286
  * filter details.
1287
+ * The payload includes an optional `applicability` attribute indicating the
1288
+ * scope of the changed filter. It contains a `level` (`LIVEBOARD`,
1289
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
1290
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
1291
+ * is no `targetId`, since the filter applies to the whole Liveboard.
1292
+ * The `applicability` attribute is available from SDK: 1.53.0 |
1293
+ * ThoughtSpot: 26.10.0.cl.
1283
1294
  * @example
1284
1295
  *
1285
1296
  * ```js
1286
1297
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1287
1298
  * console.log('payload', payload);
1299
+ * // payload.data optionally includes applicability: { level, targetId }
1288
1300
  * })
1289
1301
  * ```
1290
1302
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
@@ -1476,9 +1488,17 @@ var EmbedEvent;
1476
1488
  /**
1477
1489
  * Emitted when parameter changes in an Answer
1478
1490
  * or Liveboard.
1491
+ * The payload includes an optional `applicability` attribute indicating the
1492
+ * scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
1493
+ * `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
1494
+ * `targetId` with the GUID of the target. At `LIVEBOARD` level there
1495
+ * is no `targetId`, since the parameter applies to the whole Liveboard.
1496
+ * The `applicability` attribute is available from SDK: 1.53.0 |
1497
+ * ThoughtSpot: 26.10.0.cl.
1479
1498
  * ```js
1480
1499
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
1481
1500
  * console.log('payload', payload);
1501
+ * // payload.data optionally includes applicability: { level, targetId }
1482
1502
  * })
1483
1503
  * ```
1484
1504
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
@@ -1780,6 +1800,158 @@ var EmbedEvent;
1780
1800
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
1781
1801
  */
1782
1802
  EmbedEvent["SpotterConversationDeleted"] = "spotterConversationDeleted";
1803
+ /**
1804
+ * Emitted when the header Share button is clicked. Fires `Start` then `End`
1805
+ * to bracket the interaction. App→host counterpart of the
1806
+ * `ShareSpotterConversation` host event (user-driven vs programmatic open).
1807
+ * @example
1808
+ * ```js
1809
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
1810
+ * // payload: { convId: string }
1811
+ * })
1812
+ * ```
1813
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1814
+ */
1815
+ EmbedEvent["SpotterShareConversationButtonHeaderClicked"] = "spotterShareConversationButtonHeaderClicked";
1816
+ /**
1817
+ * Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
1818
+ * to bracket the interaction.
1819
+ * @example
1820
+ * ```js
1821
+ * spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
1822
+ * // payload: { convId: string }
1823
+ * })
1824
+ * ```
1825
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1826
+ */
1827
+ EmbedEvent["SpotterShareConversationMenuItemSidebarClicked"] = "spotterShareConversationMenuItemSidebarClicked";
1828
+ /**
1829
+ * Emitted when a Spotter conversation is shared (recipients added, or a new
1830
+ * share created). The host builds its own link from shareId/convId + its
1831
+ * configured CONVERSATION_URL — no link string is sent. Distinct from
1832
+ * `SpotterShareModalConfirmButtonClicked`, which fires at click time before
1833
+ * the save resolves.
1834
+ * @example
1835
+ * ```js
1836
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
1837
+ * // payload: { convId: string, shareId: string,
1838
+ * // recipientsAdded: string[], recipientsRemoved: string[] }
1839
+ * })
1840
+ * ```
1841
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1842
+ */
1843
+ EmbedEvent["SpotterConversationShared"] = "spotterConversationShared";
1844
+ /**
1845
+ * Emitted when access to a shared Spotter conversation is revoked
1846
+ * (recipients removed). `fullyRevoked` is true when the last sharee is removed
1847
+ * and the share is deleted entirely.
1848
+ * @example
1849
+ * ```js
1850
+ * spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
1851
+ * // payload: { convId: string, shareId: string,
1852
+ * // recipientsRemoved: string[], fullyRevoked: boolean }
1853
+ * })
1854
+ * ```
1855
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1856
+ */
1857
+ EmbedEvent["SpotterConversationShareRevoked"] = "spotterConversationShareRevoked";
1858
+ /**
1859
+ * Emitted when a recipient opens a shared Spotter conversation (read-only
1860
+ * view). No shareId available viewer-side.
1861
+ * @example
1862
+ * ```js
1863
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
1864
+ * // payload: { convId: string, sourceConvId: string }
1865
+ * // convId = resolved snapshot conv id; sourceConvId = the shared URL id
1866
+ * })
1867
+ * ```
1868
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1869
+ */
1870
+ EmbedEvent["SpotterSharedConversationViewed"] = "spotterSharedConversationViewed";
1871
+ /**
1872
+ * Emitted when the user toggles the share-modal "include new messages since
1873
+ * last shared version" checkbox.
1874
+ * @example
1875
+ * ```js
1876
+ * spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
1877
+ * // payload: { convId: string, includeNewMessages: boolean }
1878
+ * })
1879
+ * ```
1880
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1881
+ */
1882
+ EmbedEvent["SpotterShareIncludeNewMessagesCheckboxToggled"] = "spotterShareIncludeNewMessagesCheckboxToggled";
1883
+ /**
1884
+ * Emitted when the user dismisses the stale-snapshot info banner via its
1885
+ * cross (distinct from the include-new-messages checkbox toggle).
1886
+ * @example
1887
+ * ```js
1888
+ * spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
1889
+ * // payload: { convId: string }
1890
+ * })
1891
+ * ```
1892
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1893
+ */
1894
+ EmbedEvent["SpotterShareStaleInfoBannerDismissed"] = "spotterShareStaleInfoBannerDismissed";
1895
+ /**
1896
+ * Emitted when the modal Share (confirm) button is clicked — fires at click
1897
+ * time, before the save resolves. Distinct from the `SpotterConversationShared`
1898
+ * / `SpotterConversationShareRevoked` result events.
1899
+ * @example
1900
+ * ```js
1901
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
1902
+ * // payload: { convId: string }
1903
+ * })
1904
+ * ```
1905
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1906
+ */
1907
+ EmbedEvent["SpotterShareModalConfirmButtonClicked"] = "spotterShareModalConfirmButtonClicked";
1908
+ /**
1909
+ * Emitted when the share modal is dismissed via the Cancel button.
1910
+ * @example
1911
+ * ```js
1912
+ * spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
1913
+ * // payload: { convId: string }
1914
+ * })
1915
+ * ```
1916
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1917
+ */
1918
+ EmbedEvent["SpotterShareModalCancelButtonClicked"] = "spotterShareModalCancelButtonClicked";
1919
+ /**
1920
+ * Emitted when a recipient leaves the read-only shared view via the Exit
1921
+ * button.
1922
+ * @example
1923
+ * ```js
1924
+ * spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
1925
+ * // payload: { convId: string }
1926
+ * })
1927
+ * ```
1928
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
1929
+ */
1930
+ EmbedEvent["SpotterSharedConversationExitButtonClicked"] = "spotterSharedConversationExitButtonClicked";
1931
+ /**
1932
+ * Emitted when a Spotter conversation is pinned.
1933
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
1934
+ * @example
1935
+ * ```js
1936
+ * spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
1937
+ * console.log('Conversation pinned', payload);
1938
+ * // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
1939
+ * })
1940
+ * ```
1941
+ */
1942
+ EmbedEvent["SpotterConversationPinned"] = "spotterConversationPinned";
1943
+ /**
1944
+ * Emitted when a Spotter conversation is unpinned.
1945
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
1946
+ * @example
1947
+ * ```js
1948
+ * spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
1949
+ * console.log('Conversation unpinned', payload);
1950
+ * // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
1951
+ * })
1952
+ * ```
1953
+ */
1954
+ EmbedEvent["SpotterConversationUnpinned"] = "spotterConversationUnpinned";
1783
1955
  /**
1784
1956
  * Emitted when a Spotter conversation is selected/clicked.
1785
1957
  * @example
@@ -2170,6 +2342,7 @@ var HostEvent;
2170
2342
  * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
2171
2343
  * console.log("iFrameURL", url);
2172
2344
  * ```
2345
+ * @returns iframeUrl - The URL currently loaded in the embedded iframe.
2173
2346
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2174
2347
  */
2175
2348
  HostEvent["GetIframeUrl"] = "GetIframeUrl";
@@ -2296,6 +2469,17 @@ var HostEvent;
2296
2469
  * name: string,
2297
2470
  * type: ATTRIBUTE/MEASURE,
2298
2471
  * dataType: INT64/CHAR/DATE }
2472
+ *
2473
+ * `applicability` - Optional. Scopes the filter to a specific target,
2474
+ * for example, a single Liveboard tab, so the panel for the correct
2475
+ * scoped filter is opened. Available from SDK: 1.53.0 |
2476
+ * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
2477
+ *
2478
+ * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
2479
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
2480
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
2481
+ * `level` is `LIVEBOARD`, since the filter applies to the whole
2482
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
2299
2483
  * @example
2300
2484
  * ```js
2301
2485
  * searchEmbed.trigger(HostEvent.OpenFilter,
@@ -2308,6 +2492,14 @@ var HostEvent;
2308
2492
  * ```
2309
2493
  * @example
2310
2494
  * ```js
2495
+ * // Open a filter scoped to a specific Liveboard tab
2496
+ * liveboardEmbed.trigger(HostEvent.OpenFilter, {
2497
+ * column: { columnId: '<column-GUID>' },
2498
+ * applicability: { level: 'TAB', targetId: '<tab-GUID>' }
2499
+ * });
2500
+ * ```
2501
+ * @example
2502
+ * ```js
2311
2503
  * // Open filter from search context
2312
2504
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
2313
2505
  * searchEmbed.trigger(HostEvent.OpenFilter, {
@@ -2317,6 +2509,73 @@ var HostEvent;
2317
2509
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2318
2510
  */
2319
2511
  HostEvent["OpenFilter"] = "openFilter";
2512
+ /**
2513
+ * Open the add-filter modal of a Liveboard, the same dialog that the
2514
+ * *Add filter* button in the Liveboard edit header opens, so the host
2515
+ * app can start the add-filter flow from its own UI.
2516
+ *
2517
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
2518
+ * Hiding the *Add filter* button with `hiddenActions:
2519
+ * [Action.AddFilter]` does not block this event, but disabling it with
2520
+ * `disabledActions` does.
2521
+ *
2522
+ * Unlike {@link HostEvent.OpenFilter}, which opens the panel of an
2523
+ * existing filter, this event starts the creation of a new filter.
2524
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
2525
+ * @example
2526
+ * ```js
2527
+ * liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);
2528
+ * ```
2529
+ */
2530
+ HostEvent["OpenAddFilterModal"] = "openAddFilterModal";
2531
+ /**
2532
+ * Open the add-parameter panel of a Liveboard, the same panel that the
2533
+ * *Add parameter* button in the Liveboard edit header opens.
2534
+ * Mirrors {@link HostEvent.OpenAddFilterModal} for parameters.
2535
+ *
2536
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
2537
+ * Hiding the *Add parameter* button with `hiddenActions:
2538
+ * [Action.AddParameter]` does not block this event, but disabling it
2539
+ * with `disabledActions` does.
2540
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
2541
+ * @example
2542
+ * ```js
2543
+ * liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);
2544
+ * ```
2545
+ */
2546
+ HostEvent["OpenAddParameterModal"] = "openAddParameterModal";
2547
+ /**
2548
+ * Open the parameter panel for a particular parameter on a Liveboard.
2549
+ * Mirrors {@link HostEvent.OpenFilter} for parameters.
2550
+ * @param - Includes the following keys:
2551
+ * - `parameter`: An object identifying the parameter to open, for
2552
+ * example, `{ parameterId: '<parameter-GUID>' }`.
2553
+ * - `applicability`: Optional. Scopes the parameter to a specific target,
2554
+ * for example, a single Liveboard tab, so the panel for the correct
2555
+ * scoped parameter is opened. Includes the following attributes:
2556
+ *
2557
+ * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
2558
+ * - `targetId`: The GUID of the target, for example, the tab GUID.
2559
+ * Required when `level` is `TAB` or `GROUP`. Do not pass it when
2560
+ * `level` is `LIVEBOARD`, since the parameter applies to the whole
2561
+ * Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
2562
+ * @example
2563
+ * ```js
2564
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
2565
+ * parameter: { parameterId: '<parameter-GUID>' }
2566
+ * });
2567
+ * ```
2568
+ * @example
2569
+ * ```js
2570
+ * // Open a parameter scoped to a specific group
2571
+ * liveboardEmbed.trigger(HostEvent.OpenParameter, {
2572
+ * parameter: { parameterId: '<parameter-GUID>' },
2573
+ * applicability: { level: 'GROUP', targetId: '<group-GUID>' }
2574
+ * });
2575
+ * ```
2576
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
2577
+ */
2578
+ HostEvent["OpenParameter"] = "openParameter";
2320
2579
  /**
2321
2580
  * Add columns to the current search query.
2322
2581
  * @param - { columnIds: string[] }
@@ -2366,6 +2625,10 @@ var HostEvent;
2366
2625
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
2367
2626
  * data=>console.log(data))
2368
2627
  * ```
2628
+ * @returns data - Object with a `v2Content` string: the export request
2629
+ * payload for the current Liveboard.
2630
+ * @returns type - The passthrough event name,
2631
+ * `getExportRequestForCurrentPinboard`.
2369
2632
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
2370
2633
  */
2371
2634
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
@@ -2468,6 +2731,9 @@ var HostEvent;
2468
2731
  * }, ContextType.Spotter);
2469
2732
  * ```
2470
2733
  *
2734
+ * @returns liveboardId - GUID of the Liveboard the Answer was pinned to.
2735
+ * @returns tabId - GUID of the tab within that Liveboard.
2736
+ * @returns vizId - GUID of the newly created visualization.
2471
2737
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2472
2738
  */
2473
2739
  HostEvent["Pin"] = "pin";
@@ -2506,13 +2772,13 @@ var HostEvent;
2506
2772
  * Trigger the **Manage schedule** action on an embedded Liveboard
2507
2773
  * @example
2508
2774
  * ```js
2509
- * liveboardEmbed.trigger(HostEvent.ScheduleList)
2775
+ * liveboardEmbed.trigger(HostEvent.SchedulesList)
2510
2776
  * ```
2511
2777
  * @example
2512
2778
  * ```js
2513
2779
  * // Manage schedules from liveboard context
2514
2780
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
2515
- * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
2781
+ * liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);
2516
2782
  * ```
2517
2783
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2518
2784
  */
@@ -2957,6 +3223,7 @@ var HostEvent;
2957
3223
  * console.log(tml.answer);
2958
3224
  * });
2959
3225
  * ```
3226
+ * @returns The TML representation of the current Answer, as an object.
2960
3227
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2961
3228
  * @important
2962
3229
  */
@@ -3381,13 +3648,13 @@ var HostEvent;
3381
3648
  /**
3382
3649
  * Get details of filters applied on the Liveboard.
3383
3650
  * Returns arrays containing Liveboard filter and runtime filter elements.
3384
- * Each Liveboard filter may include an `applicability` attribute
3651
+ * Each Liveboard filter includes an optional `applicability` attribute
3385
3652
  * indicating the scope of the filter. It contains a `level`
3386
3653
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
3387
3654
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
3388
3655
  * level there is no `targetId`, since the filter applies to the
3389
3656
  * whole Liveboard.
3390
- * The `applicability` attribute is available from SDK: 1.51.0 |
3657
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3391
3658
  * ThoughtSpot: 26.10.0.cl.
3392
3659
  * @example
3393
3660
  * ```js
@@ -3401,6 +3668,8 @@ var HostEvent;
3401
3668
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
3402
3669
  * console.log('filters', data);
3403
3670
  * ```
3671
+ * @returns liveboardFilters - Filters applied on the Liveboard.
3672
+ * @returns runtimeFilters - Runtime filters applied on the Liveboard.
3404
3673
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
3405
3674
  */
3406
3675
  HostEvent["GetFilters"] = "getFilters";
@@ -3430,7 +3699,7 @@ var HostEvent;
3430
3699
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
3431
3700
  *
3432
3701
  * `applicability` - Optional. Scopes the filter to a specific target,
3433
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
3702
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3434
3703
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3435
3704
  *
3436
3705
  * - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -3550,9 +3819,37 @@ var HostEvent;
3550
3819
  * console.log('tabs', tabDetails);
3551
3820
  * });
3552
3821
  * ```
3822
+ * @returns orderedTabIds - Tab GUIDs in the order they appear.
3823
+ * @returns numberOfTabs - Total number of tabs on the Liveboard.
3824
+ * @returns Tabs - Tab details, each with at least `id` and `name`.
3553
3825
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
3554
3826
  */
3555
3827
  HostEvent["GetTabs"] = "getTabs";
3828
+ /**
3829
+ * Get group details for the current Liveboard.
3830
+ * Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
3831
+ * @example
3832
+ * ```js
3833
+ * liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
3834
+ * console.log(
3835
+ * groupDetails // GroupDetails of current Liveboard
3836
+ * );
3837
+ * })
3838
+ * ```
3839
+ * @example
3840
+ * ```js
3841
+ * // Get groups from liveboard context
3842
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3843
+ * liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
3844
+ * console.log('groups', groupDetails);
3845
+ * });
3846
+ * ```
3847
+ * @returns orderedGroupIds - Group GUIDs in the order they appear.
3848
+ * @returns numberOfGroups - Total number of groups on the Liveboard.
3849
+ * @returns Groups - Group details, each with at least `id` and `name`.
3850
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
3851
+ */
3852
+ HostEvent["GetGroups"] = "getGroups";
3556
3853
  /**
3557
3854
  * Set the visible tabs on a Liveboard.
3558
3855
  * @param - an array of ids of tabs to show, the IDs not passed
@@ -3624,6 +3921,9 @@ var HostEvent;
3624
3921
  * // Alternative direct usage (not recommended)
3625
3922
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
3626
3923
  * ```
3924
+ * @returns session - Session identifier for the Answer, for use with the
3925
+ * `AnswerService`.
3926
+ * @returns embedAnswerData - Data backing the Answer, when available.
3627
3927
  * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
3628
3928
  */
3629
3929
  HostEvent["GetAnswerSession"] = "getAnswerSession";
@@ -3681,7 +3981,7 @@ var HostEvent;
3681
3981
  * - `value`: The value to set for the parameter.
3682
3982
  * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
3683
3983
  * - `applicability`: Optional. Scopes the parameter to a specific target,
3684
- * for example, a single Liveboard tab. Available from SDK: 1.51.0 |
3984
+ * for example, a single Liveboard tab. Available from SDK: 1.53.0 |
3685
3985
  * ThoughtSpot: 26.10.0.cl. Includes the following attributes:
3686
3986
  *
3687
3987
  * - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
@@ -3725,13 +4025,13 @@ var HostEvent;
3725
4025
  HostEvent["UpdateParameters"] = "UpdateParameters";
3726
4026
  /**
3727
4027
  * Triggers GetParameters to fetch the runtime Parameters.
3728
- * Each parameter may include an `applicability` attribute
4028
+ * Each parameter includes an optional `applicability` attribute
3729
4029
  * indicating the scope of the parameter. It contains a `level`
3730
4030
  * (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
3731
4031
  * `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
3732
4032
  * level there is no `targetId`, since the parameter applies to the
3733
4033
  * whole Liveboard.
3734
- * The `applicability` attribute is available from SDK: 1.51.0 |
4034
+ * The `applicability` attribute is available from SDK: 1.53.0 |
3735
4035
  * ThoughtSpot: 26.10.0.cl.
3736
4036
  * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3737
4037
  * ```js
@@ -3757,12 +4057,16 @@ var HostEvent;
3757
4057
  * console.log('parameters', parameters);
3758
4058
  * });
3759
4059
  * ```
4060
+ * @returns parameters - Parameters currently applied on the Liveboard.
3760
4061
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
3761
4062
  */
3762
4063
  HostEvent["GetParameters"] = "GetParameters";
3763
4064
  /**
3764
4065
  * Triggers an event to update a personalized view of a Liveboard.
3765
- * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
4066
+ * This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
4067
+ * which additionally accepts a `viewName`, resets to the original view when
4068
+ * called with an empty payload, and reports an error when a named view
4069
+ * cannot be found.
3766
4070
  * ```js
3767
4071
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
3768
4072
  * ```
@@ -3780,10 +4084,15 @@ var HostEvent;
3780
4084
  HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
3781
4085
  /**
3782
4086
  * Triggers an event to update a personalized view of a Liveboard.
4087
+ * This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
4088
+ * which additionally accepts a `viewName`, resets to the original view when
4089
+ * called with an empty payload, and reports an error when a named view
4090
+ * cannot be found.
3783
4091
  * ```js
3784
4092
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
3785
4093
  * ```
3786
4094
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4095
+ * @deprecated SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
3787
4096
  */
3788
4097
  HostEvent["UpdatePersonalizedView"] = "UpdatePersonalisedView";
3789
4098
  /**
@@ -3886,6 +4195,10 @@ var HostEvent;
3886
4195
  * description: "Generated from Spotter"
3887
4196
  * }, ContextType.Spotter);
3888
4197
  * ```
4198
+ * @returns answerId - GUID of the saved Answer.
4199
+ * @returns saveResponse - Raw response from the save operation.
4200
+ * @returns shareResponse - Raw response from the share operation, when the
4201
+ * Answer was also made discoverable.
3889
4202
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
3890
4203
  */
3891
4204
  HostEvent["SaveAnswer"] = "saveAnswer";
@@ -3999,6 +4312,36 @@ var HostEvent;
3999
4312
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4000
4313
  */
4001
4314
  HostEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
4315
+ /**
4316
+ * Opens the Spotter share-conversation modal for the given conversation.
4317
+ * `conversationId` is **mandatory** — you must pass the id of the
4318
+ * conversation to share. Also no-op when sharing is disabled
4319
+ * (enableShareConversation off) or when already in the read-only shared view.
4320
+ * @example
4321
+ * ```js
4322
+ * spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
4323
+ * ```
4324
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4325
+ */
4326
+ HostEvent["ShareSpotterConversation"] = "ShareSpotterConversation";
4327
+ /**
4328
+ * Closes the Spotter share-conversation modal. No-op if none is open.
4329
+ * @example
4330
+ * ```js
4331
+ * spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
4332
+ * ```
4333
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4334
+ */
4335
+ HostEvent["CloseSpotterShareConversation"] = "CloseSpotterShareConversation";
4336
+ /**
4337
+ * Exits the read-only shared-conversation view.
4338
+ * @example
4339
+ * ```js
4340
+ * spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
4341
+ * ```
4342
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
4343
+ */
4344
+ HostEvent["ExitSpotterSharedConversation"] = "ExitSpotterSharedConversation";
4002
4345
  /**
4003
4346
  * Deletes the last prompt in spotter embed.
4004
4347
  * @example
@@ -4094,6 +4437,41 @@ var HostEvent;
4094
4437
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4095
4438
  */
4096
4439
  HostEvent["StartNewSpotterConversation"] = "StartNewSpotterConversation";
4440
+ /**
4441
+ * Pins a saved Spotter conversation so it floats to the top of the past
4442
+ * conversations sidebar. The `conversationId` of the conversation to pin is
4443
+ * required.
4444
+ *
4445
+ * This feature is available only when chat history is enabled on your ThoughtSpot
4446
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
4447
+ * instance.
4448
+ *
4449
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4450
+ * @example
4451
+ * ```js
4452
+ * spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
4453
+ * conversationId: '<conversation-id>',
4454
+ * });
4455
+ * ```
4456
+ */
4457
+ HostEvent["PinSpotterConversation"] = "PinSpotterConversation";
4458
+ /**
4459
+ * Unpins a previously pinned Spotter conversation. The `conversationId` of the
4460
+ * conversation to unpin is required.
4461
+ *
4462
+ * This feature is available only when chat history is enabled on your ThoughtSpot
4463
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
4464
+ * instance.
4465
+ *
4466
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4467
+ * @example
4468
+ * ```js
4469
+ * spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
4470
+ * conversationId: '<conversation-id>',
4471
+ * });
4472
+ * ```
4473
+ */
4474
+ HostEvent["UnpinSpotterConversation"] = "UnpinSpotterConversation";
4097
4475
  /**
4098
4476
  * @hidden
4099
4477
  * Get the current context of the embedded page.
@@ -4302,6 +4680,7 @@ var Param;
4302
4680
  Param["NumberFormatLocale"] = "numberFormatLocale";
4303
4681
  Param["CurrencyFormat"] = "currencyFormat";
4304
4682
  Param["Enable2ColumnLayout"] = "enable2ColumnLayout";
4683
+ Param["IsLiveboardAlwaysOn12ColLayout"] = "isLiveboardAlwaysOn12ColLayout";
4305
4684
  Param["IsFullAppEmbed"] = "isFullAppEmbed";
4306
4685
  Param["IsOnBeforeGetVizDataInterceptEnabled"] = "isOnBeforeGetVizDataInterceptEnabled";
4307
4686
  Param["FocusSearchBarOnRender"] = "focusSearchBarOnRender";
@@ -4325,6 +4704,7 @@ var Param;
4325
4704
  Param["PrimaryAction"] = "primaryAction";
4326
4705
  Param["isSpotterAgentEmbed"] = "isSpotterAgentEmbed";
4327
4706
  Param["IsLiveboardStylingAndGroupingEnabled"] = "isLiveboardStylingAndGroupingEnabled";
4707
+ Param["LiveboardGutter"] = "liveboardGutter";
4328
4708
  Param["IsLazyLoadingForEmbedEnabled"] = "isLazyLoadingForEmbedEnabled";
4329
4709
  Param["RootMarginForLazyLoad"] = "rootMarginForLazyLoad";
4330
4710
  Param["isPNGInScheduledEmailsEnabled"] = "isPNGInScheduledEmailsEnabled";
@@ -4333,9 +4713,11 @@ var Param;
4333
4713
  Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
4334
4714
  Param["isSendNowLiveboardSchedulingEnabled"] = "isSendNowLiveboardSchedulingEnabled";
4335
4715
  Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
4716
+ Param["isScopedLiveboardFilteringEnabled"] = "isScopedLiveboardFilteringEnabled";
4336
4717
  Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
4337
4718
  Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
4338
4719
  Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
4720
+ Param["ShowSpotterRadiance"] = "showSpotterRadiance";
4339
4721
  Param["DefaultQueryMode"] = "defaultQueryMode";
4340
4722
  Param["EnableStopAnswerGenerationEmbed"] = "enableStopAnswerGenerationEmbed";
4341
4723
  Param["SpotterSidebarTitle"] = "spotterSidebarTitle";
@@ -4356,14 +4738,19 @@ var Param;
4356
4738
  Param["SpotterFileUploadEnabled"] = "spotterFileUploadEnabled";
4357
4739
  Param["SpotterFileUploadFileTypes"] = "spotterFileUploadFileTypes";
4358
4740
  Param["IsStarterPromptsEnabled"] = "enableStarterPrompts";
4741
+ Param["UpdatedSpotterExperience"] = "updatedSpotterExperience";
4742
+ Param["SpotterDataSources"] = "spotterDataSources";
4743
+ Param["AnalystId"] = "analystId";
4744
+ Param["OpenSpotterOnLiveboardByDefault"] = "openSpotterOnLiveboardByDefault";
4359
4745
  })(Param = exports.Param || (exports.Param = {}));
4360
4746
  /**
4361
4747
  * ThoughtSpot application pages include actions and menu commands
4362
4748
  * for various user-initiated operations. These actions are represented
4363
4749
  * as enumeration members in the SDK. To control actions in the embedded view:
4364
- * - disabledActions — the action is grayed out and still visible, but non-interactive (user can see but not click).
4365
- * - hiddenActions — the action is completely removed from the UI (user cannot see it at all).
4366
- * - visibleActions — allowlist, only these actions are shown; all others are hidden.
4750
+ * - disabledActions — the action is grayed out and still visible, but non-interactive
4751
+ * (user can see but not click). - hiddenActions — the action is completely removed from
4752
+ * the UI (user cannot see it at all). - visibleActions — allowlist, only these actions
4753
+ * are shown; all others are hidden.
4367
4754
  *
4368
4755
  * Use disabledActions to disable (gray out) an action.
4369
4756
  * Use hiddenActions to hide (fully remove) an action.
@@ -4417,6 +4804,17 @@ var Action;
4417
4804
  * ```
4418
4805
  */
4419
4806
  Action["SaveAsView"] = "saveAsView";
4807
+ /**
4808
+ * The **EditInputTable** action on a Liveboard
4809
+ * page. Allows users to edit an input table used in an Answer directly from
4810
+ * a Liveboard.
4811
+ * @example
4812
+ * ```js
4813
+ * disabledActions: [Action.EditInputTable]
4814
+ * ```
4815
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
4816
+ */
4817
+ Action["EditInputTable"] = "editInputTable";
4420
4818
  /**
4421
4819
  * The **Make a copy** action on a Liveboard or Answer
4422
4820
  * page. Creates a copy of the Liveboard.
@@ -5620,6 +6018,19 @@ var Action;
5620
6018
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
5621
6019
  */
5622
6020
  Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
6021
+ /**
6022
+ * Action ID to show, hide, or disable all filter surfaces on a Liveboard,
6023
+ * including filter, parameter, and cross-filter chips at the liveboard,
6024
+ * tab, and group levels. Parameter and cross-filter chips are hide-only.
6025
+ *
6026
+ * @example
6027
+ * ```js
6028
+ * hiddenActions: [Action.AllLiveboardFilters]
6029
+ * disabledActions: [Action.AllLiveboardFilters]
6030
+ * ```
6031
+ * @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
6032
+ */
6033
+ Action["AllLiveboardFilters"] = "allLiveboardFilters";
5623
6034
  /**
5624
6035
  * The **Data model instructions** button on the Spotter interface.
5625
6036
  * Allows opening the data model instructions modal.
@@ -5721,6 +6132,10 @@ var Action;
5721
6132
  * The **Add to Coaching** feature allows adding reference questions and
5722
6133
  * business terms to improve Spotter’s responses. This feature is generally available
5723
6134
  * (GA) from version 26.2.0.cl and enabled by default on embed deployments.
6135
+ *
6136
+ * This action governs both the answer-card **Add to memory** CTA and its
6137
+ * Spotter 3 successor, the response-footer **Remember this** CTA
6138
+ * (they are mutually exclusive).
5724
6139
  * @example
5725
6140
  * ```js
5726
6141
  * hiddenAction: [Action.InConversationTraining]
@@ -5955,6 +6370,89 @@ var Action;
5955
6370
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5956
6371
  */
5957
6372
  Action["SpotterChatRename"] = "spotterChatRename";
6373
+ /**
6374
+ * Controls visibility and disable state of the Spotter conversation Share
6375
+ * button in the chat header. Only takes effect once sharing is enabled
6376
+ * (enableShareConversation on).
6377
+ * @example
6378
+ * ```js
6379
+ * disabledActions: [Action.SpotterShareConversationButtonHeader]
6380
+ * ```
6381
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6382
+ */
6383
+ Action["SpotterShareConversationButtonHeader"] = "spotterShareConversationButtonHeader";
6384
+ /**
6385
+ * Controls visibility and disable state of the Share item in the Spotter
6386
+ * conversation history (sidebar) edit menu. Independent of the header button
6387
+ * above, so a host can show Share in one entry point and hide it in the other.
6388
+ * @example
6389
+ * ```js
6390
+ * disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
6391
+ * ```
6392
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6393
+ */
6394
+ Action["SpotterShareConversationMenuItemSidebar"] = "spotterShareConversationMenuItemSidebar";
6395
+ /**
6396
+ * Controls visibility of the entire read-only shared-conversation data-access
6397
+ * banner shown when a recipient opens a shared view. Hide-only.
6398
+ * @example
6399
+ * ```js
6400
+ * hiddenActions: [Action.SpotterSharedConversationBanner]
6401
+ * ```
6402
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6403
+ */
6404
+ Action["SpotterSharedConversationBanner"] = "spotterSharedConversationBanner";
6405
+ /**
6406
+ * Controls visibility and disable state of the cross/close button on the
6407
+ * read-only shared-conversation data-access banner (keeps the banner itself).
6408
+ * @example
6409
+ * ```js
6410
+ * hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
6411
+ * ```
6412
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6413
+ */
6414
+ Action["SpotterSharedConversationBannerDismissButton"] = "spotterSharedConversationBannerDismissButton";
6415
+ /**
6416
+ * Controls visibility and disable state of the Exit button in the read-only
6417
+ * shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
6418
+ * host event.
6419
+ * @example
6420
+ * ```js
6421
+ * hiddenActions: [Action.SpotterSharedConversationExitButton]
6422
+ * ```
6423
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6424
+ */
6425
+ Action["SpotterSharedConversationExitButton"] = "spotterSharedConversationExitButton";
6426
+ /**
6427
+ * Controls visibility of the share-modal footer note ("Chat will be shared up
6428
+ * to the current moment…"). Hide-only.
6429
+ * @example
6430
+ * ```js
6431
+ * hiddenActions: [Action.SpotterShareUpToCurrentInfo]
6432
+ * ```
6433
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6434
+ */
6435
+ Action["SpotterShareUpToCurrentInfo"] = "spotterShareUpToCurrentInfo";
6436
+ /**
6437
+ * Controls visibility and disable state of the share-modal "include new
6438
+ * messages since last shared version" checkbox.
6439
+ * @example
6440
+ * ```js
6441
+ * disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
6442
+ * ```
6443
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6444
+ */
6445
+ Action["SpotterShareIncludeNewMessagesCheckbox"] = "spotterShareIncludeNewMessagesCheckbox";
6446
+ /**
6447
+ * Controls visibility and disable state of the cross on the share-modal
6448
+ * stale-snapshot info banner.
6449
+ * @example
6450
+ * ```js
6451
+ * hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
6452
+ * ```
6453
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6454
+ */
6455
+ Action["SpotterShareStaleInfoBannerDismissButton"] = "spotterShareStaleInfoBannerDismissButton";
5958
6456
  /**
5959
6457
  * Controls visibility and disable state of the delete action
5960
6458
  * in the Spotter conversation edit menu.
@@ -5965,6 +6463,16 @@ var Action;
5965
6463
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
5966
6464
  */
5967
6465
  Action["SpotterChatDelete"] = "spotterChatDelete";
6466
+ /**
6467
+ * Controls visibility and disable state of the pin/unpin action
6468
+ * in the Spotter conversation edit menu.
6469
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6470
+ * @example
6471
+ * ```js
6472
+ * disabledActions: [Action.SpotterChatPin]
6473
+ * ```
6474
+ */
6475
+ Action["SpotterChatPin"] = "spotterChatPin";
5968
6476
  /**
5969
6477
  * Controls visibility and disable state of the documentation/best practices
5970
6478
  * link in the Spotter sidebar footer.
@@ -6008,6 +6516,56 @@ var Action;
6008
6516
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
6009
6517
  */
6010
6518
  Action["SpotterChatModeSwitcher"] = "spotterChatModeSwitcher";
6519
+ /**
6520
+ * The **Basic Search** starter prompt pill.
6521
+ *
6522
+ * Starter prompt pills are the row of category buttons shown above the
6523
+ * Spotter chat input before a conversation starts. They give a new user
6524
+ * ready-made questions to click instead of typing one from scratch, and
6525
+ * disappear once the conversation begins. There are three, one per action
6526
+ * below.
6527
+ *
6528
+ * Clicking this pill opens a card of suggested simple questions; picking one
6529
+ * submits it to Spotter right away. Visible by default, and hidden along
6530
+ * with the other pills when the surface itself is off (see
6531
+ * {@link SpotterChatViewConfig.starterPrompts}).
6532
+ * @example
6533
+ * ```js
6534
+ * hiddenActions: [Action.QuickSearchPill]
6535
+ * ```
6536
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6537
+ */
6538
+ Action["QuickSearchPill"] = "quickSearchPill";
6539
+ /**
6540
+ * The **Deep Analysis** starter prompt pill, next to
6541
+ * {@link Action.QuickSearchPill} above the Spotter chat input.
6542
+ *
6543
+ * Clicking it opens a card of suggested investigative questions ("why did
6544
+ * revenue drop?"). Picking one fills the chat input in Deep Analysis mode
6545
+ * rather than submitting immediately, so the user can edit it first.
6546
+ * Visible by default.
6547
+ * @example
6548
+ * ```js
6549
+ * hiddenActions: [Action.DeepAnalysisPill]
6550
+ * ```
6551
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6552
+ */
6553
+ Action["DeepAnalysisPill"] = "deepAnalysisPill";
6554
+ /**
6555
+ * The **Data Literacy** starter prompt pill, next to
6556
+ * {@link Action.QuickSearchPill} above the Spotter chat input.
6557
+ *
6558
+ * Unlike the other two pills it opens no card: clicking it submits a prompt
6559
+ * that describes the data the model can answer over, helping a user who does
6560
+ * not yet know what is in the data source. The prompt text always comes from
6561
+ * ThoughtSpot, so only its label is customizable. Visible by default.
6562
+ * @example
6563
+ * ```js
6564
+ * hiddenActions: [Action.DataLiteracyPill]
6565
+ * ```
6566
+ * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
6567
+ */
6568
+ Action["DataLiteracyPill"] = "dataLiteracyPill";
6011
6569
  /**
6012
6570
  * The **Include current period** checkbox for date filters.
6013
6571
  * Controls the visibility and availability of the option to include
@@ -6156,6 +6714,38 @@ var Action;
6156
6714
  * ```
6157
6715
  */
6158
6716
  Action["SpotterAnalystSidebar"] = "spotterAnalystSidebar";
6717
+ /**
6718
+ * Controls visibility and disable state of the analyst list
6719
+ * ("Show all") in the Spotter Analyst interface.
6720
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6721
+ * @example
6722
+ * ```js
6723
+ * hiddenActions: [Action.SpotterAnalystList]
6724
+ * disabledActions: [Action.SpotterAnalystList]
6725
+ * ```
6726
+ */
6727
+ Action["SpotterAnalystList"] = "spotterAnalystList";
6728
+ /**
6729
+ * Controls visibility and disable state of the default Spotter analyst
6730
+ * entry in the Spotter Analyst interface.
6731
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6732
+ * @example
6733
+ * ```js
6734
+ * hiddenActions: [Action.SpotterDefaultAnalyst]
6735
+ * disabledActions: [Action.SpotterDefaultAnalyst]
6736
+ * ```
6737
+ */
6738
+ Action["SpotterDefaultAnalyst"] = "spotterDefaultAnalyst";
6739
+ /**
6740
+ * The **Spotter** button in the Liveboard header.
6741
+ * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
6742
+ * @example
6743
+ * ```js
6744
+ * hiddenActions: [Action.SpotterOnLiveboard]
6745
+ * disabledActions: [Action.SpotterOnLiveboard]
6746
+ * ```
6747
+ */
6748
+ Action["SpotterOnLiveboard"] = "spotterOnLiveboard";
6159
6749
  })(Action = exports.Action || (exports.Action = {}));
6160
6750
  var PrefetchFeatures;
6161
6751
  (function (PrefetchFeatures) {